Embedded Files
Message Content v1.0 Guidelines
Message Content v1.0 Guidelines
Data available:
Footfalls, passage counting.
Footfalls have a direction IN/OUT relative to how the line is drawn.
Actual direction have to be mapped as a tag. i.e. "field": "IN", "Direction": "North"
Fields available:"IN", passage in footfall direction
"OUT", passage in opposite footfall direction
"IN_TOTAL", unclean total crossings, where same object may pass multiple times
"OUT_TOTAL", unclean total crossings opposite direction.
Area presence, object within area.
Fields available:"value", the sampled count of objects within area
Diagnostic Metrics, staton health & quality metrics
Health matrics to determine station health.fpsWorker - Working rate, processed frames per second.
fpsVideo - Video frame rate
frameDrop - Frames dropped
AvgCol - Mean pixel color in view, sudden changes could imply an obstruction of the video view.
AvgDetections - Mean detections during the interval period
AvgTracks - Mean maintained objects during interval period
SumNewTracks - Sum of new objects during interval period
Status audit, runtime events and alerts.
Any audit event reported.
Events are tagged with a severity level - informative/warning/error. Error events are also tagged with an error code.
Reboot events occur when all submodules has started up successfully.
EStatus enum
Order of enumeration may change REBOOTEStatus enum
VIDEO_UNAVAILABLE
VIDEO_DISCONNECTED
VIDEO_NO_FRAME
CONFIG_UPDATE_FAILED
CONFIG_UPDATE_IGNORED
CONFIG_NOT_REPORTED
WORKER_HIGH_FAIL_RATE
INFERENCE_UNAVAILABLE
INFERENCE_FRAME_ERROR
INITIALIZE_ERROR
DataMessage
DataMessage
{
version: string literal "1.0"
deployment_id: string uuid
count: integer
payload: list<SensorData | StatusData>
}
SensorData
SensorData
{
measurement_id: string
time: string (ISO 8601 TimeString [YYYY-MM-DDThh:mm:ss.sssZ])
type: enum string "footfall" | "area_presence"
field: string
value: double
tags: list<TagValue>
}
StatusData
StatusData
{
measurement_id: string (Station ID)
time: string (ISO 8601 TimeString [YYYY-MM-DDThh:mm:ss.sssZ])
type: enum string "audit"
field: string <ESTatus>
value: string
tags: list<TagValue>
}
DiagnosticMetricData
DiagnosticMetricData
{
measurement_id: string (Station ID)
time: string (ISO 8601 TimeString [YYYY-MM-DDThh:mm:ss.sssZ])
type: enum string "diagnostics"
field: string
value: double
tags: list<TagValue>
}
TagValue
TagValue
{
tag: string
value: string
}
Message Example (SensorData)
Message Example (SensorData)
{
"version": "1.0",
"deployment_id": "12341234-1234-1234-1234-abcdabcdabcd",
"count": 14,
"payload": [
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:27.007000Z",
"type": "footfall",
"field": "IN",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:27.007000Z",
"type": "footfall",
"field": "IN_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.604000Z",
"type": "footfall",
"field": "OUT",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.604000Z",
"type": "footfall",
"field": "OUT_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.525000Z",
"type": "footfall",
"field": "IN",
"value": 0.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.525000Z",
"type": "footfall",
"field": "IN_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.608000Z",
"type": "footfall",
"field": "OUT",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:28.608000Z",
"type": "footfall",
"field": "OUT_TOTAL",
"value": 2.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:31.148000Z",
"type": "footfall",
"field": "OUT",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:31.148000Z",
"type": "footfall",
"field": "OUT_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:31.911000Z",
"type": "footfall",
"field": "OUT",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:31.911000Z",
"type": "footfall",
"field": "OUT_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:33.526000Z",
"type": "footfall",
"field": "IN",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
},
{
"measurement_id": "line-12349740194436363",
"time": "2023-02-07T08:24:33.526000Z",
"type": "footfall",
"field": "IN_TOTAL",
"value": 1.0,
"tags": [
{
"tag": "class",
"value": "person"
}
]
}
]
}
Message Example (Diagnostics)
Message Example (Diagnostics)
{
"version": "1.0",
"deployment_id": "12341234-1234-1234-1234-abcdabcdabcd",
"count": 2,
"payload": [
{
"measurement_id": "12341234-1234-1234-1234-abcdabcdabcd",
"time": "2025-02-07T08:24:27.007000Z",
"type": "diagnostics",
"field": "fpsWorker",
"value": 17.4,
"tags": []
},
{
"measurement_id": "12341234-1234-1234-1234-abcdabcdabcd",
"time": "2025-02-07T08:24:27.007000Z",
"type": "diagnostics",
"field": "fpsVideo",
"value": 30.0,
"tags": []
},
]
}
Message Example (Status)
Message Example (Status)
{
"version": "1.0",
"deployment_id": "12341234-1234-1234-1234-abcdabcdabcd",
"count": 2,
"payload": [
{
"measurement_id": "12341234-1234-1234-1234-abcdabcdabcd",
"time": "2025-02-07T08:24:27.007000Z",
"type": "audit",
"field": "REBOOT",
"value": "rebooted",
"tags": [
{
"tag": "severity",
"value": "INFO"
}
]
},
{
"measurement_id": "12341234-1234-1234-1234-abcdabcdabcd",
"time": "2025-02-07T08:24:27.007000Z",
"type": "audit",
"field": "VIDEO_NO_FRAME",
"value": "No frame received",
"tags": [
{
"tag": "severity",
"value": "ERROR"
},
{
"tag": "errorCode",
"value": "E2"
},
]
},
]
}
Page updated
Report abuse