SENSOR FLAME devices data structure. More...

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

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

artik_error(*	get_signals )(artik_sensor_handle handle, int *store)
	get_signals 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 471 of file artik_sensor.h.

Field Documentation

artik_error(* artik_sensor_flame::get_signals) (artik_sensor_handle handle, int *store)

Parameters

[in]	handle	Handle tied to the requested FLAME communication module instance to be released. This handle is returned by the 'get_flame_sensor' function.
[out]	store	Pointer to a variable returning the result of the function.

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

Definition at line 509 of file artik_sensor.h.

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

Parameters

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

Definition at line 493 of file artik_sensor.h.

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

Parameters

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

Definition at line 482 of file artik_sensor.h.

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