JSON schema of the .skyc format
The Skybrush Compiled Format (.skyc) is basically a compressed JSON file.
The format of this inner .json file is defined by the JSON schema definition under the spec/skyc/schema folder in the format specification private repo.
A TypeScript interface is also generated from this JSON schema into the spec/skyc/types folder of the same repo.
The section below is also auto-generated from the original JSON schema.
Skybrush compiled show
This schema describes the proper usage of the JSON structure inside the Skybrush compiled show file format (.skyc).
Property |
Type |
Required |
Description |
|
object |
✔️ |
The environment of the show, including important areas, objects, buildings, camera positions etc |
|
object |
Media settings associated with the drone show |
|
|
object |
Metadata of the show, such as a unique ID or title. |
|
|
object |
General settings associated with a drone show |
|
|
object |
✔️ |
All data that needs to be defined on a per-drone basis |
|
integer |
✔️ |
The version of the .skyc format used. |
.environment
Property |
Type |
Required |
Description |
|
string |
✔️ |
Specifies whether the show is an outdoor or an indoor show |
|
array<object> |
Array of pre-defined camera positions and orientations |
|
|
object |
The proposed show origin and orientation that locate the show in the real world |
|
|
object |
A terrain model of the show location |
.environment.cameras[]
Property |
Type |
Required |
Description |
|
string |
The type of the camera as an optional parameter. Leave it to its default for the time being. |
|
|
string |
An optional, unique, human-readable identifier of the camera. |
|
|
array<object> |
The position of the camera. |
|
|
array<object> |
The orientation of the camera, expressed as a quaternion relative to the base orientation. In the base orientation, the camera points towards the negative Z axis such that the positive X axis is to the right. The coordinate system is right-handed. |
|
|
number |
The focal length of the camera, in millimeters. |
|
|
boolean |
Whether this camera is the default, preferred camera of the show. |
.environment.location
Property |
Type |
Required |
Description |
|
array<object> |
✔️ |
Geodetic location of the show coordinate system |
|
number |
✔️ |
Angle of the X+ axis of the show coordinate system in degrees relative to North |
.environment.terrain
Property |
Type |
Required |
Description |
|
object |
✔️ |
The terrain model data |
|
object |
Transformation to position the model in the show coordinate system. Defaults to identity transform (no translation, no rotation, unit scale). |
.environment.terrain.model
Property |
Type |
Required |
Description |
|
string |
✔️ |
Base64-encoded representation of the terrain model |
|
string |
✔️ |
MIME media type of the model data |
.environment.terrain.transform
Property |
Type |
Required |
Description |
|
array<object> |
Translation of the model origin in meters, relative to the show origin |
|
|
array<object> |
Orientation of the model as a quaternion in WXYZ notation |
|
|
array<object> |
Scale factors for the model along each axis |
.media
Property |
Type |
Required |
Description |
|
object |
Settings of the music associated with the drone show |
.media.audio
Property |
Type |
Required |
Description |
|
string |
✔️ |
Base64-encoded representation of the music of the show |
|
string |
✔️ |
MIME media type of the audio data |
.meta
Property |
Type |
Required |
Description |
|
string |
The title of the drone show. |
|
|
string |
Unique short string ID associated with the drone show. |
|
|
object |
Object that maps show segment identifiers to the corresponding start (inclusive) and end (exclusive) timestamps. |
|
|
array<string> |
Names of the input files, directories or URLs that the .skyc file was created from, if relevant. |
|
|
number |
Number of seconds to add to every timestamp in the show file; used when the trajectories in the show file represent only a part of the full trajectory. |
.settings
Property |
Type |
Required |
Description |
|
object |
The cue sheet of the show |
|
|
object |
The proposed geofence definition in the used relative coordinate system |
|
|
object |
The safety validation thresholds of the show |
.settings.cues
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the cue sheet format. This definition is for version 1. |
|
array<object> |
✔️ |
List of cues in the cue sheet |
.settings.cues.items[]
Property |
Type |
Required |
Description |
|
string |
✔️ |
A human-readable name of the cue, used in plots and 3D animation software |
|
number |
✔️ |
The time corresponding to the cue, in seconds |
.settings.geofence
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the geofence format. This definition is for version 1. |
|
array<object> |
✔️ |
|
|
string |
Action to perform when the fence is breached |
.settings.geofence.polygons[]
Property |
Type |
Required |
Description |
|
boolean |
✔️ |
Stores whether the polygon is an inclusion polygon |
|
array<array> |
✔️ |
The list of points in the polygon |
.settings.validation
Property |
Type |
Required |
Description |
|
number |
The maximum horizontal acceleration allowed for drones, in meters per second squared |
|
|
number |
The maximum vertical acceleration allowed for drones, in meters per second squared |
|
|
number |
The maximum allowed altitude for drones, in meters, above ground level |
|
|
number |
The maximum horizontal velocity allowed for drones, in meters per second |
|
|
number |
The maximum vertical velocity allowed for drones, in meters per second |
|
|
number |
The maximum vertical velocity allowed for drones when heading upwards, in meters per second, if it is different from the downward velocity limit |
|
|
number |
The minimum allowed distance between drones, in meters |
|
|
number |
The minimum navigation altitude below which horizontal motion is not adviced and nearest neighbor distances are not checked, in meters |
.swarm.drones[]
Property |
Type |
Required |
Description |
|
string |
The type of the drone as an optional parameter. Leave it to its default for the time being. |
|
|
object |
✔️ |
All settings related to a single drone |
.swarm.drones[].settings
Property |
Type |
Required |
Description |
|
string |
An optional, unique, human-readable identifier of the drone. |
|
|
object |
✔️ |
The trajectory definition of a single drone |
|
object |
The light program of a single drone |
|
|
object |
The pyro program of a single drone |
|
|
object |
The return-to-home plan of a single drone, as part of the collective RTH plan. |
|
|
object |
The yaw control definition of a single drone |
|
|
array<object> |
This schema describes how to define relative coordinates inside .skyc files |
|
|
array<object> |
This schema describes how to define relative coordinates inside .skyc files |
|
|
object |
Additional unstructured data attached to the drone. Useful for prototyping purposes. |
.swarm.drones[].settings.trajectory
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the trajectory format. This definition is for version 1. |
|
array<array> |
✔️ |
The list of keypoints in the trajectory |
|
number |
The takeoff time of the drone in seconds; zero if missing |
|
|
number |
The landing time of the drone in seconds |
.swarm.drones[].settings.lights
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the light program format. This definition is for version 1. |
|
string |
✔️ |
Light program as ledctrl bytecode, encoded as a base64 string. |
.swarm.drones[].settings.pyro
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the pyro program format. This definition is for version 1. |
|
array<array> |
✔️ |
The temporal list of pyro events |
|
object |
✔️ |
Description of the pyro payloads attached to the drone, indexed by their ID |
.swarm.drones[].settings.rthPlan
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the plan format. This definition is for version 1. |
|
number |
✔️ |
The linear acceleration value used in all entries, in m/s/s |
|
number |
✔️ |
The vertical landing speed used in the landing phase of all entries, in m/s |
|
number |
The default final landing altitude used in the landing phase of all entries, in meters |
|
|
array<object> |
✔️ |
The entries in the return-to-home plan. |
.swarm.drones[].settings.yawControl
Property |
Type |
Required |
Description |
|
integer |
✔️ |
The version of the yaw control format. This definition is for version 1. |
|
array<array> |
✔️ |
The list of yaw control setpoints with continuous interpretation of angles (i.e. 720 will turn right twice, while -720 will turn left twice from 0); The first setpoint angle must be in the range [0, 360) |
|
boolean |
Change yaw automatically based on the momentary direction of motion |
|
|
number |
The yaw offset to use relative to front when in auto-yaw mode, in degrees |