License
An OmniBus gateway installed with the OmniBus installer (.run) is licensed.
System → License (administrators) shows what the license covers, who it is
licensed to and the key it uses, and is where a key is entered, moved or
removed.
What a license covers
A license covers a number of ports (each serial port or network connection counts as one) and a set of driver families:
| Driver family | Drivers |
|---|---|
| Every plan | Raw serial, Modbus (RTU, inline, TCP client), M-Bus |
| VRF HVAC | Samsung, Daikin, Mitsubishi, LG and Toshiba VRF, Mitsubishi MELANS (AE-200/EW-50) |
| BACnet | BACnet MS/TP ports and the BACnet/IP object server |
| Security | OSDP |
| Building and pool | Johnson Controls N2, DNP3, Pentair, Jandy |
MQTT/Sparkplug, the Modbus/TCP object server and Prometheus metrics are in every plan.
Nothing that is running stops
The license never stops a port that is already configured, whatever its driver. What it refuses is growth:
- adding a port beyond the number the license covers
- choosing a driver from a family the license does not include, on a new port or by changing an existing port's protocol
- switching the BACnet/IP object server on
A port already using a licensed driver keeps it, and its other settings stay editable. The refusal says why, and what to do.
Trial
A new gateway starts a 30-day trial the first time it reaches the OmniBus license server, with every driver family included. Until it first reaches the server, it works as a trial for up to 14 days. After that it needs a license key or a license file.
Entering a license key
Open System → License, enter the key (OMB-XXXX-XXXX-XXXX-XXXX) and choose
Activate. Letters may be typed in either case; a mistyped key is caught
before it is sent. The installer can also activate one:
sudo ./omnibus-VERSION-linux-ARCH.run -- --install --license-key OMB-XXXX-XXXX-XXXX-XXXX
A key covers a set number of gateways. If it is already in use, the License tab says where, and offers Move the license here, for a gateway that was replaced or reinstalled. A key can be moved twice in 90 days; after that, contact support. Remove from this gateway frees its place.
The license is renewed with every update check, and Check now renews it at once. A gateway that cannot reach the license server keeps its license for 30 days, then for 14 more days of grace, and then works as unlicensed until it reaches the server again.
A gateway with no internet
Gateways often sit on a building network with no route out. They are licensed by file:
- Open System → License and, under Without an internet connection, choose Download license request. The file names this gateway and is signed by it, so nothing in it can be mistyped or altered on the way.
- Send the file to your OmniBus supplier. They return a license file for this gateway.
- Choose Import a license file and pick it.
A license file only works on the gateway that asked for it. It lasts until the license ends, or a year for a perpetual license; the License tab shows when it runs out. Renew it the same way before then.
Updates
A license may include updates until a date; the gateway is then offered the newest release published before it. Security fixes are offered to every gateway. A release uploaded by hand under System → Maintenance follows the same rules: one made after the license's update date is refused with the reason, and an unlicensed gateway accepts only security fixes.