Face tracking

API for communication with ZBOS by Zora Robotics.

Channels

zbos/facetracking/start

publish

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

Channel tags
  • Face tracking

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/facetracking/stop

publish

Stop continuous facetracking

Channel tags
  • Face tracking

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/facetracking/detected/faces

subscribe

event: Detected faces

Channel tags
  • Face tracking

Message 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/camera/picture/event

publish

event: Get picture

Picture in base64 formatsee zbos/facetracking/response for response

Channel tags
  • Face tracking

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/facetracking/response

subscribe

response: Face

Channel tags
  • Face tracking

Message 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

publish

Add a person

Channel tags
  • Face tracking

Message 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

object

How closely the person must match

  • LOOSE

  • NORMAL

  • STRICT

options.mode.euclideanThreshold

number

Any

options.mode.cosineThreshold

number

Any

options.mode.name

string

Any

options.mode.ordinal

integer

Any

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

subscribe

response: Add a person

Channel tags
  • Face tracking

Message 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

publish

Add a new face to an existing person

Channel tags
  • Face tracking

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/facetracking/update_response

subscribe

response: Add a new face to an existing person

Channel tags
  • Face tracking

Message 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

publish

Update a person

Channel tags
  • Face tracking

Message 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

subscribe

response: Update a person

Channel tags
  • Face tracking

Message 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

publish

Delete a person

Channel tags
  • Face tracking

Message 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

subscribe

response: Delete a person

Channel tags
  • Face tracking

Message 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

publish

Request the list of registered persons

Channel tags
  • Face tracking

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/facetracking/name_response

subscribe

response: Request the list of registered persons

Channel tags
  • Face tracking

Message 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

publish

Request all data of a person

Channel tags
  • Face tracking

Message 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

subscribe

response: Request all data of a person

Channel tags
  • Face tracking

Message 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"
}