TelemetryApi Class Reference
Provides access to telemetry features of TReK. More...
Inherits ApiClient.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and destruction. | |
| def | TelemetryApi () -> None |
| Class initializer. More... | |
Packet Handling | |
Functions for retrieving packets. | |
| def | get_packet_definition (packet_key: str, Packet packet) -> None |
| Retrieve the Packet definition for the specified key. More... | |
| def | get_newest_packet (packet_key: str, buffer: bytearray) -> Tuple[int, int] |
| Gets a copy of the newest packet available from the data store. More... | |
| def | get_next_packet (packet_key: str, token: int, buffer: bytearray) -> Tuple[int, int, int] |
| Gets a copy of the next packet available from the data store. More... | |
| def | get_this_packet (packet_key: str, token: int, buffer: bytearray) -> int |
| Gets a copy of the specified packet from the data store. More... | |
| def | get_source_list () -> List[str] |
| Gets the list of packet keys currently being processed. More... | |
| def | register_packet_semaphore (packet_key: str) -> None |
| Registers a semaphore to be signaled when a packet arrives. More... | |
| def | unregister_packet_semaphore (packet_key: str) -> None |
| Unregisters the packet arrival semaphore. More... | |
| def | wait_for_packet (packet_key: str, timeout: int=0) -> bool |
| Waits for the specified packet to arrive. More... | |
Logging | |
Functions handling TReK logging. | |
| def | set_monitor_log_file (filename: str) -> None |
| Sets the filename prefix and path used for writing monitor messages if monitor logging is on. More... | |
| def | start_monitor_logging () -> None |
| Starts the logging of monitor messages. More... | |
| def | stop_monitor_logging () -> None |
| Stops the logging of monitor messages. More... | |
 Public Member Functions inherited from ApiClient | |
| def | cleanse () -> None |
| Cleans up any resources from crashed TReK user programs. More... | |
| def | connect (destination: str="DefaultDataStore") -> None |
| Connects this instance of the API to TReK for the specified destination. More... | |
| def | is_connected () -> bool |
| Indicates if the API is connected. More... | |
| def | disconnect () -> None |
| Disconnects from the destination. More... | |
| def | get_wait_timeout () -> int |
| Returns the current timeout value for API calls. More... | |
| def | set_wait_timeout (timeout: int) -> None |
| Sets the timeout value for API calls that require communicating with TReK. More... | |
Detailed Description
Provides access to telemetry features of TReK.
This class provides access to the telemetry feature of TReK. Users of the class can get packets, convert and calibrate parameters.
Constructor & Destructor Documentation
◆ TelemetryApi()
| TelemetryApi | ( | ) | -> None |
Class initializer.
TelemetryApi creation:
my_telemetry_api = TelemetryApi()
Reimplemented from ApiClient.
Member Function Documentation
◆ get_newest_packet()
| get_newest_packet | ( | packet_key | : str |