SensorClient Class Reference

Inheritance diagram for SensorClient:

Public Member Functions
bool	begin (int id, uint32_t subscriptions=0, int rate=0, int sample_watermark_num=0, int size_per_sample=0, sensor_data_mh_callback_t cb=NULL)
	Register sensor ID.
bool	begin (int id, uint32_t subscriptions, sensor_data_mh_callback_t cb)
bool	end (void)
	Release sensor ID.
int	publish (PoolId id, FAR void *data, uint32_t size_per_sample, uint32_t freq, uint32_t sample_watermark_num, uint32_t timestamp)
	Write sensing data from buffer. More...
int	publish (MemMgrLite::MemHandle &mh, uint32_t size_per_sample, uint32_t freq, uint32_t sample_watermark_num, uint32_t timestamp)
	Write sensing data from MemHandle. More...
int	publish (FAR void *data, uint32_t size_per_sample, uint32_t freq, uint32_t sample_watermark_num, uint32_t timestamp)
void *	subscribe (sensor_command_data_mh_t &data)
	Read sensing data from buffer. More...

Protected Attributes
int	m_id
int	m_rate
int	m_sample_watermark_num
int	m_size_per_sample

Member Function Documentation

publish() [1/2]

int SensorClient::publish	(	PoolId	id,
		FAR void *	data,
		uint32_t	size_per_sample,
		uint32_t	freq,
		uint32_t	sample_watermark_num,
		uint32_t	timestamp
	)

Write sensing data from buffer.

This function writes from the buffer to the logical sensor in the sensor library. It can be called on seinsing is active.

Parameters

data	Memory pool ID.
size_per_sample	Sensor data address.
freq	Sample size of the sensor data.
sample_watermark_num	Frequency of the sensor data.
timestamp	Sample number of the sensor data.

publish() [2/2]

int SensorClient::publish	(	MemMgrLite::MemHandle &	mh,
		uint32_t	size_per_sample,
		uint32_t	freq,
		uint32_t	sample_watermark_num,
		uint32_t	timestamp
	)

Write sensing data from MemHandle.

Timestamp of the sensor data.

subscribe()

void * SensorClient::subscribe ( sensor_command_data_mh_t &  data )

inline

Read sensing data from buffer.

This function Called when subscribed from the logical sensor.

---

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

• Sensing/SensorClient.h