Skip to main content

Devices App

Devices are the physical gateways that connect your equipment to the platform. Each device is a cellular industrial gateway installed on an asset, responsible for collecting sensor data from the equipment and transmitting it securely to the cloud in real time.


๐Ÿ“– What Is a Device?โ€‹

In the platform, a Device (also referred to as a Gateway) is the hardware bridge between a physical asset and the platform. It reads data from the asset's onboard controller โ€” pressure readings, runtime hours, engine status, fault codes, and more โ€” and sends that data to the platform over a secure cellular or network connection.

Each asset has one dedicated gateway. Once a gateway is registered and activated, the asset begins transmitting live telemetry automatically.

Key Terminologyโ€‹

TermMeaning
Device / GatewayThe cellular industrial gateway installed on the asset
Asset / MachineThe equipment the gateway is connected to (e.g., a compressor)
ConnectorThe communication protocol used to interface with the asset's controller (Modbus, Canbus, or BLE)
TSNTelematics Serial Number โ€” the unique identifier linking the gateway to its asset
OTAOver-the-Air update โ€” remotely pushing firmware or configuration changes to a gateway

๐Ÿ–ฅ๏ธ Devices Dashboardโ€‹

The Devices landing page presents three real-time summary panels at the top, followed by the full device list.

Summary Panelsโ€‹

๐Ÿ“Š Device Statistics โ€” A line chart showing the count of Available vs. Unavailable devices over time. Use this panel to monitor fleet connectivity health at a glance โ€” a sudden drop in available devices may indicate a network or power issue in the field.

๐Ÿ”ต Device Status โ€” A pie chart breaking down the current status distribution of all devices across the four lifecycle stages: Provisioned, Registered, Activated, and Available/Unavailable.

๐Ÿ”Œ Device Connector Statistics โ€” A pie chart showing the breakdown of connector protocols in use across all registered devices โ€” Modbus, Canbus, and BLE.

Device Listโ€‹

Below the summary panels, the Device List displays every gateway in the system.

What does each column mean?
ColumnDescription
NameGateway display name
Serial NumberUnique hardware serial number of the gateway
ModelGateway hardware model
StatusCurrent lifecycle status โ€” see status definitions below
Last CommunicatedTimestamp of the most recent data transmission from this gateway
ActionRegister or configure the device

Available tools: Search by name or serial number ยท Toggle between grid and list views ยท Bulk select with checkboxes


๐Ÿšฆ Device Status Definitionsโ€‹

Every gateway progresses through the following lifecycle stages.

StatusColorMeaning
Provisioned๐ŸŸก OrangeThe gateway has been manufactured and pre-configured. It is powered on and communicating with the platform, but has not yet been registered to an asset.
Registered๐ŸŸข GreenThe gateway has been registered by a user, linked to an asset via its Telematics Serial Number, and is ready to transmit data.
Activated๐ŸŸข GreenThe associated asset is active and the gateway is transmitting live sensor data.
Available๐ŸŸข GreenThe gateway is online and connected.
Unavailable๐ŸŸ  OrangeThe gateway is offline or not currently reachable.

๐Ÿ’ก A device in Provisioned status is waiting to be registered. If you have installed a new gateway in the field and it is not yet appearing as Registered, it will show here as Provisioned until you complete the registration process.


๐Ÿ” Device Detail Viewโ€‹

Click any device name in the list to open its detail page. The page is organized into four information panels and a Job Details log.

๐Ÿ“‹ Device Infoโ€‹

What does each field mean?
FieldDescription
Serial NumberHardware serial number of the gateway unit
Telematics #The TSN linking this gateway to its associated asset
ModelHardware model designation
ManufacturerGateway hardware manufacturer
Firmware VersionCurrently installed firmware version on the device

โš™๏ธ Device Configurationโ€‹

What does each field mean?
FieldDescription
Connection TypeNetwork protocol in use (e.g., 3G, 4G LTE)
IMSIIdentifies the SIM card
ICCIDSIM card serial number
SIM ProviderCellular carrier providing connectivity
IMEIHardware identifier for the cellular module

๐Ÿ”Œ Device Connector Infoโ€‹

What does each field mean?
FieldDescription
StatusCurrent registration status (Provisioned, Registered, Activated)
Connector TypeCommunication protocol in use โ€” Modbus, Canbus, or BLE
Connector VersionInstalled version of the connector configuration
AvailabilityWhether the connector is currently available or unavailable
Last ConnectedTimestamp of the most recent successful connector communication

๐Ÿ“ Device Locationโ€‹

Displays the last known GPS coordinates and physical location of the gateway, updated with each data transmission. If no location data has been received yet, this panel will show "Not found."

๐Ÿ”ง Job Detailsโ€‹

A log of all Over-the-Air (OTA) update jobs that have been dispatched to this gateway.

What does each column mean?
ColumnDescription
ActivityDescription of the job (firmware update, configuration update, etc.)
VersionThe version being deployed
StatusCurrent job state (pending, in progress, completed, failed)
Created AtWhen the job was initiated
Completed AtWhen the job finished

๐Ÿ“ Device Registrationโ€‹

Before a gateway can transmit live data, it must be registered and linked to its corresponding asset. Registration is a one-time process performed when a new gateway is deployed in the field.

The Registration Lifecycleโ€‹

๐Ÿ“ฆ Provisioned
Gateway is powered on and communicating with the platform.
Awaiting registration.
โ†“
๐Ÿ“ Registered
User registers the gateway using its serial number.
Gateway is linked to an asset via its Telematics Serial Number.
Initial firmware and connector configuration are applied.
โ†“
โœ… Activated
Asset is activated. Gateway begins transmitting live sensor data.
โ†“
๐ŸŸข Available / ๐ŸŸ  Unavailable
Ongoing connectivity status โ€” updates in real time.

