Tricolops Dimensioning Application Integration Guide

This guide outlines different methods to obtain dimensions from Tricolops Dimensioning application, allowing you to print shipping labels directly from a barcode scan. The Tricolops Dimensioning application can be downloaded here. Follow this guide to setup the Tricolops Dimensioning application.
A scale or Tricolops dimensioner connection is not required for testing, the application will simply respond with 0 values if the scale or dimensioner is not connected.

There are 2 ways to get dimensions from the Tricolops Dimensioning application:

  • TCP/IP socket

  • Webserver / RESTful API

TCP/IP

It is recommended to use TCP/IP method if you are using a Windows or Linux Desktop application.

  • With the Tricolops Dimensioning application running, the application will listen to port 59086 on localhost (127.0.0.1)

  • Once communication is established, the program will respond to the following ASCII character commands:

    Command
    Function
    Example reply
    D
    Return dimensions of the object (dimensions are always in mm)
    0.0 0.0 0.0 (if no object detected)
    12.3 13.3 14.3 (object detected)
    d
    Return dimensions of the object
    (dimensions are as displayed)
    0.0 0.0 0.0 (if no object detected)
    12.3 13.3 14.3 (object detected)
    W
    Weight captured by the scale
    (weight is always in kg)
    0.41
    w
    Return weight of the object
    (weight is as displayed)
    0.41
    T
    Send test dimensions (Can be used without a dimensioner connected)
    1.23 12.3 123.0
    Q
    Terminate communication (the
    communication socket will be closed)
    N/A
    K
    Terminate Tricolops Dimensioning App
    (the communication socket will be closed and Tricolops Dimensioning App will
    exit)
    N/A

    Sample Screen Shot:

Webserver / RESTful API

It is recommended to use the RESTful API method if you are using a web application to communicate with the Tricolops Dimensioning app

  • The application will listen to HTTP port 8080 on localhost (127.0.0.1) while it is running.
  • The HTTP port can be configured by going to Advanced -> Settings -> Advanced -> Webserver Port
  • The API end point is http://127.0.0.1:8080/data.
  • Sample data
    NOTE: dimensions are always in mm, weight is always in kilograms
    {
      "length": "388.113037",
      "width": "321.346466",
      "height": "689.845215",
      "weight": "11.920000",
      "status": "7",
      "message": "Object detected"
    }
    { "length": "0.000000", "width": "0.000000", "height": "0.000000", "weight": "0.000000", "status": "0", "message": "Device not connected"
    }
  • List of status and codes:
    Status State
    0INIT – Application is running, but no dimensioner is connected
    1CONNECTING – Application is attempting to connect to a dimensioner
    2REQUIRE_SETUP – Additional setup is required (setting dimension area)
    3CONNECTED – Application has successfully connected to the dimensioner
    4WARMUP – Dimensioner is warming up
    5NOT_READY – Dimension area is not flat / not perpendicular to surface
    6READY – Dimensioner is dimensioning packages but no package is detected in dimension area
    7DIMENSIONING – Package is detected in dimension area, if package is dimensioned successfully, length, width, and height will be non-zero. If the package cannot be dimensioned (out of field of view, too reflective, or dark), length, width, and height will be zero.

Need more info?

This documentation page has been extracted from the Q&A section where you can discuss it and get feedback.
Related question