Trueface Elevated Body Temperature Configuration Server

Simple HTTP server used for setting the configuration options of the Trueface temperature detection application.

GET/config

http://{{camera_ip}}:8090/config

Returns the configuration parameters which have been set.

Example Request

curl

curl --location -g 'http://{{camera_ip}}:8090/config'

200 OK

Example Response

json

{
  "display_text": "Eye duct temperature",
  "display_text_color": "3",
  "draw_mask": "true",
  "draw_temperature": "true",
  "face_detection_filter": "balanced",
  "face_detection_mode": "versatile",
  "frame_count": "20",
  "liveness_check": "false",
  "offset_temperature": "0.0",
  "smallest_face_height": "40",
  "stream_number": "1",
  "temperature_unit": "C",
  "websocket_port": "8091"
}

Content-Length

423

Content-Type

application/json

POST/config

http://{{camera_ip}}:8090/config

Sets the configuration parameters. Camera must be rebooted for changes to take effect. Can set one or more configuration parameters at once.

Bodyurlencoded

temperature_unit

Type: string Default: F The unit for temperature (for the temperatures reported over websocket and temperatures drawn onto the stream). Options: C, F

offset_temperature

0.0

Type: float Default: 0.0 An offset temperature (in the selected unit) to be added to every temperature measurement, including average temperature and the temperature drawn on the video stream.

websocket_port

8091

Type: int Default: 8091 The port for the websocket streaming. Only change this if you are certain there are no other processes using the chosen port.

stream_number

Type: int Default: 6 The stream on which to draw the results (bounding box, temp, etc). Options: 1 (1920x1080 resolution), 3 (640x360 resolution), 6 (1280x960 resolution - same aspect ratio as thermal camera). Note: This option is only avaliable for the IRYX solution.

smallest_face_height

Type: int Default: 40 The smallest face height in pixels that the face detector should detect faces. The smaller the size, the longer the face detection will take. The smallest allowable size is 16.

frame_count

Type: int Default: 10 The number of frames over which to compute the average and median temperature.

face_detection_filter

balanced

Type: string Default: balanced The face detection filter to be used. For more information: https://reference.trueface.ai/cpp/dev/latest/usage/general.html#_CPPv4N8Trueface19FaceDetectionFilterE. Unless you require specific behaviour, the default value will generally suffice. Options: balanced, high_recall, high_precision, unfiltered.

face_detection_mode

versatile

Type: string Default: versatile The face detection mode to be used. For more information: https://reference.trueface.ai/cpp/dev/latest/usage/general.html#_CPPv4N8Trueface17FaceDetectionModeE. Unless you require specific behaviour, the default value will generally suffice. Options: robust, versatile.

draw_temperature

true

Type: bool Default: true Draw the temperature label ("Eye duct temp: ...") on the video stream. Options: true, false.

display_text

Eye duct temperature

Type: string Default: "Eye duct Temperature" The text to draw on the video stream. Only draws if draw_temperature is enabled.

display_text_color

Type: int Default: 3 The color of the text to draw on the video stream. Only draws if draw_temperature is enabled. 1 - red 2 - blue 3 - black 4 - white 5 - green 6 - yellow 7 - cyan 8 - magenta

draw_mask

true

Type: bool Default: true Draw the mask label on the video stream. Options: true, false.

liveness_check

false

Type: bool Default: false Determines if a liveness check should be run on the detected face. A liveness check protects against possible spoof attacks such as holding up a phone with a face to the camera, or holding up an image to the camera. When a face fails the liveness check, no bounding box will be drawn around the face, and the liveness_check_passed field in the websocket packet will set set appropriately. Note, when this option is enabled, fast movement of the face may cause the liveness check to fail. For best results, ensure the face in cenetered in the frame with minimal movement. Additionally, wearing a mask may sometimes result in the liveness check to fail as well.

enable_snapshot

false

Type: bool Default: false This option only applies for the IRYX camera. It determines if the snapshot should be sent as part of the websocket packet. Only enable this if you require the synced snapshot frame as it can slow things down.

Example Request

curl

curl --location -g 'http://{{camera_ip}}:8090/config' \
--data-urlencode 'temperature_unit=C' \
--data-urlencode 'offset_temperature=0.0' \
--data-urlencode 'websocket_port=8091' \
--data-urlencode 'stream_number=6' \
--data-urlencode 'smallest_face_height=40' \
--data-urlencode 'frame_count=10' \
--data-urlencode 'face_detection_filter=balanced' \
--data-urlencode 'face_detection_mode=versatile' \
--data-urlencode 'draw_temperature=true' \
--data-urlencode 'display_text=Eye duct temperature' \
--data-urlencode 'display_text_color=3' \
--data-urlencode 'draw_mask=true' \
--data-urlencode 'liveness_check=false' \
--data-urlencode 'enable_snapshot=false'

200 OK

Example Response

plain

Success

Content-Length

Content-Type

text/plain

Keep-Alive

timeout=5, max=5

GET/restore-defaults

http://{{camera_ip}}:8090/restore-defaults

Restores to the default configuration parameters.

Example Request

curl

curl --location -g 'http://{{camera_ip}}:8090/restore-defaults'

200 OK

Example Response

plain

Success

Content-Length

Content-Type

text/plain

GET/default-config

http://{{camera_ip}}:8090/default-config

Returns the default configuration parameters.

Example Request

curl

curl --location -g 'http://{{camera_ip}}:8090/default-config'

200 OK

Example Response

json

{
  "display_text": "Eye duct temperature",
  "display_text_color": "3",
  "draw_mask": "true",
  "draw_temperature": "true",
  "face_detection_filter": "balanced",
  "face_detection_mode": "versatile",
  "frame_count": "20",
  "liveness_check": "false",
  "offset_temperature": "0.0",
  "smallest_face_height": "40",
  "stream_number": "6",
  "temperature_unit": "F",
  "websocket_port": "8091"
}

Content-Length

423

Content-Type

application/json