nRF5 SDK for Mesh v3.2.0  08c60f6

Access layer defines. More...

Macros

#define ACCESS_HANDLE_INVALID   (0xFFFF)
 Invalid access model handle value.
 
#define ACCESS_COMPANY_ID_NONE   (0xFFFF)
 Company ID value for Bluetooth SIG opcodes or models.
 
#define ACCESS_COMPANY_ID_NORDIC   (0x0059)
 Company ID value for Nordic Semiconductor.
 
#define ACCESS_ELEMENT_INDEX_INVALID   (0xFFFF)
 Invalid element index.
 
#define ACCESS_OPCODE_SIG(opcode)   { (opcode), ACCESS_COMPANY_ID_NONE }
 Macro used to define a SIG model opcode. More...
 
#define ACCESS_OPCODE_VENDOR(opcode, company)   { (opcode), (company) }
 Macro used to define a vendor model opcode. More...
 
#define ACCESS_MODEL_SIG(id)   {.company_id = ACCESS_COMPANY_ID_NONE, .model_id = (id)}
 Macro used to define a SIG model ID. More...
 
#define ACCESS_MODEL_VENDOR(id, company)   {.company_id = (company), .model_id = (id)}
 Macro used to define a vendor model ID. More...
 
#define ACCESS_TTL_USE_DEFAULT   (0xFF)
 Value used for TTL parameters in order to set the TTL to the default value.
 
#define ACCESS_MESSAGE_LENGTH_MAX   (NRF_MESH_SEG_PAYLOAD_SIZE_MAX)
 Maximum payload length for an access layer message. More...
 
#define ACCESS_PUBLISH_PERIOD_STEP_MAX   (0x3F)
 Max step size used for periodic publishing.
 
#define ACCESS_PUBLISH_STEP_RES_BITS   (2)
 Publish step resolution, number of bits.
 
#define ACCESS_PUBLISH_STEP_NUM_BITS   (6)
 Publish step number, number of bits.
 
#define ACCESS_PUBLISH_RETRANSMIT_COUNT_BITS   (3)
 Publish Retransmit Count, number of bits.
 
#define ACCESS_PUBLISH_RETRANSMIT_INTERVAL_STEPS_BITS   (5)
 Publish Retransmit Interval Steps, number of bits.
 
#define ACCESS_PUBLISH_PERIOD_NONE   { ACCESS_PUBLISH_RESOLUTION_100MS, 0 }
 Value used for access_publish_period_t structs when publishing is disabled.
 

Detailed Description

Access layer defines.

Macro Definition Documentation

◆ ACCESS_OPCODE_SIG

#define ACCESS_OPCODE_SIG (   opcode)    { (opcode), ACCESS_COMPANY_ID_NONE }

Macro used to define a SIG model opcode.

Parameters
[in]opcodeOpcode of the SIG model.
Returns
Expands to an initializer for an access_opcode_t struct.
See also
access_opcode_t, access_message_tx_t

Definition at line 87 of file access.h.

◆ ACCESS_OPCODE_VENDOR

#define ACCESS_OPCODE_VENDOR (   opcode,
  company 
)    { (opcode), (company) }

Macro used to define a vendor model opcode.

Parameters
[in]opcodeOpcode of the vendor model.
[in]companyCompany ID for the vendor model.
Returns
Expands to an initializer for an access_opcode_t struct.
See also
access_opcode_t, access_message_tx_t

Definition at line 96 of file access.h.

◆ ACCESS_MODEL_SIG

#define ACCESS_MODEL_SIG (   id)    {.company_id = ACCESS_COMPANY_ID_NONE, .model_id = (id)}

Macro used to define a SIG model ID.

Parameters
[in]idModel ID.
Returns
Expands to an initializer for an access_model_id_t struct.
See also
access_model_id_t

Definition at line 104 of file access.h.

◆ ACCESS_MODEL_VENDOR

#define ACCESS_MODEL_VENDOR (   id,
  company 
)    {.company_id = (company), .model_id = (id)}

Macro used to define a vendor model ID.

Parameters
[in]idModel ID.
[in]companyCompany ID for the vendor model.
Returns
Expands to an initializer for an access_model_id_t struct.
See also
access_model_id_t

Definition at line 113 of file access.h.

◆ ACCESS_MESSAGE_LENGTH_MAX

#define ACCESS_MESSAGE_LENGTH_MAX   (NRF_MESH_SEG_PAYLOAD_SIZE_MAX)

Maximum payload length for an access layer message.

Note
Payloads greater than NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX will be segmented.

Definition at line 123 of file access.h.