Access layer type definitions. More...

Data Structures
struct	access_model_id_t
	Access layer model ID. More...

struct	access_opcode_t
	Access layer opcode type. More...

struct	access_message_rx_meta_t
	Metadata for received messages. More...

struct	access_message_rx_t
	Access layer RX event structure. More...

struct	access_message_tx_t
	Access layer TX parameter structure. More...

struct	access_opcode_handler_t
	Opcode handler type. More...

struct	access_model_add_params_t
	Access model allocation parameter structure. More...

struct	access_publish_period_t
	Model publish period structure. More...

struct	access_publish_retransmit_t
	Model publish retransmit structure. More...

Typedefs
typedef uint16_t	access_model_handle_t
	Access layer handle type. More...

typedef void(*	access_publish_timeout_cb_t) (access_model_handle_t handle, void *p_args)
	Access layer publish timeout event callback. More...

typedef void(*	access_opcode_handler_cb_t) (access_model_handle_t handle, const access_message_rx_t p_message, void p_args)
	Access layer opcode handler callback type. More...

Enumerations
enum	access_publish_resolution_t { ACCESS_PUBLISH_RESOLUTION_100MS = 0, ACCESS_PUBLISH_RESOLUTION_1S = 1, ACCESS_PUBLISH_RESOLUTION_10S = 2, ACCESS_PUBLISH_RESOLUTION_10MIN = 3, ACCESS_PUBLISH_RESOLUTION_MAX = ACCESS_PUBLISH_RESOLUTION_10MIN }
	Periodic publishing step resolution. More...

enum	access_status_t { ACCESS_STATUS_SUCCESS = 0x00, ACCESS_STATUS_INVALID_ADDRESS = 0x01, ACCESS_STATUS_INVALID_MODEL = 0x02, ACCESS_STATUS_INVALID_APPKEY = 0x03, ACCESS_STATUS_INVALID_NETKEY = 0x04, ACCESS_STATUS_INSUFFICIENT_RESOURCES = 0x05, ACCESS_STATUS_KEY_INDEX_ALREADY_STORED = 0x06, ACCESS_STATUS_NOT_A_PUBLISH_MODEL = 0x07, ACCESS_STATUS_NOT_A_SUBSCRIBE_MODEL = 0x08, ACCESS_STATUS_STORAGE_FAILURE = 0x09, ACCESS_STATUS_FEATURE_NOT_SUPPORTED = 0x0A, ACCESS_STATUS_CANNOT_UPDATE = 0x0B, ACCESS_STATUS_CANNOT_REMOVE = 0x0C, ACCESS_STATUS_CANNOT_BIND = 0x0D, ACCESS_STATUS_TEMPORARILY_UNABLE_TO_CHANGE_STATE = 0x0E, ACCESS_STATUS_CANNOT_SET = 0x0F, ACCESS_STATUS_UNSPECIFIED_ERROR = 0x10, ACCESS_STATUS_INVALID_BINDING = 0x11 }
	Access layer status codes. More...

Detailed Description

Access layer type definitions.

Typedef Documentation

◆ access_model_handle_t

typedef uint16_t access_model_handle_t

Access layer handle type.

Definition at line 162 of file access.h.

◆ access_publish_timeout_cb_t

typedef void(* access_publish_timeout_cb_t) (access_model_handle_t handle, void *p_args)

Access layer publish timeout event callback.

Parameters

[in]	handle	Access layer model handle.
[in]	p_args	Optional generic argument pointer.

Definition at line 170 of file access.h.

◆ access_opcode_handler_cb_t

typedef void(* access_opcode_handler_cb_t) (access_model_handle_t handle, const access_message_rx_t *p_message, void *p_args)

Access layer opcode handler callback type.

Parameters

[in]	handle	Access layer model handle.
[in]	p_message	Access RX message structure.
[in]	p_args	Optional generic argument pointer.

Definition at line 250 of file access.h.

Enumeration Type Documentation

◆ access_publish_resolution_t

enum access_publish_resolution_t

Periodic publishing step resolution.

Enumerator
ACCESS_PUBLISH_RESOLUTION_100MS	Step resolution: 100ms / step.
ACCESS_PUBLISH_RESOLUTION_1S	Step resolution: 1s / step.
ACCESS_PUBLISH_RESOLUTION_10S	Step resolution: 10s / step.
ACCESS_PUBLISH_RESOLUTION_10MIN	Step resolution: 10min / step.
ACCESS_PUBLISH_RESOLUTION_MAX	Maximum publish resolution.

Definition at line 321 of file access.h.

◆ access_status_t

enum access_status_t

Access layer status codes.

Enumerator
ACCESS_STATUS_SUCCESS	Command successfully processed.
ACCESS_STATUS_INVALID_ADDRESS	The provided value is not a valid address in this context.
ACCESS_STATUS_INVALID_MODEL	The provided Model index is not valid in this Element.
ACCESS_STATUS_INVALID_APPKEY	The provided AppKey index is not valid for this node.
ACCESS_STATUS_INVALID_NETKEY	The provided NetKey index is not valid for this node.
ACCESS_STATUS_INSUFFICIENT_RESOURCES	The node cannot store provided information due to insufficient resources on node.
ACCESS_STATUS_KEY_INDEX_ALREADY_STORED	The key with given index is already stored in the node with a different value.
ACCESS_STATUS_NOT_A_PUBLISH_MODEL	The referenced Model is not a Publish Model.
ACCESS_STATUS_NOT_A_SUBSCRIBE_MODEL	The referenced Model is not a Subscribe Model.
ACCESS_STATUS_STORAGE_FAILURE	The node was not able to store new value in persistent storage .
ACCESS_STATUS_FEATURE_NOT_SUPPORTED	The feature is not supported in this node.
ACCESS_STATUS_CANNOT_UPDATE	The requested update operation cannot be performed due to general constraints.
ACCESS_STATUS_CANNOT_REMOVE	The requested delete operation cannot be performed due to general constraints.
ACCESS_STATUS_CANNOT_BIND	The requested bind operation cannot be performed due to general constraints.
ACCESS_STATUS_TEMPORARILY_UNABLE_TO_CHANGE_STATE	The requested operation temporarily cannot be performed due to internal state of the node.
ACCESS_STATUS_CANNOT_SET	The requested set operation cannot be performed due to general constraints.
ACCESS_STATUS_UNSPECIFIED_ERROR	An error occurred that does not correspond to any error conditions defined for a given state.
ACCESS_STATUS_INVALID_BINDING	The NetKeyIndex and AppKeyIndex combination is not valid.

Definition at line 47 of file access_status.h.

Types

nRF5 SDK for Mesh v5.0.0

Data Structures

Typedefs

Enumerations