Sputnik Satellite#

Demonstrator satellite serving as prototype for new satellites

Description#

This satellite does very little, just as its namesake. It mostly serves as demonstrator for the different functionalities of satellites. New satellites may be created by copying and modifying the Sputnik satellite.

This section describes the functions of the satellite and all relevant information about the connected hardware as well as its requirements or external software dependencies.

Building#

The Sputnik satellite has no additional dependencies and is build by default.

Parameters#

The following parameters are read and interpreted by this satellite. Parameters without a default value are required.

Parameter	Type	Description	Default Value
`my_param`	Unsigned integer	Number of channels to be used	`1024`
`other_param`	String	Name of the communication module	`"antenna"`

Configuration Example#

An example configuration for this satellite which could be dropped into a Constellation configuration as a starting point

[Sputnik.1]
my_param = 7
other_param = "antenna"

Custom Commands#

This section describes all custom commands the satellite exposes to the command interface. The description should contain the name and the description of the command as well as all of its arguments, the return value and the allowed states:

Command	Description	Arguments	Return Value	Allowed States
`get_channel_reading`	This command returns the reading from the given channel number	channel number, `int`	channel reading, `double`	`INIT`, `ORBIT`
`get_module_name`	Reads the name of the communication module	-	module name, `string`	all

Metrics#

The following metrics are distributed by this satellite and can be subscribed to. Timed metrics provide an interval in units of time, triggered metrics in number of calls.

Metric	Description	Value Type	Metric Type	Interval
`CPULOAD`	Current CPU load of the satellite host machine	Float	`AVERAGE`	3s
`TEMP`	Highest reported system temperature of the satellite	Float	`AVERAGE`	5s
`EVENTS`	Currently processed event number	Unsigned integer	`LAST_VALUE`	100

Framework Parameters#

This satellite inherits the following framework parameters from its base classes:

Parameters inherited from `Satellite`#

Parameter	Type	Description	Default Value
`_allow_departure`	Bool	If `true`, regular departures of satellites will not cause an interrupt to SAFE mode	`true`
`_heartbeat_interval`	Unsigned integer	Interval in seconds between heartbeats to be sent to other Constellation components	`10`