ecom.message

Module Contents

Classes

MessageDatapointType	A base for all message datapoint types.
MessageType	A base for all message types.
TelecommandResponseType	A type of telecommand response.
DependantTelecommandResponseType	A telecommand response whose type depends on the value of a datapoint of the telecommand.
TelemetryDatapointType	A telemetry response data type.
TelemetryType	A type of telemetry message.
Message	A generic message.
Telemetry	A telemetry message. This is a message that has been sent to the base.
Telecommand	A telecommand message. This is a message that has been sent from the base.
TelecommandDatapointType	A datapoint of a telecommand.
DependantTelecommandDatapointType	A datapoint whose type depends on the value of another datapoint.
TelecommandType	A telecommand message.

Functions

iterateRequiredDatapoints(...)

Iterate over the datapoints of the given telecommand that are required to serialize the telecommand.

class ecom.message.MessageDatapointType

A base for all message datapoint types.

name: str

The name of this datapoint.

type: ecom.datatypes.TypeInfo

The type information of this datapoint.

description: Optional[str]

The description of this datapoint.

class ecom.message.MessageType

A base for all message types.

id: ecom.datatypes.EnumType

An enum value representing this message type.

data: List[MessageDatapointType]

A list of datapoints that will be transmitted with this message.

class ecom.message.TelecommandResponseType

A type of telecommand response.

name: str

The name of the response value.

typeInfo: ecom.datatypes.TypeInfo

The type of the response value.

description: Optional[str]

A description of the response value.

class ecom.message.DependantTelecommandResponseType

Bases: TelecommandResponseType, abc.ABC

A telecommand response whose type depends on the value of a datapoint of the telecommand.

provider: TelecommandDatapointType

The datapoint that this response is dependent on.

abstract configureWith(providerValue: Any) → TelecommandResponseType

Create an instance of the dependant response for the value of the provider.

Parameters:

providerValue – The value of the provider that this response depends on.

Returns:

The configured TelecommandResponseType instance.

class ecom.message.TelemetryDatapointType

Bases: MessageDatapointType

A telemetry response data type.

class ecom.message.TelemetryType

Bases: MessageType

A type of telemetry message.

id: ecom.datatypes.EnumType

An enum value representing this telemetry type. See CommunicationDatabase.telemetryTypeEnum.

data: List[TelemetryDatapointType]

A list of datapoints that will be transmitted with the telemetry.

class ecom.message.Message

A generic message.

type: ecom.datatypes.EnumType

The type of the message. See CommunicationDatabase.telemetryTypeEnum and CommunicationDatabase.telecommandTypeEnum.

data: Dict[str, Any]

The data of this message.

header: Dict[str, Any]

The data from the header of this message.

class ecom.message.Telemetry

Bases: Message

A telemetry message. This is a message that has been sent to the base.

class ecom.message.Telecommand

Bases: Message

A telecommand message. This is a message that has been sent from the base.

class ecom.message.TelecommandDatapointType

Bases: MessageDatapointType

A datapoint of a telecommand.

default: Optional

The default value for the datapoint.

class ecom.message.DependantTelecommandDatapointType

Bases: TelecommandDatapointType, abc.ABC

A datapoint whose type depends on the value of another datapoint.

provider: TelecommandDatapointType

The argument that this datapoint is dependent on.

abstract configureWith(providerValue: Any) → TelecommandDatapointType

Create an instance of this dependant telecommand datapoint for the value of the provider.

Parameters:

providerValue – The value of the provider that this datapoint depends on.

class ecom.message.TelecommandType

Bases: MessageType

A telecommand message.

id: ecom.datatypes.EnumType

An enum value representing this telecommand type. See CommunicationDatabase.telecommandTypeEnum.

data: List[TelecommandDatapointType]

The datapoints of the telecommand.

response: Optional[TelecommandResponseType]

The type information of the return value of the telecommand.

description: Optional[str]

A description of the telecommand.

isDebug: bool

Whether the telecommand is a debugging command.

ecom.message.iterateRequiredDatapoints(telecommand: TelecommandType) → Iterator[TelecommandDatapointType]

Iterate over the datapoints of the given telecommand that are required to serialize the telecommand. Parameters not included in the resulting iterator can be deduced from other parameters.

Parameters:

telecommand – The telecommand type whose required datapoints should be iterated.

Returns:

An iterator over the required datapoints of the telecommand type.