SENSOR PROXIMITY devices data structure. More...

Data Fields
artik_error(*	request )(artik_sensor_handle handle, artik_sensor_config config)
	Request a PROXIMITY SENSOR instance. More...

artik_error(*	release )(artik_sensor_handle handle)
	Release a PROXIMITY SENSOR instance. More...

artik_error(*	get_presence )(artik_sensor_handle handle, int *store)
	get_presence permit to return if an object is in front of the sensor. More...

Detailed Description

Structure which serve as an interface for requested SENSOR device

Definition at line 424 of file artik_sensor.h.

Field Documentation

artik_error(* artik_sensor_proximity::get_presence) (artik_sensor_handle handle, int *store)

Parameters

[in]	handle	handle tied to the requested PROXIMITY communication module instance to be released. This handle is returned by the 'get_proximity_sensor' function.
[in]	store	permit to save the result of the function.

Returns: S_OK and store the value into the parameter on success, error code otherwise

Definition at line 460 of file artik_sensor.h.

artik_error(* artik_sensor_proximity::release) (artik_sensor_handle handle)

Parameters

[in] handle handle tied to the requested PROXIMITY instance to be released. This handle is returned by the 'request' function.

Definition at line 446 of file artik_sensor.h.

artik_error(* artik_sensor_proximity::request) (artik_sensor_handle *handle, artik_sensor_config *config)

Parameters

[in]	handle	handle tied to the requested PROXIMITY instance to be released. This handle is returned by the 'request' function.
[in,out]	config	config is the configuration structure.

Definition at line 435 of file artik_sensor.h.

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