Alarm¶
- class Alarm¶
Represents an alarm. Obtained by calling
alarms
,alarm_with_name()
oralarms_with_type()
.- action¶
The action that the alarm triggers.
- Attribute:
Can be read or written
- Return type:
- margin¶
The number of seconds before the event that the alarm will fire.
- Attribute:
Can be read or written
- Return type:
float
- time¶
The time at which the alarm will fire.
- Attribute:
Can be read or written
- Return type:
float
- id¶
The unique identifier for the alarm.
- Attribute:
Read-only, cannot be set
- Return type:
str
- name¶
The short name of the alarm.
- Attribute:
Can be read or written
- Return type:
str
- notes¶
The long description of the alarm.
- Attribute:
Can be read or written
- Return type:
str
- remaining¶
The number of seconds until the alarm will fire.
- Attribute:
Read-only, cannot be set
- Return type:
float
- repeat¶
Whether the alarm will be repeated after it has fired.
- Attribute:
Can be read or written
- Return type:
bool
- repeat_period¶
The time delay to automatically create an alarm after it has fired.
- Attribute:
Can be read or written
- Return type:
float
- vessel¶
The vessel that the alarm is attached to.
- Attribute:
Can be read or written
- Return type:
- xfer_origin_body¶
The celestial body the vessel is departing from.
- Attribute:
Can be read or written
- Return type:
- xfer_target_body¶
The celestial body the vessel is arriving at.
- Attribute:
Can be read or written
- Return type:
- remove()¶
Removes the alarm.