ruuvi_task_advertisement.h File Reference

#include "ruuvi_driver_error.h"
#include "ruuvi_interface_communication_ble_advertising.h"

Go to the source code of this file.

Data Structures
struct	rt_adv_init_t
	Initial configuration for advertisement. PHY will be transferred to GATT. More...

Macros
#define	SCAN_RSP_NAME_MAX_LEN   (11U)
	Longer name gets truncated when advertised with UUID.
#define	RT_ADV_SCAN_WINDOW_MS   (7000U)
	Window of one scan per channel. Scan takes this * num_channels time.
#define	RT_ADV_SCAN_INTERVAL_MS   (7000U)

Functions
rd_status_t	rt_adv_init (rt_adv_init_t *const adv_init_settings)
	Initializes data advertising.
rd_status_t	rt_adv_uninit (void)
	Uninitializes data advertising.
rd_status_t	rt_adv_stop (void)
	Stops advertising. This is relevant only if the message was on repeat.
rd_status_t	rt_adv_send_data (ri_comm_message_t *const msg)
	Send given message as a BLE advertisement.
rd_status_t	rt_adv_connectability_set (const bool enable, const char *const device_name)
	Start advertising BLE GATT connection.
bool	rt_adv_is_init (void)
	check if advertisement is initialized
rd_status_t	rt_adv_scan_start (const ri_comm_evt_handler_fp_t on_evt)
	Start scanning BLE advertisements.
rd_status_t	rt_adv_scan_stop (void)
	Abort scanning.

Detailed Description

Author

Otso Jousimaa otso@.nosp@m.ojou.nosp@m.sima..nosp@m.net

Date

2020-06-01

Copyright

Ruuvi Innovations Ltd, license BSD-3-Clause.

Advertise data and GATT connection if available.

Typical usage:

rd_status_t err_code = RD_SUCCESS;
err_code |= ri_radio_init(RI_RADIO_BLE_2MBPS);
ri_radio_channels_t channels;
channels.channel_37 = 1;
channels.channel_38 = 1;
channels.channel_39 = 1;
rt_adv_init_t adv_settings;
adv_settings.adv_interval_ms = APP_ADV_INTERVAL_MS;
adv_settings.adv_pwr_dbm = RB_TX_POWER_MAX;
adv_settings.channels = channels;
adv_settings.manufacturer_id = RB_BLE_MANUFACTURER_ID;
err_code |= rt_adv_init(&adv_settings);
err_code |= ri_adv_type_set(NONCONNECTABLE_NONSCANNABLE);
err_code |= rt_adv_send_data (&my_message);

Definition in file ruuvi_task_advertisement.h.