/  Python Yamcs Client  /  General Client  /  Model

Model

class yamcs.model.AuthInfo(proto)

Bases: object

Authentication information

property require_authentication
class yamcs.model.Event(proto)

Bases: object

A timetagged free-text message. Events work a lot like log messages in logging frameworks, but then targeted at operators.

property event_type

The event type. This is mission-specific and can be any string.

property generation_time

The time when the event was generated.

Type

datetime

property message

Event message.

property reception_time

The time when the event was received by Yamcs.

Type

datetime

property sequence_number

Sequence number. Usually this is assigned by the source of the event.

property severity

Severity level of the event. One of INFO, WATCH, WARNING, DISTRESS, CRITICAL or SEVERE.

property source

The event source. Can be any string.

class yamcs.model.Instance(proto)

Bases: object

property failure_cause

Failure message when state == 'FAILED'

property mission_time

Mission time of this instance’s time service.

Type

datetime

property name

Name of this instance.

property state

State of this instance. One of OFFLINE, INITIALIZING, INITIALIZED, STARTING, RUNNING, STOPPING or FAILED.

class yamcs.model.InstanceTemplate(proto)

Bases: object

A template for creating an instance.

property name

Name of this template.

Bases: object

Represents a link with an external system. Depending on the semantics of the link, this may imply inbound data, outbound data or a combination of both.

property class_name

Name of this link’s class.

property enabled

If True, this link accepts or outputs data.

property in_count

The number of inbound data events (example: packet count).

property instance

Name of the instance where this link is defined.

property name

Name of this link (unique per instance).

property out_count

The number of outbound data events (example: command count).

property status

Short status.

class yamcs.model.LinkEvent(proto)

Bases: object

Data holder used in link subscriptions.

property event_type

The type of the event. One of REGISTERED, UNREGISTERED, or UPDATED.

Link state at the time of this event.

Type

Link

class yamcs.model.ObjectPrivilege(proto)

Bases: object

property name
property objects
class yamcs.model.Processor(proto)

Bases: object

property instance

Name of the instance where this processor is defined.

property mission_time

Mission time of this processor.

Type

datetime

property name

Name of this processor.

property owner

User that owns this processor.

property persistent

If True, this processor does not close if no clients are connected.

property state

State of this processor.

property type

Type of this processor.

class yamcs.model.ServerInfo(proto)

Bases: object

General server properties.

property default_yamcs_instance

Returns the default Yamcs instance.

property id

The Server ID.

property version

The version of Yamcs Server.

class yamcs.model.Service(proto)

Bases: object

A Yamcs service.

property class_name

Name of this service’s class.

property instance

Name of the instance where this service is defined.

property name

Name of this service.

property processor

Name of the processor where this service is defined.

property state

State of this service.

class yamcs.model.UserInfo(proto)

Bases: object

Info on a Yamcs User.

property object_privileges
property superuser
property system_privileges
property username