nRF51 SDK - S110 SoftDevice
|
Functions | |
uint32_t | sd_ble_gatts_service_add (uint8_t type, ble_uuid_t const *p_uuid, uint16_t *p_handle) |
Add a service declaration to the Attribute Table. More... | |
uint32_t | sd_ble_gatts_include_add (uint16_t service_handle, uint16_t inc_srvc_handle, uint16_t *p_include_handle) |
Add an include declaration to the Attribute Table. More... | |
uint32_t | sd_ble_gatts_characteristic_add (uint16_t service_handle, ble_gatts_char_md_t const *p_char_md, ble_gatts_attr_t const *p_attr_char_value, ble_gatts_char_handles_t *p_handles) |
Add a characteristic declaration, a characteristic value declaration and optional characteristic descriptor declarations to the Attribute Table. More... | |
uint32_t | sd_ble_gatts_descriptor_add (uint16_t char_handle, ble_gatts_attr_t const *p_attr, uint16_t *p_handle) |
Add a descriptor to the Attribute Table. More... | |
uint32_t | sd_ble_gatts_value_set (uint16_t conn_handle, uint16_t handle, ble_gatts_value_t *p_value) |
Set the value of a given attribute. More... | |
uint32_t | sd_ble_gatts_value_get (uint16_t conn_handle, uint16_t handle, ble_gatts_value_t *p_value) |
Get the value of a given attribute. More... | |
uint32_t | sd_ble_gatts_hvx (uint16_t conn_handle, ble_gatts_hvx_params_t const *p_hvx_params) |
Notify or Indicate an attribute value. More... | |
uint32_t | sd_ble_gatts_service_changed (uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle) |
Indicate the Service Changed attribute value. More... | |
uint32_t | sd_ble_gatts_rw_authorize_reply (uint16_t conn_handle, ble_gatts_rw_authorize_reply_params_t const *p_rw_authorize_reply_params) |
Respond to a Read/Write authorization request. More... | |
uint32_t | sd_ble_gatts_sys_attr_set (uint16_t conn_handle, uint8_t const *p_sys_attr_data, uint16_t len, uint32_t flags) |
Update persistent system attribute information. More... | |
uint32_t | sd_ble_gatts_sys_attr_get (uint16_t conn_handle, uint8_t *p_sys_attr_data, uint16_t *p_len, uint32_t flags) |
Retrieve persistent system attribute information from the stack. More... | |
uint32_t sd_ble_gatts_characteristic_add | ( | uint16_t | service_handle, |
ble_gatts_char_md_t const * | p_char_md, | ||
ble_gatts_attr_t const * | p_attr_char_value, | ||
ble_gatts_char_handles_t * | p_handles | ||
) |
Add a characteristic declaration, a characteristic value declaration and optional characteristic descriptor declarations to the Attribute Table.
[in] | service_handle | Handle of the service where the characteristic is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially. |
[in] | p_char_md | Characteristic metadata. |
[in] | p_attr_char_value | Pointer to the attribute structure corresponding to the characteristic value. |
[out] | p_handles | Pointer to the structure where the assigned handles will be stored. |
NRF_SUCCESS | Successfully added a characteristic. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, service handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation, a service context is required. |
NRF_ERROR_FORBIDDEN | Forbidden value supplied, certain UUIDs are reserved for the stack. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied, attribute lengths are restricted by Maximum attribute lengths. |
uint32_t sd_ble_gatts_descriptor_add | ( | uint16_t | char_handle, |
ble_gatts_attr_t const * | p_attr, | ||
uint16_t * | p_handle | ||
) |
Add a descriptor to the Attribute Table.
[in] | char_handle | Handle of the characteristic where the descriptor is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially. |
[in] | p_attr | Pointer to the attribute structure. |
[out] | p_handle | Pointer to a 16-bit word where the assigned handle will be stored. |
NRF_SUCCESS | Successfully added a descriptor. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, characteristic handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation, a characteristic context is required. |
NRF_ERROR_FORBIDDEN | Forbidden value supplied, certain UUIDs are reserved for the stack. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied, attribute lengths are restricted by Maximum attribute lengths. |
uint32_t sd_ble_gatts_hvx | ( | uint16_t | conn_handle, |
ble_gatts_hvx_params_t const * | p_hvx_params | ||
) |
Notify or Indicate an attribute value.
This function checks for the relevant Client Characteristic Configuration descriptor value to verify that the relevant operation (notification or indication) has been enabled by the client. It is also able to update the attribute value before issuing the PDU, so that the application can atomically perform a value update and a server initiated transaction with a single API call. If the application chooses to indicate an attribute value, a BLE_GATTS_EVT_HVC event will be issued as soon as the confirmation arrives from the peer.
[in] | conn_handle | Connection handle. |
[in] | p_hvx_params | Pointer to an HVx parameters structure. If the p_data member contains a non-NULL pointer the attribute value will be updated with the contents pointed by it before sending the notification or indication. |
NRF_SUCCESS | Successfully queued a notification or indication for transmission, and optionally updated the attribute value. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid Connection Handle. |
NRF_ERROR_INVALID_STATE | Invalid Connection State or notifications and/or indications not enabled in the CCCD. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
BLE_ERROR_INVALID_ATTR_HANDLE | Invalid attribute handle(s) supplied. Only attributes added directly by the application are available to notify and indicate. |
BLE_ERROR_GATTS_INVALID_ATTR_TYPE | Invalid attribute type(s) supplied, only characteristic values may be notified and indicated. |
NRF_ERROR_NOT_FOUND | Attribute not found. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied. |
NRF_ERROR_BUSY | Procedure already in progress. |
BLE_ERROR_GATTS_SYS_ATTR_MISSING | System attributes missing, use sd_ble_gatts_sys_attr_set to set them to a known value. |
BLE_ERROR_NO_TX_BUFFERS | There are no available buffers to send the data, applies only to notifications. |
uint32_t sd_ble_gatts_include_add | ( | uint16_t | service_handle, |
uint16_t | inc_srvc_handle, | ||
uint16_t * | p_include_handle | ||
) |
Add an include declaration to the Attribute Table.
[in] | service_handle | Handle of the service where the included service is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially. |
[in] | inc_srvc_handle | Handle of the included service. |
[out] | p_include_handle | Pointer to a 16-bit word where the assigned handle will be stored. |
NRF_SUCCESS | Successfully added an include declaration. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, handle values need to match previously added services. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_FORBIDDEN | Forbidden value supplied, self inclusions are not allowed. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
NRF_ERROR_NOT_FOUND | Attribute not found. |
uint32_t sd_ble_gatts_rw_authorize_reply | ( | uint16_t | conn_handle, |
ble_gatts_rw_authorize_reply_params_t const * | p_rw_authorize_reply_params | ||
) |
Respond to a Read/Write authorization request.
[in] | conn_handle | Connection handle. |
[in] | p_rw_authorize_reply_params | Pointer to a structure with the attribute provided by the application. |
NRF_SUCCESS | Successfully queued a response to the peer, and in the case of a write operation, Attribute Table updated. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid Connection Handle. |
NRF_ERROR_INVALID_STATE | Invalid Connection State or no authorization request pending. |
NRF_ERROR_INVALID_PARAM | Authorization op invalid, or for Read Authorization reply: requested handles not replied with, or for Write Authorization reply: handle supplied does not match requested handle. |
NRF_ERROR_BUSY | The stack is busy. Retry at later time. |
uint32_t sd_ble_gatts_service_add | ( | uint8_t | type, |
ble_uuid_t const * | p_uuid, | ||
uint16_t * | p_handle | ||
) |
Add a service declaration to the Attribute Table.
[in] | type | Toggles between primary and secondary services, see GATT Server Service Types. |
[in] | p_uuid | Pointer to service UUID. |
[out] | p_handle | Pointer to a 16-bit word where the assigned handle will be stored. |
NRF_SUCCESS | Successfully added a service declaration. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, Vendor Specific UUIDs need to be present in the table. |
NRF_ERROR_FORBIDDEN | Forbidden value supplied, certain UUIDs are reserved for the stack. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
uint32_t sd_ble_gatts_service_changed | ( | uint16_t | conn_handle, |
uint16_t | start_handle, | ||
uint16_t | end_handle | ||
) |
Indicate the Service Changed attribute value.
This call will send a Handle Value Indication to one or more peers connected to inform them that the Attribute Table layout has changed. As soon as the peer has confirmed the indication, a BLE_GATTS_EVT_SC_CONFIRM event will be issued.
[in] | conn_handle | Connection handle. |
[in] | start_handle | Start of affected attribute handle range. |
[in] | end_handle | End of affected attribute handle range. |
NRF_SUCCESS | Successfully queued the Service Changed indication for transmission. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid Connection Handle. |
NRF_ERROR_INVALID_STATE | Invalid Connection State or notifications and/or indications not enabled in the CCCD. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
BLE_ERROR_INVALID_ATTR_HANDLE | Invalid attribute handle(s) supplied, handles must be in the range populated by the application. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation, notifications or indications must be enabled in the CCCD. |
NRF_ERROR_BUSY | Procedure already in progress. |
BLE_ERROR_GATTS_SYS_ATTR_MISSING | System attributes missing, use sd_ble_gatts_sys_attr_set to set them to a known value. |
uint32_t sd_ble_gatts_sys_attr_get | ( | uint16_t | conn_handle, |
uint8_t * | p_sys_attr_data, | ||
uint16_t * | p_len, | ||
uint32_t | flags | ||
) |
Retrieve persistent system attribute information from the stack.
This call is used to retrieve information about values to be stored perisistently by the application during the lifetime of a connection or after it has been terminated. When a new connection is established with the same bonded device, the system attribute information retrieved with this function should be restored using using sd_ble_gatts_sys_attr_set. If retrieved after disconnection, the data should be read before a new connection established. The connection handle for the previous, now disconnected, connection will remain valid until a new one is created to allow this API call to refer to it. Connection handles belonging to active connections can be used as well, but care should be taken since the system attributes may be written to at any time by the peer during a connection's lifetime.
[in] | conn_handle | Connection handle of the recently terminated connection. |
[out] | p_sys_attr_data | Pointer to a buffer where updated information about system attributes will be filled in. NULL can be provided to obtain the length of the data |
[in,out] | p_len | Size of application buffer if p_sys_attr_data is not NULL. Unconditially updated to actual length of system attribute data. |
[in] | flags | Optional additional flags, see System Attribute Flags |
NRF_SUCCESS | Successfully retrieved the system attribute information. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid Connection Handle. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_DATA_SIZE | The system attribute information did not fit into the provided buffer. |
NRF_ERROR_NOT_FOUND | No system attributes found. |
uint32_t sd_ble_gatts_sys_attr_set | ( | uint16_t | conn_handle, |
uint8_t const * | p_sys_attr_data, | ||
uint16_t | len, | ||
uint32_t | flags | ||
) |
Update persistent system attribute information.
Supply information about persistent system attributes to the stack, previously obtained using sd_ble_gatts_sys_attr_get. This call is only allowed for active connections, and is usually made immediately after a connection is established with an known bonded device, often as a response to a BLE_GATTS_EVT_SYS_ATTR_MISSING.
p_sysattrs may point directly to the application's stored copy of the system attributes obtained using sd_ble_gatts_sys_attr_get. If the pointer is NULL, the system attribute info is initialized, assuming that the application does not have any previously saved system attribute data for this device.
[in] | conn_handle | Connection handle. |
[in] | p_sys_attr_data | Pointer to a saved copy of system attributes supplied to the stack, or NULL. |
[in] | len | Size of data pointed by p_sys_attr_data, in octets. |
[in] | flags | Optional additional flags, see System Attribute Flags |
NRF_SUCCESS | Successfully set the system attribute information. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid Connection Handle. |
NRF_ERROR_INVALID_STATE | Invalid Connection State. |
NRF_ERROR_INVALID_DATA | Invalid data supplied, the data should be exactly the same as retrieved with sd_ble_gatts_sys_attr_get. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
NRF_ERROR_BUSY | The stack is busy. Retry at later time. |
uint32_t sd_ble_gatts_value_get | ( | uint16_t | conn_handle, |
uint16_t | handle, | ||
ble_gatts_value_t * | p_value | ||
) |
Get the value of a given attribute.
[in] | conn_handle | Connection handle. If the value does not belong to a system attribute then BLE_CONN_HANDLE_INVALID can be used. |
[in] | handle | Attribute handle. |
[in,out] | p_value | Attribute value information. |
NRF_SUCCESS | Successfully retrieved the value of the attribute. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_NOT_FOUND | Attribute not found. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
BLE_ERROR_GATTS_INVALID_ATTR_TYPE | BLE_CONN_HANDLE_INVALID supplied on a system attribute. |
uint32_t sd_ble_gatts_value_set | ( | uint16_t | conn_handle, |
uint16_t | handle, | ||
ble_gatts_value_t * | p_value | ||
) |
Set the value of a given attribute.
[in] | conn_handle | Connection handle. If the value does not belong to a system attribute then BLE_CONN_HANDLE_INVALID can be used. |
[in] | handle | Attribute handle. |
[in,out] | p_value | Attribute value information. |
NRF_SUCCESS | Successfully set the value of the attribute. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_NOT_FOUND | Attribute not found. |
NRF_ERROR_FORBIDDEN | Forbidden handle supplied, certain attributes are not modifiable by the application. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied, attribute lengths are restricted by Maximum attribute lengths. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
BLE_ERROR_GATTS_INVALID_ATTR_TYPE | BLE_CONN_HANDLE_INVALID supplied on a system attribute. |