Skip to main content
Version: 8.3

Installation

Prerequisites

  • Ignition 8.3.0 or higher
  • One or more LoRaWAN gateways speaking the Semtech Packet Forwarder UDP protocol
  • Network connectivity between gateways and Ignition (inbound UDP, default port 1700)
  • No required Ignition modules
Paid Module

The LoRaWAN module runs in trial mode until licensed. See Licensing for what happens when the trial expires.

Ignition Edge

On Ignition Edge, the module is capped at 50 devices.

Download

Download LoRaWAN Module

Installation Steps

  1. Log in to your Ignition Gateway web interface
  2. Navigate to Platform > System > Modules
  3. Click Install or Upgrade a Module
  4. Select the LoRaWAN.modl file
  5. Review and accept the license agreement
  6. The module installs automatically

Verification

After installation:

  1. Verify the module appears in the modules list with Running status
  2. Navigate to Connections > LoRaWAN
  3. You should see three menu items: Settings, Gateways, Devices

Upgrading from Ignition 8.1

The module contains no automatic migration code. Installing the 8.3 build leaves the 8.1 configuration in place, untouched and unread.

Move devices and gateways with CSV

The 8.1 build stored everything as PersistentRecord rows in the gateway's internal database; the 8.3 build stores each object as a config resource:

8.1 record8.3 resourceManaged atCarried over by
SettingsRecord (singleton)lorawan-settingsConnections > LoRaWAN > SettingsRe-enter (4 fields)
GatewayRecordgatewayConnections > LoRaWAN > GatewaysCSV
DeviceRecorddeviceConnections > LoRaWAN > DevicesCSV
DecoderRecorddecoderConnections > LoRaWAN > Devices (Decoders tab)Re-enter

Both builds ship the same CSV import/export with identical column layouts, so the bulk of the configuration moves across without retyping.

On the 8.1 gateway, export with the scripting functions — that build has no web UI:

system.lorawan.exportDevices("/tmp/devices.csv")
system.lorawan.exportGateways("/tmp/gateways.csv")

On the 8.3 gateway, import the two files. The Devices and Gateways pages each carry Export CSV and Import CSV buttons, which is the easiest route; the same operations are also available over REST (POST /devices/import, POST /gateways/import) and from scripting:

system.lorawan.importDevices("/tmp/devices.csv")
system.lorawan.importGateways("/tmp/gateways.csv")

Both pages also offer a template download (GET /devices/template, GET /gateways/template) if you would rather build the file from scratch than export one.

Import is an upsert matched by EUI and is best-effort: invalid rows are collected into a JSON report rather than aborting the run, and column order is flexible (headers are matched by name, case-insensitively). Check the returned report for skipped rows.

What CSV does and does not carry

The device CSV columns are name, devEui, mode, deviceClass, decoder, appKey, devAddr, nwkSKey, appSKey, fCntUp, fCntDown; the gateway CSV columns are name, eui, description, location.

ABP devices therefore keep their session — address, session keys, and frame counters all travel in the file. OTAA devices keep their appKey but not the live session, so they re-join after the upgrade. Decoders have no CSV: copy each decoder script over by hand, and make sure a device's decoder column names a decoder that exists on the 8.3 gateway before importing.

What is new

  • A full admin web UI — the 8.1 build has only the Settings page; gateways, devices, and decoders were managed by script.
  • A REST API alongside the system.lorawan.* scripting functions.
  • Settings gained a region field. It has a default, so a settings resource written by an earlier 8.3 release still loads.

Network Requirements

Inbound (Gateways to Ignition)

The Ignition gateway must accept UDP traffic from LoRaWAN gateways:

SourceProtocolPortBind AddressDescription
LoRaWAN GatewaysUDP1700 (default, configurable)0.0.0.0 (default)Semtech Packet Forwarder
Firewall Configuration

Ensure your firewall allows inbound UDP traffic on the configured port (default 1700) from all gateway IP addresses.

Restart Required

Changing the UDP port or bind address requires a gateway restart to take effect. See Configuration.

Gateway Configuration

Configure your LoRaWAN gateways to point to the Ignition server:

{
"server_address": "your-ignition-server-ip",
"serv_port_up": 1700,
"serv_port_down": 1700
}

Compatible Gateways

The module works with any gateway using the Semtech Packet Forwarder UDP protocol.

Tag Provider

After installation, a managed tag provider [LoRaWAN] is created automatically:

[LoRaWAN]
├── _Meta/
│ ├── DeviceCount
│ ├── ActiveDeviceCount
│ ├── GatewayCount
│ └── ConnectedGatewayCount
├── Devices/
│ └── {DeviceName}/
└── Gateways/
└── {GatewayName}/

See Per-Device Tags for the full structure.

Troubleshooting

IssueSolution
Module not appearingRestart the Ignition gateway and check logs
LoRaWAN menu not visibleClear browser cache and refresh
Gateways not connectingCheck UDP port, firewall rules, and gateway configuration
[LoRaWAN] tags report Bad_TrialExpiredModule trial has expired; apply a license to restart the network layer
[LoRaWAN] tags not visibleModule may need a restart; check gateway logs