JMRI: Reporters Documentation

What is a Reporter?

A Reporter is JMRI's way of representing information reported back from the layout.

A Reporter can contain arbitrary information, unlike a Sensor which is only ACTIVE or INACTIVE. Each Reporter is associated with some specific source of information on the layout, and makes that devices information available to the rest of JMRI.

The initial implementation is for LocoNet (Digitrax) transponding, where the Reporter provides access to information from Digitrax BDL168 cards with RX4 transponding sensors. When the BDL168 reports that a decoder has been seen in a transponding block or is not longer visible in the block, the corresponding Reporter will display messages like "1234 enter" and "1234 exits". There is also a LocoNet Reporter implementation for displaying messages from Lissy detectors.

How to setup Reporters

The Reporter Table

The Reporter Table provides easy access to the contents of all Reporters that JMRI knows about. There's also an "Add..." button for creating your own internal Reporters; JMRI automatically creates Reporter objects for devices on the layout.

Displaying Reporter Values on Panels

A Reporter's value can be displayed on a Panel via an icon. To do this:

  • On the Panel Editor window for your Panel, find the "Add Reporter" button.
  • In the text box next to that button, type the user name or System Name of the desired Reporter.
  • Click the "Add to Panel" button. The Reporter icon will be placed on your Panel. If it's not visible, that might be because the value is currently blank; use the Reporter Table to change the value to something that will be visible.
  • You can drag the icon to where you want it in the usual way.
  • The pop-up menu on the icon will let you change the formatting.

Reporters are kept in your layout configuration, along with Turnouts, Sensors, Signal Heads, control panel setup etc. To store this information on disk, allowing to reload it next time you run JMRI, use Store Configuration... in the File menu at the top of the Reporter Table (or other tables from the Tools menu), or select Store Panel... in the Panel menu.