↓

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_remote_control Struct Reference

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

#include <zigbee/artik_zigbee.h>

Data Fields

artik_error(* reset_to_factory_default )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint)
 Resets all attribute values to factory default. More...
 
artik_error(* identify_request )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, int duration)
 Send command "Identify". More...
 
artik_error(* identify_get_remaining_time )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, int *time)
 Send command "Identify Query", to get remote identify time. More...
 
artik_error(* onoff_command )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_onoff_status target_status)
 Send command to control remote on/off. More...
 
artik_error(* level_control_request )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, const artik_zigbee_level_control_command *command)
 Send commands about level control, to control remote level. More...
 
artik_error(* request_reporting )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_reporting_type report_type, int min_interval, int max_interval, int change_threshold)
 Notice device server to report the attribute. More...
 
artik_error(* stop_reporting )(artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_reporting_type report_type)
 Notice device server to stop the attribute reporting. 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 1193 of file artik_zigbee.h.

Field Documentation

artik_error(* artik_zigbee_device_remote_control::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

Definition at line 1326 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::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 1350 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::identify_get_remaining_time) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, int *time)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[out]timeRemaining seconds of identifying.
Returns
Result of operation, S_OK on success, error code otherwise.

Definition at line 1228 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::identify_request) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, int duration)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[in]durationIdentify duration.
Returns
Result of operation, S_OK on success, error code otherwise.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1215 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::level_control_request) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, const artik_zigbee_level_control_command *command)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[in]commandLevel control command, please refer to "struct zigbee_level_control_command".
Returns
Result of operation, S_OK on success, error code otherwise.

Definition at line 1257 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::onoff_command) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_onoff_status target_status)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[in]target_statusOn/off command, please 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 1243 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::request_reporting) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_reporting_type report_type, int min_interval, int max_interval, int change_threshold)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[in]report_typeThe reporting type to be requested. This parameter in remote control device supports: ARTIK_ZIGBEE_REPORTING_THERMOSTAT_TEMPERATURE, ARTIK_ZIGBEE_REPORTING_MEASURED_ILLUMINANCE, ARTIK_ZIGBEE_REPORTING_MEASURED_TEMPERATURE
[in]min_intervalThe reporting minimum interval.
[in]max_intervalThe reporting maximum interval.
[in]change_thresholdMinimum changed value to trigger reporting.
Returns
Result of operation, EZ_OK on success, error code otherwise.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1279 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::reset_to_factory_default) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
Returns
Result of operation, S_OK on success, error code otherwise.

Definition at line 1202 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_remote_control::stop_reporting) (artik_zigbee_endpoint_handle handle, const artik_zigbee_endpoint *endpoint, artik_zigbee_reporting_type report_type)
Parameters
[in]handleThe handle of each endpoint instance.
[in]endpointRemote endpoint instance pointer.
[in]report_typeThe reporting type to be stopped.. This parameter in remote control device supports: ARTIK_ZIGBEE_REPORTING_THERMOSTAT_TEMPERATURE, ARTIK_ZIGBEE_REPORTING_MEASURED_ILLUMINANCE, ARTIK_ZIGBEE_REPORTING_MEASURED_TEMPERATURE
Returns
Result of operation, S_OK on success, error code otherwise.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1300 of file artik_zigbee.h.

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