JMRI: WiFi Throttle

This window controls the connection between WiFi throttles, e.g. an iPhone, iPod Touch, or Android Phone, and JMRI.

It can be set to start automatically with the "Start Up" section in the "JMRI Preferences" section of JMRI Preferences under the heading of "Actions".

Preferences for the WiFi throttles can be found in the JMRI Preferences under the heading WiThrottle.

This utility broadcasts its connection information across the local network, so it can be picked up by any device looking for the service. This eliminates having to enter connection information into the device. If the computer running JMRI is protected by a software firewall, you may need to disable the firewall to allow the WiFi throttle to connect.

When using a WiFi throttle, if the computer enters sleep mode, control will be lost. System preferences may need to be adjusted to prevent the computer from putting itself to sleep when it is inactive.

To use your iPhone or iPod Touch with JMRI as a throttle, you run the WiThrottle app on the iPhone or iPod Touch. The basic application is available for free download from the iTunes store.

To use your Android phone with JMRI as a throttle, you run the Engine Driver program on the Android phone.

The protocol is described on a separate page. For more on JMRI networking, see the networking technical page.

Function Labels

Function labels can be customized for each roster entry through JMRI. These labels will then be displayed in place of the generic F1, F2... on the screen of the mobile device. The labels can be added when a new roster entry is created, or by editing an existing roster entry under the Function Labels tab. To enter function labels, the programmer format has to be either "Advanced" or "Custom".

Routes & Turnouts

The app can control any turnouts (and routes) that JMRI has control of. If they are available in the JMRI turnout (or route) table, they are automatically available in WiFi throttles.  If there are no turnouts (or routes) on the table(s), then the control screen for them does not show in the app. It will do all of this by default. However, if JMRI cannot control them, WiFi throttles will not be able to either.

Additionally, you can limit what turnouts appear. In JMRI, with the WiThrottle window active, there is a menu named WiThrottle. It has an item titled "Filter Controls" that will let you pick which turnouts to display or hide.

Advanced Consisting

There are now two options for how Advanced (or Decoder Assisted) Consisting is handled. This can be selected from the WiThrottle portion of JMRI Preferences.

The default is NMRA Format. This will build a consist using NMRA consisting commands. It does not use any techniques specific to the connected DCC system. This allows WiFi throttles to work in a DCC manufacturer independent way. These consists may perform better for building and controlling with WiFi devices.

The second option is DCC Brand-Specific which will build consists in a manner where they will function as though built using a throttle from the DCC manufacturer. This will follow manufacturer specific features as to how consists are built and controlled. These consists should perform better when built with a WiFi device, but controlled by a throttle from the DCC manufacturer of your system.

This is the package/jmri/jmrit/withrottle/UserInterface help page