LED Blinker example app. More...

#include <LedBlinker.h>

Inheritance diagram for warpos::LedBlinker:

[legend]

Classes
struct	Params
struct	Outputs

Public Member Functions
	LedBlinker (FlightExecutive &executive)
virtual	~LedBlinker ()
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.
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")
Outputs	outputs = Outputs(this, "outputs")
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
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
uint8	_freq = 0
	The frequency at which the LED blinker should blink.
uint8	_count = 0
	The current LED blinker counter which resets when frequency achieved.
tlm_led_blinker_count	_tlm_count
	Packet to hold LED blink count.
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

LED Blinker example app.

The LED blinker is a simple example app which blinks an app at a pre-defined frequency and implements all elements of the app.

Constructor & Destructor Documentation

◆ LedBlinker()

warpos::LedBlinker::LedBlinker ( FlightExecutive & executive )

◆ ~LedBlinker()

virtual warpos::LedBlinker::~LedBlinker ( )

inlinevirtual

Member Function Documentation

◆ activate()

int16 warpos::LedBlinker::activate ( )

overridevirtual

Activate the app. The app will step when active.

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ command()

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

overridevirtual

Process commands issued to the app.

Parameters

apid	The APID of the command sent
buffer	Pointer to the location of the buffer holding the command
size	The size of the command being sent

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ deactivate()

int16 warpos::LedBlinker::deactivate ( )

overridevirtual

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

Returns: Flag indicating success/failure

Reimplemented from warpos::App.

◆ execute()

int16 warpos::LedBlinker::execute ( )

overrideprotectedvirtual

Reimplemented from warpos::App.

◆ start()

int16 warpos::LedBlinker::start ( )

overrideprotectedvirtual

Reimplemented from warpos::App.

Member Data Documentation

◆ _count

uint8 warpos::LedBlinker::_count = 0

protected

The current LED blinker counter which resets when frequency achieved.

◆ _freq

uint8 warpos::LedBlinker::_freq = 0

protected

The frequency at which the LED blinker should blink.

◆ _tlm_count

tlm_led_blinker_count warpos::LedBlinker::_tlm_count

protected

Packet to hold LED blink count.

◆ outputs

Outputs warpos::LedBlinker::outputs = Outputs(this, "outputs")

◆ params

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

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

/Users/mickey/Documents/Projects/warptwin/warpos/src/apps/LedBlinker.h
/Users/mickey/Documents/Projects/warptwin/warpos/src/apps/LedBlinker.cpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LedBlinker()

◆ ~LedBlinker()

Member Function Documentation

◆ activate()

◆ command()

◆ deactivate()

◆ execute()

◆ start()

Member Data Documentation

◆ _count

◆ _freq

◆ _tlm_count

◆ outputs

◆ params