Scene Controller API Reference#

Version: 1.3.0

Overview#

scenescape/regulated/scene/{scene_id}

 Scene Controller publishes regulated track data, 4

scenescape/data/scene/{scene_id}/{thing_type}

 Scene Controller publishes unregulated track data, 6

scenescape/event/{region_type}/{scene_id}/{region_id}/{event_type}

 Scene Controller publishes scene event messages, 8

MQTT Channels#

scenescape/data/camera/{camera_id}
parameters
camera_id
description:
Camera identifier
schema
type:
string
scenescape/data/camera/{camera_id}
subscribe
summary:
Scene Controller subscribes to live camera data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
debug_timestamp_end
type:
string
format:
date-time
debug_mac
type:
string
id
type:
string
objects
type:
object
additionalProperties
type:
array
items
type:
object
rate
type:
number
minimum:
0
intrinsics
type:
object
properties
fx
type:
number
fy
type:
number
cx
type:
number
cy
type:
number
distortion
type:
object
description:
Lens distortion coefficients keyed by name.
properties
k1
type:
number
k2
type:
number
p1
type:
number
p2
type:
number
k3
type:
number
scenescape/regulated/scene/{scene_id}
parameters
scene_id
description:
Scene identifier
schema
type:
string
scenescape/regulated/scene/{scene_id}
publish
summary:
Scene Controller publishes regulated track data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
id
type:
string
name
type:
string
scene_rate
type:
number
minimum:
0
rate
type:
object
additionalProperties
type:
number
objects
type:
array
description:
Array of tracked scene objects. Each object includes fields such as `id`, `translation`, `velocity`, `visibility`, `regions`, `sensors`, `metadata`, and more.
items
type:
object
scenescape/data/scene/{scene_id}/{thing_type}
parameters
scene_id
description:
Scene identifier
schema
type:
string
thing_type
description:
Type of object (e.g., person, car)
schema
type:
string
scenescape/data/scene/{scene_id}/{thing_type}
publish
summary:
Scene Controller publishes unregulated track data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
id
type:
string
name
type:
string
rate
type:
number
minimum:
0
unique_detection_count
type:
integer
minimum:
0
objects
type:
array
description:
Array of tracked scene objects. Each object includes fields such as `id`, `translation`, `velocity`, `visibility`, `regions`, `sensors`, `metadata`, and more.
items
type:
object
scenescape/event/{region_type}/{scene_id}/{region_id}/{event_type}
parameters
region_type
description:
Region, sensor, or tripwire type
schema
type:
string
scene_id
description:
Scene identifier
schema
type:
string
region_id
description:
Region, sensor, or tripwire identifier
schema
type:
string
event_type
description:
Event type
schema
type:
string
scenescape/event/{region_type}/{scene_id}/{region_id}/{event_type}
publish
summary:
Scene Controller publishes scene event messages
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
scene_id
type:
string
scene_name
type:
string
region_id
type:
string
description:
Present in region events
region_name
type:
string
description:
Present in region events
tripwire_id
type:
string
description:
Present in tripwire events
tripwire_name
type:
string
description:
Present in tripwire events
counts
type:
object
additionalProperties
type:
integer
objects
type:
array
items
type:
object
entered
type:
array
items
type:
object
description:
Objects that entered the region during this cycle. In region events, each element is a bare track object. In tripwire events, this array is always empty. May be empty in region events when no entry occurred.
exited
type:
array
items
type:
object
description:
Objects that exited the region during this cycle. In region events, each element has shape {"object": <track>, "dwell": <seconds>}. In tripwire events, this array is always empty. May be empty in region events when no exit occurred.
metadata
type:
object
description:
Region or tripwire geometry. Region events include: title, uuid, points (polygon vertices), area, fromSensor. Tripwire events include: title, uuid, points (two endpoints).
scenescape/data/sensor/{sensor_id}
parameters
sensor_id
description:
Sensor identifier
schema
type:
string
scenescape/data/sensor/{sensor_id}
subscribe
summary:
Scene Controller subscribes to sensor data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
id
type:
string
value
description:
Sensor reading — numeric scalar, string, boolean, or any JSON value.
subtype
type:
string
rate
type:
number
minimum:
0
On this page

This Page