3.3. People counter

This section provides the API specifications for people counter devices.

3.3.1. Definitions

Common definitions

3.3.1.1. People Counter Definitions

People Counter

A device that count the number of people going through the detection area: The people counter device counted 500 people going through the main door

Count Cycle

The period during which people are being counted: Only 3 people passed through the gate during the last count cycle

Count Cycle Duration

The time interval of the count cycle: The count cycle duration is 1 hour

Count Cycle Start Date and Time

The date and time that determines the start of a cycle: The last cycle started on July 23 2021 at 10:00…

Count Cycle End Date and Time

The date and time that determines the end of a cycle. Note that the cycle duration is the difference between the cycle’s end and start date/time: … and ended on July 23 2021 at 11:00

Count Cycle Sequence

An incremental number that identifies a cycle since the people counter device has been registered: The sequence of the last cycle was 34566

Count

The number of people counted during a count cycle: The count during the last cycle was 25

Total Count

The number of people counted during an aggregation period: The total number of people counted during the last 24 hours is 3452

3.3.2. FDS compliance requirements

3.3.2.1. Object Model

3.3.2.1.1. Specification object for the people counter device type

the device information provider must provide a specification object that contains a device_type_specific object defined in the following diagram

../../_images/people_counter_specification_object_model.png

When provided, the sensor technology can be
- “radar”
- “time_of_flight”
- “image”
- “sonar”

3.3.2.1.2. Status object for the people counter device type

The device information provider must provide a status object that contains a device_type_specific object defined in the following diagram

../../_images/people_counter_status_object_model.png

3.3.2.1.3. Statistic object for the people counter device type

The device information provider must provide a statistic object that contains a device_type_specific object defined in the following diagram

../../_images/people_counter_statistic_object_model.png

3.3.2.1.4. Diagnostic object for the people counter device type

Note

The Diagnostic object is not being defined for people counters in FDS Version 2

3.3.2.2. Web API (Pull Model)

The device information provider must expose the specifications endpoint to get the list of available devices and their specifications

GET https://{Device Information Provider URL}/fds/v2/specifications

The device information provider must expose the statuses endpoint to get the latest status for one or multiple devices

GET https://{Device Information Provider URL}/fds/v2/statuses

The device information provider must expose the statistics endpoint to get the statistics for one or multiple devices

GET https://{Device Information Provider URL}/fds/v2/statistics

Note

The diagnostics endpoint to expose the prognostic and predictive information is not being defined for people counters in FDS Version 2

A call to:

GET https://{Device Information Provider URL}/fds/v2/diagnostics

must return an error object

{
    "status": 204,
    "message": "not_implemented"
}

The device information provider must expose the POST request on the tag endpoint to let a client application create a new tag

POST https://{Entity Information Provider URL}/fds/v2/tag

The device information provider must expose the GET request on the tag endpoint to provide the content of a tag

GET https://{Entity Information Provider URL}/fds/v2/tag

The device information provider must expose the DELETE request on the tag endpoint

DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>

The device information provider must expose the PUT request on the tag/<tag_id>/entities endpoint

PUT https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

The device information provider must expose the DELETE request on the tag/<tag_id>/entities endpoint

DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

3.3.2.3. Publish/Subscribe (Push model)

3.3.2.3.1. Events

The device information provider must publish the following alerts and notifications

Message code	Description	Message category	Message code specific object
out_of_order	The device is out of order and needs service intervention	alert	out_of_order_details property - array of information provider codes
offline	The device is not communicating	notification	last_contact property

3.3.2.3.2. Publish status information

Note

No status information is being published by people counter device information providers in FDS Version 2

3.3.2.3.3. Publish predictive and prognostic information

Note

No predictive and prognostic information is being published by people counter device information providers in FDS Version 2