Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_csip_set_member_register_param Struct Reference

Register structure for Coordinated Set Identification Service. More...

#include <csip.h>

Data Fields

uint8_t set_size
 Size of the set.
 
uint8_t sirk [16]
 The unique Set Identity Resolving Key (SIRK)
 
bool lockable
 Boolean to set whether the set is lockable by clients.
 
uint8_t rank
 Rank of this device in this set.
 
struct bt_csip_set_member_cbcb
 Pointer to the callback structure.
 
const struct bt_gatt_serviceparent
 Parent service pointer.
 

Detailed Description

Register structure for Coordinated Set Identification Service.

Field Documentation

◆ cb

struct bt_csip_set_member_cb* bt_csip_set_member_register_param::cb

Pointer to the callback structure.

◆ lockable

bool bt_csip_set_member_register_param::lockable

Boolean to set whether the set is lockable by clients.

Setting this to false will disable the lock characteristic.

◆ parent

const struct bt_gatt_service* bt_csip_set_member_register_param::parent

Parent service pointer.

Mandatory parent service pointer if this CSIS instance is included by another service. All CSIS instances when

CONFIG_BT_CSIP_SET_MEMBER_MAX_INSTANCE_COUNT 

is above 1 shall be included by another service, as per the Coordinated Set Identification Profile (CSIP).

◆ rank

uint8_t bt_csip_set_member_register_param::rank

Rank of this device in this set.

If the lockable parameter is set to true, this shall be > 0 and <= to the set_size. If the lockable parameter is set to false, this may be set to 0 to disable the rank characteristic.

◆ set_size

uint8_t bt_csip_set_member_register_param::set_size

Size of the set.

If set to 0, the set size characteristic won't be initialized.

◆ sirk

uint8_t bt_csip_set_member_register_param::sirk[16]

The unique Set Identity Resolving Key (SIRK)

This shall be unique between different sets, and shall be the same for each set member for each set.


The documentation for this struct was generated from the following file: