Skip to main content

ProGlove Documentation

Worker Feedback command

The Worker Feedback command enables you to send messages to the connected devices in order to play specific feedback sequences. Use it to notify workers about an event to enhance their workflow and help with daily tasks completion.

Response: An Error event in case of error.

Fields

Name

Type

Description

Accepted values

Constraints

Required

api_version

string

The input API schema version number.

1.0, 1.1

Yes

event_type

string

The message type.

feedback!

Yes

event_id

string

The message identifier. This can be used to reference it.

Any

UUID format UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Yes

time_created

integer

The time of creation client-side, used to determine the order of incoming messages. Unix time stamp in milliseconds.

Any

1546300800000 <= value <= 99999999999999

Yes

device_serial

string

The serial number of a worker device.

Any

1 <= length <= 128

Yes

feedback_action_id

string

The predefined feedback action that should be signaled.

  • FEEDBACK_POSITIVE

  • FEEDBACK_NEGATIVE

  • FEEDBACK_SPECIAL_YELLOW

  • FEEDBACK_SPECIAL_PURPLE

  • FEEDBACK_SPECIAL_CYAN

 

Yes

event_time_to_live_duration

integer

The maximum duration the event is valid, compared to its creation time (in milliseconds).

Default value: 0.

If the value is default, the event must be processed irrespective of its age. If the event is the last one (no queued events after it) then it must be processed regardless of its age. If the event has not been processed before this time has passed it will be ignored.

*Compatible with api_version >=1.1.

Any

value >=0

No

Example
{
  "api_version": "1.0",
  "event_type": "feedback!",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "device_serial": "M2MR111100928",
  "feedback_action_id": "FEEDBACK_POSITIVE"
}
In this section: