App which manages all storage output from the flight system. More...

#include <StorageManager.h>

Inheritance diagram for warpos::StorageManager:

[legend]

Classes
struct	Params

Public Member Functions
	StorageManager (FlightExecutive &exc)
	Only available flight executive constructor.
virtual	~StorageManager ()
int16	storeTlm (const cmd_tlm_base &pkt, uint8 instance)
	Add a telemetry packet to the queue.
int16	registerTlmPacket (uint16 tlm_apid, uint8 instance)
	Register a telemetry packet by adding it to the table.
int16	configureTlmPacket (const PacketTypeInfo &info)
	Configure values on telemetry packet.
int16	activate () override
	Activate the app. The app will step when active.
int16	deactivate () override
	Deactivate the app. The app will not step when deactivated.
int16	command (uint16 apid, uint8 *buffer, uint16 size) override
	Process commands issued to the app.
uint16	numRegisteredPackets ()
	Get the number of registered telemetry packets.
Public Member Functions inherited from warpos::App
	App (FlightExecutive &executive, const char *name, uint16 apid, uint8 instance=0)
	Executive-based constructor for the task.
virtual	~App ()
	Destructor. Doesn't really do anything.
int16	startup ()
	Initialize the app. Should be called once before step.
int16	step ()
	Step the app by a single step. Maps params, inputs, etc. to outputs.
log_level_e	logLevel ()
	Get the log level set for the executive.
void	logLevel (log_level_e log_level)
	Set the executive log level.
bool	isStarted ()
	Return whether task startup has been run.
uint16	apid ()
	Get the apid for this app.
uint8 &	instance ()
	Get the instance of this app (used to differentiate between multiple instances of the same app).
Public Member Functions inherited from clockwerk::GraphTreeObject
	GraphTreeObject (const char gt_nme="", GraphTreeObject *storage_array=nullptr, uint32 storage_size=0)
	Name-based constructor for GraphTreeObject which will have no children by default.
virtual	~GraphTreeObject ()
	Destructor.
GraphTreeObject *	parent ()
	Functions to get object's parent/children.
GraphTreeObject **	children ()
GraphTreeObject *	childAtIndex (uint8 i) const
int16	parent (GraphTreeObject *new_parent)
	Function to assign the node's parent via pointer.
int16	parent (GraphTreeObject &new_parent)
	Function to assign the node's parent via reference.
uint8	nChildren () const
	Getters for number of children and descendants.
uint16	nDescendants () const
uint8	capacity () const
const char *	name () const
	Getter and setter for object name.
int16	name (const char *new_name)
uint8	rank ()
	Getter for the object rank.
int8	type ()
	Function to indicate type – -1 by default unless implemented downstream.
bool	loggable ()
	Getter for object logability flag – note no setter because should only be set by this or a derived class in its definition.
GraphTreeObject *	getRootDataPointer ()
	Get the pointer to the highest object in the graph tree.
virtual int16	str (char *output, size_t size) const
	Get object represented as string.
virtual int16	fromStr (const char *val)
	Set value of graphtreeobject from string.

Public Attributes
Params	params = Params(this, "params")
Public Attributes inherited from warpos::App
clockwerk::DataIO< bool >	active = clockwerk::DataIO<bool>(this, "active", true)
	The active flag for the task – set to true by default.

Protected Member Functions
int16	start () override
int16	execute () override
int32	_findPktIndex (uint16 apid, uint8 instance)
	Find index of packet in tlm table matching apid.
Protected Member Functions inherited from clockwerk::GraphTreeObject
int16	_setStorage (GraphTreeObject **storage_array, uint8 storage_size)
	Getter for object's string address.
void	_recalculateDescendants ()
	Function to recursively re-calculate the number of descendants of a given node on the tree.
void	_recalculateRank ()
	Function to recursively re-calculate the rank of a given node on the tree.
int16	_addChild (GraphTreeObject *child)
	Function to decompose a string into a series of substrings via indexing.
int16	_removeChild (GraphTreeObject *child)
	Function to remove a child from the graph node's children.

Protected Attributes
PacketTypeInfo	_tlm_table [MAX_TLM_TABLE_SIZE]
uint16	_tlm_table_idx = 0
	Table of telemetry packet metadata.
char	_print_buff [200]
	Buffer for printing error/warning/debug statements.
int32	_fd_table_1 [MAX_TLM_TABLE_SIZE] = {-1}
	Table of file descriptors for individual packet files for SD card 1.
int32	_fd_table_2 [MAX_TLM_TABLE_SIZE] = {-1}
	Table of file descriptors for individual packet files for SD card 2.
char	_default_storage_loc [1] = ""
	Default file storage location.
bool	_fsys_working = false
	Boolean to track and protect errors in file system.
char	_time_str [TIME_STR_SIZE]
	Variables for writing to file.
char	_f_write_buf [CMD_TLM_STR_MAX_SIZE_BYTES]
	Buffer for file write in both modes.
char	_file_name [FILE_NAME_MAX]
	Buffer to hold file names.
Protected Attributes inherited from warpos::App
FlightExecutive &	exc
	Override our executive to include the FlightExecutive instead.
int16	_error = 0
	Internal variable to track and return error on app step through.
uint16	_apid = 0
	Internal variable to hold the APID for this app.
bool	_is_started = false
	Flag indicating whether app has been started or not.
log_level_e	_local_log_level = log_level_e::LOG_WARNING
	The log level for this particular app.
GraphTreeObject *	_app_children [MAXIMUM_APP_CHILDREN]
	Local storage for App children so it can live on the graph tree.
uint8	_instance
	Instance number of this app. Used to differentiate between multiple instances of the same app.
Protected Attributes inherited from clockwerk::GraphTreeObject
GraphTreeObject *	_parent = nullptr
GraphTreeObject **	_children_ptr = nullptr
uint32	_max_num_children = 0
uint16	_num_descendants = 0
char	_name [MAXIMUM_NAME_CHARS] = ""
	String name for object.
uint8	_num_children = 0
	Number of direct children of the tree (not including the tree itself).
uint8	_rank = 0
int8	_graph_tree_type = BASE_GRAPH_TREE
	Variable to store graph tree object type.
bool	_loggable = false
	Variable to indicate whether the selected object is loggable. Set to false by default.
uint32	_index = 0
	Index pointing to the next write location for the graph tree children.

Detailed Description

App which manages all storage output from the flight system.

The storage manager is a simple wrapper around the OS write functions which allows users to register telemetry packets to save at a fixed rate and writes to file at that rate.

TODOs:

Implement chapter 10 or similar logging in binary format with header/checksum
Add append/read mode options to os file open and open files in append, rather than write mode to ensure data is not overwritten

Constructor & Destructor Documentation

◆ StorageManager()

warpos::StorageManager::StorageManager ( FlightExecutive & exc )

Only available flight executive constructor.

Parameters

exc	Pointer to executive object

Note: Implicitly names task "telemetry". Cannot have any other name

◆ ~StorageManager()

warpos::StorageManager::~StorageManager ( )

virtual

Member Function Documentation

◆ _findPktIndex()

int32 warpos::StorageManager::_findPktIndex	(	uint16	apid,
		uint8	instance )

protected

Find index of packet in tlm table matching apid.

Parameters

apid	The apid to seek
instance	The instance of the apid to seek

Returns: The (always positive) table index of the packet. -1 if not found

◆ activate()

int16 warpos::StorageManager::activate ( )

overridevirtual

Activate the app. The app will step when active.

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ command()

int16 warpos::StorageManager::command	(	uint16	apid,
		uint8 *	buffer,
		uint16	size )

overridevirtual

Process commands issued to the app.

Parameters

apid	The apid of the command to execute
buffer	The buffer of command data
size	The size of the command data buffer

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ configureTlmPacket()

