settings.h File Reference

Configures Bluetooth Low Energy advertisement and connection settings. More...

#include <stdint.h>
#include "datasignal_fwd.h"
#include "event_fwd.h"
#include "metawearboard_fwd.h"
#include "metawear/platform/dllmarker.h"

Go to the source code of this file.

Classes
struct	MblMwBtleAddress
	BLE MAC Address. More...

Enumerations
enum	MblMwWhitelistFilter { MBL_MW_WHITELIST_FILTER_ALLOW_FROM_ANY = 0, MBL_MW_WHITELIST_FILTER_SCAN_REQUESTS = 1, MBL_MW_WHITELIST_FILTER_CONNECTION_REQUESTS = 2, MBL_MW_WHITELIST_FILTER_SCAN_AND_CONNECTION_REQUESTS = 3 }
	Whitelist filter modes.
enum	MblMwBleAdType { MBL_MW_BLE_AD_TYPE_CONNECTED_UNDIRECTED = 0, MBL_MW_BLE_AD_TYPE_CONNECTED_DIRECTED = 1 }

Functions
METAWEAR_API MblMwEvent *	mbl_mw_settings_get_disconnect_event (const MblMwMetaWearBoard *board)
	Retrieves an event pointer representing a disconnect event. More...
METAWEAR_API MblMwDataSignal *	mbl_mw_settings_get_battery_state_data_signal (const MblMwMetaWearBoard *board)
	Retrieves the data signal representing battery state. More...
METAWEAR_API MblMwDataSignal *	mbl_mw_settings_get_mac_data_signal (const MblMwMetaWearBoard *board)
	Retrieves the data signal representing the device GAP (MAC) address. More...
METAWEAR_API void	mbl_mw_settings_set_device_name (const MblMwMetaWearBoard *board, const uint8_t *device_name, uint8_t len)
	Sets the advertisement name. More...
METAWEAR_API void	mbl_mw_settings_set_ad_interval (const MblMwMetaWearBoard *board, uint16_t interval, uint8_t timeout)
METAWEAR_API void	mbl_mw_settings_set_ad_parameters (const MblMwMetaWearBoard *board, uint16_t interval, uint8_t timeout, MblMwBleAdType type)
	Configures Bluetooth LE ad parameters. More...
METAWEAR_API void	mbl_mw_settings_set_tx_power (const MblMwMetaWearBoard *board, int8_t tx_power)
	Sets advertising transmitting power. More...
METAWEAR_API void	mbl_mw_settings_start_advertising (const MblMwMetaWearBoard *board)
	Starts advertising. More...
METAWEAR_API void	mbl_mw_settings_set_scan_response (const MblMwMetaWearBoard *board, const uint8_t *response, uint8_t len)
	Sets scan response. More...
METAWEAR_API void	mbl_mw_settings_set_connection_parameters (const MblMwMetaWearBoard *board, float min_conn_interval, float max_conn_interval, uint16_t latency, uint16_t timeout)
	Sets connection parameters. More...
METAWEAR_API void	mbl_mw_settings_add_whitelist_address (const MblMwMetaWearBoard *board, uint8_t index, const MblMwBtleAddress *address)
	Adds MAC Addresses for Whitelist filtering. More...
METAWEAR_API MblMwDataSignal *	mbl_mw_settings_get_whitelist_data_signal (MblMwMetaWearBoard *board, uint8_t index)
	Adds MAC Addresses for Whitelist filtering. More...
METAWEAR_API void	mbl_mw_settings_set_whitelist_filter_mode (const MblMwMetaWearBoard *board, MblMwWhitelistFilter mode)
	Sets connection parameters. More...

Variables
const uint8_t	MBL_MW_ADDRESS_TYPE_PUBLIC = 0
	Types of BLE addresses.
const uint8_t	MBL_MW_ADDRESS_TYPE_RANDOM_STATIC = 1
const uint8_t	MBL_MW_ADDRESS_TYPE_PRIVATE_RESOLVABLE = 2
const uint8_t	MBL_MW_ADDRESS_TYPE_PRIVATE_NON_RESOLVABLE = 3
const uint8_t	MBL_MW_SETTINGS_BATTERY_VOLTAGE_INDEX = 0
	< Indices for component values of the battery data signal, to be used with mbl_mw_datasignal_get_component
const uint8_t	MBL_MW_SETTINGS_BATTERY_CHARGE_INDEX = 1
	< Indices for component values of the battery data signal, to be used with mbl_mw_datasignal_get_component

Detailed Description

Configures Bluetooth Low Energy advertisement and connection settings.

Copyright

MbientLab License

Function Documentation

mbl_mw_settings_add_whitelist_address()

