ProGlove Streams API 3.4.12

Event-based API to interface between customer integration apps and edge connected devices

  • #ProGlove
  • #Insight
  • #Gateway

Operations

  • RECEIVE button_pressed

    Channel delivering button_pressed notifications from the edge.

    Events on button presses on connected devices.

    Operation IDbutton_pressed

    Accepts the following message:

    Message IDbutton_pressed-event

    Event messages notifying a button pressed.

    object [Worker Feedback domain button_pressed event stream schema]

    Schema of event data sent in the button_pressed stream

    Examples

  • SEND capture_image

    Channel delivering image capture requests to the edge.

    Command to capture an image on a connected device.

    Operation IDcapture_image

    Accepts the following message:

    Message IDcapture_image-event

    Event messages requesting an image capture.

    object [Image Capture Request domain capture_image! command stream schema]

    Schema of image capture command data sent in the capture_image! stream

    Examples

  • SEND display

    Channel posting display commands to the edge.

    Command to display visual content on a connected device.

    Operation IDdisplay

    Accepts the following message:

    Message IDmessage

    Command messages to interface with a display capable connected device

    object [Worker Feedback domain display! command stream schema]

    Schema of feedback command data sent in the display! stream to render text on display devices

    Examples

  • SEND display_v2

    Channel posting display_v2 commands to the edge.

    Operation IDdisplay_v2

    Accepts the following message:

    Message IDdisplay_v2-command-event

    Command messages to interface with a display capable connected device

    object [Worker Feedback domain display_v2! command stream schema]

    Schema of the display_v2! command stream to set multiple screen views on a compatible device

    Examples

  • RECEIVE display_v2-event

    Channel posting display_v2 events to the edge.

    Operation IDdisplay_v2-event

    Accepts the following message:

    Message IDdisplay_v2-event

    Command messages to interface with a display capable connected device

    object [Worker Feedback domain display_v2 event stream schema]

    Schema of the display_v2 event stream received when the device triggered an event like a timer has expired or a UI component has been clicked.

    Examples

  • RECEIVE errors

    Channel delivering errors notifications from the edge.

    Error events encountered on an edge device.

    Operation IDerrors

    Accepts the following message:

    Message IDerrors-event

    Event messages notifying an error.

    object [Error notification stream.]

    Schema of error event sent in the error stream.

    Examples

  • SEND feedback

    Channel posting feedback commands to the edge.

    Command to cause feedback to the user on a connected device.

    Operation IDfeedback

    Accepts the following message:

    Message IDfeedback-event

    Command messages to interface with a feedback capable connected device

    object [Worker Feedback domain feedback! command stream schema]

    Schema of feedback command data sent in the feedback! stream

    Examples

  • SEND gateway_state

    Channel posting Gateway state commands to the edge.

    Command to request edge devices state including current software and configuration.

    Operation IDgateway_state

    Accepts the following message:

    Message IDgateway_state-event

    Command messages to request the Gateway state.

    object [Gateway state command schema.]

    Schema of the command to request the Gateway state.

    Examples

  • RECEIVE gateway_state-event

    Channel posting Gateway state events from the edge.

    Events on an edge devices software and configuration state.

    Operation IDgateway_state-event

    Accepts the following message:

    Message IDgateway_state-event

    Events messages notifying the Gateway state.

    object [Gateway state event schema.]

    Schema of the event sent to report the Gateway state.

    Examples

  • RECEIVE photo_report_status

    Channel posting photo report status events from the edge.

    Events on the status of photo reports ongoing on connected devices.

    Operation IDphoto_report_status

    Accepts the following message:

    Message IDphoto_report_status-event

    Command messages to report upload status of a photo report to insight.

    object [Photo report sent schema.]

    Schema of the event sent to notify the status of the photo report (creating/created) for customer integrations.

    Examples

  • SEND process_identifiers

    Channel posting set process identifiers request events from the edge.

    Command to set the process identifiers on a connected device.

    Operation IDprocess_identifiers

    Accepts the following message:

    Message IDprocess_identifiers-event

    Command messages to set the process identifiers..

    object [Set process identifiers stream schema]

    Schema for setting process identifiers via Streams API stream. When a customer sets a process identifier, the connectivity device will decorate the event with the provided data. Process identifiers should be set for every scanner independently.

    Examples

  • RECEIVE scan

    Channel delivering scan notifications from the edge.

    Events on scans taken on a connected device.

    Operation IDscan

    Accepts the following message:

    Message IDscan-event

    Event messages notifying a scan from a connected device

    object [Scanner domain scan event stream schema]

    Schema of scan event data sent in the scan stream

    Examples

  • RECEIVE scanner_connectivity

    Channel posting scanner connectivity commands from the edge.

    Events on connected devices on the edge appearing or disappearing.

    Operation IDscanner_connectivity

    Accepts the following message:

    Message IDscanner_connectivity-event

    Command messages to control the connectivity of attached devices.

    object anyOf

    Schema for managing scanners connectivity.

    Examples

  • RECEIVE scanner_state

    Channel delivering scanner state notifications from the edge.

    Events propagated to update on the state of connected devices.

    Operation IDscanner_state

    Accepts the following message:

    Message IDscanner-state-event

    Event messages notifying a scanner state change.

    object [Scanner state event stream schema]

    Schema of scanner state event sent in the scanner_connection stream.

    Examples

  • SEND trigger_block

    Channel posting trigger block commands to the edge.

    Command blocking some button actions on connected device.

    Operation IDtrigger_block

    Accepts the following message:

    Message IDtrigger-block-event

    Command messages to interface with a trigger blocking capable connected device

    object [Trigger block domain trigger_block! command stream schema]

    Schema of trigger block command data sent in the trigger_block! stream

    Examples