↓

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

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

#include <zigbee/artik_zigbee.h>

Data Fields

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(* illum_set_measured_value_range )(artik_zigbee_endpoint_handle handle, int min, int max)
 Set the range of illuminance in measured value(1 to 65534(0xFFFE)) Max value shall be greater than min value. MeasuredValue represents the Illuminance in Lux (symbol lx) as follows: MeasuredValue = 10,000 x log10 Illuminance + 1. More...
 
artik_error(* illum_set_measured_value )(artik_zigbee_endpoint_handle handle, int value)
 Set the measured illuminance value. More...
 
artik_error(* illum_get_measured_value )(artik_zigbee_endpoint_handle handle, int *value)
 Get the Illuminance value. More...
 
artik_error(* ezmode_commissioning_initiator_start )(artik_zigbee_endpoint_handle handle)
 Start ezmode commissioning on some endpoint as initiator refer to [Home Automation Public Application Profile] chapter 8 [Home Automation Commissioning] it includes following step: network steering, finding-and-binding this API will do everything inside automatically. More...
 
artik_error(* ezmode_commissioning_initiator_stop )(artik_zigbee_endpoint_handle handle)
 Stop ezmode commissioning on some endpoint as initiator refer to [Home Automation Public Application Profile] chapter 8 [Home Automation Commissioning] it stop commissioning procedure. More...
 

Detailed Description

Definition at line 1052 of file artik_zigbee.h.

Field Documentation

artik_error(* artik_zigbee_device_light_sensor::ezmode_commissioning_initiator_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_INITIATOR_SUCCESS COMMISSIONING_INITIATOR_FAILED COMMISSIONING_ERROR COMMISSIONING_ERR_IN_PROGRESS
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1157 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_light_sensor::ezmode_commissioning_initiator_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_INITIATOR_STOP COMMISSIONING_INITIATOR_FAILED COMMISSIONING_ERROR COMMISSIONING_ERR_IN_PROGRESS
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1182 of file artik_zigbee.h.

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

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

artik_error(* artik_zigbee_device_light_sensor::illum_get_measured_value) (artik_zigbee_endpoint_handle handle, int *value)
Parameters
[in]handleThe handle of each endpoint instance.
[out]valueMeasured value, in the range 1 to 65534(0xfffe). 
         MeasuredValue represents the Illuminance in
         Lux (symbol lx) as follows:
         MeasuredValue = 10,000 x log10 Illuminance + 1

e.g. The returned value 10001 means 10 lx.
Returns
Result of operation, S_OK when succeeded, otherwise failed.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1127 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_light_sensor::illum_set_measured_value) (artik_zigbee_endpoint_handle handle, int value)
Parameters
[in]handleThe handle of each endpoint instance.
[in]valueMeasured value, in the range 1 to 65534(0xfffe), which corresponding to illuminance of 1 lx to 3.576 x 10^6 lx. 
MeasuredValue represents the Illuminance in
Lux (symbol lx) as follows:
MeasuredValue = 10,000 x log10 Illuminance + 1

e.g. To set the sensor to 10 lx, use calculated
     value 10001.
Returns
Result of operation, S_OK when succeeded, otherwise failed.
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1110 of file artik_zigbee.h.

artik_error(* artik_zigbee_device_light_sensor::illum_set_measured_value_range) (artik_zigbee_endpoint_handle handle, int min, int max)
Parameters
[in]handleThe handle of each endpoint instance.
[in]minMin measured value.
[in]maxMax measured value.
Returns
Result of operation, S_OK on success, error code otherwise..
Examples:
zigbee_test/artik_zigbee_test.c.

Definition at line 1092 of file artik_zigbee.h.

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