Class DeviceProperties

ClassList > DeviceProperties

• #include <device_properties.hpp>

Public Functions

Type	Name
void	AssignSensorToI2CPort (uint8_t Device) Change the sensor.
uint8_t	GetSampleTime () Get the current sample rate.
uint8_t	GetSensorType () Get the current selected sensortype.
void	Init (UniversalSensor * obj_pool) Init and add the SensorObjPool to the DeviceProperties .
void	PauseSensor () Suspend sensor measurements polling task.
void	ResumeSensor () Resume sensor measurements after polling task is suspended.
void	SetSampleTime (const uint8_t sample_time) Set the sample rate of the polling task in ms.
void	SetupI2C (I2CDriver * i2c_handle, QueueHandle_t * SensorQueue) Link the i2c_handle and SensorQueue to internall shadow copies.. This way the sensors can be allocated using these handles!

Public Functions Documentation

function AssignSensorToI2CPort

Change the sensor.

inline void DeviceProperties::AssignSensorToI2CPort (
    uint8_t Device
) 

Parameters:

• Device The Sensortype to change to

function GetSampleTime

Get the current sample rate.

inline uint8_t DeviceProperties::GetSampleTime () 

Returns:

sample rate in milliseconds

function GetSensorType

Get the current selected sensortype.

inline uint8_t DeviceProperties::GetSensorType () 

Returns:

The sensortype

function Init

Init and add the SensorObjPool to the DeviceProperties .

inline void DeviceProperties::Init (
    UniversalSensor * obj_pool
) 

Parameters:

• obj_pool Array with size defined in device_sensor_lib_settings.hpp containing static sensor obj allocations

function PauseSensor

inline void DeviceProperties::PauseSensor () 

function ResumeSensor

inline void DeviceProperties::ResumeSensor () 

function SetSampleTime

Set the sample rate of the polling task in ms.

inline void DeviceProperties::SetSampleTime (
    const uint8_t sample_time
) 

Parameters:

• sample_time the sample rate to set in milliseconds.

function SetupI2C

Link the i2c_handle and SensorQueue to internall shadow copies.. This way the sensors can be allocated using these handles!

inline void DeviceProperties::SetupI2C (
    I2CDriver * i2c_handle,
    QueueHandle_t * SensorQueue
) 

Parameters:

• i2c_handle The handle to a I2CDriver instance
• SensorQueue The handle to the measurement queue to post sensorvalue's in

---

The documentation for this class was generated from the following file SensorHub_FW/src/device_properties.hpp