METAWEAR_API void mbl_mw_settings_add_whitelist_address	(	const MblMwMetaWearBoard *	board,
		uint8_t	index,
		const MblMwBtleAddress *	address
	)

Adds MAC Addresses for Whitelist filtering.

Parameters

board	Board to modify
index	Whitelist MAC address in range [1, 8], must start at 1 and go in increasing order
address	Address to add

mbl_mw_settings_get_battery_state_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_settings_get_battery_state_data_signal

(

const MblMwMetaWearBoard *

board

)

Retrieves the data signal representing battery state.

Parameters

board

Calling object

Returns

Pointer to the battery state signal

mbl_mw_settings_get_disconnect_event()

METAWEAR_API MblMwEvent* mbl_mw_settings_get_disconnect_event

(

const MblMwMetaWearBoard *

board

)

Retrieves an event pointer representing a disconnect event.

Parameters

board

Board the event is fired on

Returns

Pointer to the disconnect event

mbl_mw_settings_get_mac_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_settings_get_mac_data_signal

(

const MblMwMetaWearBoard *

board

)

Retrieves the data signal representing the device GAP (MAC) address.

Parameters

board

Calling object

Returns

Pointer to the mac signal

mbl_mw_settings_get_whitelist_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_settings_get_whitelist_data_signal	(	MblMwMetaWearBoard *	board,
		uint8_t	index
	)

Adds MAC Addresses for Whitelist filtering.

Parameters

board	Board to modify
index	Whitelist MAC address in range [1, 8], must start at 1 and go in increasing order
address	Address to add

mbl_mw_settings_set_ad_interval()

METAWEAR_API void mbl_mw_settings_set_ad_interval	(	const MblMwMetaWearBoard *	board,
		uint16_t	interval,
		uint8_t	timeout
	)

Deprecated:

In v0.14.0, use mbl_mw_settings_set_ad_parameters instead

mbl_mw_settings_set_ad_parameters()

METAWEAR_API void mbl_mw_settings_set_ad_parameters	(	const MblMwMetaWearBoard *	board,
		uint16_t	interval,
		uint8_t	timeout,
		MblMwBleAdType	type
	)

Configures Bluetooth LE ad parameters.

Parameters

board	Calling object
interval	Advertisement interval, between [0, 65535] milliseconds
timeout	Advertisement timeout, between [0, 180] seconds where 0 indicates no timeout
type	Advertisement type, ignored if unsupported on current firmware

mbl_mw_settings_set_connection_parameters()

METAWEAR_API void mbl_mw_settings_set_connection_parameters	(	const MblMwMetaWearBoard *	board,
		float	min_conn_interval,
		float	max_conn_interval,
		uint16_t	latency,
		uint16_t	timeout
	)

Sets connection parameters.

Parameters

board	Board to modify
min_conn_interval	Connection interval lower bound, min 7.5ms
max_conn_interval	Connection interval upper bound, max 4000ms
latency	Number of connection intervals to skip, betwen [0, 1000]
timeout	Max time between data exchanges until the connection is considered to be lost, between [10, 32000]ms

mbl_mw_settings_set_device_name()

METAWEAR_API void mbl_mw_settings_set_device_name	(	const MblMwMetaWearBoard *	board,
		const uint8_t *	device_name,
		uint8_t	len
	)

Sets the advertisement name.

Parameters

board	Board to modify
device_name	Byte array containing the device name, max 8 ASCII characters
len	Length of the array

mbl_mw_settings_set_scan_response()

METAWEAR_API void mbl_mw_settings_set_scan_response	(	const MblMwMetaWearBoard *	board,
		const uint8_t *	response,
		uint8_t	len
	)

Sets scan response.

Parameters

board	Board to modify
response	Scan response as a byte array
len	Length of the array

mbl_mw_settings_set_tx_power()

METAWEAR_API void mbl_mw_settings_set_tx_power	(	const MblMwMetaWearBoard *	board,
		int8_t	tx_power
	)

Sets advertising transmitting power.

If a non valid value is set, the nearest valid value will be used instead

Parameters

board	Board to set the TX power
tx_power	Valid values are: 4, 0, -4, -8, -12, -16, -20, -30

mbl_mw_settings_set_whitelist_filter_mode()

METAWEAR_API void mbl_mw_settings_set_whitelist_filter_mode	(	const MblMwMetaWearBoard *	board,
		MblMwWhitelistFilter	mode
	)

Sets connection parameters.

Parameters

board	Board to modify
mode	Whitelist filter mode

mbl_mw_settings_start_advertising()

METAWEAR_API void mbl_mw_settings_start_advertising

(

const MblMwMetaWearBoard *

board

)

Starts advertising.

Parameters

board

Board to start btle advertisement