Battery Service

Battery service sample implementation API. More...

Files
file	bas.h
	Battery Service sample implementation API.

Data Structures
struct	bas_battery_info_t

Functions
ble_service_t *	bas_init (const ble_service_config_t *config, const bas_battery_info_t *info)
void	bas_notify_level (ble_service_t *svc, uint16_t conn_idx)
void	bas_set_level (ble_service_t *svc, uint8_t level, bool notify)

Detailed Description

Battery service sample implementation API.

Function Documentation

bas_init()

ble_service_t* bas_init	(	const ble_service_config_t *	config,
		const bas_battery_info_t *	info
	)

Register Battery Service instance

For application with single instance of BAS, info parameter is optional. Otherwise info is mandatory as per BAS 1.0 specification since this will add Content Presentation Format descriptor to Battery Level characteristic.

Parameters

[in]	config	service configuration
[in]	info	battery instance information

Returns

service instance

bas_notify_level()

void bas_notify_level	(	ble_service_t *	svc,
		uint16_t	conn_idx
	)

Notify client with battery level

Parameters

[in]	svc	service instance
[in]	conn_idx	connection index

bas_set_level()

void bas_set_level	(	ble_service_t *	svc,
		uint8_t	level,
		bool	notify
	)

Set reported battery level

Parameters

[in]	svc	service instance
[in]	level	new battery level
[in]	notify	true if clients shall be notified, false otherwise