SatNOGS-COMMS  4.1.0
A COMMS subsystem for CubeSats
Loading...
Searching...
No Matches
satnogs::comms::lib::bsp::sensor Class Referenceabstract

Sensor device abstraction. More...

#include <sensor.hpp>

Inheritance diagram for satnogs::comms::lib::bsp::sensor:
satnogs::comms::sensor_bsp

Public Member Functions

 sensor ()
 Construct a new sensor object.
 ~sensor ()
virtual float vbat ()=0
 Get the VBAT from SoCs designated internal ADC channel.
virtual float vref ()=0
 Get the VREF from SoCs designated internal ADC channel.

Detailed Description

Sensor device abstraction.

This class provides a generic abstraction for accessing internal ADC channel sensor readings of the SoC(e.g.STM32H743XI), such as internal VBAT (battery voltage) and VREF (reference voltage).

Warning
Depending on the target platform/RTOS users are expected to define a class that inherits this one and implement at least the pure virtual methods

Definition at line 40 of file sensor.hpp.

Constructor & Destructor Documentation

◆ sensor()

satnogs::comms::lib::bsp::sensor::sensor ( )
inline

Construct a new sensor object.

Definition at line 47 of file sensor.hpp.

◆ ~sensor()

satnogs::comms::lib::bsp::sensor::~sensor ( )
inline

Definition at line 48 of file sensor.hpp.

Member Function Documentation

◆ vbat()

virtual float satnogs::comms::lib::bsp::sensor::vbat ( )
pure virtual

Get the VBAT from SoCs designated internal ADC channel.

Returns
float VBAT voltage in Volts

Implemented in satnogs::comms::sensor_bsp.

◆ vref()

virtual float satnogs::comms::lib::bsp::sensor::vref ( )
pure virtual

Get the VREF from SoCs designated internal ADC channel.

Returns
float VBAT voltage in Volts

Implemented in satnogs::comms::sensor_bsp.


The documentation for this class was generated from the following file:
  • libsatnogs-comms/include/satnogs-comms-lib/bsp/sensor.hpp