CS Ranging Service#
Channel Sounding (CS) Ranging Service (RAS) is used for parsing RAS GATT messages as well as creating RAS GATT responses.
Modules#
ras_control_point_parse_result
Enumerations#
Functions#
Macros#
Enumeration Documentation#
ras_opcode_t#
ras_opcode_t
Enumerator | |
---|---|
CS_RAS_OPCODE_RANGING_DATA_READY_INDICATION | |
CS_RAS_OPCODE_RANGING_DATA_OVERWRITTEN_INDICATION | |
CS_RAS_OPCODE_RANGING_DATA_GET_COMMAND | |
CS_RAS_OPCODE_RANGING_DATA_DELETE_COMMAND | |
CS_RAS_OPCODE_INVALID |
70
of file common/cs_ras/cs_ras.h
Function Documentation#
typedef#
typedef (struct { uint8_t opcode;uint16_t procedure_index;uint8_t number_of_subevents;uint16_t subevent_index;uint16_t subevent_index_data_size;} )
N/A |
83
of file common/cs_ras/cs_ras.h
typedef#
typedef (struct { uint8_t opcode;uint16_t procedure_index;uint8_t subevent_index;uint16_t subevent_ranging_data_offset;uint8_t max_number_of_notifications;uint8_t keep_notification;uint8_t antenna_path_index_filter;} )
N/A |
91
of file common/cs_ras/cs_ras.h
cs_ras_periodic_notification_mode_set_enabled#
void cs_ras_periodic_notification_mode_set_enabled (bool state)
[in] | state | bool value to set/disable notification mode |
CS RAS set periodic notification.
108
of file common/cs_ras/cs_ras.h
cs_ras_periodic_notification_mode_enabled#
bool cs_ras_periodic_notification_mode_enabled (void )
N/A |
CS RAS get periodic notification state. Returns
notification state
114
of file common/cs_ras/cs_ras.h
cs_ras_parse_control_point_message#
ras_control_point_parse_result cs_ras_parse_control_point_message (uint8_t * message, uint8_t message_len)
[in] | message | pointer to the RAS message |
[in] | message_len | length of the message |
Parse a RAS control point message and extract the payload contents. The opcode in the result structure will indicate whether the parsing was successful.
Returns
ras_control_point_parse_result struct with the results
125
of file common/cs_ras/cs_ras.h
cs_ras_create_control_point_response#
sl_status_t cs_ras_create_control_point_response (uint8_t * data, uint8_t len, bool enable_periodic_notification_mode, ras_ranging_data_get_command_t * cmd)
[in] | data | pointer to the data received in the Control Point |
[in] | len | length of the data received in the Control Point |
[in] | enable_periodic_notification_mode | set to true to enable periodic notifications in the response |
[out] | cmd | pointer to the response message to be filled |
Creates a response message to the data received in the RAS control point characteristic
Returns
status code
139
of file common/cs_ras/cs_ras.h
Macro Definition Documentation#
RAS_SERVICE_UUID#
#define RAS_SERVICE_UUIDValue:
52
of file common/cs_ras/cs_ras.h
RAS_CONTROL_POINT_CHARACTERISTIC_UUID#
#define RAS_CONTROL_POINT_CHARACTERISTIC_UUIDValue:
56
of file common/cs_ras/cs_ras.h
RAS_PROCEDURE_ENABLE_DATA_CHARACTERISTIC_UUID#
#define RAS_PROCEDURE_ENABLE_DATA_CHARACTERISTIC_UUIDValue:
60
of file common/cs_ras/cs_ras.h
RAS_SE_RANGING_DATA_CHARACTERISTIC_UUID#
#define RAS_SE_RANGING_DATA_CHARACTERISTIC_UUIDValue:
64
of file common/cs_ras/cs_ras.h