Skip to main content

ProGlove Documentation

Scanner connectivity command

This command is used for managing connections between the Gateway and scanners.

Response: If successful, the scanner will connect or disconnect, depending on its current status. Error event might be returned if trying to connect more devices than it is supported.

Note

Disconnections may not happen automatically. If only connection is commanded, and gateway device already have maximum of supported connections created, new connection will not be initiated, and error will be thrown.

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.

scanner_connectivity!

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

connect

boolean

States that connection with scanner device should be initiated.

true

Not required if disconnect is set. It is allowed to set both.

Yes

disconnect

string

Either:

  • an array of serial numbers of scanners that need to get disconnected

  • all keyword for disconnecting all scanners is accepted

Either:

  • array of serial numbers

  • all keyword

If array of serial numbers:

  • 1 <= array size <= 50

  • 1 <= serial number length <= 128

Not required if connect is set. It is allowed to set both.

Example
{
  "api_version": "1.0",
  "event_type": "scanner_connectivity!",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "disconnect": ["MDMR100000001", "MDMR10000002"],
  "connect": true
}
{
  "api_version": "1.0",
  "event_type": "scanner_connectivity!",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "disconnect": "all",
  "connect": true
}
In this section: