semf
semf::AnalogDmaSensor< T, N_CHANNELS > Class Template Reference

Provides data from an AnalogInDma to one to more Sensor objects. More...

#include <analogdmasensor.h>

Inheritance diagram for semf::AnalogDmaSensor< T, N_CHANNELS >:
Inheritance graph
Collaboration diagram for semf::AnalogDmaSensor< T, N_CHANNELS >:
Collaboration graph

Public Member Functions

 AnalogDmaSensor (AnalogInDma &analogInDma, T buffer[], size_t bufferSize)
 Constructor. More...
 
 AnalogDmaSensor (const AnalogDmaSensor &other)=delete
 
virtual ~AnalogDmaSensor ()=default
 
void update () override
 
LastInBuffer< T > & buffer (size_t index) override
 Returns the buffer, where the measurement data is stored in. More...
 
- Public Member Functions inherited from semf::HardwareSensor< T >
virtual ~HardwareSensor ()=default
 
virtual void update ()=0
 
virtual LastInBuffer< T > & buffer (size_t index)=0
 Returns the buffer, where the measurement data is stored in. More...
 

Additional Inherited Members

- Public Attributes inherited from semf::HardwareSensor< T >
Signal< size_t > dataAvailable
 

Detailed Description

template<typename T, size_t N_CHANNELS = 1>
class semf::AnalogDmaSensor< T, N_CHANNELS >

Provides data from an AnalogInDma to one to more Sensor objects.

Template Parameters
T_RAWType of a raw sensor value, e.g. uint16_t for a 16-bit ADC value.
N_CHANNELSNumber of ADC channels connected to this ADC unit.
See also
AnalogDmaSensor
HardwareSensor
Sensor

Definition at line 31 of file analogdmasensor.h.

Constructor & Destructor Documentation

◆ AnalogDmaSensor() [1/2]

template<typename T , size_t N_CHANNELS>
semf::AnalogDmaSensor< T, N_CHANNELS >::AnalogDmaSensor ( AnalogInDma analogInDma,
buffer[],
size_t  bufferSize 
)

Constructor.

Parameters
analogInDmaADC interface, that is used for measuring sensor value(s).
bufferPointer to the data buffer of the measured values.
bufferSizeSize of buffer in T.

Definition at line 64 of file analogdmasensor.h.

Here is the call graph for this function:

◆ AnalogDmaSensor() [2/2]

template<typename T , size_t N_CHANNELS = 1>
semf::AnalogDmaSensor< T, N_CHANNELS >::AnalogDmaSensor ( const AnalogDmaSensor< T, N_CHANNELS > &  other)
explicitdelete

◆ ~AnalogDmaSensor()

template<typename T , size_t N_CHANNELS = 1>
virtual semf::AnalogDmaSensor< T, N_CHANNELS >::~AnalogDmaSensor ( )
virtualdefault

Member Function Documentation

◆ buffer()

template<typename T , size_t N_CHANNELS>
LastInBuffer< T > & semf::AnalogDmaSensor< T, N_CHANNELS >::buffer ( size_t  index)
overridevirtual

Returns the buffer, where the measurement data is stored in.

Parameters
indexIndex of a specific sensor.
Returns
Buffer.

Implements semf::HardwareSensor< T >.

Definition at line 84 of file analogdmasensor.h.

Here is the caller graph for this function:

◆ update()

template<typename T , size_t N_CHANNELS>
void semf::AnalogDmaSensor< T, N_CHANNELS >::update
overridevirtual

Starts a measurement cycle and will emit dataAvailable afterwards.

Implements semf::HardwareSensor< T >.

Definition at line 78 of file analogdmasensor.h.