mirror of https://github.com/nasa/openmct.git synced 2024-12-20 21:53:08 +00:00

History

Victor Woeltjen 0635e7c38e [Timeline] Disambiguate datetime control Timeline uses a custom date-time control on creation; use a distinct key for this to avoid a naming collision with platform's datetime. Addresses abnormal behavior identified in nasa/openmctweb#208		2015-11-20 17:26:43 -08:00
..
res	[Frontend] Final cleanups, tweaks; Refactored s-icon-btn	2015-11-20 16:47:04 -08:00
src	[Licenses] Add license headers	2015-11-05 12:45:51 -08:00
test	[Licenses] Add license headers	2015-11-05 12:45:51 -08:00
bundle.json	[Timeline] Disambiguate datetime control	2015-11-20 17:26:43 -08:00
README.md	[Timeline] Remove namespacing from README	2015-10-23 13:45:54 -07:00

README.md

This bundle provides the Timeline domain object type, as well as other associated domain object types and relevant views.

Implementation notes

Model Properties

The properties below record properties relevant to using and understanding timelines based on their JSON representation. Additional common properties, such as modified or persisted timestamps, may also be present.

Timeline Model

A timeline's model looks like:

{
    "type": "timeline",
    "start": {
        "timestamp": <number> (milliseconds since epoch),
        "epoch": <string> (currently, always "SET")
    },
    "capacity": <number> (optional; battery capacity in watt-hours)
    "composition": <string[]> (array of identifiers for contained objects)
}

The identifiers in a timeline's composition field should refer to other Timeline objects, or to Activity objects.

Activity Model

An activity's model looks like:

{
    "type": "activity",
    "start": {
        "timestamp": <number> (milliseconds since epoch),
        "epoch": <string> (currently, always "SET")
    },
    "duration": {
        "timestamp": <number> (duration of this activity, in milliseconds)
        "epoch": "SET" (this is ignored)
    },
    "relationships": {
        "modes": <string[]> (array of applicable Activity Mode ids)
    },
    "link": <string> (optional; URL linking to associated external resource)
    "composition": <string[]> (array of identifiers for contained objects)
}

The identifiers in a timeline's composition field should only refer to other Activity objects.

Activity Mode Model

An activity mode's model looks like:

{
    "type": "mode",
    "resources": {
        "comms": <number> (communications utilization, in Kbps)
        "power": <number> (power utilization, in watts)
    }
}