yamcs parameters¶

Description¶

yamcs parameters list
yamcs parameters describe <PARAMETER>
yamcs parameters get [--date <DATE>] <PARAMETER>
yamcs parameters set [--next [--timeout <TIMEOUT>]] <PARAMETER> <VALUE>
yamcs parameters export-csv [--interval <INTERVAL>]
[-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] <PARAMETER>

Desription¶

Manage parameters.

Commands¶

list: List parameters

describe <PARAMETER>: Describe a parameter

get <PARAMETER>: Get a parameter's value

set <PARAMETER> <VALUE>: Set a parameter's value (unless this is a readonly parameter).

export-csv <PARAMETER>: Export parameter values in CSV format

Options¶

--processor <PROCESSOR>¶

With get and set, specifies the name of the target processor.

Default is realtime.

--next¶

With get, wait for the next parameter value to be processed by Yamcs.

If not set, the latest received value is returned.

--timeout <TIMEOUT>¶: With get, this indicates the maximum time to wait for a new value if the next option is used.

--date <DATE>¶

Value time. If unspecified, defaults to mission time.

When parsing timestamps, yamcs-cli accepts a specification in ISO format. The following special patterns are also recognised:

now: current time
now UTC: current UTC time
today: 00:00:00 of the current day
today UTC: 00:00:00 UTC of the current day
yesterday: 00:00:00 of the day before
yesterday UTC: 00:00:00 UTC of the day before
tomorrow: 00:00:00 of the next day
tomorrow UTC: 00:00:00 UTC of the next day

--interval <INTERVAL>¶: With export-csv, limit values to max one per interval (in seconds).

-s <DATE>, --since <DATE>¶

With export-csv, include values not older than the specified date.

The date should be specified in ISO format or as detailed under Timestamps.

-u <DATE>, --until <DATE>¶

With export-csv, include values not newer than the specified date.

The date should be specified in ISO format or as detailed under Timestamps.

Timestamps¶

When parsing timestamps, yamcs-cli accepts a specification in ISO format. The following special patterns are also recognised:

now: current time
now UTC: current UTC time
today: 00:00:00 of the current day
today UTC: 00:00:00 UTC of the current day
yesterday: 00:00:00 of the day before
yesterday UTC: 00:00:00 UTC of the day before
tomorrow: 00:00:00 of the next day
tomorrow UTC: 00:00:00 UTC of the next day