Skip to main content

ProGlove Documentation

State command and state event
State command

The state command is a request to get the state of the Gateway Plus.

Response: You will receive a state event if the request is successful, and an Error event in case of errors.

Name

Type

Description

Accepted values

Constraints

Required

api_version

string

The input API schema version number.

1.0

Yes

event_type

string

The message type.

gateway_state!

Yes

event_id

string

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

Any

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

Example
{
  "api_version": "1.0",
  "event_type": "gateway_state!",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000
}
State event

The state event is received as a response to the state command. When you connect a Gateway Plus, a state message is automatically sent as soon as the Gateway Plus boots up and is ready for use.

Fields

Name

Type

Description

Accepted values

Constraints

Required

api_version

string

The input API schema version number.

1.0

Yes

event_type

string

The message type.

gateway_state

Yes

event_id

string

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

Any

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

event_reference_id

string

The reference message identifier. Used to reference the message that caused this error.

Any

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

No

gateway_serial

string

The serial number of the Gateway Plus

Any

1 <= length <= 128

Yes

gateway_app_version

string

The version of Gateway Plus application.

Any

1 <= length <= 128

Yes

device_connected_list

array[Device]

The list of connected devices (see Device object below).

Any

size <= 50 items

Yes

Device object

Name

Type

Description

Accepted values

Constraints

Required

device_serial

string

The serial number of the worker device.

Any

1 <= length <= 128

Yes

device_firmware_version

string

The firmware version of the device.

Any

1 <= length <= 128

No

device_model

string

The model of the device.

Any

1 <= length <= 128

No

device_manufacturer

string

The manufacturer of the device.

Any

1 <= length <= 128

No

Example
{
  "api_version": "1.0",
  "event_type": "gateway_state",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "event_reference_id": "e4f0da9f-056b-49c8-80fa-af42614e150c",
  "gateway_serial": "PGGW000000058",
  "gateway_app_version": "v1.5.0",
  "device_connected_list": [
    {
      "device_serial": "M2MR111100928",
      "device_firmware_version": "v2.2.0",
      "device_model": "Mark Two",
      "device_manufacturer": "Workaround GmbH"
    },
    {
      "device_serial": "M2MR111100942",
      "device_firmware_version": "v2.0.0",
      "device_model": "Mark Two",
      "device_manufacturer": "Workaround GmbH"
    }
  ]
}
In this section: