↓

Filter results by

Older Versions

Older API versions are available as a download. To view, extract the file and open the index.html file in a web browser.

Data Fields
artik_zigbee_device_dimmable_light Struct Reference

Structure for device dimmable light, to storage the local endpoint information and functions can be invoked. More...

#include <zigbee/artik_zigbee.h>

Data Fields

artik_error(* groups_get_local_name_support )(artik_zigbee_endpoint_handle handle, int endpoint)
 Get attribute of "name support" of cluster "Groups". More...
 
artik_error(* groups_set_local_name_support )(artik_zigbee_endpoint_handle handle, bool support)
 Set local attribute of "name support" of cluster "Groups". More...
 
artik_error(* onoff_get_value )(artik_zigbee_endpoint_handle handle, artik_zigbee_onoff_status *status)
 Get attribute of "on/off" of cluster "On/off". More...
 
artik_error(* level_control_get_value )(artik_zigbee_endpoint_handle handle, int *value)
 Get attribute of "current level" of cluster "Levle Control". More...
 
artik_error(* ezmode_commissioning_target_start )(artik_zigbee_endpoint_handle handle)
 Start ezmode commissioning on some endpoint as target refer to [Home Automation Public Application Profile] chapter 8 [Home Automation Commissioning]. More...
 
artik_error(* ezmode_commissioning_target_stop )(artik_zigbee_endpoint_handle handle)
 Stop ezmode commissioning on some endpoint as target refer to [Home Automation Public Application Profile] chapter 8 [Home Automation Commissioning]. More...
 

Detailed Description

Definition at line 950 of file artik_zigbee.h.

Field Documentation

artik_error(* artik_zigbee_device_dimmable_light::ezmode_commissioning_target_start) (artik_zigbee_endpoint_handle handle)
Parameters
[in]handleThe handle of endpoint that start do ezmode commissioning
Returns
Result of operation, S_OK on success, error code otherwise. The result will be delivered through callback function. Callback function is called for notifying the result. -Response type : ARTIK_ZIGBEE_RESPONSE_COMMISSIONING_STATUS -Response payload : pointer of enum zigbee_commissioning_state, which including: COMMISSIONING_NETWORK_STEERING_FORM COMMISSIONING_NETWORK_STEERING_SUCCESS COMMISSIONING_TARGET_SUCCESS COMMISSIONING_TARGET_FAILED COMMISSIONING_ERROR COMMISSIONING_ERR_IN_PROGRESS
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1018 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_dimmable_light::ezmode_commissioning_target_stop) (artik_zigbee_endpoint_handle handle)
Parameters
[in]handleThe handle of endpoint that stop do ezmode commissioning
Returns
Result of operation, S_OK on success, error code otherwise. The result will be delivered through callback function. Callback function is called for notifying the result. -Response type : ARTIK_ZIGBEE_RESPONSE_COMMISSIONING_STATUS -Response payload : pointer of enum zigbee_commissioning_state, which including: COMMISSIONING_TARGET_STOP COMMISSIONING_TARGET_FAILED COMMISSIONING_ERROR COMMISSIONING_ERR_IN_PROGRESS
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1041 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_dimmable_light::groups_get_local_name_support) (artik_zigbee_endpoint_handle handle, int endpoint)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointLocal endpoint id.
Returns
S_OK group names is supported. E_NOT_SUPPORTED group names isn't supported. otherwise is others error code.

Definition at line 961 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_dimmable_light::groups_set_local_name_support) (artik_zigbee_endpoint_handle handle, bool support)
Parameters
[in]handleThe handle of each endpoint instance.
[in]supportSet name support attribute.
Returns
Result of operation, EZ_OK on success, error code otherwise.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 971 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_dimmable_light::level_control_get_value) (artik_zigbee_endpoint_handle handle, int *value)
Parameters
[in]handleThe handle of each endpoint instance.
[out]valueCurrent level of this device. The meaning of 'level' is device dependent.
Returns
Result of operation, S_OK on success, error code otherwise.

Definition at line 993 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_dimmable_light::onoff_get_value) (artik_zigbee_endpoint_handle handle, artik_zigbee_onoff_status *status)
Parameters
[in]handleThe handle of each endpoint instance.
[out]statusOn/off status. (refer to enum zigbee_onoff_status).
Returns
Result of operation, S_OK on success, error code otherwise.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 982 of file artik_zigbee.h.

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