MRAS
Multi Rocket Avionics System
Loading...
Searching...
No Matches
Sensor_LIS3MDL Class Reference

A subsystem for the LIS3MDL magnetometer. More...

#include <Sensor_LIS3MDL.h>

Inheritance diagram for Sensor_LIS3MDL:
Inheritance graph
Collaboration diagram for Sensor_LIS3MDL:
Collaboration graph

Public Member Functions

 Sensor_LIS3MDL (uint8_t id, uint8_t chip_select, SPIClass &spi, uint32_t frequency)
 Construct a new Sensor_LIS3MDL object.
 
int8_t setup () override
 
int8_t loop () override
 
- Public Member Functions inherited from Subsystem
virtual const char * get_name ()=0
 
virtual int8_t setup ()=0
 
virtual int8_t loop ()=0
 
uint8_t get_id () const
 
int8_t get_status () const
 
int8_t self_test () const
 
bool add_subscriber (Subsystem *subscriber)
 
 Subsystem (uint8_t id)
 

Additional Inherited Members

- Protected Member Functions inherited from Subsystem
void log (const char fmt[],...)
 
virtual void on_message (SystemMessage *msg)=0
 
void publish (SystemMessage *msg)
 
- Static Protected Member Functions inherited from Subsystem
static void buzzer (uint16_t frequency, uint32_t duration, bool block=false)
 
- Protected Attributes inherited from Subsystem
int8_t status = 0
 
int8_t self_test_result = -1
 

Detailed Description

A subsystem for the LIS3MDL magnetometer.

This Subsystem handles the setup and reading of data from the LIS3MDL magnetometer.

This Subsystem emits MagnetometerDataMsg messages to its subscribers.

Constructor & Destructor Documentation

◆ Sensor_LIS3MDL()

Sensor_LIS3MDL::Sensor_LIS3MDL ( uint8_t  id,
uint8_t  chip_select,
SPIClass &  spi,
uint32_t  frequency 
)
inline

Construct a new Sensor_LIS3MDL object.

Parameters
idThe ID of the Subsystem
chip_selectThe chip select pin for the LIS3MDL
spiThe SPI object to use
frequencyThe frequency to use for the SPI connection

Member Function Documentation

◆ loop()

int8_t Sensor_LIS3MDL::loop ( )
overridevirtual

Implements Subsystem.

◆ setup()

int8_t Sensor_LIS3MDL::setup ( )
overridevirtual

Implements Subsystem.


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