JMRI : MERGCBUS Console Tool

Initial Merg Cbus Console Tool Screen

JMRI provides a communications monitor window so you can see what's happening on the communications link between the program and the layout MERGCBUS.

Once you open a MERGCBUS Console window, it will automatically display all traffic.
The left part contains the raw CAN frames. The right part interprets their MERGCBUS meaning.

You can drag the window boundaries between these to suit your display.

The vertical scrollbar synchronises both windows.

Short MERGCBUS events appear in the Console with a node number of 00.

Buttons

Merg Cbus Console Tool Screen Expanded
Clear Screen
Erases the log area at the top of the screen.
Freeze Screen
Stops acquiring new information, so that the captured information stops scrolling up.
Hide Events
Hides event accessory OPCs, including fast clock messages from the console.
Event messages will continue to be counted in the statistics.
Hide DCC
Hides DCC OPCs from the console.
DCC messages will continue to be counted in the statistics.

Checkboxes

Timestamps
Normally, the program just displays the data from the communication link. If you'd like each message to be preceded by the time it was sent or received, check this box.
Priorities
If you'd like each message to be preceded by the MERGCBUS priorities used in sending the message, check this box.
Direction
Displays a visual clue to network flow.
CanID
Displays the Can ID of the message sender.
RTR
Displays the RTR status of the CAN message.
OPC
Displays the OPC of the message.
OPC Extra
Displays extra information on the OPC.
Address
Displays the CBUS short an ID of the message.
You can use this to enter as a CBUS hardware address for sensor inputs or turnout and light outputs.
CAN
Displays the CAN message as appears in left side of main console.
Enables Including the CAN message in your log files.

Logging To A File

Sometimes, it's helpful to capture what's happening. For example, you might encounter a bug (!!), and want to send a copy of what's happening to the people who are trying to fix it.

Small amounts of data can be copied from the log window with your computers "copy" command (e.g. ctrl-C or cmd-C), and then pasted into an email.

MERG CBUS Console Logging to File

If you want to capture more, you can have the window write a log file on your computer's disk. To do this:

  1. Click "Choose log file". A file-chooser window will open. Navigate to where you want to store the file, enter a name for the new log file, and click "Save".
    Note that if you pick a file that already exists, it will be overwritten.
  2. When you're ready to capture the data you want, click "Start logging" on the monitor window.
  3. When you're done, click "Stop logging" to store the data and close the file.

You can view contents of the log file by clicking on the Open Log File Button.

If you'd like to annotate the message log with your own comments, enter a comment and press ENTER or click the Add to Log button.

Statistics

MERG CBUS Console Statistics

This part of the window shows the number of packets received and transmitted.

Clear button resets the packet counts to zero.

Packets

MERG CBUS Console Packets

This displays the most recent packet received from the layout, along with a send packet tool.
The individual elements displayed are dynamic and minor priority, the first data byte which is the MERGCBUS opcode and the remaining, up to seven, data bytes.

Copy
Copies the most recently received packet into the send packet data fields.
Send
Sends the packet.
Decimal Data Entry/Display
Normally, the packets display data in hexadecimal and treats data entered as hexadecimal. To change the default to decimal, check this box.

Send Event

MERG CBUS Console Send Event

At the bottom part of the Console, you can construct an Event packet to be sent to the layout. For normal operation, do not edit the preloaded values in the dynamic and normal priority fields.
Enter the opcode and the correct number of data bytes (depending upon the opcode).

If the decimal data entry/display checkbox is not selected then data entry will, by default, be treated as hexadecimal. If the decimal data entry/display checkbox is selected then data entry will, by default, be treated as hexadecimal.

At any time, you may force data entered to be treated as hexadecimal, decimal or binary by adding a "0x", "0d" or "0b" prefix. For example "0x20", "0d32" and "0b00100000" all donate a decimal value of 32.

Send
Checks the packet entered and sends it to the layout or reports any error condition detected (e.g. the number of data bytes does not match the opcode).
Clear
Clears the data entry fields and preloads the priority values.
Decimal Data Entry/Display
When the decimal data entry/display checkbox is not selected (hexadecimal mode), any value with three or more digits will be treated as binary. When the decimal data entry/display checkbox is selected (decimal mode), any value with four or more digits will be treated as binary.

Event Highlighter

MERG CBUS Console Event Highlighter

This window can be accessed from the Display options at top of the main console.

It can highlight a specific node or event CBUS message, both on and off options.

MERG CBUS Console Event Highlighter Output

JMRI Help

You can view this help page within JMRI by selecting Help > Window Help in the top bar of the MERGCBUS Console window.

Main JMRI MERGCBUS Help page.