satnogs::comms::lib::board Class Reference

#include <board.hpp>

Classes
class	io_conf
	IO peripherals required for the control of the various subsystems of the board. More...
class	params
	Board initialization parameters. More...

Public Member Functions
	board (board const &)=delete
void	operator= (board const &)=delete
comms::lib::radio &	radio ()
	Returns a reference to the radio subsystem.
comms::lib::emmc &	emmc ()
	Returns a reference to the eMMC subsystem.
comms::lib::power &	power ()
	Returns a reference to the power subsystem.
comms::lib::fpga &	fpga ()
	Returns a reference to the FPGA subsystem.
comms::lib::leds &	leds ()
	Returns a reference to the LEDs subsystem.
comms::lib::antenna &	antenna (radio::interface iface)
bool	alert (temperature_sensor s) const
	Checks if there is an alert from a specific sensor.
float	temperature (temperature_sensor s) const
	Gets the temperature from a specific sensor.

Static Public Member Functions
static void	init (const io_conf &io, const params &p)
	Initializes the board and creates a single instance.
static board &	get_instance ()
	Gets a reference to the single instance of the Board interface class.
static bool	is_init ()
	Checks if the init() has already called by the user.

Protected Member Functions
	board (const io_conf &io, const params &p)

Detailed Description

Definition at line 73 of file board.hpp.

Constructor & Destructor Documentation

board() [1/2]

satnogs::comms::lib::board::board ( board const & )

delete

board() [2/2]

satnogs::comms::lib::board::board ( const io_conf & io, const params & p )

protected

Definition at line 167 of file board.cpp.

Member Function Documentation

alert()

bool satnogs::comms::lib::board::alert

(

temperature_sensor

s

)

const

Checks if there is an alert from a specific sensor.

Parameters

s	the target sensor

Returns

true if the alert is set

false if there is no alert

Definition at line 150 of file board.cpp.

antenna()

antenna & satnogs::comms::lib::board::antenna

(

radio::interface

iface

)

Definition at line 130 of file board.cpp.

emmc()

comms::lib::emmc & satnogs::comms::lib::board::emmc

(

)

Returns a reference to the eMMC subsystem.

Returns

comms::lib::emmc&

Definition at line 91 of file board.cpp.

fpga()

comms::lib::fpga & satnogs::comms::lib::board::fpga

(

)

Returns a reference to the FPGA subsystem.

Returns

comms::lib::fpga&

Definition at line 113 of file board.cpp.

get_instance()

board & satnogs::comms::lib::board::get_instance ( )

static

Gets a reference to the single instance of the Board interface class.

Warning

Call init() first, otherwise a uninitialization_exception will be thrown

Returns

board&

Definition at line 66 of file board.cpp.

init()

void satnogs::comms::lib::board::init ( const io_conf & io, const params & p )

static

Initializes the board and creates a single instance.

Warning

This static method should be called only once

Parameters

io	IO configuration
p	initialization parameters

Definition at line 36 of file board.cpp.

is_init()

bool satnogs::comms::lib::board::is_init ( )

static

Checks if the init() has already called by the user.

Returns

true if init() has already called and the single instance for the Board interface class has been defined

false if the init() has not yet called

Definition at line 54 of file board.cpp.

leds()

comms::lib::leds & satnogs::comms::lib::board::leds

(

)

Returns a reference to the LEDs subsystem.

Returns

comms::lib::leds&

Definition at line 124 of file board.cpp.

operator=()

void satnogs::comms::lib::board::operator= ( board const & )

delete

power()

comms::lib::power & satnogs::comms::lib::board::power

(

)

Returns a reference to the power subsystem.

Returns

comms::lib::power&

Definition at line 102 of file board.cpp.

radio()

comms::lib::radio & satnogs::comms::lib::board::radio

(

)

Returns a reference to the radio subsystem.

Returns

comms::lib::radio&

Definition at line 80 of file board.cpp.

temperature()

float satnogs::comms::lib::board::temperature

(

temperature_sensor

s

)

const

Gets the temperature from a specific sensor.

Parameters

s	the target sensor

Returns

float with the temperature in Celsius

Definition at line 162 of file board.cpp.

---

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

• libsatnogs-comms/include/satnogs-comms-lib/board.hpp
• libsatnogs-comms/src/board.cpp