Developing with ZBOSS for Zigbee
Data Structures | Macros | Typedefs | Enumerations | Functions
Messaging cluster commands
Zigbee stack API » ZCL API » ZCL clusters » ZCL Messaging cluster

Data Structures

struct  zb_zcl_messaging_display_message_payload_s
 
struct  zb_zcl_messaging_cancel_message_payload_s
 
struct  zb_zcl_messaging_message_confirm_payload_s
 
struct  zb_zcl_messaging_cancel_all_message_payload_s
 
struct  zb_zcl_messaging_get_message_cancellation_payload_s
 
struct  zb_zcl_messaging_get_last_message_response_s
 

Macros

#define ZB_ZCL_CLUSTER_ID_MESSAGING_SERVER_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_MESSAGING_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MESSAGING_SERVER_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_MESSAGING_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_MESSAGING_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_MESSAGING_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_TRANSMISSION_MECHANISM(x, val)   ((x) &= (0xFC | ((val) & 0x03)))
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_TRANSMISSION_MECHANISM(x)   ((x) & 0x03)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_TRANSMISSION_MECHANISM(x)   ((x) &= 0xFC)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_IMPORTANCE_LEVEL(x, val)   ((x) &= (0xF3 | ((val) & 0x03) << 2)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_IMPORTANCE_LEVEL(x)   (((x) >> 2) & 0x03)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_IMPORTANCE_LEVEL(x)   ((x) &= 0xF3)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_ENHANCED_CONFIRMATION(x, val)   ((x) &= (0xDF | ((val) & 0x01) << 5)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_ENHANCED_CONFIRMATION(x)   (((x) >> 5) & 0x01)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_ENHANCED_CONFIRMATION(x)   ((x) &= 0xDF )
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_MESSAGE_CONFIRMATION(x, val)   ((x) &= (0x7F | ((val) & 0x01) << 7)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_MESSAGE_CONFIRMATION(x)   (((x) >> 7) & 0x01)
 
#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_MESSAGE_CONFIRMATION(x)   ((x) &= 0x7F)
 
#define ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_SIZE_IS_VALID(size)
 
#define ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT
 
#define ZB_ZCL_MESSAGING_CANCEL_MSG_PAYLOAD_INIT   (zb_zcl_messaging_cancel_message_payload_t) {0}
 
#define ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_SIZE_IS_VALID(size)
 
#define ZB_ZCL_MESSAGING_GET_LAST_MESSAGE_RESPONSE_INIT
 
#define ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_INIT
 
#define ZB_ZCL_MESSAGING_SEND_GET_LAST_MSG(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep)
 
#define ZB_ZCL_MESSAGING_SEND_DISPLAY_MSG(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_MESSAGING_SEND_MSG_CONFIRMATION(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload)
 
#define ZB_ZCL_MESSAGING_SEND_CANCEL_MSG(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload)
 

Typedefs

typedef enum zb_zcl_messaging_srv_cmd_e zb_zcl_messaging_srv_cmd_t
 
typedef enum zb_zcl_messaging_cli_cmd_e zb_zcl_messaging_cli_cmd_t
 
typedef enum zb_zcl_messaging_extended_message_control_e zb_zcl_messaging_extended_message_control_field_t
 
typedef struct zb_zcl_messaging_display_message_payload_s zb_zcl_messaging_display_message_payload_t
 
typedef enum zb_zcl_messaging_message_control_transmission_mechanism_e zb_zcl_messaging_control_field_transmission_mechanism_t
 
typedef enum zb_zcl_messaging_message_control_importance_level_e zb_zcl_messaging_message_control_importance_level_t
 
typedef enum zb_zcl_messaging_message_control_enhanced_confirmation_e zb_zcl_messaging_message_control_enhanced_confirmation_t
 
typedef enum zb_zcl_messaging_message_control_message_confirmation_e zb_zcl_messaging_message_control_message_confirmation_t
 
typedef struct zb_zcl_messaging_cancel_message_payload_s zb_zcl_messaging_cancel_message_payload_t
 
typedef enum zb_zcl_messaging_message_confirmation_control_e zb_zcl_messaging_message_confirmation_control_t
 
typedef struct zb_zcl_messaging_message_confirm_payload_s zb_zcl_messaging_message_confirm_payload_t
 
typedef struct zb_zcl_messaging_cancel_all_message_payload_s zb_zcl_messaging_cancel_all_message_payload_t
 
typedef struct zb_zcl_messaging_get_message_cancellation_payload_s zb_zcl_messaging_get_message_cancellation_payload_t
 
typedef enum zb_zcl_messaging_response_type_e zb_zcl_messaging_response_type_t
 
typedef struct zb_zcl_messaging_get_last_message_response_s zb_zcl_messaging_get_last_message_response_t
 

Enumerations

enum  zb_zcl_messaging_srv_cmd_e { ZB_ZCL_MESSAGING_SRV_CMD_DISPLAY_MESSAGE = 0x00, ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_MESSAGE = 0x01, ZB_ZCL_MESSAGING_SRV_CMD_DISPLAY_PROTECTED_MESSAGE = 0x02, ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_ALL_MESSAGES = 0x03 }
 
enum  zb_zcl_messaging_cli_cmd_e { ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE = 0x00, ZB_ZCL_MESSAGING_CLI_CMD_MESSAGE_CONFIRMATION = 0x01, ZB_ZCL_MESSAGING_CLI_CMD_GET_MESSAGE_CANCELLATION = 0x02 }
 
enum  zb_zcl_messaging_extended_message_control_e { ZB_ZCL_MESSAGING_MESSAGE_HAS_NOT_BEEN_CONFIRMED = 0, ZB_ZCL_MESSAGING_MESSAGE_HAS_BEEN_CONFIRMED = 1 }
 
enum  zb_zcl_messaging_extended_message_control_field_bitmap_e { ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_STATUS = 0 }
 
enum  zb_zcl_messaging_message_control_transmission_mechanism_e { ZB_ZCL_MESSAGING_NORMAL_TRANSMISSION_ONLY = 0, ZB_ZCL_MESSAGING_NORMAL_AND_INTERNAL_PAN_TRANSMISSION = 1, ZB_ZCL_MESSAGING_INTER_PAN_TRANSMISSION_ONLY = 2 }
 
enum  zb_zcl_messaging_message_control_importance_level_e { ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_LOW = 0, ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_MEDIUM = 1, ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_HIGH = 2, ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_CRITICAL = 3 }
 
enum  zb_zcl_messaging_message_control_enhanced_confirmation_e { ZB_ZCL_MESSAGING_ENHANCED_CONFIRMATION_NOT_REQUIRED = 0, ZB_ZCL_MESSAGING_ENHANCED_CONFIRMATION_REQUIRED = 1 }
 
enum  zb_zcl_messaging_message_control_message_confirmation_e { ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_NOT_REQUIRED = 0x00, ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_REQUIRED = 0x01 }
 
enum  zb_zcl_messaging_message_confirmation_control_e { ZB_ZCL_MESSAGING_NO_RETURNED = 1 << 0, ZB_ZCL_MESSAGING_YES_RETURNED = 1 << 1 }
 
enum  zb_zcl_messaging_response_type_e { ZB_ZCL_MESSAGING_RESPONSE_TYPE_NORMAL, ZB_ZCL_MESSAGING_RESPONSE_TYPE_PROTECTED, ZB_ZCL_MESSAGING_RESPONSE_TYPE_NOT_FOUND }
 

Functions

void zb_zcl_messaging_send_get_last_msg (zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_callback_t cb)
 
void zb_zcl_messaging_send_display_msg (zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_display_message_payload_t *payload, zb_callback_t cb)
 
void zb_zcl_messaging_send_msg_confirmation (zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_message_confirm_payload_t *payload, zb_callback_t cb)
 
void zb_zcl_messaging_send_cancel_msg (zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_cancel_message_payload_t *payload, zb_callback_t cb)
 

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_CLUSTER_ID_MESSAGING_CLIENT_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MESSAGING_CLIENT_ROLE_GENERATED_CMD_LIST
Value:
ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE, \
ZB_ZCL_MESSAGING_CLI_CMD_MESSAGE_CONFIRMATION

◆ ZB_ZCL_CLUSTER_ID_MESSAGING_SERVER_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_MESSAGING_SERVER_ROLE_GENERATED_CMD_LIST
Value:
ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_MESSAGE, \
ZB_ZCL_MESSAGING_SRV_CMD_DISPLAY_MESSAGE

◆ ZB_ZCL_MESSAGING_CANCEL_MSG_PAYLOAD_INIT

#define ZB_ZCL_MESSAGING_CANCEL_MSG_PAYLOAD_INIT   (zb_zcl_messaging_cancel_message_payload_t) {0}

zb_zcl_messaging_cancel_message_payload_t initializer

◆ ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT

#define ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT
Value:
(zb_zcl_messaging_display_message_payload_t)\
{ \
.extended_message_control = 0x00, \
}

zb_zcl_messaging_display_message_payload_t initializer

◆ ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_SIZE_IS_VALID

#define ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_SIZE_IS_VALID (   size)
Value:
((size) > ((zb_int16_t)sizeof(zb_zcl_messaging_display_message_payload_t) - \
(zb_int16_t)ZB_SIZEOF_FIELD(zb_zcl_messaging_display_message_payload_t, \
message) - 1/*extended_message_control field is optional*/))

Check if some size in range of variable size of specified payload.

◆ ZB_ZCL_MESSAGING_GET_LAST_MESSAGE_RESPONSE_INIT

#define ZB_ZCL_MESSAGING_GET_LAST_MESSAGE_RESPONSE_INIT
Value:
(zb_zcl_messaging_get_last_message_response_t) \
{ \
.resp_type = ZB_ZCL_MESSAGING_RESPONSE_TYPE_NOT_FOUND, \
.resp.display_message = ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT, \
}

zb_zcl_messaging_get_last_message_response_t initializer

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_ENHANCED_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_ENHANCED_CONFIRMATION (   x)    ((x) &= 0xDF )

Clear MessageControl's enhanced confirmation value

Parameters
x- variable that stores enhanced confirmation value
See also
zb_zcl_messaging_message_control_enhanced_confirmation_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_IMPORTANCE_LEVEL

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_IMPORTANCE_LEVEL (   x)    ((x) &= 0xF3)

Clear MessageControl's control importance value

Parameters
x- variable that stores control importance value
See also
zb_zcl_messaging_message_control_importance_level_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_MESSAGE_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_MESSAGE_CONFIRMATION (   x)    ((x) &= 0x7F)

Clear MessageControl's message confirmation value

Parameters
x- variable that stores message confirmation value
See also
zb_zcl_messaging_message_control_message_confirmation_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_TRANSMISSION_MECHANISM

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_TRANSMISSION_MECHANISM (   x)    ((x) &= 0xFC)

Clear MessageControl's transmission mechanism value

Parameters
x- variable that stores transmission mechanism value
See also
zb_zcl_messaging_control_field_transmission_mechanism_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_ENHANCED_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_ENHANCED_CONFIRMATION (   x)    (((x) >> 5) & 0x01)

Get MessageControl's enhanced confirmation value

Parameters
x- variable that stores enhanced confirmation value
See also
zb_zcl_messaging_message_control_enhanced_confirmation_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_IMPORTANCE_LEVEL

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_IMPORTANCE_LEVEL (   x)    (((x) >> 2) & 0x03)

Get MessageControl's control importance value

Parameters
x- variable that stores control importance value
See also
zb_zcl_messaging_message_control_importance_level_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_MESSAGE_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_MESSAGE_CONFIRMATION (   x)    (((x) >> 7) & 0x01)

Get MessageControl's message confirmation value

Parameters
x- variable that stores message confirmation value
See also
zb_zcl_messaging_message_control_message_confirmation_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_TRANSMISSION_MECHANISM

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_TRANSMISSION_MECHANISM (   x)    ((x) & 0x03)

Get MessageControl's transmission mechanism value

Parameters
x- variable that stores transmission mechanism value
See also
zb_zcl_messaging_control_field_transmission_mechanism_t

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_ENHANCED_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_ENHANCED_CONFIRMATION (   x,
  val 
)    ((x) &= (0xDF | ((val) & 0x01) << 5)

Set MessageControl's enhanced confirmation value

Parameters
x- variable to store enhanced confirmation value
val- zb_zcl_messaging_message_control_enhanced_confirmation_t value

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_IMPORTANCE_LEVEL

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_IMPORTANCE_LEVEL (   x,
  val 
)    ((x) &= (0xF3 | ((val) & 0x03) << 2)

Set MessageControl's control importance value

Parameters
x- variable to store control importance value
val- zb_zcl_messaging_message_control_importance_level_t value

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_MESSAGE_CONFIRMATION

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_MESSAGE_CONFIRMATION (   x,
  val 
)    ((x) &= (0x7F | ((val) & 0x01) << 7)

Set MessageControl's message confirmation value

Parameters
x- variable to store message confirmation value
val- zb_zcl_messaging_message_control_message_confirmation_t value

◆ ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_TRANSMISSION_MECHANISM

#define ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_TRANSMISSION_MECHANISM (   x,
  val 
)    ((x) &= (0xFC | ((val) & 0x03)))

Set MessageControl's transmission mechanism value

Parameters
x- variable to store transmission mechanism value
val- zb_zcl_messaging_control_field_transmission_mechanism_t value

◆ ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_INIT

#define ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_INIT
Value:
(zb_zcl_messaging_message_confirm_payload_t) \
{\
.message_confirmation_response = {0x00} \
}

zb_zcl_messaging_message_confirm_payload_t initializer

◆ ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_SIZE_IS_VALID

#define ZB_ZCL_MESSAGING_MSG_CONFIRM_PAYLOAD_SIZE_IS_VALID (   size)
Value:
((size) <= sizeof(zb_zcl_messaging_message_confirm_payload_t)) && \
((size) > sizeof(zb_zcl_messaging_message_confirm_payload_t) - \
ZB_SIZEOF_FIELD(zb_zcl_messaging_message_confirm_payload_t, \
message_confirmation_response))

Check if some size in range of variable size of specified payload.

◆ ZB_ZCL_MESSAGING_SEND_CANCEL_MSG

#define ZB_ZCL_MESSAGING_SEND_CANCEL_MSG (   _param,
  _dst_addr,
  _addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_zcl_messaging_send_cancel_msg(_param, _dst_addr, _addr_mode, \
_dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_messaging_send_cancel_msg function

◆ ZB_ZCL_MESSAGING_SEND_DISPLAY_MSG

#define ZB_ZCL_MESSAGING_SEND_DISPLAY_MSG (   _param,
  _dst_addr,
  _addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_zcl_messaging_send_display_msg(_param, _dst_addr, _addr_mode, \
_dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_messaging_send_display_msg function

◆ ZB_ZCL_MESSAGING_SEND_GET_LAST_MSG

#define ZB_ZCL_MESSAGING_SEND_GET_LAST_MSG (   _param,
  _dst_addr,
  _addr_mode,
  _dst_ep,
  _src_ep 
)
Value:
zb_zcl_messaging_send_get_last_msg(_param, _dst_addr, _addr_mode, \
_dst_ep, _src_ep, NULL) \

Macro for call zb_zcl_messaging_send_get_last_msg function

◆ ZB_ZCL_MESSAGING_SEND_MSG_CONFIRMATION

#define ZB_ZCL_MESSAGING_SEND_MSG_CONFIRMATION (   _param,
  _dst_addr,
  _addr_mode,
  _dst_ep,
  _src_ep,
  _payload 
)
Value:
zb_zcl_messaging_send_msg_confirmation(_param, _dst_addr, _addr_mode, \
_dst_ep, _src_ep, _payload, NULL)

Macro for call zb_zcl_messaging_send_msg_confirmation function

Typedef Documentation

◆ zb_zcl_messaging_cancel_all_message_payload_t

typedef struct zb_zcl_messaging_cancel_all_message_payload_s zb_zcl_messaging_cancel_all_message_payload_t

CancelAllMessages command payload

See also
SE spec, subclause D.5.2.3.4.2

◆ zb_zcl_messaging_cancel_message_payload_t

typedef struct zb_zcl_messaging_cancel_message_payload_s zb_zcl_messaging_cancel_message_payload_t

CancelMessage command payload

See also
SE spec, subclause D.5.2.3.2.1

◆ zb_zcl_messaging_cli_cmd_t

typedef enum zb_zcl_messaging_cli_cmd_e zb_zcl_messaging_cli_cmd_t

Commands generated by Messaging Client

See also
SE spec, D.5.3.3

◆ zb_zcl_messaging_control_field_transmission_mechanism_t

typedef enum zb_zcl_messaging_message_control_transmission_mechanism_e zb_zcl_messaging_control_field_transmission_mechanism_t

MessageControl field's transmission mechanism values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_TRANSMISSION_MECHANISM
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_TRANSMISSION_MECHANISM
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_TRANSMISSION_MECHANISM

◆ zb_zcl_messaging_display_message_payload_t

typedef struct zb_zcl_messaging_display_message_payload_s zb_zcl_messaging_display_message_payload_t

DisplayMessage command payload

See also
SE spec, subclause D.5.2.3.1.1

◆ zb_zcl_messaging_extended_message_control_field_t

typedef enum zb_zcl_messaging_extended_message_control_e zb_zcl_messaging_extended_message_control_field_t

Extended Message Control Field values

See also
SE spec, Table D-118
zb_zcl_messaging_display_message_payload_t::extended_message_control

◆ zb_zcl_messaging_get_last_message_response_t

typedef struct zb_zcl_messaging_get_last_message_response_s zb_zcl_messaging_get_last_message_response_t

According to SE spec, server could send following responses to GetLastMessage command:

  • NOT_FOUND as default response
  • DisplayMessage command
  • DisplayProtectedMessage command

◆ zb_zcl_messaging_get_message_cancellation_payload_t

typedef struct zb_zcl_messaging_get_message_cancellation_payload_s zb_zcl_messaging_get_message_cancellation_payload_t

GetMessageCancellation command payload

See also
SE spec, subclause D.5.3.3.3.2

◆ zb_zcl_messaging_message_confirm_payload_t

typedef struct zb_zcl_messaging_message_confirm_payload_s zb_zcl_messaging_message_confirm_payload_t

MessageConfirmation command payload

See also
SE spec, subclause D.5.3.3.2.1

◆ zb_zcl_messaging_message_confirmation_control_t

typedef enum zb_zcl_messaging_message_confirmation_control_e zb_zcl_messaging_message_confirmation_control_t

Message Confirmation Control

See also
SE spec, Table D-120
zb_zcl_messaging_message_confirm_payload_t::message_confirmation_control

◆ zb_zcl_messaging_message_control_enhanced_confirmation_t

typedef enum zb_zcl_messaging_message_control_enhanced_confirmation_e zb_zcl_messaging_message_control_enhanced_confirmation_t

MessageControl field's enhanced confirmation values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_ENHANCED_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_ENHANCED_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_ENHANCED_CONFIRMATION

◆ zb_zcl_messaging_message_control_importance_level_t

typedef enum zb_zcl_messaging_message_control_importance_level_e zb_zcl_messaging_message_control_importance_level_t

MessageControl field's control importance values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_IMPORTANCE_LEVEL
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_IMPORTANCE_LEVEL
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_IMPORTANCE_LEVEL

◆ zb_zcl_messaging_message_control_message_confirmation_t

typedef enum zb_zcl_messaging_message_control_message_confirmation_e zb_zcl_messaging_message_control_message_confirmation_t

MessageControl field's message confirmation values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_MESSAGE_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_MESSAGE_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_MESSAGE_CONFIRMATION

◆ zb_zcl_messaging_srv_cmd_t

typedef enum zb_zcl_messaging_srv_cmd_e zb_zcl_messaging_srv_cmd_t

Commands generated by Messaging Server

See also
SE spec, subclause D.5.2.3

Enumeration Type Documentation

◆ zb_zcl_messaging_cli_cmd_e

enum zb_zcl_messaging_cli_cmd_e

Commands generated by Messaging Client

See also
SE spec, D.5.3.3
Enumerator
ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE 

On receipt of this command, the device shall send a DisplayMessage or DisplayProtectedMessage command as appropriate. A ZCL Default Response with status NOT_FOUND shall be returned if no message is available.

See also
SE spec, subclause D.5.3.3.1
Note
This command has no payload.
ZB_ZCL_MESSAGING_CLI_CMD_MESSAGE_CONFIRMATION 

TheMessageConfirmation command provides an indication that a Utility Customer has acknowledged and/or accepted the contents of a message previously received from the Messaging cluster server. Enhanced Message Confirmation commands shall contain an answer of ‘NO’, ‘YES’ and/or a message confirmation string. If the optional Message Confirmation Response is required, the Message Confirmation Control field shall also be present.

See also
SE spec, subclause D.5.3.3.2
zb_zcl_messaging_message_confirm_payload_s
ZB_ZCL_MESSAGING_CLI_CMD_GET_MESSAGE_CANCELLATION 

This command initiates the return of the first (and maybe only) CancelAllMessages command held on the associated server, and which has an implementation time equal to or later than the value indicated in the payload.

Note
The GetMessageCancellation command in this revision of this specification is provisional and not certifiable. This feature may change before reaching certifiable status in a future revision of this specification.
See also
zb_zcl_messaging_get_message_cancellation_payload_s

◆ zb_zcl_messaging_extended_message_control_e

enum zb_zcl_messaging_extended_message_control_e

Extended Message Control Field values

See also
SE spec, Table D-118
zb_zcl_messaging_display_message_payload_t::extended_message_control
Enumerator
ZB_ZCL_MESSAGING_MESSAGE_HAS_NOT_BEEN_CONFIRMED 

Message has not been confirmed

ZB_ZCL_MESSAGING_MESSAGE_HAS_BEEN_CONFIRMED 

Message has been confirmed

◆ zb_zcl_messaging_extended_message_control_field_bitmap_e

enum zb_zcl_messaging_extended_message_control_field_bitmap_e

Extended Message Control Field Bit Map

See also
SE spec, Table D-118
Enumerator
ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_STATUS 
See also
zb_zcl_messaging_extended_message_control_field_e

◆ zb_zcl_messaging_message_confirmation_control_e

enum zb_zcl_messaging_message_confirmation_control_e

Message Confirmation Control

See also
SE spec, Table D-120
zb_zcl_messaging_message_confirm_payload_t::message_confirmation_control
Enumerator
ZB_ZCL_MESSAGING_NO_RETURNED 

The answer is ‘NO’

ZB_ZCL_MESSAGING_YES_RETURNED 

The answer is ‘YES’

◆ zb_zcl_messaging_message_control_enhanced_confirmation_e

enum zb_zcl_messaging_message_control_enhanced_confirmation_e

MessageControl field's enhanced confirmation values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_ENHANCED_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_ENHANCED_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_ENHANCED_CONFIRMATION
Enumerator
ZB_ZCL_MESSAGING_ENHANCED_CONFIRMATION_NOT_REQUIRED 

Enhanced Confirmation not required

ZB_ZCL_MESSAGING_ENHANCED_CONFIRMATION_REQUIRED 

Enhanced Confirmation required

◆ zb_zcl_messaging_message_control_importance_level_e

enum zb_zcl_messaging_message_control_importance_level_e

MessageControl field's control importance values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_IMPORTANCE_LEVEL
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_IMPORTANCE_LEVEL
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_IMPORTANCE_LEVEL
Enumerator
ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_LOW 

Low importance level

ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_MEDIUM 

Medium importance level

ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_HIGH 

High importance level

ZB_ZCL_MESSAGING_IMPORTANCE_LEVEL_CRITICAL 

Critical importance level

◆ zb_zcl_messaging_message_control_message_confirmation_e

enum zb_zcl_messaging_message_control_message_confirmation_e

MessageControl field's message confirmation values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_MESSAGE_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_MESSAGE_CONFIRMATION
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_MESSAGE_CONFIRMATION
Enumerator
ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_NOT_REQUIRED 

Message Confirmation not required.

ZB_ZCL_MESSAGING_MESSAGE_CONFIRMATION_REQUIRED 

Message Confirmation required.

◆ zb_zcl_messaging_message_control_transmission_mechanism_e

enum zb_zcl_messaging_message_control_transmission_mechanism_e

MessageControl field's transmission mechanism values

See also
SE spec, Table D-117
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_SET_TRANSMISSION_MECHANISM
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_GET_TRANSMISSION_MECHANISM
ZB_ZCL_MESSAGING_MESSAGE_CONTROL_CLR_TRANSMISSION_MECHANISM
Enumerator
ZB_ZCL_MESSAGING_NORMAL_TRANSMISSION_ONLY 

Send message through normal command function to client.

ZB_ZCL_MESSAGING_NORMAL_AND_INTERNAL_PAN_TRANSMISSION 

Send message through normal command function to client and pass message onto the Inter-PAN transmission mechanism.

ZB_ZCL_MESSAGING_INTER_PAN_TRANSMISSION_ONLY 

Send message through the Inter-PAN transmission mechanism.

◆ zb_zcl_messaging_srv_cmd_e

enum zb_zcl_messaging_srv_cmd_e

Commands generated by Messaging Server

See also
SE spec, subclause D.5.2.3
Enumerator
ZB_ZCL_MESSAGING_SRV_CMD_DISPLAY_MESSAGE 
See also
SE spec, subclause D.5.2.3.1
zb_zcl_messaging_display_message_payload_s
ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_MESSAGE 

TheCancelMessage command provides the ability to cancel the sending or acceptance of previously sent messages. When this message is received the recipient device has the option of clearing any display or user interfaces it supports, or has the option of logging the message for future reference.

See also
SE spec, subclause D.5.2.3.2
zb_zcl_messaging_cancel_message_payload_s
ZB_ZCL_MESSAGING_SRV_CMD_DISPLAY_PROTECTED_MESSAGE 

The Display Protected Message command is for use with messages that are protected by a password or PIN.

See also
zb_zcl_messaging_display_message_payload_s
ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_ALL_MESSAGES 

TheCancelAllMessages command indicates to a client device that it should cancel all display messages currently held by it.

Note
TheCancelAllMessages command in this revision of this specification is provisional and not certifiable. This feature may change before reaching certifiable status in a future revision of this specification.
See also
zb_zcl_messaging_cancel_all_message_payload_s

Function Documentation

◆ zb_zcl_messaging_send_cancel_msg()

void zb_zcl_messaging_send_cancel_msg ( zb_uint8_t  param,
const zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
const zb_zcl_messaging_cancel_message_payload_t *  payload,
zb_callback_t  cb 
)

Function for send CancelMessage command On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_MESSAGING_CANCEL_MSG_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_messaging_cancel_message_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.

◆ zb_zcl_messaging_send_display_msg()

void zb_zcl_messaging_send_display_msg ( zb_uint8_t  param,
const zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
const zb_zcl_messaging_display_message_payload_t *  payload,
zb_callback_t  cb 
)

Function for send DisplayMessage command. On sender's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_MESSAGING_GET_LAST_MSG_CB_ID callback id on reception of GetLastMessage command.
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_MESSAGING_DISPLAY_MSG_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_messaging_display_message_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
Usage

Handle GetLastMessage command

◆ zb_zcl_messaging_send_get_last_msg()

void zb_zcl_messaging_send_get_last_msg ( zb_uint8_t  param,
const zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
zb_callback_t  cb 
)

Function for send GetLastMessage command
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_MESSAGING_GET_LAST_MSG_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
cb- Callback which should be called when the ZCL stack receives APS ack.
Usage

Example of sending ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE "GetLastMessage" command

◆ zb_zcl_messaging_send_msg_confirmation()

void zb_zcl_messaging_send_msg_confirmation ( zb_uint8_t  param,
const zb_addr_u *  dst_addr,
zb_aps_addr_mode_t  dst_addr_mode,
zb_uint8_t  dst_ep,
zb_uint8_t  src_ep,
const zb_zcl_messaging_message_confirm_payload_t *  payload,
zb_callback_t  cb 
)

Function for send MessageConfirmation command On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_MESSAGING_MSG_CONFIRMATION_CB_ID callback id.

Parameters
param- Reference to buffer.
dst_addr- Address of the device to send command to.
dst_addr_mode- Address mode for dst_addr.
dst_ep- Destination endpoint.
src_ep- Current endpoint.
payload- Packet payload (zb_zcl_messaging_message_confirm_payload_t).
cb- Callback which should be called when the ZCL stack receives APS ack.
zb_int16_t
signed short zb_int16_t
Project-local 2-byte signed int type.
Definition: zb_types.h:155
zb_zcl_messaging_display_message_payload_s
Definition: zb_zcl_messaging.h:161
ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_MESSAGE
@ ZB_ZCL_MESSAGING_SRV_CMD_CANCEL_MESSAGE
Definition: zb_zcl_messaging.h:67
ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE
@ ZB_ZCL_MESSAGING_CLI_CMD_GET_LAST_MESSAGE
Definition: zb_zcl_messaging.h:98
zb_zcl_messaging_send_get_last_msg
void zb_zcl_messaging_send_get_last_msg(zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, zb_callback_t cb)
zb_zcl_messaging_message_confirm_payload_s
Definition: zb_zcl_messaging.h:396
zb_zcl_messaging_display_message_payload_t
struct zb_zcl_messaging_display_message_payload_s zb_zcl_messaging_display_message_payload_t
zb_zcl_messaging_get_last_message_response_t
struct zb_zcl_messaging_get_last_message_response_s zb_zcl_messaging_get_last_message_response_t
zb_zcl_messaging_message_confirm_payload_t
struct zb_zcl_messaging_message_confirm_payload_s zb_zcl_messaging_message_confirm_payload_t
zb_zcl_messaging_send_cancel_msg
void zb_zcl_messaging_send_cancel_msg(zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_cancel_message_payload_t *payload, zb_callback_t cb)
zb_zcl_messaging_send_msg_confirmation
void zb_zcl_messaging_send_msg_confirmation(zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_message_confirm_payload_t *payload, zb_callback_t cb)
zb_zcl_messaging_send_display_msg
void zb_zcl_messaging_send_display_msg(zb_uint8_t param, const zb_addr_u *dst_addr, zb_aps_addr_mode_t dst_addr_mode, zb_uint8_t dst_ep, zb_uint8_t src_ep, const zb_zcl_messaging_display_message_payload_t *payload, zb_callback_t cb)
ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT
#define ZB_ZCL_MESSAGING_DISPLAY_MSG_PAYLOAD_INIT
Definition: zb_zcl_messaging.h:356