The LED Button Service client can be used to set up a LED and read a button state on a LED button service server.
More...
|
#define | BLE_LBS_C_DEF(_name) |
| Macro for defining a ble_lbs_c instance. More...
|
|
#define | BLE_LBS_C_ARRAY_DEF(_name, _cnt) |
| Macro for defining multiple ble_lbs_c instances. More...
|
|
#define | LBS_UUID_BASE |
|
#define | LBS_UUID_SERVICE 0x1523 |
|
#define | LBS_UUID_BUTTON_CHAR 0x1524 |
|
#define | LBS_UUID_LED_CHAR 0x1525 |
|
The LED Button Service client can be used to set up a LED and read a button state on a LED button service server.
This module contains the APIs and types exposed by the LED Button Service Client module. The application can use these APIs and types to perform the discovery of LED Button Service at the peer and to interact with it.
- Note
- The application must register this module as the BLE event observer by using the NRF_SDH_BLE_OBSERVER macro. Example:
#define BLE_LBS_C_ARRAY_DEF |
( |
|
_name, |
|
|
|
_cnt |
|
) |
| |
Value:
NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
Macro for defining multiple ble_lbs_c instances.
- Parameters
-
_name | Name of the array of instances. |
_cnt | Number of instances to define. |
#define BLE_LBS_C_DEF |
( |
|
_name | ) |
|
Macro for defining a ble_lbs_c instance.
- Parameters
-
_name | Name of the instance. |
Value:{0x23, 0xD1, 0xBC, 0xEA, 0x5F, 0x78, 0x23, 0x15, \
0xDE, 0xEF, 0x12, 0x12, 0x00, 0x00, 0x00, 0x00}
Event handler type.
This is the type of the event handler that is to be provided by the application of this module in order to receive events.
LBS Client event type.
Enumerator |
---|
BLE_LBS_C_EVT_DISCOVERY_COMPLETE |
Event indicating that the LED Button Service was discovered at the peer.
|
BLE_LBS_C_EVT_BUTTON_NOTIFICATION |
Event indicating that a notification of the LED Button Button characteristic was received from the peer.
|
uint32_t ble_lbs_c_button_notif_enable |
( |
ble_lbs_c_t * |
p_ble_lbs_c | ) |
|
Function for requesting the peer to start sending notification of the Button Characteristic.
This function enables to notification of the Button at the peer by writing to the CCCD of the Button characteristic.
- Parameters
-
[in] | p_ble_lbs_c | Pointer to the LED Button Client structure. |
- Return values
-
NRF_SUCCESS | If the SoftDevice has been requested to write to the CCCD of the peer. |
NRF_ERROR_INVALID_STATE | If no connection handle has been assigned (ble_lbs_c_handles_assign). |
NRF_ERROR_NULL | If the given parameter is NULL. |
err_code | Otherwise, this API propagates the error code returned by function nrf_ble_gq_item_add. |
uint32_t ble_lbs_c_handles_assign |
( |
ble_lbs_c_t * |
p_ble_lbs_c, |
|
|
uint16_t |
conn_handle, |
|
|
const lbs_db_t * |
p_peer_handles |
|
) |
| |
Function for assigning handles to this instance of lbs_c.
Call this function when a link has been established with a peer to associate the link to this instance of the module. This makes it possible to handle several links and associate each link to a particular instance of this module.
- Parameters
-
[in] | p_ble_lbs_c | Pointer to the LED Button client structure instance for associating the link. |
[in] | conn_handle | Connection handle to associate with the given LED Button Client Instance. |
[in] | p_peer_handles | LED Button Service handles found on the peer (from BLE_LBS_C_EVT_DISCOVERY_COMPLETE event). |
- Return values
-
NRF_SUCCESS | If the status was sent successfully. |
err_code | Otherwise, this API propagates the error code returned by function nrf_ble_gq_item_add. |
Function for initializing the LED Button client module.
This function registers with the Database Discovery module for the LED Button Service. The module looks for the presence of a LED Button Service instance at the peer when a discovery is started.
- Parameters
-
[in] | p_ble_lbs_c | Pointer to the LED Button client structure. |
[in] | p_ble_lbs_c_init | Pointer to the LED Button initialization structure that contains the initialization information. |
- Return values
-
NRF_SUCCESS | On successful initialization. |
err_code | Otherwise, this function propagates the error code returned by the Database Discovery module API ble_db_discovery_evt_register. |
void ble_lbs_c_on_ble_evt |
( |
ble_evt_t const * |
p_ble_evt, |
|
|
void * |
p_context |
|
) |
| |
Function for handling BLE events from the SoftDevice.
This function handles the BLE events received from the SoftDevice. If a BLE event is relevant to the LED Button Client module, the function uses the event's data to update interval variables and, if necessary, send events to the application.
- Parameters
-
[in] | p_ble_evt | Pointer to the BLE event. |
[in] | p_context | Pointer to the LED button client structure. |
uint32_t ble_lbs_led_status_send |
( |
ble_lbs_c_t * |
p_ble_lbs_c, |
|
|
uint8_t |
status |
|
) |
| |
Function for writing the LED status to the connected server.
- Parameters
-
[in] | p_ble_lbs_c | Pointer to the LED Button client structure. |
[in] | status | LED status to send. |
- Return values
-
NRF_SUCCESS | If the status was sent successfully. |
err_code | Otherwise, this API propagates the error code returned by function nrf_ble_gq_conn_handle_register. |
Function for handling events from the Database Discovery module.
Call this function when you get a callback event from the Database Discovery module. This function handles an event from the Database Discovery module, and determines whether it relates to the discovery of LED Button service at the peer. If it does, this function calls the application's event handler to indicate that the LED Button service was discovered at the peer. The function also populates the event with service-related information before providing it to the application.
- Parameters
-
[in] | p_ble_lbs_c | Pointer to the LED Button client structure. |
[in] | p_evt | Pointer to the event received from the Database Discovery module. |