How to Register a Gatewayโ€‹

  1. Locate the gateway's serial number on the physical unit or in the Device List (where it will appear as Provisioned)
  2. Click the registration action (โž• icon) on that device's row
  3. Enter the serial number to confirm the device
  4. The platform links the gateway to its associated asset using the Telematics Serial Number
  5. An initial firmware update and default connector configuration are applied automatically
  6. The device status changes to Registered and begins transmitting data

โš ๏ธ Non-obvious: The gateway must be powered on and connected to a network before registration can complete. A device that cannot reach the platform will not advance past the Provisioned state.


๐Ÿ”Œ Connector Typesโ€‹

The connector is the communication protocol the gateway uses to read data from the asset's onboard controller.

ConnectorProtocolTypical Use
ModbusSerial / TCP-IPIndustrial controllers, PLCs, compressors, drives
CanbusCAN 2.0Mobile equipment, vehicle-based controllers
BLEBluetooth Low EnergyWireless sensors, beacon-based part tracking

The connector type is configured during registration and can be updated remotely via an OTA configuration update at any time.


๐Ÿ“ก Over-the-Air (OTA) Updatesโ€‹

The platform supports two types of remote updates that can be pushed to any registered gateway without requiring physical access to the device.

Firmware Updatesโ€‹

Deploys a new version of the gateway's core software โ€” used to introduce new capabilities, apply security patches, or resolve known issues. Once dispatched, the gateway downloads the new version, applies it, and restarts the necessary services automatically. The updated firmware version is reflected in the Device Info panel after completion.

Connector Configuration Updatesโ€‹

Updates the configuration that controls how the gateway communicates with the asset's controller. Used when sensor parameters change, new data points need to be enabled, or connector settings need to be adjusted for a specific asset model. The new sensor data begins flowing to the platform immediately after the gateway applies the updated configuration.

๐Ÿ“Œ All OTA job activity is logged in the Job Details section of the device detail page, including the activity description, version deployed, and completion status โ€” providing a full audit trail of every remote update performed on the device.


๐Ÿ”„ Common Workflowsโ€‹

Workflow 1 โ€” Deploying a New Gateway in the Fieldโ€‹

  1. Install the gateway hardware on the asset
  2. Power the device on โ€” it connects automatically and appears as Provisioned in the Device List
  3. In the Devices app, locate the device by its serial number
  4. Click the registration action and complete the registration form
  5. Confirm the TSN to link the gateway to the correct asset
  6. The platform pushes the initial firmware and connector configuration automatically
  7. Device status advances to Registered, then Activated
  8. Verify live data is flowing via the asset's Sensors tab

โœ… Result: The gateway is live, transmitting sensor data, and fully visible in the platform.


Workflow 2 โ€” Pushing a Configuration Update to a Gatewayโ€‹

  1. Navigate to Devices and open the target device
  2. Review the current Connector Type and Connector Version in the Device Connector Info panel
  3. Initiate a configuration update job with the new configuration file
  4. Monitor the job status in the Job Details section โ€” it will progress from pending to completed
  5. Once complete, verify the new sensor data is flowing correctly via the asset's Sensors tab

โœ… Result: The gateway's connector configuration is updated remotely with no physical access required. The new data points are live immediately.


Workflow 3 โ€” Investigating an Offline Gatewayโ€‹

  1. In the Device List, identify devices with Unavailable status
  2. Check the Last Communicated timestamp โ€” how long has the device been offline?
  3. Open the device detail and review the Device Connector Info panel for the last connected timestamp
  4. Check the Device Configuration panel to confirm the SIM Provider and Connection Type are as expected
  5. If the device was recently online, the issue may be a temporary network disruption โ€” monitor for reconnection
  6. If the device has been offline for an extended period, dispatch a field technician to inspect the hardware and network connection

โœ… Best Practicesโ€‹

  • ๐Ÿ”‘ Register gateways before deploying assets. Completing registration before the asset goes into service ensures live data flows from the first day of operation, with no gap in the telemetry history.
  • ๐Ÿ“‹ Record serial numbers during installation. The gateway serial number is the primary identifier during registration. Capturing it at the time of installation โ€” before the equipment is in a hard-to-reach location โ€” saves time later.
  • ๐Ÿ”„ Keep firmware current. Use OTA firmware updates to maintain gateways on the latest version. Outdated firmware can cause connectivity issues or limit the platform's ability to receive new sensor data types.
  • ๐Ÿ“ Use device location data to verify field deployments. The Device Location panel confirms that a gateway is physically where it is supposed to be โ€” useful for multi-site deployments.
  • ๐Ÿ”Œ Match the connector type to the asset's controller. Modbus is the most common for industrial compressors and machinery. Confirm the correct protocol before applying a connector configuration update.

๐Ÿ’ก Tips & Shortcutsโ€‹

TipHow
Find a specific gatewaySearch by gateway name or serial number in the Device List
Check fleet connectivity at a glanceThe Device Statistics chart shows Available vs. Unavailable counts without opening individual devices
Identify unregistered hardwareFilter or scan for devices in Provisioned status โ€” these are installed but not yet registered
Track OTA job progressOpen the device detail page and check the Job Details section for real-time job status
Verify after a configuration updateAlways confirm new sensor data is flowing in the asset's Sensors tab after any connector configuration change