Scan Parameters Service

Scan Parameters Service Client. More...

Files
file	scps_client.h
	Scan Parameters Service Client header file.

Data Structures
struct	scps_client_callbacks_t

Typedefs
typedef void(*	scps_client_set_event_state_completed_cb_t) (ble_client_t *scps_client, scps_client_event_t event, att_error_t status)
	Set event state completed callback. More...
typedef void(*	scps_client_get_event_state_completed_cb_t) (ble_client_t *scps_client, scps_client_event_t event, att_error_t status, bool enabled)
	Get event state completed callback. More...
typedef void(*	scps_client_refresh_notif_cb_t) (ble_client_t *scps_client)

Enumerations
enum	scps_client_event_t { SCPS_CLIENT_EVENT_REFRESH_NOTIF = 0x01 }
enum	scps_client_cap_t { SCPS_CLIENT_CAP_REFRESH = 0x01 }

Functions
ble_client_t *	scps_client_init (const scps_client_callbacks_t *cb, const ble_evt_gattc_browse_svc_t *evt)
	Register SCPS Client instance. More...
scps_client_cap_t	scps_client_get_capabilities (ble_client_t *scps_client)
	Get capabilites. More...
bool	scps_client_get_event_state (ble_client_t *scps_client, scps_client_event_t event)
	Get event state. More...
bool	scps_client_set_event_state (ble_client_t *scps_client, scps_client_event_t event, bool enable)
	Set Refresh characteristic notification state. More...
bool	scps_client_write_scan_interval_window (ble_client_t *scps_client, uint16_t scan_interval, uint16_t scan_window)
	Write Scan Interval Window. More...

Detailed Description

Scan Parameters Service Client.

Typedef Documentation

scps_client_get_event_state_completed_cb_t

typedef void(* scps_client_get_event_state_completed_cb_t) (ble_client_t *scps_client, scps_client_event_t event, att_error_t status, bool enabled)

Get event state completed callback.

Called When particular characteristic's event state has been returned by server

Parameters

[in]	scps_client	SCPS Client instance
[in]	event	Event type
[in]	status	ATT status of operation
[in]	enabled	State flag

scps_client_refresh_notif_cb_t

typedef void(* scps_client_refresh_notif_cb_t) (ble_client_t *scps_client)

Refresh characteristic notification callback

Called when refresh notification has been received

Parameters

[in]

scps_client

SCPS Client instance

scps_client_set_event_state_completed_cb_t

typedef void(* scps_client_set_event_state_completed_cb_t) (ble_client_t *scps_client, scps_client_event_t event, att_error_t status)

Set event state completed callback.

Called When particular characteristic's event state has been set

Parameters

[in]	scps_client	SCPS Client instance
[in]	event	Event type
[in]	status	ATT status of operation

Enumeration Type Documentation

scps_client_cap_t

enum scps_client_cap_t

Supported characteristics bit mask

Enumerator
SCPS_CLIENT_CAP_REFRESH	Refresh characteristic

scps_client_event_t

enum scps_client_event_t

Capabilities (supported characteristics)

Enumerator
SCPS_CLIENT_EVENT_REFRESH_NOTIF	Refresh notify

Function Documentation

scps_client_get_capabilities()

scps_client_cap_t scps_client_get_capabilities

(

ble_client_t *

scps_client

)

Get capabilites.

Function returns bit mask with supported capabilities

Parameters

[in]

scps_client

client instance

Returns

Bit mask with supported characteristics

scps_client_get_event_state()

bool scps_client_get_event_state	(	ble_client_t *	scps_client,
		scps_client_event_t	event
	)

Get event state.

Function reads CCC descriptor. After successful operation get_event_state callback will be called

Parameters

[in]	scps_client	client instance
[in]	event	event type

Returns

true if read request has been sent successfully, false if server doesn't support specified event.

scps_client_init()

ble_client_t* scps_client_init	(	const scps_client_callbacks_t *	cb,
		const ble_evt_gattc_browse_svc_t *	evt
	)

Register SCPS Client instance.

Function registers SCPS Client

Parameters

[in]	cb	application callbacks
[in]	evt	browse svc event with Battery Service details

Returns

client instance in case of success, otherwise NULL.

scps_client_set_event_state()

bool scps_client_set_event_state	(	ble_client_t *	scps_client,
		scps_client_event_t	event,
		bool	enable
	)

Set Refresh characteristic notification state.

Function writes to CCC descriptor. After successful operation set_notif_state callback will be called

Parameters

[in]	scps_client	client instance
[in]	event	event type
[in]	enable	state flag

Returns

true if write request has been sent successfully, false if server doesn't support specified event.

scps_client_write_scan_interval_window()

bool scps_client_write_scan_interval_window	(	ble_client_t *	scps_client,
		uint16_t	scan_interval,
		uint16_t	scan_window
	)

Write Scan Interval Window.

Function send Write Command to Scan Interval Window Characteristic

Parameters

[in]	scps_client	client instance
[in]	scan_interval	le scan interval
[in]	scan_window	le scan window

Returns

true if write command has been sent successfully, false otherwise.