satnogs::comms::startup Class Reference

Firmware initialization helper class. More...

#include <startup.hpp>

Public Member Functions
	startup (startup const &)=delete
void	operator= (startup const &)=delete
void	prepare ()
	Prepares and initializes the transceiver.
void	start ()
	Starts the execution of all the subsystems and their coressponding tasks.
int	wdg_id () const
	Returns the Task Watchdog ID registered at the contructor.
struct k_work_q *	workq ()

Static Public Member Functions
static startup &	get_instance ()
	Get a singleton access to the startup subsystem.

Detailed Description

Firmware initialization helper class.

This class provides a safe and convenient way to perform the initial configuration and initialization of all the underlying subsystems of the transceiver. The class provides two different stages, the prepare() and the start() respectively. Between them, users may apply any kind of mission specific operations that may be required.

Attention

instantiating an object of the class using the singleton get_instance() engages the hardware watchdog and initiates the Task Watchdog of the Zephyr-RTOS. It is crucial that the instantiation of this class is performed as early as possible to ensure reliable operation.

Definition at line 68 of file startup.hpp.

Constructor & Destructor Documentation

startup()

satnogs::comms::startup::startup ( startup const & )

delete

Member Function Documentation

get_instance()

startup & satnogs::comms::startup::get_instance ( )

inlinestatic

Get a singleton access to the startup subsystem.

At the first instantiation of the class the hardware watchdog is engaged and the Task Watchdog of the Zephyr-RTOS is initiated.

Returns

startup& singleton access to the startup subsystem

Definition at line 80 of file startup.hpp.

operator=()

void satnogs::comms::startup::operator= ( startup const & )

delete

prepare()

void satnogs::comms::startup::prepare

(

)

Prepares and initializes the transceiver.

Definition at line 428 of file startup.cpp.

start()

void satnogs::comms::startup::start

(

)

Starts the execution of all the subsystems and their coressponding tasks.

Note

This method internally calls the mission::start() as the last step

Definition at line 528 of file startup.cpp.

wdg_id()

int satnogs::comms::startup::wdg_id

(

)

const

Returns the Task Watchdog ID registered at the contructor.

Note

The ID returned from this method can be used inside the calling thread. There is no need to register for another one.

Returns

int the Task Watchdog ID

Definition at line 582 of file startup.cpp.

workq()

k_work_q * satnogs::comms::startup::workq

(

)

Definition at line 588 of file startup.cpp.

---

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

• src/startup.hpp
• src/startup.cpp