4.36Diagnostics

Diagnostics is a button in the Configurator toolbar. Its page is titled Local Diagnostics. It shows a status card for each engine, and below the cards five tabs: KNX Telegrams, Zigbee, Modbus, CAN and Other Engines. Use it to test the system before you hand it over, and to find out why a value does not arrive.

#Requirements

• The Configurator on Windows. Diagnostics is part of the Configurator. The KNX telegram monitor of the first tab listens from your PC (see below). Everything else reads from the gateway.
• A gateway address. Everything on the page reads from the gateway. Set Local IP Address under Gateway. Without it the gateway cards cannot be read.
• The deploy token. The gateway expects the Configurator's deploy token on these requests. Paste it under Server > Gateway > Deploy Token. See Gateway.
• A deployed project for the RS485, RS232, Sun Engine and MQTT cards, because they report on what the gateway is running. The Zigbee tab needs no deploy.
• Your PC on the same network as the gateway.

If the gateway cannot be reached, the RS485, RS232, Sun Engine and both MQTT cards turn OFFLINE and show the error. The gateway state refreshes every 15 seconds, and the Zigbee list every 5 seconds.

#Status cards

Each card has a tag and one line of text.

#KNX Telegrams tab

The KNX Telegram Monitor (direct interface) connects your PC straight to the KNX/IP network and lists the telegrams it sees. The PC must be on the same local network as the KNX/IP router or interface (or as the gateway, which routes the bus onto the network).

• Start Monitor begins listening on the KNX routing address 224.0.23.12, port 3671. The badge changes from Stopped to Monitoring. The first time, Windows may ask whether the Configurator may use the network: allow it on private networks.
• Each telegram is one row: Time, Direction (inbound), Event (GroupValue_Write, GroupValue_Response or GroupValue_Read), Source (the sender's physical address), Destination (the group address), DPT and Value. The newest row is at the top, and the table keeps the last 500.
• The value is read with the datapoint type of the group address when it is in the project's group address list. Otherwise it is guessed from its size: one byte as ON/OFF or a number (1.x, 5.x), two bytes as a 2-byte float (9.x), four bytes as a 4-byte float (14.x), and anything else as hexadecimal.
• Stop ends the listening. Clear empties the table.
• If it cannot start, the page shows the reason in red under the buttons.

The monitor shows the telegrams that reach the network. It does not send anything. To send a test telegram, use the gateway console's Monitor tab. See Gateway console and logs and KNX basics for installers.

#Zigbee tab

The Zigbee Devices card reads the coordinator on the gateway. Devices that are already paired appear even if they are not in the project yet. The tag shows Running, Stopped or Unreachable, and Pairing open appears while pairing is on.

The table columns are:

See Zigbee for pairing and device setup.

#Other Engines tab

The card RS485 / RS232 / Sun Engine / MQTT has a Refresh button and these parts:

• A table for the two serial buses with Bus, State, Device Path, Baud, Devices, OK / Errors and Last Poll.
• A Sun Engine card with civil dawn, sunrise, solar noon, sunset and civil dusk. Compare them with a trusted sunrise table for the site.
• An MQTT card with the broker and client status.

#CAN tab

The CAN tab shows the gateway's CAN port: its state (Running, Not running or Not set up), the device and bitrate, how many frames were received and sent, and the last error. Below it are the 100 latest frames, newest first, each with its time, direction (RX received, TX sent), id and data bytes. The list refreshes every 2 seconds while the tab is open. Send a frame sends one frame by hand: type the CAN id, tick 29-bit id for an extended id, type the Data as hex bytes and press Send. See CAN.

#Modbus tab

The Modbus tab lists every Modbus connection the deployed gateway has: RS485, RS232 and each Modbus TCP device. For each one it shows whether it is online, what it talks to (the serial device or host:port and unit id), how many datapoints it polls, the number of successful and failed reads, when the last read worked and the last error. Press Refresh to read it again. The page only asks the gateway for its own record: it does not read anything from a device.

A serial bus is Online when its port is open. A Modbus TCP device is Online while its connection is open and Offline when it cannot be reached or the connection dropped (the gateway reconnects on the next poll). The Modbus TCP card at the top shows whether the interface is enabled.

#Modbus Register Test

The Modbus Register Test reads any register on demand. The register does not have to be a defined datapoint.

Click Read. A green result lists the registers as unsigned 16-bit numbers without scaling, plus the raw frame in hex. A red Read failed shows the reason, for example a timeout.

The bus must have been deployed with its Linux device and serial settings, even with no device defined. If the bus has devices, the test shares the open connection. Otherwise the gateway opens the port just for this read and closes it again. The gateway waits 1.5 seconds for an answer. See Modbus devices and datapoints.

#Example

Check a new RS485 meter before you define its datapoints:

1. Set up and deploy the RS485 interface with the meter's baud rate, parity and stop bits.
2. Open Diagnostics > Other Engines. In the Modbus Register Test choose Bus RS485, Slave ID 5, Function FC3 Holding Registers, Address 0 and Count 2.
3. Click Read. If you get registers, the wiring and serial settings are right. Use the address from the meter's register list to find the value you want.

#Tips and common problems

• Everything is OFFLINE with the same error: the gateway cannot be reached. Check the Local IP Address, the network and the deploy token.
• The gateway answers but the Zigbee tab is empty: the coordinator has no paired devices, or Zigbee is stopped. Check the tag in the card title.
• No telegrams in the KNX monitor: the PC must be on the same network as the KNX/IP router or the gateway, and Windows must allow the Configurator on the network. Telegrams sent on the bus appear only if the router or the gateway forwards them to the network (routing). Compare with the gateway console's Monitor tab.
• The Modbus test times out: check wiring, Slave ID, function and the serial parameters.

#See also

• System objects overview
• RS485 interface
• Zigbee
• Common problems