  hwm | |
  command | |
 command | Contains a class used to store the state of submitted ground station commands |
  Command | Used to represent user commands |
| CommandNotFound | |
| CommandInvalidSchema | |
| CommandMalformed | |
 CommandError | A general purpose exception thrown in the event that a command fails |
| connection | Contains a resource for processing commands |
| CommandResource | Handles commands received over the network |
| handlers | |
 handler | Contains the base command handler interfaces and abstract classes that all system and device command handlers should implement |
| CommandHandler | The base command handler interface |
| DeviceCommandHandler | The base interface class for device command handlers |
| system | Contains a class that handles various system commands received by the ground station |
| SystemCommandHandler | A command handler that responds to system commands |
 tests | |
| test_system_command_handler | |
| TestSystemCommandHandler | This test suite is responsible for testing the functionality of the system command handler (handles general system wide commands) |
| metadata | This module contains functions used to build a command's meta-data dictionary |
| InvalidCommandMetadata | |
| InvalidCommandAddress | |
| parser | Parses system and hardware commands and passes them to the appropriate command handler |
| CommandParser | Processes all commands received by the hardware manager |
| CommandFailed | Used to wrap command execution errors |
| tests | |
| test_command_infrastructure | |
| TestCommandInfrastructure | This test suite tests the functionality of the command parser (CommandParser), default Command class, and command Resource individually and holistically |
| utilities | |
| TestCommandHandler | A test command handler containing commands designed to test the command system |
| core | |
| configuration | Contains a class to store the hardware manager configuration |
| Config | Provides access to the hardware manager application configuration |
| ConfigFileMalformed | |
| ConfigInvalid | |
| OptionProtected | |
| OptionNotFound | |
| errors | Contains general error handling functions |
| initialization | Initializes the Hardware Manager application |
| tests | |
| test_configuration | |
| TestConfiguration | This test case tests the functionality of the configuration module (and Config class) |
| hardware | |
| devices | |
| drivers | |
| driver | This module defines the base driver classes available to Mercury2 |
| Driver | Provides the base driver class interface |
| HardwareDriver | The base hardware driver interface |
| VirtualDriver | Defines the base driver used for virtual devices |
| DriverError | |
| PipelineAlreadyRegistered | |
| PipelineNotRegistered | |
| StateNotDefined | |
| CommandHandlerNotDefined | |
| DeviceInUse | |
| icom_910 | |
| icom_910 | This module contains a hardware driver and command handler for the ICOM 910 radio |
| ICOM_910 | A driver for the ICOM 910 radio |
| ICOM910Handler | A command handler that handles basic commands for the ICOM 910 series of radios |
| ICOM910Error | |
| InvalidTargetPosition | |
| tests | |
| test_icom_910 | |
| TestIcom910 | This test suite verifies the functionality of the ICOM 910 driver |
| TestHamlibRig | |
| TestICOM910Handler | Tests the functionality of the ICOM 910's command handler class |
| kantronics_tnc | |
| kantronics_tnc | This module contains a simple driver for Kantronics TNCs as well as a service that it uses to report its state to other pipeline devices |
| Kantronics_TNC | " A driver for the Kantronics TNC |
| TNCStateService | Provides a service that reveals some state of the TNC |
| KantronicsTNCProtocol | Used to pass data to and from the TNC over a serial transport |
| tests | |
| test_kantronics_tnc | |
| TestKantronicsTNC | This test suite verifies the functionality of the Kantronics TNC driver |
| TestKantronicsTNCStateService | Tests the functionality of the Kantronics TNC driver's 'tnc_state' service, which provides information about the TNC to other devices in the pipeline |
| TestKantronicsTNCProtocol | Tests the Protocol that is used to connect to the TNC |
| mxl_antenna_controller | |
| mxl_antenna_controller | This module contains the driver and command handler for the MXL Antenna Controller |
| MXL_Antenna_Controller | A driver for the custom MXL antenna controller |
| AntennaControllerHandler | This command handler processes commands for the MXL Antenna Controller |
| AntennaControllerError | |
| InvalidTargetPosition | |
| tests | |
| test_mxl_antenna_controller | |
| TestMXLAntennaControllerDriver | This test suite verifies the functionality of the custom MXL antenna controller driver |
| TestMXLAntennaControllerHandler | Tests the command handler for the MXL antenna controller |
| MockAntennaControllerHandler | A mock HTTP handler for simulating antenna controller API queries |
| mxl_balloon_tracker | |
| mxl_balloon_tracker | This module contains a virtual driver that provides tracking information for MXL balloon missions using a combination of the APRS.fi network and position information downlinked directly from the balloon |
| MXL_Balloon_Tracker | A general purpose tracker for MXL Balloon missions |
| Direct_Downlink_APRS_Service | This Service class provides the Direct Downlink and APRS tracking service |
| BalloonHandler | A command handler that handles commands for the balloon tracker |
| BalloonTrackerError | |
| PositionNotAvailable | |
| APRSAPIError | |
| tests | |
| test_mxl_balloon_tracker | |
| TestMXLBalloonTrackerDriver | This test suite verifies the functionality of the MXL Balloon Tracker virtual driver |
| TestBalloonHandler | This test suite verifies the functionality of the MXL Balloon Tracker command handler |
| TestAPRSTrackingService | This test suite is designed to test the functionality of the APRS balloon tracking service |
| MockAPRSHandler | A mock HTTP handler for simulating APRS.fi API queries |
| service | Provides a base abstract class that driver services may implement |
| Service | Provides the base automated service abstract class |
| sgp4_tracker | |
| sgp4_tracker | This module contains a virtual driver and command handler for a standard SGP4 tracker |
| SGP4_Tracker | A virtual driver that provides a SGP4 tracking service |
| SGP4PropagationService | This service provides access to a SGP4 propagator |
| SGP4Handler | A command handler that handles commands for the SGP4 propagator virtual driver |
| tests | |
| test_sgp4_tracker | |
| TestSGP4Tracker | This test suite verifies the functionality of the SGP4 tracker virtual driver |
| TestSGP4Handler | This test suite verifies the functionality of the SGP4 virtual driver's command handler |
| TestSGP4TrackingService | This test suite is designed to test the functionality of the SGP4 tracking service |
| test_driver | |
| test_driver | Contains a simple empty driver for unit testing purposes |
| Test_Driver | A simple test driver used by unit tests to test the correctness of the device manager and base driver class |
| test_virtual_driver | |
| test_virtual_driver | Contains a simple empty virtual driver for unit testing purposes |
| Test_Virtual_Driver | A simple test virtual driver used by unit tests to test the correctness of the device manager and the virtual device mechanisms |
| tests | |
| test_base_driver_class | |
| TestBaseDriver | This test suite tests the functionality of the base driver class that all other drivers inherit from |
| manager | Manages access to hardware devices |
| DeviceManager | Manages access to configured hardware devices |
| DeviceConfigInvalid | |
| DriverNotFound | |
| DriverInitError | |
| DevicesAlreadyInitialized | |
| DeviceNotFound | |
| tests | |
| test_device_manager | |
| TestDeviceManager | This test suite tests the functionality of the device manager, which is responsible for initializing and providing access to device drivers |
| pipelines | |
| manager | Manages access to the hardware pipeline pool |
| PipelineManager | Provides access the collection of available hardware pipelines |
| PipelineManagerError | |
| PipelinesNotDefined | |
| PipelinesAlreadyInitialized | |
| PipelineNotFound | |
| PipelineSchemaInvalid | |
| pipeline | Represents individual hardware pipelines |
| Pipeline | Represents and provides access to a hardware pipeline |
| PipelineTelemetryProducer | A push producer that is responsible for moderating pipeline telemetry production |
| PipelineError | |
| PipelineConfigInvalid | |
| PipelineInUse | |
| SessionAlreadyRegistered | |
| ServiceInvalid | |
| ServiceAlreadyRegistered | |
| ServiceTypeNotFound | |
| tests | |
| test_pipeline | |
| TestPipeline | This test suite is used to test the functionality of the Pipeline class, which is used to represent and provide access to hardware pipelines |
| TestPipelineError | |
| test_pipeline_manager | |
| TestPipelineManager | This collection of tests tests the hardware pipeline manager, which is responsible for managing access to the individual hardware pipelines |
| network | |
| protocols | |
| data | This module contains the Twisted Protocol and related classes used to pass pipeline data to and from the session user |
| PipelineData | Represents a Pipeline data connection |
| PipelineDataFactory | Constructs PipelineData protocol instances for pipeline data stream connections |
| telemetry | This module contains the Twisted Protocol (and related classes) used to broadcast pipeline telemetry to its users |
| PipelineTelemetry | Represents a pipeline telemetry connection |
| PipelineTelemetryFactory | Constructs PipelineTelemetry protocol instances for pipeline telemetry stream connections |
| tests | |
| test_data_protocol | |
| TestPipelineDataProtocol | This test suite is designed to test the functionality of the PipelineData protocol, which is responsible for routing the primary pipeline data stream to and from the end user |
| test_protocol_utilities | |
| TestProtocolUtilities | This test suite tests the various utility and functions used by the hardware manager protocols |
| test_telemetry_protocol | |
| TestPipelineTelemetryProtocol | This test suite is designed to test the functionality of the PipelineTelemetry protocol, which is responsible for routing the various pipeline telemetry streams to the end user (typically through the user interface) |
| utilities | Contains methods commonly used by the HWM network protocols |
| security | |
| permissions | This module contains a class used to manage and cache user command permissions |
| PermissionManager | Stores and provides access to user permission settings |
| PermissionsInvalidSchema | |
| PermissionsUserNotFound | |
| PermissionsError | |
| tests | |
| test_permission_manager | |
| TestPermissionManager | This test suite tests the permission manager class, which is used to manage and cache downloaded user command execution permissions |
| verification | Contains functions for verifying user authorization credentials |
| sessions | |
| coordinator | Coordinates various periodic tasks used by the hardware manager |
| SessionCoordinator | Handles the creation and management of reservation sessions |
| CoordinatorError | |
| SessionNotFound | |
| schedule | Stores and maintains the reservation access schedule |
| ScheduleManager | Represents a reservation access schedule |
| ScheduleError | |
| session | Provides a representation for hardware manager usage sessions |
| Session | Represents a user hardware pipeline usage session |
| SessionError | |
| ProtocolAlreadyRegistered | |
| tests | |
| test_coordinator | |
| TestCoordinator | This test suite tests the functionality of the SessionCoordinator class, which is responsible for setting up new sessions based on the reservation schedule and managing other periodic tasks |
| test_schedule | |
| TestSchedule | This test suite tests the functionality of the schedule manager (ScheduleManager) |
| test_session | |
| TestSession | This test suite is used to test the functionality of the Session class, which is used to represent user hardware pipeline reservations |
| TestSessionError | |
| utilities | |
| MockSessionCoordinator | A mock session coordinator that provides enough functionality to test the command parser |
1.8.4 
