Generic Sensor Interface

HAL Generic Sensor Interface. More...

Collaboration diagram for Generic Sensor Interface:

Detailed Description

HAL Generic Sensor Interface.

Macros
#define	_base_sensor_methods_alone
	BaseSensor specific methods. More...
#define	_base_sensor_methods
	BaseSensor specific methods with inherited ones. More...
#define	_base_sensor_data
	BaseSensor specific data. More...

Macro Functions (BaseSensor)
#define	sensorGetChannelNumber(ip)   (ip)->vmt->get_channels_number(ip)
	Sensors get channels number. More...
#define	sensorReadRaw(ip, dp)   (ip)->vmt->read_raw(ip, dp)
	Sensors read raw data. More...
#define	sensorReadCooked(ip, dp)   (ip)->vmt->read_cooked(ip, dp)
	Sensors read cooked data. More...

Data Structures
struct	BaseSensorVMT
	BaseSensor virtual methods table. More...
struct	BaseSensor
	Base stream class. More...

Macro Definition Documentation

#define _base_sensor_methods_alone

Value:

/* Get number of channels.*/                                              \
  size_t (*get_channels_number)(void *instance);                            \
  /* Reads the sensor raw data.*/                                           \
  msg_t (*read_raw)(void *instance, int32_t axes[]);                        \
  /* Reads the sensor returning normalized data.*/                          \
  msg_t (*read_cooked)(void *instance, float axes[]);

BaseSensor specific methods.

Definition at line 47 of file hal_sensors.h.

#define _base_sensor_methods

Value:

_base_object_methods                                                      \
  _base_sensor_methods_alone

BaseSensor specific methods with inherited ones.

Definition at line 58 of file hal_sensors.h.

#define _base_sensor_data

BaseSensor specific data.

Note

It is empty because BaseSensor is only an interface without implementation.

Definition at line 74 of file hal_sensors.h.

#define sensorGetChannelNumber

(

ip

)

(ip)->vmt->get_channels_number(ip)

Sensors get channels number.

Parameters

[in]

ip

pointer to a BaseSensor or derived class.

Returns

The number of channels of the BaseSensor

Function Class:Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 106 of file hal_sensors.h.

#define sensorReadRaw	(		ip,
			dp
	)		(ip)->vmt->read_raw(ip, dp)

Sensors read raw data.

Parameters

[in]	ip	pointer to a BaseSensor or derived class.
[in]	dp	pointer to a data array.

Returns

The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more errors occurred.

Function Class:Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 120 of file hal_sensors.h.

#define sensorReadCooked	(		ip,
			dp
	)		(ip)->vmt->read_cooked(ip, dp)

Sensors read cooked data.

Parameters

[in]	ip	pointer to a BaseSensor or derived class.
[in]	dp	pointer to a data array.

Returns

The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more errors occurred.

Function Class:Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 134 of file hal_sensors.h.