Integration Guide

Introduction

A guide to integrating the enVision K150S device into your operation.

Overview

The enVision K150S is a versatile dimensioning device. It natively supports a growing list of of weigh scales and barcode scanners and is fully configurable to work in numerous operating modes. When integrating a K150S, it is important to consider how you would like the device to behave based on your requirements. A key factor in this process is determining the type of "measuring trigger" you wish to take advantage of.

A "Measure Trigger" in this context refers to the source of the action that causes the device to perform a single measure operation. The options available are dependent on a number of factors such as the type of host system (the system that wishes to consume measurement transactions created by the device), the peripherals involved and the operating envionment.

Cloud Native

The enVision K150S device is cloud native, and must be able to communicate with enVision Cloud on startup. Measurement transactions generated by K150S devices are always pushed to enVision Cloud. Regardless of whether a measurement was triggered via a local action, or through the onboard local API, or via Cloud Triggering, the transaction data is sent to enVision Cloud and stored for future reference.

Consult the enVision Cloud API Guide for information on access enVision Cloud data.

Supported Trigger Types

When integrating a K150S device, a key decision is how the device should trigger. More plainly, what action or operation is to be performed that should cause the device to perform a measure operation? The K150S supports three categories of triggers:

  1. Local Trigger
  2. Onboard API Trigger
  3. Cloud Trigger

Each of these is discussed in more detail below. Whenever a local trigger type is used, captured transactions must be retrieved from enVision Cloud using enVision Cloud APIs.

Local Trigger

A Local Trigger refers to a category of triggers that originate from within the device itself, rather than from an external source. enVision K150S supports two types of Local Triggers:

Barcode Scan Trigger

Barcode Scan Trigger refers to a trigger that occurs when a barcode is scanned from a supported scanner that is connected to the K150S device. Use of this trigger requires that a compatible barcode scanner is plugged into a USB port on the base of the device.

Weigh Scale Trigger

Weigh Scale Trigger refers to a trigger that occurs when a scale weight changes. Use of this trigger requires a compatible weigh scale to be plugged into a USB port on the base of the device. When enabled, enVision K150S will trigger a measure operation when the scale weight changes from zero to non-zero (i.e. when an item is placed on the scale to be measured).

NOTE

These triggers are applicable only if the peripherals mentioned are connected directly to the K150S device. If a scale and/or barcode scanner is being used through the host system then you must use the Cloud Trigger and/or Onboard API Trigger types instead.

Onboard API Trigger

The enVision K150S device hosts a set of onboard HTTP APIs that can be called from other applications on the same network. These APIs can be used when a host application on the same network wishes to control when the device should measure in order to immediately consume the result. That is, some action is taken within the host system (such as a barcode scan, a button click or a keystroke is entered), and that action triggers a K150S device to measure. In such scenarios, the host application makes the request and receives the response immediately. Note that transaction results will still be published to enVision Cloud for future reference.

Consult the Onboard API Overview for more information.

Cloud Trigger

The final trigger type supported with the enVision K150S device is called Cloud Trigger. With Cloud Trigger, you can securely trigger a K150S device to measure from anywhere by calling an enVision Cloud endpoint from the host application without having to be concerned with managing device IP addresses. This option is suitable for applications where the host application is not running on the same network as the physical device (like a browser-based application), or the network environment is such that managing changing addresses of multiple devices is prohibitive.

Consult the Cloud Trigger Guide for more information on Cloud Triggering.

Retrieving Measurement Transactions

enVision Cloud provides multiple ways of consuming measurement transaction data in your applications:

  1. Cloud Triggering enables your application to trigger any support device to measure and makes the response available immediately for processing.
  2. Webhooks allow you to configure endpoint handlers that are called by enVision Cloud whenever measurement transactions are generated by devices in your fleet.
  3. enVision Cloud Transactions API allows you to fetch transactions in bulk based on various criteria, such as date ranges.

Copyright © PHD Solutions 2024