Site gateways
A computer at the site that reads its industrial equipment, keeps rules and alarms running when the internet is down, and gives operators a screen on the site's own network.
Availability
Gateways are part of Sites, which is switched on per account. To use them, write to MaxwellTrack support.
When to use one
Most equipment connects directly, with a board running the device library or through the device report API. A gateway is for a site that needs more than that:
- Equipment that already speaks an industrial language: meters and drives on RS-485 cables, controllers on the site's network, machines and generators on a CAN bus.
- Many readings in one place: up to 1,000 readings and 64 local rules on one gateway.
- A site that must keep working, and keep its history, when the internet is down.
- A control room that needs its own screen on the site's network.
| A gateway reads | How it connects | Set up with |
|---|---|---|
| Meters, drives and sensors on an RS-485 cable | Modbus RTU, through an RS-485 adapter | Port, baud rate and parity |
| Controllers and meters on the site's network | Modbus TCP | Address and port |
| Controllers and servers that publish their values | OPC UA | Server address |
| Vehicles, generators and machines | CAN, through a CAN interface | Interface, plus the machine's DBC file |
What you need
- A Linux computer at the site, 64-bit, such as an industrial PC or a Raspberry Pi 4 or 5, with internet access and a connection to the equipment: the site's network, an RS-485 adapter or a CAN interface.
- Someone who can install software on that computer. The download includes the installation steps and the computer's requirements, in
INSTALL.txt.
Add a gateway
- 1
Download the software
Open Sites > Gateways and choose Download software, or Add gateway and the download in step 1. Copy the file to the site computer.
- 2
Install it
Whoever sets up the computer follows
INSTALL.txtin the download. At the end, the installer shows a code such asABCD-EFGH. - 3
Enter the code
In Add gateway, enter the code, a name and the site it belongs to, then choose Add gateway. The gateway connects within a few seconds and shows online in the list.
The code is also on the gateway's site screen until the gateway is added. It is valid for 24 hours; after that a new one appears there. Nobody types a password or a credential into the gateway: the code links it to your account, and only that gateway can use the result.
Check the code
Add the gateway with the code shown on the computer you installed. If Add gateway says the code is not valid, check it on the site screen: it may have been replaced by a new one.
Connect the equipment
Everything about the site's equipment is set in the console, never on the computer. Open the gateway from the Gateways list; its Controller tab has:
| Section | What you set |
|---|---|
| Buses | Where the gateway finds the equipment. Add bus and choose the kind: Modbus RTU (RS-485), Modbus TCP, OPC UA or CAN. |
| Equipment | Meters and drives on a Modbus bus. Pick the Model to load its registers, or a Custom register with its Register kind, Address on the bus, Scale and how often to read it. |
| OPC UA readings | Add OPC UA node: the node id on the server, the reading it fills and how often to sample it. |
| CAN signals | Import CAN signals: choose the machine's DBC file, then the signals to read. The file is read in your browser. |
| Local rules | Rules the gateway runs itself, with or without internet. Use Test the rules before you save. |
Each reading becomes a datastream of the gateway, so its values appear on dashboards, diagrams, trends and alarms like any other device's. Changes reach the gateway within seconds.
How often readings are sent
A gateway sends a reading when it changes by more than its deadband, and at least every 5 minutes by default when it is steady. A reading that barely moves therefore costs little: each value sent is metered as one reading, so set a deadband on noisy values. See Billing.
Local rules
Local rules act on the site without the cloud, for example: when the tank level is above 95% for 10 seconds, stop the fill pump. Set the Reading, the Limit, how long it must hold (For (seconds)) and what to set (Then set). A Network lost rule acts when the internet has been down for a time you choose (After the network is lost for (seconds)), so equipment goes to a safe state on its own.
Not a safety system
Local rules help a site run safely, but they do not replace hardwired safety devices such as level switches, pressure relief valves or emergency stops.
Without internet
- Rules keep running and local alarms keep showing on the site screen.
- The gateway keeps 30 days of history and holds up to 30 days of readings it could not send, then sends them with the time they were measured once the internet is back. Charts show them at the right time, not when they arrived.
- Controls from the site screen keep working and are added to the journal when the gateway reconnects, with their original times.
The site screen
Each gateway shows a screen on the site's own network, at https:// followed by the gateway's address and :8443, for example https://192.168.1.20:8443. It shows the site's diagrams with live values, the gateway's alarms, its readings and their recent history, and it keeps working without internet.
The first time, the browser warns about the page's certificate, because the gateway makes its own. Continue to the page; the warning does not mean the gateway is unsafe.
Operator sign-in
To use controls on the site screen, an operator signs in with their name and the site's operator PIN. Set the PIN on Sites > Gateways with Set PIN: 6 to 12 digits. The gateway picks it up within a minute and checks it itself, so sign-in works without internet. After 5 wrong tries, sign-in from that computer pauses for 5 minutes. Remove PIN turns off controls on the site screen.
- Every control used on the site screen goes into the site's journal with the operator's name.
- Controls protected with Second person approves stay in the console; the site screen refuses them.
- A local rule holding an output also refuses a change to it, and says so.
Wall display
Add ?kiosk=1 to the address, for example https://192.168.1.20:8443/?kiosk=1, for a control-room wall: the diagrams fill the screen, with no sign-in and no controls.
Updates
When newer gateway software is available, the Gateways list shows it under the gateway's version, with an Update button. The gateway downloads the update from MaxwellTrack, checks that it is genuine, installs it beside the running version and restarts. If the new version does not reconnect, the gateway goes back to the previous one by itself.
Security
- The gateway gets its credential from the code, never from a person typing it, and the code alone is useless to anyone else.
- It accepts commands only from MaxwellTrack, each one signed and checked, and refuses anything else.
- Software updates come only from MaxwellTrack and are checked before they install.
- The site screen allows controls only after operator sign-in, and records who used them.
Move or remove a gateway
- To give a gateway to another account, ask whoever set up the computer to reset it;
INSTALL.txtexplains how. It then shows a new code for the new account. - To remove a gateway, delete it from the Devices list. Its credential stops working at once.
A gateway is billed as one device, and its readings like any other device's.
Troubleshooting
| What you see | Likely cause | Fix |
|---|---|---|
| The site screen says the gateway cannot reach MaxwellTrack | No internet at the computer | Check its network. It keeps trying, and shows a code as soon as it connects. |
| Add gateway says the code is not valid | A typo, or the code was replaced after 24 hours | Use the code on the site screen now. |
| Added, but never online | The computer lost internet after it was added | Check its network; it connects by itself when it can. |
| A reading never arrives | The bus or register settings do not match the equipment | Check the bus settings and the equipment's address and registers on the Controller tab. |
| The site screen does not open | Wrong address, or the computer is off | Use the address the installer showed, with :8443, from a computer on the same network. |
Still stuck?
Write to MaxwellTrack support with the gateway's name and what you see.
Something unclear or out of date on this page? Tell support.
