Get zone set configuration metadata

GET

http://os-992244000006.local/api/v1/zone_monitor/:zone_set

GET

/api/v1/zone_monitor/:zone_set

$ curl http://os-992244000006.local/api/v1/zone_monitor/active

1 {
2   "version": {
3     "metadata": 12,
4     "file_naming": 7
5   },
6   "power_on_live_ids": [
7     3,
8     7,
9     12
10   ],
11   "zones": {
12     "3": {
13       "point_count": 15,
14       "frame_count": 5,
15       "mode": "OCCUPANCY",
16       "file_hash": "a3f5c9d8e7b4f2a1c6d8e9f0b1a2c3d4",
17       "coordinate_frame": "sensor"
18     },
19     "7": {
20       "point_count": 10,
21       "frame_count": 3,
22       "mode": "VACANCY",
23       "file_hash": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6",
24       "coordinate_frame": "body"
25     },
26     "12": {
27       "point_count": 20,
28       "frame_count": 7,
29       "mode": "OCCUPANCY",
30       "file_hash": "c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9",
31       "coordinate_frame": "sensor"
32     }
33   },
34   "label": "Warehouse Zone Set A",
35   "sensor_to_body_transform": [
36     1,
37     0,
38     0,
39     0,
40     0,
41     0.866,
42     -0.5,
43     0,
44     0,
45     0.5,
46     0.866,
47     0,
48     0.1,
49     0.2,
50     0.3,
51     1
52   ]
53 }

Returns the complete zone set metadata including version, zones configuration, power-on live IDs, and sensor-to-body transform. Zone configurations include file hashes and coordinate frames.

Path parameters

zone_setenumRequired

Zone set identifier. Valid values are 'active' or 'staged'. The 'pending' set is a transient state and should not be used.

Allowed values:

Response

Zone set metadata with enriched zone information

versionobject

power_on_live_idslist of integers

List of power-on live zone IDs (max 16). Must be non-empty when zones are configured.

zonesobject

Zone configurations (at least one zone required per schema)

labelstring<=64 characters

Optional label for the zone set

sensor_to_body_transformlist of doubles

4x4 transformation matrix as a flat array of 16 elements

Errors

404

Not Found Error