Stack commands¶
minisky¶
ADDWPT¶
Aliases: WPTYPE
Select FLYBY, FLYOVER, or FLYTURN through the ADDWPT mode form.
acidx |
An existing aircraft callsign.
Internal Type: int. |
mode |
Accepted: FLYBY, FLY-BY, FLYOVER, FLY-OVER, FLYTURN, FLY-TURN.
Internal Type: WaypointMode. |
Clear a turn parameter through the ADDWPT mode form.
acidx |
An existing aircraft callsign.
Internal Type: int. |
parameter |
Accepted: TURNRAD, TURNRADIUS, TURNSPD, TURNSPEED, TURNHDG, TURNHDGR, TURNHDGRATE.
Internal Type: TurnParameter. |
Add a takeoff waypoint from an explicit runway.
Examples:
ADDWPT KL204 TAKEOFF EHAM/RW06
acidx |
An existing aircraft callsign.
Internal Type: int. |
runway |
(e.g. EHAM/RW06, LFPG/RWY23)
Internal Type: RunwayReference. |
Add a takeoff waypoint using a runway already in the route or current position.
acidx |
An existing aircraft callsign.
Internal Type: int. |
Insert a route waypoint before an existing waypoint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
waypoint |
One of:
|
altitude |
One of:
|
airspeed |
One of: |
before |
A command token (internally upper-cased).
Internal Type: str. |
Insert a route waypoint after an existing waypoint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
waypoint |
One of:
|
altitude |
One of:
|
airspeed |
One of: |
after |
A command token (internally upper-cased).
Internal Type: str. |
Append a route waypoint with optional altitude and airspeed constraints.
Examples:
ADDWPT KL204 SPL FL250 250KT[CAS]
ADDWPT KL204 RTM,,250KT[CAS]
acidx |
An existing aircraft callsign.
Internal Type: int. |
waypoint |
One of:
|
altitude |
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
ADDWPTMODE¶
Show the current waypoint insertion/fly-turn mode.
acidx |
An existing aircraft callsign.
Internal Type: int. |
Select FLYBY, FLYOVER, or FLYTURN waypoint mode.
acidx |
An existing aircraft callsign.
Internal Type: int. |
mode |
Accepted: FLYBY, FLY-BY, FLYOVER, FLY-OVER, FLYTURN, FLY-TURN.
Internal Type: WaypointMode. |
AFTER¶
Insert a waypoint after an existing route waypoint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
afterwp |
A command token (internally upper-cased).
Internal Type: str. |
waypoint |
One of:
|
alt |
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
ALT¶
Select the autopilot altitude, optionally with a vertical speed.
Selecting an altitude disengages VNAV for this aircraft. When no vertical speed is given and the currently selected vertical speed opposes the required climb/descent direction, it is reset so the default vertical speed is used.
Examples:
ALT KL204 FL200 1500FT/MIN
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
alt |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. |
vspd |
One of:
|
ASAS¶
Aliases: CD, CDMETHOD
Enable conflict detection.
Enable or disable conflict detection.
enabled |
True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF.
Internal Type: bool. |
AT¶
Set the altitude constraint at a route waypoint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
atwp |
A command token (internally upper-cased).
Internal Type: str. |
value |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. |
Store a command to execute when a route waypoint is passed.
Important
Note that we deliberately differ from bluesky in a subtle way.
BlueSky supports an implicit-ownship shorthand.
For example, BlueSky interprets HX2 AT WPT10 STACK ALT 95FT[STD]
as though the deferred command were HX2 ALT 95FT[STD] (the HX2 target
here is injected implicitly by bluesky)
Minisky intentionally does not infer or inject that aircraft
target. Write the complete deferred command instead:
HX2 AT WPT10 STACK HX2 ALT 95FT[STD] (or the equivalent command-first
form HX2 AT WPT10 STACK ALT HX2 95FT[STD]).
The same rule applies to nested conditional commands. A BlueSky
scenario line such as
HX2 AT WPT9D STACK ATSPD 200KT[CAS] HX2 ALT 100FT[STD] should be
HX2 AT WPT9D STACK HX2 ATSPD 200KT[CAS] HX2 ALT 100FT[STD] in minisky:
the deferred ATSPD command must itself be complete.
See also:
- BlueSky commit that introduced
AT ... DO/STACK - Metropolis 2
scenario/M2AP3.scnandscenario/LNAV_VNAV/LNAV-VNAV-TwoRoutesFlights.scnupstream
ATALT¶
Schedule a command for when an aircraft crosses an altitude.
acidx |
An existing aircraft callsign.
Internal Type: int. |
targalt |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. |
cmdtxt |
Internal Type: str. |
ATDIST¶
Schedule a command for crossing a distance.
acidx |
An existing aircraft callsign.
Internal Type: int. |
position |
One of:
LatLonDegrees. |
targdist |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
cmdtxt |
Internal Type: str. |
ATSPD¶
Schedule a command for crossing an explicit CAS in m/s or Mach target.
BANK¶
Aliases: BANKLIM
Show the bank-angle limit for an aircraft or selection.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
BEFORE¶
Insert a waypoint before an existing route waypoint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
beforewp |
A command token (internally upper-cased).
Internal Type: str. |
waypoint |
One of:
|
alt |
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
BOX¶
Define a box-shaped area from two opposite corners.
name |
A command token (internally upper-cased).
Internal Type: str. |
first |
One of:
LatLonDegrees. |
second |
One of:
LatLonDegrees. |
top |
One of:
|
bottom |
One of:
|
CIRCLE¶
Define a circular area.
name |
A command token (internally upper-cased).
Internal Type: str. |
center |
One of:
LatLonDegrees. |
radius |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
top |
One of:
|
bottom |
One of:
|
CLRCRECMD¶
Clear the list of commands issued for newly created aircraft.
Remove all command lines previously added with CRECMD.
CRE¶
Aliases: CREATE
Create an aircraft.
Examples:
CRE KL204 B744 52.0 4.0 90 FL100 250KT[CAS]
CRE AF007 A359 SUGOL 180 FL360 M0.85
CRE KLM10 A320 EHAM/RW06 * 0FT[STD] 150KT[CAS]
callsign |
A command token (internally upper-cased).
Internal Type: str. |
actype |
A command token (internally upper-cased).
Internal Type: str. |
position |
A waypoint, airport, runway, aircraft, or coordinate expression resolved against navigation data and traffic. One of:
LatLonDegrees or RunwayPosition. |
hdg |
One of:
|
alt |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. Optional; omission uses the callback default. |
airspeed |
One of: Optional; omission uses the callback default. |
CRECMD¶
Show commands issued for every newly created aircraft.
Show commands issued for every newly created aircraft.
Add a command to issue for every newly created aircraft.
cmdline |
Internal Type: str. |
CRECONFS¶
Create an aircraft in conflict with a target aircraft.
The intruder position, track and airspeed are computed such that, relative to the target aircraft,
separation is lost after the given time with the given distance at
the closest point of approach. The protected-zone radius and height
from the config (asas_pzr, asas_pzh) are taken into account. Omitting
the vertical offset creates a level conflict; omitted vertical LoS time
defaults to the horizontal LoS time, and omitted airspeed uses the
ownship ground speed.
callsign |
Callsign of the new intruder.
A command token (internally upper-cased).
Internal Type: str. |
actype |
Aircraft type of the new intruder.
A command token (internally upper-cased).
Internal Type: str. |
targetidx |
Ownship aircraft index.
An existing aircraft callsign.
Internal Type: int. |
dpsi |
Angle between ownship and intruder tracks. Constraints: finite.
Internal Type: float. Internal Unit: degree. |
dcpa |
Requested horizontal separation at CPA. (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
tlosh |
Time until horizontal loss of separation. (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite.
Internal Type: float. Internal Unit: second. |
dH |
Initial vertical offset; None creates a level conflict.
One of:
|
tlosv |
Time until vertical loss of separation; defaults to tlosh.
One of:
|
airspeed |
Explicit intruder CAS/Mach; omitted uses ownship ground speed. One of: Optional; omission uses the callback default. |
DATE¶
Report the current simulation UTC timestamp.
DEFWPT¶
Inspect a scenario-specific waypoint or report that its name is available.
name |
A command token (internally upper-cased).
Internal Type: str. |
Delete a scenario-specific waypoint.
name |
A command token (internally upper-cased).
Internal Type: str. |
Define a scenario-specific waypoint from a position.
Examples:
DEFWPT MYWPT 52.3 4.7
name |
A command token (internally upper-cased).
Internal Type: str. |
position |
One of:
LatLonDegrees. |
Delete a waypoint from the DEFWPT name,position,DEL form.
name |
A command token (internally upper-cased).
Internal Type: str. |
position |
One of:
LatLonDegrees. |
Define a scenario-specific waypoint with an explicit waypoint type.
name |
A command token (internally upper-cased).
Internal Type: str. |
position |
One of:
LatLonDegrees. |
waypoint_type |
A command token (internally upper-cased).
Internal Type: str. |
DEL¶
Aliases: DELETE
Delete an element (aircraft, wind field, area shape, or group).
DEL = "DEL" ( "WIND" | area-name | group-name
| selection { selection } ) ;
selection = aircraft-id | group-name | "*" | "ALL" ;
A sole stored group deletes its member aircraft and releases the group, matching BlueSky. In a multi-selection form a group expands to aircraft but the group definition remains.
DELAY¶
DELRTE¶
Aliases: DELROUTE
Delete the route when a single aircraft exists.
Delete an aircraft route.
acidx |
An existing aircraft callsign.
Internal Type: int. |
DELWPT¶
Aliases: DELWP
Delete the complete route using BlueSky's DELWPT callsign,* form.
acidx |
An existing aircraft callsign.
Internal Type: int. |
DEST¶
Show the destination of an aircraft.
acidx |
An existing aircraft callsign.
Internal Type: int. |
Set the destination with an optional CAS in m/s or Mach constraint.
acidx |
An existing aircraft callsign.
Internal Type: int. |
waypoint |
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
DIRECT¶
Aliases: DCT, DIRECTTO, DIRTO
DTLOOK¶
Report the default conflict-detection lookahead.
Set the default conflict-detection lookahead.
time |
(e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite.
Internal Type: float. Internal Unit: second. |
Set conflict-detection lookahead for selected aircraft.
time |
(e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite.
Internal Type: float. Internal Unit: second. |
first |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
additional |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. Optional; omission uses the callback default. Repeatable. |
DTMULT¶
Aliases: RTF
Set the simulation speed multiplier.
The loop targets a simulation step every simdt / speed wall-clock
seconds, so a larger multiplier makes simulated time advance faster
relative to the wall clock.
mult |
Constraints: > 0, finite.
Internal Type: float. |
DTNOLOOK¶
Report the default post-resolution no-look interval.
Set the default post-resolution no-look interval.
time |
(e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite.
Internal Type: float. Internal Unit: second. |
Set the post-resolution no-look interval for selected aircraft.
time |
(e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite.
Internal Type: float. Internal Unit: second. |
first |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
additional |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. Optional; omission uses the callback default. Repeatable. |
ECHO¶
Aliases: PRINT
Print a console message.
The message goes to stdout with prefix, and to every callback
registered with subscribe. It also overwrites output_buffer, so an
earlier message read_output_buffer has not drained yet is lost.
text |
Message to echo; each line is printed separately.
Internal Type: str. |
GETWIND¶
Report wind at an aviation position and optional altitude.
position |
One of:
LatLonDegrees. |
alt |
One of:
|
GROUP¶
List all stored traffic groups.
List the aircraft in a traffic group.
groupname |
A command token (internally upper-cased).
Internal Type: str. |
Create or extend a traffic group from selections or an area.
HDG¶
Aliases: HEADING, TURN
Select the autopilot heading.
When a wind field is defined and the aircraft is airborne (above 50 ft), the commanded track is computed from the given heading and the local wind; otherwise track equals heading. Selecting a heading disengages LNAV for this aircraft.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
hdg |
One of:
|
HELP¶
Aliases: ?
Show help for a command.
cmd |
A command token (internally upper-cased).
Internal Type: str. |
HOLD¶
Aliases: PAUSE
Set simulation state to HOLD.
Pauses the advance of simulation time and triggers the plugin hold
hooks. Stack commands are still processed while holding, so the
simulation can be resumed with the OP command.
IC¶
Aliases: LOAD, OPEN
Load a scenario file.
Resets the simulation, reads the scenario file relative to the project root, and buffers its timestamped commands for execution when the simulation time passes their timestamps.
scn |
Internal Type: str. |
LINE¶
Draw a line between two positions.
name |
A command token (internally upper-cased).
Internal Type: str. |
start |
One of:
LatLonDegrees. |
end |
One of:
LatLonDegrees. |
LISTRTE¶
LNAV¶
Show LNAV state for an aircraft or selection.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
LSVAR¶
List registered variable parents.
Show information about a simulation variable.
varname |
A non-empty command field. Spaces or commas terminate bare fields, surrounding quotes are removed.
Internal Type: str. |
MAGVAR¶
Aliases: MAGDEC, MAGDECL, VAR
Show magnetic variation at an aviation position.
position |
One of:
LatLonDegrees. |
MCRE¶
Create multiple aircraft at random positions in a lat/lon box.
Callsigns are generated randomly (two letters plus a sequence number). Heading is drawn uniformly from 1-360 deg; when not given, altitude is drawn from 2000-39000 ft and calibrated airspeed from 250-450 kts. The default area is the North Sea region.
n |
Constraints: > 0.
Internal Type: int. |
lat_min |
(e.g. 52.5, N52'30') Constraints: finite, >= -90, <= 90.
Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default. |
lon_min |
(e.g. 4.5, E004'30') Constraints: finite, >= -180, <= 180.
Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default. |
lat_max |
(e.g. 52.5, N52'30') Constraints: finite, >= -90, <= 90.
Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default. |
lon_max |
(e.g. 4.5, E004'30') Constraints: finite, >= -180, <= 180.
Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default. |
actype |
A command token (internally upper-cased).
Internal Type: str. Optional; omission uses the callback default. |
acalt |
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
MOVE¶
Instantaneously move an aircraft to a new position/state.
Optional state values are left unchanged when omitted. Setting a vertical speed disengages VNAV.
idx |
An existing aircraft callsign.
Internal Type: int. |
position |
One of:
LatLonDegrees. |
alt |
New altitude; also becomes the selected altitude.
One of:
|
hdg |
New heading; also becomes the autopilot track command.
One of:
|
airspeed |
One of: Optional; omission uses the callback default. |
vspd |
New vertical speed; setting it disengages VNAV.
One of:
|
NOISE¶
Report trajectory-noise state.
Enable or disable trajectory and surveillance noise.
noise |
True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF.
Internal Type: bool. |
NORESO¶
Show aircraft that nobody will avoid.
Toggle the nobody-avoids flag for selected aircraft.
OP¶
Aliases: CONTINUE, RUN, START
Set simulation state to OPERATE.
Resumes (or starts) advancing simulation time. Also re-anchors the
system time reference syst to the current wall-clock time plus one
simulation step.
ORIG¶
Show the origin of an aircraft.
acidx |
An existing aircraft callsign.
Internal Type: int. |
Set the origin of an aircraft.
acidx |
An existing aircraft callsign.
Internal Type: int. |
waypoint |
One of:
|
PERFSTATS¶
Aliases: PERFDATA, PERFINFO
Report the current performance state of an aircraft.
Includes flight phase, thrust, drag, fuel flow, speed and vertical-speed envelopes, and ceiling in aviation units (kN, kg/s, kts, fpm, ft).
acidx |
An existing aircraft callsign.
Internal Type: int. |
PLUGINS¶
Aliases: PLUG-IN, PLUG-INS, PLUGIN, SIMPLUGIN
List loaded and available plugins.
List loaded and available plugins.
Load a plugin by name.
plugin_name |
A command token (internally upper-cased).
Internal Type: str. |
Load a plugin by name.
plugin_name |
A command token (internally upper-cased).
Internal Type: str. |
POLY¶
Aliases: POLYGON
Define a polygon from position vertices.
name |
A command token (internally upper-cased).
Internal Type: str. |
points |
One of:
LatLonDegrees. Optional; omission uses the callback default. Repeatable. |
POLYALT¶
Define a polygon between top and bottom altitudes.
name |
A command token (internally upper-cased).
Internal Type: str. |
top |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. |
bottom |
Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite.
Internal Type: StdPressureAltM. Internal Unit: meter. |
first |
One of:
LatLonDegrees. |
additional |
One of:
LatLonDegrees. Optional; omission uses the callback default. Repeatable. |
POLYLINE¶
Aliases: LINES, POLYLINES
Draw a multi-segment line through position vertices.
name |
A command token (internally upper-cased).
Internal Type: str. |
first |
One of:
LatLonDegrees. |
additional |
One of:
LatLonDegrees. Optional; omission uses the callback default. Repeatable. |
POS¶
Aliases: AIRPORT, AIRWAY, AIRWAYS, AWY, RUNWAYS
Show information on an aircraft, airport, waypoint or navaid.
name |
A command token (internally upper-cased).
Internal Type: str. |
PRIORULES¶
Show priority-rule support and state.
QUIT¶
Aliases: CLOSE, END, EXIT, Q, STOP
Stop the simulation.
Sets the simulation state to END and asks the runner to exit its
loop. If the runner was configured with
minisky.Runner.prevent_shutdown, the loop
keeps running and only the state changes.
REALTIME¶
Aliases: RT
Report realtime mode.
Enable or disable realtime mode.
flag |
True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF.
Internal Type: bool. |
RESET¶
Reset all simulation objects (stack RESET command).
Returns the simulation to its initial state: simulation time back to 0 s, timestep back to 1 s, the simulated UTC clock to today at 00:00:00, and all traffic, stack, navigation database, area filters, console output, replaceable entities (autopilot, performance models, etc.) and plugin timers/hooks reset to their defaults.
RESO¶
Show the current and available conflict-resolution methods.
Disable conflict resolution.
Select and enable MVP conflict resolution.
RESOOFF¶
Show aircraft that perform no resolution manoeuvres.
Toggle resolution manoeuvres for selected aircraft.
RFACH¶
Aliases: HRESOFAC, HRFAC, RESOFACH
Show the horizontal resolution factor.
Set the horizontal resolution factor.
factor |
Constraints: > 0, finite.
Internal Type: float. |
RFACV¶
Aliases: RESOFACV
Show the vertical resolution factor.
Set the vertical resolution factor.
factor |
Constraints: > 0, finite.
Internal Type: float. |
RMETHH¶
Show horizontal resolution-method settings.
Configure horizontal resolution degrees of freedom.
value |
Accepted: BOTH, SPD, HDG, NONE, ON, OFF, OF.
Internal Type: str. |
RMETHV¶
Show vertical resolution-method settings.
Configure vertical resolution degrees of freedom.
value |
Accepted: NONE, ON, OFF, OF, V/S.
Internal Type: str. |
RSZONEDH¶
Aliases: RESOZONEDH
Show the absolute vertical resolution zone.
Set the absolute vertical resolution-zone height.
zonedh |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
RSZONER¶
Aliases: RESOZONER
Show the absolute horizontal resolution zone.
Set the absolute horizontal resolution-zone radius.
zoner |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
RTA¶
SCENARIO¶
Aliases: SCEN
Set the scenario name for the current simulation.
name |
Internal Type: str. |
SCHEDULE¶
SEED¶
Set the random seed for this simulation (stack SEED command).
Seeds this runtime's Python and NumPy generators so stochastic scenario elements are reproducible without affecting other runtimes.
value |
Internal Type: int. |
SELECTIMPL¶
Aliases: IMPL, IMPLEMENT, IMPLEMENTATION
List replaceable classes.
Show the current and available implementations for a replaceable.
basename |
A command token (internally upper-cased).
Internal Type: str. |
SPD¶
Aliases: SPEED
Select CAS in m/s or Mach explicitly.
Examples:
SPD KL204 250KT[CAS]
SPD KL204 M0.78
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
airspeed |
One of: |
SWTOC¶
Show Top-of-Climb state for an aircraft or selection.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
SWTOD¶
Show Top-of-Descent state for an aircraft or selection.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
THR¶
Report autothrottle state and fixed throttle when applicable.
idx |
An existing aircraft callsign.
Internal Type: int. |
Enable autothrottle.
idx |
An existing aircraft callsign.
Internal Type: int. |
Disable autothrottle and select idle thrust.
idx |
An existing aircraft callsign.
Internal Type: int. |
TIME¶
Report the current simulation UTC timestamp.
Set simulation UTC to the start of the current UTC day.
Set simulation UTC from the current local wall clock.
Set simulation UTC from the current UTC wall clock.
Set only the time-of-day, preserving BlueSky's 1900-01-01 date behavior.
time |
(e.g. 12:34:56, 12:34:56.123456)
Internal Type: time. |
UNGROUP¶
Remove several selections from a stored group.
VNAV¶
Show VNAV state for an aircraft or selection.
idx |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
VS¶
Select the autopilot vertical speed.
Setting a vertical speed disengages VNAV for this aircraft.
WIND¶
Clear wind defined at a position.
position |
One of:
LatLonDegrees. |
Define altitude-independent wind.
Examples:
WIND 52 4 270 20KT
position |
One of:
LatLonDegrees. |
direction |
Constraints: finite.
Internal Type: float. Internal Unit: degree. |
speed |
(e.g. 10MPS, 600FT/MIN, 20KT, 90KMH) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter · second⁻¹. |
Define constant wind with an omitted altitude.
Examples:
WIND 52 4,,270 20KT
position |
One of:
LatLonDegrees. |
direction |
Constraints: finite.
Internal Type: float. Internal Unit: degree. |
speed |
(e.g. 10MPS, 600FT/MIN, 20KT, 90KMH) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter · second⁻¹. |
Define altitude-dependent wind vectors.
Examples:
WIND 52 4 FL050 270 20KT FL100 300 30KT
position |
One of:
LatLonDegrees. |
first |
All of:
WindLevel. |
additional |
All of:
WindLevel. Optional; omission uses the callback default. Repeatable. |
ZONEDH¶
Aliases: DHPZ, PZDH, PZHEIGHT
Report the default protected-zone half-height.
Set the default protected-zone half-height.
height |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
Set the protected-zone half-height for selected aircraft.
height |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
first |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
additional |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. Optional; omission uses the callback default. Repeatable. |
ZONER¶
Aliases: PZR, PZRADIUS, RPZ
Report the default protected-zone radius.
Set the default protected-zone radius.
radius |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
Set the protected-zone radius for selected aircraft.
radius |
(e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0.
Internal Type: float. Internal Unit: meter. |
first |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. |
additional |
An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL)
Internal Type: ndarray. Optional; omission uses the callback default. Repeatable. |
example¶
PASSENGERS¶
Show the number of passengers on an aircraft.
index |
An existing aircraft callsign.
Internal Type: int. |
multicopter¶
BATT¶
Report the battery state of charge, power draw and endurance.
idx |
An existing aircraft callsign.
Internal Type: int. |
HOVER¶
Hold position, optionally for a fixed time at a given altitude.
Suspends LNAV/VNAV, commands zero ground speed, and holds the given altitude (the current one when omitted) — with an altitude the aircraft moves there vertically, at a fixed position. With a duration, the route resumes once position and altitude have been held that long; without one, the aircraft hovers until LNAV is re-engaged. Repeating the command while hovering updates the hold time and altitude, and a plain ALT command changes the hover altitude as well.
idx |
An existing aircraft callsign.
Internal Type: int. |
duration |
One of:
|
alt |
One of:
|
MCOPT¶
Report whether multicopter behavior is enabled for an aircraft.
idx |
An existing aircraft callsign.
Internal Type: int. |
YAW¶
Command the body heading (nose direction) of a multicopter.
The velocity vector keeps following the track command from the FMS or conflict resolution, so this rotates the aircraft in place.
idx |
An existing aircraft callsign.
Internal Type: int. |
hdg |
One of:
|
YAWRATE¶
Report the maximum yaw rate of a multicopter.
idx |
An existing aircraft callsign.
Internal Type: int. |
tangram¶
TANGRAM¶
Show the status of the tangram Redis bridge.