Face tracking

API for communication with ZBOS by Zora Robotics.

Channels

zbos/facetracking/start

PUB Start continuous facetracking, see zbos/facetracking/detected/faces for events

Channel tags

  • Face tracking

EmptyMessage

Empty message

zbos/facetracking/stop

PUB Stop continuous facetracking

Channel tags

  • Face tracking

EmptyMessage

Empty message

zbos/facetracking/detected/faces

SUB event: Detected faces

Channel tags

  • Face tracking

Array<Person>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. uuid

string

Any

Message Payload. name

string

Any

Message Payload. role

string

Any
Examples of payload
{
  "uuid": "some uuid",
  "name": "some name",
  "role": "some description"
}
{
  "name": "unknown"
}

zbos/facetracking/response

SUB Faces found in picture

This topic will be published when faces are detected in a picture.

Channel tags

  • Face tracking

Array<Person>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. uuid

string

Any

Message Payload. name

string

Any

Message Payload. role

string

Any
Examples of payload
{
  "uuid": "some uuid",
  "name": "some name",
  "role": "some description"
}
{
  "name": "unknown"
}

zbos/facetracking/add_request

PUB Add a person

see zbos/facetracking/add_response for response

Channel tags

  • Face tracking

PersonAddRequest
Payload

Name

Type

Description

Accepted values

name

string

Any

role

string

Optional, a descriptor for this person

Any

ImageString

string

Optional, if this has a value (in base64) the given image will be used. Otherwise, a stream will be started to find a new person

Any

options

object

Optional, the global options will be used if no value is given

Any

options. mode

string

How closely the person must match

* LOOSE * NORMAL * STRICT

options. tries

integer

How many times to check for a person before giving up

Any

options. timeout

integer

How long to look for a person before giving up

Any
Examples of payload
{
  "name": "some name",
  "role": "some description"
}
{
  "name": "another name",
  "options": {
    "mode": "STRICT",
    "tries": 5,
    "timeout": 60
  },
  "role": "another description",
  "ImageString": "some base64 image"
}

zbos/facetracking/add_response

SUB response: Add a person

Channel tags

  • Face tracking

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/facetracking/update_request

PUB Add a new face to an existing person

\[DEPRECATED] Adding multiple faces is no longer necessary or supported

see zbos/facetracking/update_response for response

Channel tags

  • Face tracking

EmptyMessage

Empty message

zbos/facetracking/update_response

SUB response: Add a new face to an existing person

\[DEPRECATED] Adding multiple faces is no longer necessary or supported

Channel tags

  • Face tracking

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/facetracking/update_person_request

PUB Update a person

see zbos/facetracking/update_person_response for response

Channel tags

  • Face tracking

Person
Payload

Name

Type

Description

Accepted values

uuid

string

Any

name

string

Any

role

string

Any
Examples of payload
{
  "uuid": "some uuid",
  "name": "some new name",
  "role": "some new description"
}

zbos/facetracking/update_person_response

SUB response: Update a person

Channel tags

  • Face tracking

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/facetracking/delete_request

PUB Delete a person

see zbos/facetracking/delete_response for response

Channel tags

  • Face tracking

Person
Payload

Name

Type

Description

Accepted values

uuid

string

Any

name

string

Any

role

string

Any
Examples of payload
{
  "uuid": "some uuid"
}

zbos/facetracking/delete_response

SUB response: Delete a person

Channel tags

  • Face tracking

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/facetracking/name_request

PUB Request the list of registered persons

see zbos/facetracking/name_response for response

Channel tags

  • Face tracking

EmptyMessage

Empty message

zbos/facetracking/name_response

SUB response: Request the list of registered persons

Channel tags

  • Face tracking

Array<Person>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. uuid

string

Any

Message Payload. name

string

Any

Message Payload. role

string

Any
Example of payload (generated)
[
  {
    "uuid": "string",
    "name": "string",
    "role": "string"
  }
]

zbos/facetracking/persondata_request

PUB Request all data of a person

see zbos/facetracking/persondata_response for response

Channel tags

  • Face tracking

Person
Payload

Name

Type

Description

Accepted values

uuid

string

Any

name

string

Any

role

string

Any
Examples of payload
{
  "uuid": "some uuid"
}

zbos/facetracking/persondata_response

SUB response: Request all data of a person

Channel tags

  • Face tracking

PersonGetResponse
Payload

Name

Type

Description

Accepted values

uuid

string

Any

name

string

Any

role

string

Any

image

string

A base64 image of this person

Any
Examples of payload
{
  "uuid": "some uuid",
  "name": "some name",
  "image": "some base64 image",
  "role": "some description"
}