State
A state transmits high-level information about the scene or setup. The information it contains depends on the configuration. States will get calculated on every frame of measurement.
Field | Type | Default | Unit |
---|---|---|---|
generator_name |
string |
- |
- |
The name of the entity generating this state |
|||
security |
- |
- |
|
The security state contains intrusion information of a zone |
|||
volume |
- |
- |
|
Current volume measured in the selected zone |
|||
object_based_security |
- |
- |
|
The object based security state contains intrusion information of a zone and the objects that trigger the intrusion |
|||
occupancy |
- |
- |
|
The state contains occupation information of a zone |
|||
traversal_security |
- |
- |
|
The traversal state |
Object Based Security
A message containing an alarm state of a zone.
Field | Type | Default | Unit |
---|---|---|---|
alarm |
bool |
- |
- |
If there is an alarm or not in the zone. |
|||
objects |
repeated ObjectsEntry |
- |
- |
Map of objects where the key is the UUID of the object that triggered the alarm. |
|||
intrusion |
- |
- |
|
Active intrusion. Can be used as pre-alarm. |
|||
intrusion_confidence |
float |
- |
- |
Confidence that it is a real intrusion. Calculates a moving average of the intrusion state. The moving average window size can be configured with the minimum intruding duration parameter. |
Security
A message containing an alarm state of a zone.
Field | Type | Default | Unit |
---|---|---|---|
alarm |
bool |
- |
- |
If there is an alarm or not in the zone. |
|||
num_detected_points |
uint32 |
- |
- |
The current number of lidar points detected in the zone. |
|||
point_cloud |
- |
- |
|
Foreground point cloud inside zone which triggered the alarm. |
|||
intrusion |
- |
- |
|
Active intrusion. Can be used as pre-alarm. |
|||
intrusion_confidence |
float |
- |
- |
Confidence that it is a real intrusion. Calculates a moving average of the intrusion state. The moving average window size can be configured with the minimum intruding duration parameter. |
Volume
A message containing the volume state of a zone. This is based on one volume zone.
Field | Type | Default | Unit |
---|---|---|---|
volume |
float |
- |
m^3 |
The current numerical volume of the zone. |
|||
coverage |
float |
- |
- |
The current zone volume surface coverage |
Occupancy
A message containing the occupancy state of a zone.
Field | Type | Default | Unit |
---|---|---|---|
occupied |
bool |
- |
- |
True if the zone is occupied. |
|||
num_detected_points |
uint32 |
- |
- |
The current number of lidar points detected in the zone. |
|||
baseline |
float |
- |
- |
Current baseline. |
Traversal Security
A message containing the traversal state of a zone.
Field | Type | Default | Unit |
---|---|---|---|
alarm |
bool |
- |
- |
The traversal alarm |
|||
objects |
repeated ObjectsEntry |
- |
- |
The objects which triggered the inbound alarm |
|||
intrusion |
- |
- |
|
Active traversal |