Module API reference

comm

gs_commands

class gs_commands.GsCommands

This file is mainly for decorating additional functionality on top of commands By default the behaviour for interpreting commands is to send the command as a string This class allows for additonal functionality when the comm module reads the string of the command the return value of the fuction should be what is sent to the satellite if nothing should be sent, return None An example below is upload_fs To include decorator commands, store then in thr gs_commands dict, With the command string as the key and the function as the value

automation

The Automation Module allows operators to execute commands automatically at the next pass.

automation.automate_communication()

Reads from a pre-defined script file called ‘automation.txt’ which contains messages separated by newlines. The Automation module will open this file and send each message to the comm module, which will then interpret and pass the message along to the satellite. The ‘automation.txt’ essentially mimicks a human user entering commands through the ‘live commands’ portal.

automation.automate_passovers()

Before Automation terminates, this function is run to set a ‘wake up’ timer for the next passover, so that it will be automatically run again during the next pass.

automation.main()

Main function called when automation is run, calls automate_communication(), sleeps for a bit, and then calls automate_passovers().

manage

The Manage Module is how you can run the flask application through the command line. It also allows you to define your own command line functions that can be called as:

python3 manage.py <command_line_command>

As is you can also run tests by specifying the module path like so:

python3 manage.py test test_api.TestHousekeepingService

or:

python3 manage.py test test_api.TestHousekeepingService.test_get_housekeeping