DeviceHub Networking Requirements and Technical Specifications for ShipAccel

DeviceHub is a program that connects your printers and scales to ShipAccel. The following are required in order for DeviceHub to work properly on your network.
Products affected: ShipAccel

DeviceHub is a program that connects your printers and scales to ShipAccel. The following are required in order for DeviceHub to work properly on your network.

Technical Specifications

Ports

The following ports are used for the communication with AWS IoT and AWS API Gateway:

External ports:

  • 8883 - MQTT
  • 443 - HTTPS / MQTT

Internal ports:

  • 443: Websocket
  • Secure Web Socket: for DeviceHub Registration Process
  • 10001, 10002, 10003 (whichever is open) - Secure Websocket

Inputs

  • AWS IoT messages with small JSON payloads
  • Jobs
    • Print - GIF file for INDICIA and PDF file for sheet
    • Scale

Outputs

  • Events
    • Heartbeats with Health checks
    • Notifications: if the upgrade is available.
    • USB and Job (print) details
  • Scale Data
  • Scanned address (ASCII format) using Optical Character Recognition (OCR) scanner

Storage

  • x.509 certificates or root certificate authority (CA) - device certificates (.crt, .pem, and root CA)
  • Configurations: number of devices, registered devices, scale, and last shadow state
  • Logs for diagnosis & troubleshooting
  • HTML pages for Out of Box (OOB) process
  • No PII info is stored within DeviceHub
  • No local database

Communications

Localhost or 127.0.0.1 is used for device activation.

DeviceHub supports IPV4 only.

Operating System Requirements

Windows

  • DeviceHub is verified on 64-bit versions of Windows 10 and Window 11.
  • The latest version updates must be installed.
  • DeviceHub must be installed on the C drive.

Mac

DeviceHub is verified on the following Mac OS versions:

  • MacOS Catalina
  • MacOS Big Sur
  • MacOS Monterey validated through 12.5
  • MacOS Ventura validated through 13.2.1

Note: DeviceHub activation is not supported in the Safari web browser at this time.

Whitelist

The following address must be whitelisted. DeviceHub does not support SSL packet inspection, and all domains should bypass that inspection.

  • iot-iad.devicehub.pitneybowes.com
  • iot-pdx.devicehub.pitneybowes.com
  • *.sendpro360.pitneycloud.com
  • devicehub.pitneybowes.com (MQTT connections)
  • Used to determine if internet connectivity is available or if proxy server may be needed:
    • devicehub.pitneybowes.com (443)
    • www.pitneybowes.com
  • devicehubsetuppackages.s3.amazonaws.com
  • *.s3.amazonaws.com (for downloading documents to print)

Technical Architecture

  • A print request from ShipAccel is sent to DeviceHub for shipping labels, stamp rolls, stamp sheets, and barcodes.
  • The print request is submitted to AWS API Gateway/Lambda.
  • The request is verified using a unique device signature from Mongo DB.
  • AWS API Gateway submits the print job to DeviceHub Agent through AWS IoT core via a secure channel with x.509.
  • DeviceHub Agent prints the INDICIA (gif) & Sheet (PDF) using the job information and passes the print confirmation to AWS IoT core.

dh-architecture

Related topics

UPDATED: October 04, 2024