Person Counting System

System to automatically track the number of people inside a closed space. Optionally also detect (missing) masks.

Backend REST API

• The REST API is located at http://127.0.0.1:9000/api/xxx

GET /api/get_customer_count

{
    "current_customer_count": 10,
    "maximal_customer_count": 50
}

POST /api/set_maximal_customer_count?maximal_customer_count=11

{
    "success": true,
    "new_maximal_customer_count": 11
}

POST /api/set_customer_count_override?customer_count=0

Override the customers inside, will also trigger the websocket broadcast.

{
    "success": true,
    "new_customer_count": 0
}

GET /api/video_stream

[image stream, use as value for src attribute of img tag, NOT video!]

<img src="/api/video_stream" />

GET /api/camera_image

[jpg image of the camera without any annotations, used as the background for the barrier selection]

<img src="/api/camera_image" />

GET /api/get_barrier

{
    "p1_x": 0,
    "p1_y": 1,
    "p2_x": 1,
    "p2_y": 1,
    "side_switched": false
}

POST /api/set_barrier?p1_x=0&p1_y=1&p2_x=1&p2_y=1&side_switched=false

{
    "success": true,
    "p1_x": 0,
    "p1_y": 1,
    "p2_x": 1,
    "p2_y": 1,
    "side_switched": false
}

POST /api/mask_detection

Check if mask detection is enabled.

{
    "enabled": true
}

POST /api/set_mask_detection?enabled=true

Enable/Disable mask detection.

{
    "success": true,
    "enabled": true
}

GET /api/get_customer_time_spent_inside

Amount of time users spent inside (in seconds).

{
    "average": 749.0221,
    "history": [
        123.1023,
        923.9201,
        ...
    ]
}

Websocket

• The websocket can be accessed via ws://127.0.0.1:9001

The websocket does not require any special initialization, it will simply broadcast all messages to any connected client.

Types of messages:

customer_count_change

{
    "message_type": "customer_count_change",
    "content": {
        "current_customer_count": 11,
        "maximal_customer_count": 50
    }
}

missing_mask_detected

Notify the frontend that a missing mask was detected so a reminder can be displayed for a short moment.

{
    "message_type": "missing_mask_detected",
    "content": {}
}