* @ingroup CAPI_NETWORK_ZIGBEE_MODULE
* @defgroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE Zigbee Device Object
*
- * @brief zigbee provides API for ZDO access.
+ * @brief Zigbee provides API for ZDO access.
*
* @section CAPI_NETWORK_ZIGBEE_ZDO_MODULE_HEADER Header
* \#include <zigbee.h>
#include <zdo/zb_zdo_bind_mgr.h>
/**
- * @brief Return readable ZDO error code
- * @details Return ZDO error code string
+ * @brief Returns readable ZDO error code
+ * @details Returns ZDO error code string
*
* @since_tizen 4.0
*
const char* zb_zdo_get_error_message(int id);
/**
- * @brief Return readable Zigbee profile id
- * @details Return Zigbee profile id
+ * @brief Returns readable Zigbee profile id
+ * @details Returns Zigbee profile id
*
* @since_tizen 4.0
*
const char* zb_get_device_id_string(int device_id);
/**
- * @brief Create simple descriptor
- * @details Create simple descriptor handle
+ * @brief Creates simple descriptor
+ * @details Creates simple descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_simple_desc_h *handle);
/**
- * @brief copy simple descriptor
- * @details copy simple descriptor handle to another
+ * @brief Copies simple descriptor
+ * @details Copies simple descriptor handle to another
*
* @since_tizen 4.0
*
zb_zdo_simple_desc_h dst);
/**
- * @brief destroy simple descriptor handle
- * @details destroy simple descriptor allocated memory
+ * @brief Destroys simple descriptor handle
+ * @details Destroys simple descriptor allocated memory
*
* @since_tizen 4.0
*
zb_zdo_simple_desc_h handle);
/**
- * @brief get active endpoint number from simple descriptor handle
- * @details get active endpoint number from simple descriptor handle
+ * @brief Gets active endpoint number from simple descriptor handle
+ * @details Gets active endpoint number from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char *ep);
/**
- * @brief set active endpoint number to simple descriptor handle
- * @details set active endpoint number to simple descriptor handle
+ * @brief Set active endpoint number to simple descriptor handle
+ * @details Set active endpoint number to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char ep);
/**
- * @brief get profile id from simple descriptor handle
- * @details get profile id from simple descriptor handle
+ * @brief Gets profile id from simple descriptor handle
+ * @details Gets profile id from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short *profile_id);
/**
- * @brief set profile id to simple descriptor handle
- * @details set profile id to simple descriptor handle
+ * @brief Sets profile id to simple descriptor handle
+ * @details Sets profile id to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short profile_id);
/**
- * @brief set device id from simple descriptor handle
- * @details set device id from simple descriptor handle
+ * @brief Gets device id from simple descriptor handle
+ * @details Gets device id from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short *device_id);
/**
- * @brief set device id to simple descriptor handle
- * @details set device id to simple descriptor handle
+ * @brief Sets device id to simple descriptor handle
+ * @details Sets device id to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short device_id);
/**
- * @brief get device version from simple descriptor handle
- * @details get device version from simple descriptor handle
+ * @brief Gets device version from simple descriptor handle
+ * @details Gets device version from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short *device_ver);
/**
- * @brief set device version to simple descriptor handle
- * @details set device version to simple descriptor handle
+ * @brief Sets device version to simple descriptor handle
+ * @details Sets device version to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short device_ver);
/**
- * @brief get number of input clusters from simple descriptor handle
- * @details get number of input clusters from simple descriptor handle
+ * @brief Gets number of input clusters from simple descriptor handle
+ * @details Gets number of input clusters from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char *num_of_in_clusters);
/**
- * @brief get number of input clusters to simple descriptor handle
- * @details get number of input clusters to simple descriptor handle
+ * @brief Sets number of input clusters to simple descriptor handle
+ * @details Sets number of input clusters to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char num_of_in_clusters);
/**
- * @brief get number of output clusters from simple descriptor handle
- * @details get number of output clusters from simple descriptor handle
+ * @brief Gets number of output clusters from simple descriptor handle
+ * @details Gets number of output clusters from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char *num_of_out_clusters);
/**
- * @brief set number of output clusters to simple descriptor handle
- * @details set number of output clusters to simple descriptor handle
+ * @brief Sets number of output clusters to simple descriptor handle
+ * @details Sets number of output clusters to simple descriptor handle
*
* @since_tizen 4.0
*
unsigned char num_of_out_clusters);
/**
- * @brief get input cluster list from simple descriptor handle
- * @details get input cluster list from simple descriptor handle
+ * @brief Gets input cluster list from simple descriptor handle
+ * @details Gets input cluster list from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short **in_clusters);
/**
- * @brief set input cluster list to simple descriptor handle
- * @details set input cluster list to simple descriptor handle
+ * @brief Sets input cluster list to simple descriptor handle
+ * @details Sets input cluster list to simple descriptor handle
*
* @since_tizen 4.0
*
int num);
/**
- * @brief get output cluster list from simple descriptor handle
- * @details get output cluster list from simple descriptor handle
+ * @brief Gets output cluster list from simple descriptor handle
+ * @details Gets output cluster list from simple descriptor handle
*
* @since_tizen 4.0
*
unsigned short **out_clusters);
/**
- * @brief set output cluster list to simple descriptor handle
- * @details set output cluster list to simple descriptor handle
+ * @brief Sets output cluster list to simple descriptor handle
+ * @details Sets output cluster list to simple descriptor handle
*
* @since_tizen 4.0
*
int num);
/**
- * @brief Create node power descriptor
- * @details Create node power descriptor handle
+ * @brief Creates node power descriptor
+ * @details Creates node power descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_power_descriptor_h *handle);
/**
- * @brief copy node power descriptor
- * @details copy node power descriptor handle
+ * @brief Copies node power descriptor
+ * @details Copies node power descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_power_descriptor_h dst);
/**
- * @brief destroy node power descriptor
- * @details destroy node power descriptor handle
+ * @brief Destroys node power descriptor
+ * @details Destroys node power descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_power_descriptor_h handle);
/**
- * @brief get current power mode from node power descriptor
+ * @brief Gets current power mode from node power descriptor
* @details The current power mode field of the node power descriptor is four bits in length
* and specifies the current sleep/power-saving mode of the node. \n\n The current power
* mode field shall be set to one of the non-reserved values
unsigned char* current_power_mode);
/**
- * @brief set current power mode from node power descriptor
+ * @brief Sets current power mode from node power descriptor
* @details The current power mode field of the node power descriptor is four bits in length
* and specifies the current sleep/power-saving mode of the node. \n\n The current power
* mode field shall be set to one of the non-reserved values
unsigned char current_power_mode);
/**
- * @brief get available power mode from node power descriptor
+ * @brief Gets available power mode from node power descriptor
* @details The available power sources field of the node power descriptor is four bits in
* length and specifies the power sources available on this node. \n\n For each power
* source supported on this node, the corresponding bit of the available power sources
unsigned char* available_power_sources);
/**
- * @brief set available power mode from node power descriptor
+ * @brief Sets available power mode from node power descriptor
* @details The available power sources field of the node power descriptor is four bits in
* length and specifies the power sources available on this node. \n\n For each power
* source supported on this node, the corresponding bit of the available power sources
unsigned char available_power_sources);
/**
- * @brief get current power source from node power descriptor
+ * @brief Gets current power source from node power descriptor
* @details The current power source field of the node power descriptor is four bits in
* length and specifies the current power source being utilized by the node. \n]n
* For the current power source selected, the corresponding bit of the current power \n\n
unsigned char* current_power_source);
/**
- * @brief set available power mode from node power descriptor
+ * @brief Sets available power mode from node power descriptor
* @details The current power source field of the node power descriptor is four bits in
* length and specifies the current power source being utilized by the node. \n]n
* For the current power source selected, the corresponding bit of the current power \n\n
unsigned char current_power_source);
/**
- * @brief get current power source level from node power descriptor
+ * @brief Gets current power source level from node power descriptor
* @details The current power source level field of the node power descriptor is four bits
* in length and specifies the level of charge of the power source. \n\n The current power
* source level field shall be set to one of the non-reserved values
unsigned char* current_power_source_level);
/**
- * @brief set current power source level from node power descriptor
+ * @brief Sets current power source level from node power descriptor
* @details The current power source level field of the node power descriptor is four bits
* in length and specifies the level of charge of the power source. \n\n The current power
* source level field shall be set to one of the non-reserved values
unsigned char current_power_source_level);
/**
- * @brief Create node descriptor
- * @details Create node descriptor handle
+ * @brief Creates node descriptor
+ * @details Creates node descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_descriptor_h *handle);
/**
- * @brief copy node descriptor
- * @details copy node descriptor handle
+ * @brief Copies node descriptor
+ * @details Copies node descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_descriptor_h dst);
/**
- * @brief destroy node descriptor
- * @details destroy node descriptor handle
+ * @brief Destroys node descriptor
+ * @details Destroys node descriptor handle
*
* @since_tizen 4.0
*
zb_zdo_node_descriptor_h handle);
/**
- * @brief get logical type from node descriptor
+ * @brief Gets logical type from node descriptor
* @details The logical type field of the node descriptor is three bits in length and
* specifies the device type of the ZigBee node. \n\n The logical type field shall be set
* to one of the non-reserved values.
unsigned char* logical_type);
/**
- * @brief set logical type from to descriptor
+ * @brief Sets logical type from to descriptor
* @details The logical type field of the node descriptor is three bits in length and
* specifies the device type of the ZigBee node. \n\n The logical type field shall be set
* to one of the non-reserved values.
unsigned char logical_type);
/**
- * @brief get complex descriptor available from node descriptor
+ * @brief Gets complex descriptor available from node descriptor
* @details The complex descriptor available field of the node descriptor is one bit in
* length and specifies whether a complex descriptor is available on this device. \n\n
* If this field is set to 1, a complex descriptor is available. \n\n
unsigned char* complex_desciptor_available);
/**
- * @brief set complex descriptor available to node descriptor
+ * @brief Sets complex descriptor available to node descriptor
* @details The complex descriptor available field of the node descriptor is one bit in
* length and specifies whether a complex descriptor is available on this device. \n\n
* If this field is set to 1, a complex descriptor is available. \n\n
unsigned char complex_desciptor_available);
/**
- * @brief get user descriptor available from node descriptor
+ * @brief Gets user descriptor available from node descriptor
* @details The user descriptor available field of the node descriptor is one bit in
* length and specifies whether a user descriptor is available on this device. \n\n
* If this field is set to 1, a user descriptor is available.
unsigned char* user_descriptor_available);
/**
- * @brief set user descriptor available to node descriptor
+ * @brief Sets user descriptor available to node descriptor
* @details The user descriptor available field of the node descriptor is one bit in
* length and specifies whether a user descriptor is available on this device. \n\n
* If this field is set to 1, a user descriptor is available.
unsigned char user_descriptor_available);
/**
- * @brief get APS flags available from node descriptor
+ * @brief Gets APS flags available from node descriptor
* @details The APS flags field of the node descriptor is three bits in length and
* specifies the application support sub-layer capabilities of the node. \n\n
* This field is currently not supported and shall be set to zero.
zb_zdo_node_descriptor_h handle,
unsigned char* aps_flags);
/**
- * @brief set APS flags available to node descriptor
+ * @brief Sets APS flags available to node descriptor
* @details The APS flags field of the node descriptor is three bits in length and
* specifies the application support sub-layer capabilities of the node. \n\n
* This field is currently not supported and shall be set to zero.
unsigned char aps_flags);
/**
- * @brief get frequency band from node descriptor
+ * @brief Gets frequency band from node descriptor
* @details The frequency band field of the node descriptor is five bits in length and
* specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio
* utilized by the node. \n\n For each frequency band supported by the underlying IEEE
unsigned char* frequency_band);
/**
- * @brief set frequency band to node descriptor
+ * @brief Sets frequency band to node descriptor
* @details The frequency band field of the node descriptor is five bits in length and
* specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio
* utilized by the node. \n\n For each frequency band supported by the underlying IEEE
unsigned char frequency_band);
/**
- * @brief get MAC capability from node descriptor
+ * @brief Gets MAC capability from node descriptor
* @details The MAC capability flags field is eight bits in length and specifies the node
* capabilities, as required by the IEEE 802.15.4-2003 MAC sub-layer. \n\n The
* MAC capability flags field shall be formatted as illustrated in below table. \n\n
unsigned char* mac_capability_flags);
/**
- * @brief set MAC capability to node descriptor
+ * @brief Sets MAC capability to node descriptor
* @details The MAC capability flags field is eight bits in length and specifies the node
* capabilities, as required by the IEEE 802.15.4-2003 MAC sub-layer. \n\n The
* MAC capability flags field shall be formatted as illustrated in below table.\n\n
unsigned char mac_capability_flags);
/**
- * @brief get manufacturer code from node descriptor
+ * @brief Gets manufacturer code from node descriptor
* @details The manufacturer code field of the node descriptor is sixteen bits in length
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
unsigned short* manufacturer_code);
/**
- * @brief set manufacturer code to node descriptor
+ * @brief Sets manufacturer code to node descriptor
* @details The manufacturer code field of the node descriptor is sixteen bits in length
* and specifies a manufacturer code that is allocated by the ZigBee Alliance, relating
* the manufacturer to the device.
unsigned short manufacturer_code);
/**
- * @brief get maximum buffer size from node descriptor
+ * @brief Gets maximum buffer size from node descriptor
* @details The maximum buffer size field of the node descriptor is eight bits in length,
* with a valid range of 0x00-0x7f. \n\n This field specifies the maximum size, in octets,
* of the network sub-layer data unit (NSDU) for this node. This is the maximum size of
unsigned char* maximum_buffer_size);
/**
- * @brief set maximum buffer size to node descriptor
+ * @brief Sets maximum buffer size to node descriptor
* @details The maximum buffer size field of the node descriptor is eight bits in length,
* with a valid range of 0x00-0x7f. \n\n This field specifies the maximum size, in octets,
* of the network sub-layer data unit (NSDU) for this node. This is the maximum size of
unsigned char maximum_buffer_size);
/**
- * @brief get maximum incoming transfer size from node descriptor
+ * @brief Gets maximum incoming transfer size from node descriptor
* @details The maximum transfer size field of the node descriptor is sixteen bits in
* length, with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum
* size, in octets, of the application sub-layer data unit (ASDU) that can be transferred
unsigned short* maximum_incoming_transfer_size);
/**
- * @brief set maximum incoming transfer size to node descriptor
+ * @brief Sets maximum incoming transfer size to node descriptor
* @details The maximum transfer size field of the node descriptor is sixteen bits in
* length, with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum
* size, in octets, of the application sub-layer data unit (ASDU) that can be transferred
unsigned short maximum_incoming_transfer_size);
/**
- * @brief get server mask from node descriptor
+ * @brief Gets server mask from node descriptor
* @details The server mask field of the node descriptor is sixteen bits in length,
* with bit settings signifying the system server capabilities of this node. \n\n
* It is used to facilitate discovery of particular system servers by other nodes on the
unsigned short* server_mask);
/**
- * @brief set server mask to node descriptor
+ * @brief Sets server mask to node descriptor
* @details The server mask field of the node descriptor is sixteen bits in length,
* with bit settings signifying the system server capabilities of this node. \n\n
* It is used to facilitate discovery of particular system servers by other nodes on the
unsigned short server_mask);
/**
- * @brief get maximum outgoing transfer size from node descriptor
+ * @brief Gets maximum outgoing transfer size from node descriptor
* @details The maximum transfer size field of the node descriptor is sixteen bits in,
* length with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum size,
* in octets, of the application sub-layer data unit (ASDU) that can be transferred from
unsigned short* maximum_outgoing_transfer_size);
/**
- * @brief set maximum outgoing transfer size to node descriptor
+ * @brief Sets maximum outgoing transfer size to node descriptor
* @details The maximum transfer size field of the node descriptor is sixteen bits in,
* length with a valid range of 0x0000-0x7fff. \n\n This field specifies the maximum size,
* in octets, of the application sub-layer data unit (ASDU) that can be transferred from
unsigned short maximum_outgoing_transfer_size);
/**
- * @brief get descriptor capability from node descriptor
+ * @brief Gets descriptor capability from node descriptor
* @details The descriptor capability field of the node descriptor is eight bits in length
* , with bit settings signifying the descriptor capabilities of this node. \n\n
* It is used to facilitate discovery of particular features of the descriptor fields by
unsigned short* descriptor_capability_field);
/**
- * @brief set descriptor capability to node descriptor
+ * @brief Sets descriptor capability to node descriptor
* @details The descriptor capability field of the node descriptor is eight bits in length
* , with bit settings signifying the descriptor capabilities of this node. \n\n
* It is used to facilitate discovery of particular features of the descriptor fields by
unsigned short descriptor_capability_field);
/**
- * @brief get extended pan id from network list record
+ * @brief Gets extended pan id from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
ieee_addr extended_pan_id);
/**
- * @brief get logical channel number from network list record
+ * @brief Gets logical channel number from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has multiple network_list_record.
* \n\n Therefore this function can help parsing parameter in network_list_record.
unsigned char* logical_channel);
/**
- * @brief get ZigBee version from network list record
+ * @brief Gets ZigBee version from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* zigbee_version);
/**
- * @brief get stack profile from network list record
+ * @brief Gets stack profile from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* stack_profile);
/**
- * @brief get beacon order from network list record
+ * @brief Gets beacon order from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* beacon_order);
/**
- * @brief get superframe order from network list record
+ * @brief Gets superframe order from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* superframe_order);
/**
- * @brief get permit joining from network list record
+ * @brief Gets permit joining from network list record
* @details When received zb_zdo_mgmt_nwk_disc_rsp callback (originally, ZigBee
* called Mgmt_NWK_Disc_rsp (ClusterID = 0x8030) ), it has a network_list_record. \n\n
* Therefore this function can help parsing parameter in network_list_record.
unsigned char* permit_joining);
/**
- * @brief get destination address from routing table record
+ * @brief Gets destination address from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
nwk_addr* dst_addr);
/**
- * @brief get status bits (3bit) from routing table record
+ * @brief Gets status bits (3bit) from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
unsigned char* status);
/**
- * @brief get memory constrained (1bit) from routing table record
+ * @brief Gets memory constrained (1bit) from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, unsigned char* memory_constrained);
/**
- * @brief get many-to-one (1bit) from routing table record
+ * @brief Gets many-to-one (1bit) from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
unsigned char* many_to_one);
/**
- * @brief get routing record required (1bit) from routing table record
+ * @brief Gets routing record required (1bit) from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, unsigned char* route_record_required);
/**
- * @brief get next hop address from routing table record
+ * @brief Gets next hop address from routing table record
* @details When received zb_zdo_mgmt_rtg_rsp callback (originally, The Mgmt_Rtg_rsp
* command (ClusterID=0x8032) ), it has a routing table record. \n\n
* Therefore this function can help parsing parameter in routing table records.
zb_zdo_routing_table_h handle, nwk_addr* next_hop_addr);
/**
- * @brief get extended pan id from neighbor table list record
+ * @brief Gets extended pan id from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
ieee_addr extended_pan_id);
/**
- * @brief get IEEE address from neighbor table list record
+ * @brief Gets IEEE address from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
ieee_addr addr64);
/**
- * @brief get network address from neighbor table list record
+ * @brief Gets network address from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
nwk_addr* addr16);
/**
- * @brief get device type from neighbor table list record
+ * @brief Gets device type from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* device_type);
/**
- * @brief get RxOnWhenIdle value from neighbor table list record
+ * @brief Gets RxOnWhenIdle value from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* rx_on_when_idle);
/**
- * @brief get Relationship value from neighbor table list record
+ * @brief Gets Relationship value from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* releationship);
/**
- * @brief get Permit joining value from neighbor table list record
+ * @brief Gets Permit joining value from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* permit_joining);
/**
- * @brief get Depth value from neighbor table list record
+ * @brief Gets Depth value from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* depth);
/**
- * @brief get LQI(Link-Quality Indicator) value from neighbor table list record
+ * @brief Gets LQI(Link-Quality Indicator) value from neighbor table list record
* @details When received zb_zdo_mgmt_lqi_rsp callback (originally, ZigBee
* called Mgmt_Lqi_rsp (ClusterID = 0x8031) ), it has multiple neigbor_table_list. \n\n
* Therefore this function can help parsing parameter in neigbor_table_list.
unsigned char* lqi);
/**
- * @brief get source MAC address from binding table record
+ * @brief Gets source MAC address from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
ieee_addr src_addr);
/**
- * @brief get SrcEndpoint from binding table record
+ * @brief Gets SrcEndpoint from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *src_ep);
/**
- * @brief get ClusterId from binding table record
+ * @brief Gets ClusterId from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned short *cluster_id);
/**
- * @brief get DstAddrMode from binding table record
+ * @brief Gets DstAddrMode from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *dst_addr_mode);
/**
- * @brief get DstAddr from binding table record
+ * @brief Gets DstAddr from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
nwk_addr *addr16);
/**
- * @brief get DstAddr from binding table record
+ * @brief Gets DstAddr from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
ieee_addr addr64);
/**
- * @brief get DstEndPoint from binding table record
+ * @brief Gets DstEndPoint from binding table record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Bind_rsp (ClusterID = 0x8033) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in binding_table structure.
unsigned char *dst_ep);
/**
- * @brief get ExtendedAddress from discovery cache record
+ * @brief Gets ExtendedAddress from discovery cache record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in discovery cache list record.
ieee_addr addr64);
/**
- * @brief get NetworkAddress from discovery cache record
+ * @brief Gets NetworkAddress from discovery cache record
* @details When received zb_zdo_mgmt_bind_rsp callback (originally, ZigBee
* called Mgmt_Cache_rsp (ClusterID = 0x8037) ), it has multiple binding table. \n\n
* Therefore this function can help parsing parameter in discovery cache list record.
ZB_ZCL_DISCOVER_COMMANDS_RECEIVED_RESPONSE_COMMAND_ID = 0x12, /**< Discover commands received */
ZB_ZCL_DISCOVER_COMMANDS_GENERATED_COMMAND_ID = 0x13, /**< Discover commands generated */
ZB_ZCL_DISCOVER_COMMANDS_GENERATED_RESPONSE_COMMAND_ID = 0x14, /**< Discover commands generated response */
- ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_COMMAND_ID = 0x15, /**< Discover attributes exteneded */
+ ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_COMMAND_ID = 0x15, /**< Discover attributes extended */
ZB_ZCL_DISCOVER_ATTRIBUTES_EXTENDED_RESPONSE_COMMAND_ID = 0x16, /**< Discover attributes extended response */
} zb_zcl_global_commands_e;
ZB_ZCL_IDENTIFY_QUERY_COMMAND_ID = 0x01, /**< Identify query */
ZB_ZCL_E_Z_MODE_INVOKE_COMMAND_ID = 0x02, /**< EZ mode invoke */
ZB_ZCL_UPDATE_COMMISSION_STATE_COMMAND_ID = 0x03, /**< Update commission state */
- ZB_ZCL_TRIGGER_EFFECT_COMMAND_ID = 0x40, /**< (since zll-1.0-11-0037-10) */
+ ZB_ZCL_TRIGGER_EFFECT_COMMAND_ID = 0x40, /**< Trigger effect (since zll-1.0-11-0037-10) */
} zb_zcl_identify_client_commands_e;
/**
*/
typedef enum {
ZB_ZCL_ADD_SCENE_COMMAND_ID = 0x00, /**< Add scene */
- ZB_ZCL_VIEW_SCENE_COMMAND_ID = 0x01, /**< View scenen */
- ZB_ZCL_REMOVE_SCENE_COMMAND_ID = 0x02, /**< Remove scnene */
- ZB_ZCL_REMOVE_ALL_SCENES_COMMAND_ID = 0x03, /**< Remove all scenens */
+ ZB_ZCL_VIEW_SCENE_COMMAND_ID = 0x01, /**< View scene */
+ ZB_ZCL_REMOVE_SCENE_COMMAND_ID = 0x02, /**< Remove scene */
+ ZB_ZCL_REMOVE_ALL_SCENES_COMMAND_ID = 0x03, /**< Remove all scenes */
ZB_ZCL_STORE_SCENE_COMMAND_ID = 0x04, /**< Store scene */
ZB_ZCL_RECALL_SCENE_COMMAND_ID = 0x05, /**< Recall scene */
ZB_ZCL_GET_SCENE_MEMBERSHIP_COMMAND_ID = 0x06, /**< Get scene membership */
ZB_ZCL_ON_COMMAND_ID = 0x01, /**< On */
ZB_ZCL_TOGGLE_COMMAND_ID = 0x02, /**< Toggle */
ZB_ZCL_OFF_WITH_EFFECT_COMMAND_ID = 0x40, /**< Off with effect (since zll-1.0-11-0037-10) */
- ZB_ZCL_ON_WITH_RECALL_GLOBAL_SCENE_COMMAND_ID = 0x41, /**< On with recall golbal scene (since zll-1.0-11-0037-10) */
+ ZB_ZCL_ON_WITH_RECALL_GLOBAL_SCENE_COMMAND_ID = 0x41, /**< On with recall global scene (since zll-1.0-11-0037-10) */
ZB_ZCL_ON_WITH_TIMED_OFF_COMMAND_ID = 0x42, /**< on with timed off (since zll-1.0-11-0037-10) */
} zb_zcl_on_off_client_commands_e;
*/
typedef enum {
ZB_ZCL_ALARM_COMMAND_ID = 0x00, /**< Alarm */
- ZB_ZCL_GET_ALARM_RESPONSE_COMMAND_ID = 0x01, /**< Alarm reponse */
+ ZB_ZCL_GET_ALARM_RESPONSE_COMMAND_ID = 0x01, /**< Alarm response */
} zb_zcl_alarms_server_commands_e;
/**
*/
typedef enum {
ZB_ZCL_RESTART_DEVICE_RESPONSE_COMMAND_ID = 0x00, /**< Restart device response */
- ZB_ZCL_SAVE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x01, /**< Svae startup parameters response */
- ZB_ZCL_RESTORE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x02, /**< Restrore startup parameters response */
- ZB_ZCL_RESET_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x03, /**< Reset startup parameters resonse */
+ ZB_ZCL_SAVE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x01, /**< Save startup parameters response */
+ ZB_ZCL_RESTORE_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x02, /**< Restore startup parameters response */
+ ZB_ZCL_RESET_STARTUP_PARAMETERS_RESPONSE_COMMAND_ID = 0x03, /**< Reset startup parameters response */
} zb_zcl_commissioning_server_commands_e;
/**
* @since_tizen 4.0
*/
typedef enum {
- ZB_ZCL_MULTIPLE_ACK_COMMAND_ID = 0x00, /**< Multiple ack */
+ ZB_ZCL_MULTIPLE_ACK_COMMAND_ID = 0x00, /**< Multiple ACK */
ZB_ZCL_READ_HANDSHAKE_PARAM_RESPONSE_COMMAND_ID = 0x01, /**< Read handshake parameters response */
} zb_zcl_partition_server_commands_e;
ZB_ZCL_POWER_PROFILE_STATE_REQUEST_COMMAND_ID = 0x01, /**< Power profile state request */
ZB_ZCL_GET_POWER_PROFILE_PRICE_RESPONSE_COMMAND_ID = 0x02, /**< Get power profile price response */
ZB_ZCL_GET_OVERALL_SCHEDULE_PRICE_RESPONSE_COMMAND_ID = 0x03, /**< Get overall schedule price response */
- ZB_ZCL_ENERGY_PHASES_SCHEDULE_NOTIFICATION_COMMAND_ID = 0x04, /**< Energy phrases schedules notificatoin */
+ ZB_ZCL_ENERGY_PHASES_SCHEDULE_NOTIFICATION_COMMAND_ID = 0x04, /**< Energy phrases schedules notification */
ZB_ZCL_ENERGY_PHASES_SCHEDULE_RESPONSE_COMMAND_ID = 0x05, /**< Energy phrases schedules response */
ZB_ZCL_POWER_PROFILE_SCHEDULE_CONSTRAINTS_REQUEST_COMMAND_ID = 0x06, /**< Power profile schedule constraints request */
ZB_ZCL_ENERGY_PHASES_SCHEDULE_STATE_REQUEST_COMMAND_ID = 0x07, /**< Energy phrases schedules state request */
* @since_tizen 4.0
*/
typedef enum {
- ZB_ZCL_CHECK_IN_RESPONSE_COMMAND_ID = 0x00, /**< Chec-in response */
+ ZB_ZCL_CHECK_IN_RESPONSE_COMMAND_ID = 0x00, /**< Check-in response */
ZB_ZCL_FAST_POLL_STOP_COMMAND_ID = 0x01, /**< Fast poll stop */
ZB_ZCL_SET_LONG_POLL_INTERVAL_COMMAND_ID = 0x02, /**< Set long poll interval */
ZB_ZCL_SET_SHORT_POLL_INTERVAL_COMMAND_ID = 0x03, /**< Set short poll interval */
typedef enum {
ZB_ZCL_LOCK_DOOR_RESPONSE_COMMAND_ID = 0x00, /**< Lock door response */
ZB_ZCL_UNLOCK_DOOR_RESPONSE_COMMAND_ID = 0x01, /**< Unlock door response */
- ZB_ZCL_TOGGLE_RESPONSE_COMMAND_ID = 0x02, /**< Toggle resposne (since ha-1.2-05-3520-29) */
+ ZB_ZCL_TOGGLE_RESPONSE_COMMAND_ID = 0x02, /**< Toggle response (since ha-1.2-05-3520-29) */
ZB_ZCL_UNLOCK_WITH_TIMEOUT_RESPONSE_COMMAND_ID = 0x03, /**< Unlock with timeout response (since ha-1.2-05-3520-29) */
ZB_ZCL_GET_LOG_RECORD_RESPONSE_COMMAND_ID = 0x04, /**< Get log record response (since ha-1.2-05-3520-29) */
ZB_ZCL_SET_PIN_RESPONSE_COMMAND_ID = 0x05, /**< Set PIN response (since ha-1.2-05-3520-29) */
ZB_ZCL_GET_USER_STATUS_RESPONSE_COMMAND_ID = 0x0A, /**< Get user status response (since ha-1.2-05-3520-29) */
ZB_ZCL_SET_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0B, /**< Set weekday schedule response (since ha-1.2-05-3520-29) */
ZB_ZCL_GET_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0C, /**< Get weekday schedule response (since ha-1.2-05-3520-29) */
- ZB_ZCL_CLEAR_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0D, /**< Clear weekday schedule resposne (since ha-1.2-05-3520-29) */
+ ZB_ZCL_CLEAR_WEEKDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0D, /**< Clear weekday schedule response (since ha-1.2-05-3520-29) */
ZB_ZCL_SET_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0E, /**< Set yearday schedule response (since ha-1.2-05-3520-29) */
ZB_ZCL_GET_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x0F, /**< Get yearday schedule response (since ha-1.2-05-3520-29) */
ZB_ZCL_CLEAR_YEARDAY_SCHEDULE_RESPONSE_COMMAND_ID = 0x10, /**< Clear yearday schedule response (since ha-1.2-05-3520-29) */
*/
typedef enum {
ZB_ZCL_SCAN_RESPONSE_COMMAND_ID = 0x01, /**< Scan response (since zll-1.0-11-0037-10) */
- ZB_ZCL_DEVICE_INFORMATION_RESPONSE_COMMAND_ID = 0x03, /**< Device informatio response (since zll-1.0-11-0037-10) */
- ZB_ZCL_NETWORK_START_RESPONSE_COMMAND_ID = 0x11, /**< Network start reponse (since zll-1.0-11-0037-10) */
+ ZB_ZCL_DEVICE_INFORMATION_RESPONSE_COMMAND_ID = 0x03, /**< Device information response (since zll-1.0-11-0037-10) */
+ ZB_ZCL_NETWORK_START_RESPONSE_COMMAND_ID = 0x11, /**< Network start response (since zll-1.0-11-0037-10) */
ZB_ZCL_NETWORK_JOIN_ROUTER_RESPONSE_COMMAND_ID = 0x13, /**< Network join router response (since zll-1.0-11-0037-10) */
ZB_ZCL_NETWORK_JOIN_END_DEVICE_RESPONSE_COMMAND_ID = 0x15, /**< Network join end device response (since zll-1.0-11-0037-10) */
ZB_ZCL_ENDPOINT_INFORMATION_COMMAND_ID = 0x40, /**< Endpoint information (since zll-1.0-11-0037-10) */
typedef enum {
ZB_ZCL_SCAN_REQUEST_COMMAND_ID = 0x00, /**< Scan request (since zll-1.0-11-0037-10) */
ZB_ZCL_DEVICE_INFORMATION_REQUEST_COMMAND_ID = 0x02, /**< Device information (since zll-1.0-11-0037-10) */
- ZB_ZCL_IDENTIFY_REQUEST_COMMAND_ID = 0x06, /**< Idenfity request (since zll-1.0-11-0037-10) */
+ ZB_ZCL_IDENTIFY_REQUEST_COMMAND_ID = 0x06, /**< Identify request (since zll-1.0-11-0037-10) */
ZB_ZCL_RESET_TO_FACTORY_NEW_REQUEST_COMMAND_ID = 0x07, /**< Reset to factory new request (since zll-1.0-11-0037-10) */
ZB_ZCL_NETWORK_START_REQUEST_COMMAND_ID = 0x10, /**< Network start request (since zll-1.0-11-0037-10) */
ZB_ZCL_NETWORK_JOIN_ROUTER_REQUEST_COMMAND_ID = 0x12, /**< Network join router request (since zll-1.0-11-0037-10) */
projects / platform / core / api / zigbee.git / commitdiff