Applies to
The XK-GW gateway (Raspberry Pi based, with Ethernet). This is the earlier gateway model.
Using the LGW communication module?
The current LGW (XK-Dongle) and XK300 Essence communication unit have different requirements: DHCP only and no tagged VLAN on the device. See the LGW gateway manuals.
1 · Network
Network checklist for the XK-GW
Firewall, addressing, bandwidth and segmentation requirements for sites using the XK-GW gateway.
Ports and whitelist
| Port | Protocol | Direction | Use | Whitelist |
|---|---|---|---|---|
| 8883 | TCP | Out | Data to the cloud (dashboard), Sensor Manager | us-central1-xk-calibrationtool.cloudfunctions.net; AWS IoT endpoint for your region (see below) |
| 80, 443 | TCP | Out | Gateway OTA | us-central1-xk-calibrationtool.cloudfunctions.net, storage.googleapis.com |
| 8080 | TCP | Out | Sensor OTA | xandarkardian.float-zone.com |
| 443 | TCP | Out | Network connectivity check | google.com |
| 53 | TCP/UDP | Out | DNS | |
| 123 | UDP | Out | NTP | |
| 80, 443 | TCP | Out | TeamViewer, AnyDesk | |
| 6568 | TCP/UDP | Out | AnyDesk | *.net.anydesk.com |
| 5938 | TCP/UDP | Out | TeamViewer (sub) | *.teamviewer.com |
| 19811 | TCP | Out | Remote support | remote.xkcorp.com |
AWS IoT endpoint by region (TCP 8883)
| Region | Endpoint |
|---|---|
| United States | a1m82llrt5xrr6-ats.iot.us-east-2.amazonaws.com |
| Canada | a1m82llrt5xrr6-ats.iot.ca-central-1.amazonaws.com |
- No port forwarding is required.
- Make sure Stateful Packet Inspection (SPI) / connection tracking is enabled on the firewall, so return traffic for sessions the gateway starts is accepted without inbound rules.
- For data to the cloud, allow outbound TCP 8883 (MQTT over TLS) to the AWS IoT endpoint for your region.
- For radar calibration and Sensor Manager (MQTT), allow outbound TCP 8883 to
us-central1-xk-calibrationtool.cloudfunctions.net. - For remote support, open outbound TCP/UDP 6568 to
*.net.anydesk.com(AnyDesk) and outbound TCP/UDP 5938 to*.teamviewer.com(TeamViewer). - For firmware updates, keep outbound TCP 8080 to
xandarkardian.float-zone.comopen at all times. - The gateway software regularly checks internet connectivity against Google; allow outbound TCP 443 to
google.com.
IP address configuration
- DHCP and static IP: the XK-GW supports both.
- DHCP: make sure there are enough IP addresses for every device that may connect to the network. If there are fewer free addresses than devices, devices compete for addresses and connections become unstable.
- Static IP: share the list of IP addresses with Xandar Kardian in advance. We configure the static IPs before deployment.
Bandwidth
Each XK300 sensor connected to an XK-GW uses, per day:
| Direction | Per sensor per day | Average bandwidth |
|---|---|---|
| Download | 9.15 MiB | 0.88 kbit/s |
| Upload | 32.48 MiB | 3.13 kbit/s |
Data is sent over MQTT every 3 seconds, so traffic is spread evenly through the day without spikes. For comparison, HD video streaming (3 to 5 Mbps) uses about as much bandwidth as 120 sensors, and general web browsing (about 1 Mbps) as much as 40 sensors.
Network segmentation
We recommend a separate Wi-Fi network for XK devices, based on a VLAN, with its own SSID and password, apart from the network used by staff. This isolates XK traffic and reduces the load on the main network.
Without segmentation, XK devices and staff devices share the same access points, switches and routers. Those devices have limited processing power, memory and connection capacity; when they are close to their limit, the network can slow down or drop packets for everyone, even though each XK device uses very little bandwidth.
Even with VLAN segmentation, a network that cannot handle many connected devices can still be overloaded. In that case, a cellular (LTE) connection keeps XK devices fully separate from the facility network.
Troubleshooting
| Symptom | Likely cause | What to do |
|---|---|---|
| Staff devices disconnect frequently after installation | Too few free IP addresses; XK devices and staff devices compete for them | Check the number of available IP addresses and extend the DHCP pool if needed |
| The network is slower after installation | Access points, switches or routers struggle with the number of connected devices | Separate XK devices with a VLAN, or move them to a cellular connection |
2 · Network
Gateway VLAN setting
The XK-GW supports tagged VLANs on its Ethernet port. First confirm whether the facility uses a tagged or an untagged VLAN. If the facility uses an untagged VLAN, no action is needed. For a tagged VLAN, obtain the VLAN number from the facility.
Tagged VLAN with DHCP
- Install the VLAN package:
sudo apt-get install vlan - Open
/etc/network/interfacesand add the following lines, where X is the VLAN number:
auto eth0.X
iface eth0.X inet dhcp
- Apply the changes:
sudo systemctl restart networking
Tagged VLAN with a static IP
- Install the VLAN package:
sudo apt-get install vlan - Open
/etc/network/interfacesand add the following lines, using the VLAN number and addresses from the facility:
auto eth0.X
iface eth0.X inet static
address 10.10.10.2 # example
netmask 255.255.255.0 # example
gateway <facility gateway IP>
dns-nameservers 8.8.8.8 # optional DNS server from the facility
- Apply the changes:
sudo systemctl restart networking
After the change
A new interface appears for the VLAN, for example eth0.10 for VLAN 10.
To check, ping the facility gateway IP address and confirm that replies are received.