DevNullReceiver Satellite#

Name	DevNullReceiver
Description	A satellite that receives data and drops it
Category	Developer Tools
Language	C++

Building#

The DevNullReceiver satellite has no additional dependencies. The satellite is not build by default, building can be enabled via:

meson configure build -Dsatellite_dev_null_receiver=true

None

Command	Description	Arguments	Return Value	Allowed States
`get_data_rate`	Get data rate during the last run in Gbps	-	data rate, `double`	`ORBIT`

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

Parameters to control data transmission in the _data section:

Parameter	Type	Description	Default Value
`file_conflict_strategy`	String	Strategy for output file name conflicts. Possible values are `ERROR`, `RENAME` and `OVERWRITE`. When set to `ERROR`, this satellite will go into `ERROR` state if the target file exists. When set to `RENAME`, a randomly generated 8-character Base36 hash such as `3md7ku73` is appended to the target file name. When set to `OVERWRITE`, the existing file or directory is removed before creating the target file.	`RENAME`
`receive_from`	List of strings	List of canonical names of transmitter satellites this receiver should connect to and receive data messages from. If empty, this receiver will connect to all transmitters.	`[]`
`eor_timeout`	Unsigned integer	Timeout waiting for the reception of the end-of-run message. The receiver satellite will wait this number of seconds for receiving the EOR message from each connected transmitter satellite, and will go into error state if the message has not been received within this period. The timeout will only be started after the pending data messages have been read from the queue.	`10`

Parameters to control autonomy in the _autonomy section:

Parameter	Type	Description	Default Value
`role`	Role name	Role this satellite should take in the Constellation. Accepted values are `ESSENTIAL`, `DYNAMIC`, `TRANSIENT` and `NONE`.	`DYNAMIC`
`max_heartbeat_interval`	Unsigned integer	Maximum interval in seconds between heartbeats to be sent to other Constellation components. The time between heartbeat is adjusted automatically according to the number of nodes in the Constellation but will never exceed this value.	`30`

Parameters to control conditional transitions in the _conditions section:

Parameter	Type	Description	Default Value
`require_initializing_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `initializing` state	-
`require_launching_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `launching` state	-
`require_landing_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `landing` state	-
`require_starting_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `starting` state	-
`require_stopping_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `stopping` state	-
`transition_timeout`	Unsigned integer	Timeout in seconds to wait for all conditions to be satisfied for conditional transitioning	`30`

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

Metric	Description	Value Type	Interval
`RX_BYTES`	Amount of bytes received from all transmitters during current run	Integer	5s
`DISKSPACE_FREE`	Amount of megabytes available on the file system the current output file is located	Integer	5s
`OUTPUT_FILE`	Path of the currently used output file for this satellite. Updated whenever it changes.	String	-

Metric	Description	Value Type	Interval
`RUN_ID`	Current run identifier. Updated whenever it changes.	String	-
`STATE`	Current satellite state. Updated when changed.	String	-
`CPU_LOAD_AVG`	CPU load average over the past 1 minute, provided in percent.	Float	10s
`MEM_AVAIL`	Available memory in Megabytes.	Integer	10s