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

environment

object

✔️

The environment of the show, including important areas, objects, buildings, camera positions etc

media

object

Media settings associated with the drone show

meta

object

Metadata of the show, such as a unique ID or title.

settings

object

General settings associated with a drone show

swarm

object

✔️

All data that needs to be defined on a per-drone basis

version

integer

✔️

The version of the .skyc format used.

.environment

Property

Type

Required

Description

type

string

✔️

Specifies whether the show is an outdoor or an indoor show

cameras

array<object>

Array of pre-defined camera positions and orientations

location

object

The proposed show origin and orientation that locate the show in the real world

terrain

object

A terrain model of the show location

.environment.cameras[]

Property

Type

Required

Description

type

string

The type of the camera as an optional parameter. Leave it to its default for the time being.

name

string

An optional, unique, human-readable identifier of the camera.

position

array<object>

The position of the camera.

orientation

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.

focalLength

number

The focal length of the camera, in millimeters.

default

boolean

Whether this camera is the default, preferred camera of the show.

.environment.location

Property

Type

Required

Description

origin

array<object>

✔️

Geodetic location of the show coordinate system

orientation

number

✔️

Angle of the X+ axis of the show coordinate system in degrees relative to North

.environment.terrain

Property

Type

Required

Description

model

object

✔️

The terrain model data

transform

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

data

string

✔️

Base64-encoded representation of the terrain model

mediaType

string

✔️

MIME media type of the model data

.environment.terrain.transform

Property

Type

Required

Description

position

array<object>

Translation of the model origin in meters, relative to the show origin

rotation

array<object>

Orientation of the model as a quaternion in WXYZ notation

scale

array<object>

Scale factors for the model along each axis

.media

Property

Type

Required

Description

audio

object

Settings of the music associated with the drone show

.media.audio

Property

Type

Required

Description

data

string

✔️

Base64-encoded representation of the music of the show

mediaType

string

✔️

MIME media type of the audio data

.meta

Property

Type

Required

Description

title

string

The title of the drone show.

id

string

Unique short string ID associated with the drone show.

segments

object

Object that maps show segment identifiers to the corresponding start (inclusive) and end (exclusive) timestamps.

inputs

array<string>

Names of the input files, directories or URLs that the .skyc file was created from, if relevant.

timestampOffset

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

cues

object

The cue sheet of the show

geofence

object

The proposed geofence definition in the used relative coordinate system

validation

object

The safety validation thresholds of the show

.settings.cues

Property

Type

Required

Description

version

integer

✔️

The version of the cue sheet format. This definition is for version 1.

items

array<object>

✔️

List of cues in the cue sheet

.settings.cues.items[]

Property

Type

Required

Description

name

string

✔️

A human-readable name of the cue, used in plots and 3D animation software

time

number

✔️

The time corresponding to the cue, in seconds

.settings.geofence

Property

Type

Required

Description

version

integer

✔️

The version of the geofence format. This definition is for version 1.

polygons

array<object>

✔️

action

string

Action to perform when the fence is breached

.settings.geofence.polygons[]

Property

Type

Required

Description

isInclusion

boolean

✔️

Stores whether the polygon is an inclusion polygon

points

array<array>

✔️

The list of points in the polygon

.settings.validation

Property

Type

Required

Description

maxAccelerationXY

number

The maximum horizontal acceleration allowed for drones, in meters per second squared

maxAccelerationZ

number

The maximum vertical acceleration allowed for drones, in meters per second squared

maxAltitude

number

The maximum allowed altitude for drones, in meters, above ground level

maxVelocityXY

number

The maximum horizontal velocity allowed for drones, in meters per second

maxVelocityZ

number

The maximum vertical velocity allowed for drones, in meters per second

maxVelocityZUp

number

The maximum vertical velocity allowed for drones when heading upwards, in meters per second, if it is different from the downward velocity limit

minDistance

number

The minimum allowed distance between drones, in meters

minNavAltitude

number

The minimum navigation altitude below which horizontal motion is not adviced and nearest neighbor distances are not checked, in meters

.swarm

Property

Type

Required

Description

drones

array<object>

✔️

Array of drone-related objects

.swarm.drones[]

Property

Type

Required

Description

type

string

The type of the drone as an optional parameter. Leave it to its default for the time being.

settings

object

✔️

All settings related to a single drone

.swarm.drones[].settings

Property

Type

Required

Description

name

string

An optional, unique, human-readable identifier of the drone.

trajectory

object

✔️

The trajectory definition of a single drone

lights

object

The light program of a single drone

pyro

object

The pyro program of a single drone

rthPlan

object

The return-to-home plan of a single drone, as part of the collective RTH plan.

yawControl

object

The yaw control definition of a single drone

home

array<object>

This schema describes how to define relative coordinates inside .skyc files

landAt

array<object>

This schema describes how to define relative coordinates inside .skyc files

extra

object

Additional unstructured data attached to the drone. Useful for prototyping purposes.

.swarm.drones[].settings.trajectory

Property

Type

Required

Description

version

integer

✔️

The version of the trajectory format. This definition is for version 1.

points

array<array>

✔️

The list of keypoints in the trajectory

takeoffTime

number

The takeoff time of the drone in seconds; zero if missing

landingTime

number

The landing time of the drone in seconds

.swarm.drones[].settings.lights

Property

Type

Required

Description

version

integer

✔️

The version of the light program format. This definition is for version 1.

data

string

✔️

Light program as ledctrl bytecode, encoded as a base64 string.

.swarm.drones[].settings.pyro

Property

Type

Required

Description

version

integer

✔️

The version of the pyro program format. This definition is for version 1.

events

array<array>

✔️

The temporal list of pyro events

payloads

object

✔️

Description of the pyro payloads attached to the drone, indexed by their ID

.swarm.drones[].settings.rthPlan

Property

Type

Required

Description

version

integer

✔️

The version of the plan format. This definition is for version 1.

acceleration

number

✔️

The linear acceleration value used in all entries, in m/s/s

landingSpeed

number

✔️

The vertical landing speed used in the landing phase of all entries, in m/s

landingAltitude

number

The default final landing altitude used in the landing phase of all entries, in meters

entries

array<object>

✔️

The entries in the return-to-home plan.

.swarm.drones[].settings.yawControl

Property

Type

Required

Description

version

integer

✔️

The version of the yaw control format. This definition is for version 1.

setpoints

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)

autoYaw

boolean

Change yaw automatically based on the momentary direction of motion

autoYawOffset

number

The yaw offset to use relative to front when in auto-yaw mode, in degrees