int16 warpos::StorageManager::configureTlmPacket ( const PacketTypeInfo & info )

Configure values on telemetry packet.

Parameters

tlm_info PacketTypeInfo instance containing data to configure on table

Returns: Error code corresponding to success/failure

◆ deactivate()

int16 warpos::StorageManager::deactivate ( )

overridevirtual

Deactivate the app. The app will not step when deactivated.

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ execute()

int16 warpos::StorageManager::execute ( )

overrideprotectedvirtual

Reimplemented from warpos::App.

◆ numRegisteredPackets()

uint16 warpos::StorageManager::numRegisteredPackets ( )

inline

Get the number of registered telemetry packets.

Returns: Number of registered telemetry packets

◆ registerTlmPacket()

int16 warpos::StorageManager::registerTlmPacket	(	uint16	tlm_apid,
		uint8	instance )

Register a telemetry packet by adding it to the table.

Parameters

tlm_apid	The apid of the telemetry to register
instance	The instance of the telemetry APID

Returns: Error code corresponding to success/failure

◆ start()

int16 warpos::StorageManager::start ( )

overrideprotectedvirtual

Reimplemented from warpos::App.

◆ storeTlm()

int16 warpos::StorageManager::storeTlm	(	const cmd_tlm_base &	pkt,
		uint8	instance )

Add a telemetry packet to the queue.

Parameters

pkt	An command/telemetry packet object with apid, size, and packetize function
instance	The instance of the packet

Note: The error code return is for testability, but might not be checked within apps

Member Data Documentation

◆ _default_storage_loc

char warpos::StorageManager::_default_storage_loc[1] = ""

protected

Default file storage location.

◆ _f_write_buf

char warpos::StorageManager::_f_write_buf[CMD_TLM_STR_MAX_SIZE_BYTES]

protected

Buffer for file write in both modes.

◆ _fd_table_1

int32 warpos::StorageManager::_fd_table_1[MAX_TLM_TABLE_SIZE] = {-1}

protected

Table of file descriptors for individual packet files for SD card 1.

◆ _fd_table_2

int32 warpos::StorageManager::_fd_table_2[MAX_TLM_TABLE_SIZE] = {-1}

protected

Table of file descriptors for individual packet files for SD card 2.

◆ _file_name

char warpos::StorageManager::_file_name[FILE_NAME_MAX]

protected

Buffer to hold file names.

◆ _fsys_working

bool warpos::StorageManager::_fsys_working = false

protected

Boolean to track and protect errors in file system.

◆ _print_buff

char warpos::StorageManager::_print_buff[200]

protected

Buffer for printing error/warning/debug statements.

◆ _time_str

char warpos::StorageManager::_time_str[TIME_STR_SIZE]

protected

Variables for writing to file.

For converting time to str in csv mode

◆ _tlm_table

PacketTypeInfo warpos::StorageManager::_tlm_table[MAX_TLM_TABLE_SIZE]

protected

◆ _tlm_table_idx

uint16 warpos::StorageManager::_tlm_table_idx = 0

protected

Table of telemetry packet metadata.

Current index in the telemetry table

◆ params

Params warpos::StorageManager::params = Params(this, "params")

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

/Users/mickey/Documents/Projects/warptwin/warpos/src/flight/StorageManager.h
/Users/mickey/Documents/Projects/warptwin/warpos/src/flight/StorageManager.cpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StorageManager()

◆ ~StorageManager()

Member Function Documentation

◆ _findPktIndex()

◆ activate()

◆ command()

◆ configureTlmPacket()

◆ deactivate()

◆ execute()

◆ numRegisteredPackets()

◆ registerTlmPacket()

◆ start()

◆ storeTlm()

Member Data Documentation

◆ _default_storage_loc

◆ _f_write_buf

◆ _fd_table_1

◆ _fd_table_2

◆ _file_name

◆ _fsys_working

◆ _print_buff

◆ _time_str

◆ _tlm_table

◆ _tlm_table_idx

◆ params