Provides common functionality between the Telemetry and Commanding APIs. More...

Inherited by CommandApi, and TelemetryApi.

Public Member Functions
Initialize / Finalize
Functions handling class initialization and destruction.
def	ApiClient () -> None
	Class initializer. More...

Connection Handling
Connect to or disconnect from destination or data store.
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...

Timeout
These functions set/get connection timeout behavior.
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 common functionality between the Telemetry and Commanding APIs.

Use the subclassed TelemetryApi and CommandApi instead.

See also: TelemetryApi; CommandApi

Constructor & Destructor Documentation

◆ ApiClient()

ApiClient ( ) -> None

Class initializer.

Reimplemented in CommandApi, and TelemetryApi.

Member Function Documentation

◆ cleanse()

cleanse ( ) -> None

Cleans up any resources from crashed TReK user programs.

This method can be called at any time. A good practice is to call this method after a successful connect(). This will allow TReK to remove any resources no longer in use.

Exceptions

TrekError 31123 - TCA_API_NOT_CONNECTED,
31122 - TCA_WORKER_WAIT_ERR

◆ connect()