Difference between revisions of "Cab Bus"

From Train Control Systems Documentation
Jump to navigation Jump to search
Line 6: Line 6:
 
While every effort has been made to provide a seamless user experience compared to Cab Bus throttles on their original system(s), a few features have been added in order to enhance the user experience further. Most of these added features are only available on NCE, Ramtraxx, and SystemOne Cabs with a 2x16 character LCD.
 
While every effort has been made to provide a seamless user experience compared to Cab Bus throttles on their original system(s), a few features have been added in order to enhance the user experience further. Most of these added features are only available on NCE, Ramtraxx, and SystemOne Cabs with a 2x16 character LCD.
  
== NCE Wireless System ==
+
==NCE Wireless System==
 
The NCE wireless system is fully supported. Because of some intrinsic properties of the NCE wireless system, the behavior of throttles operating while wireless will differ as follows:
 
The NCE wireless system is fully supported. Because of some intrinsic properties of the NCE wireless system, the behavior of throttles operating while wireless will differ as follows:
  
# The '''EXPN''' button on ProCabs is reserved for wireless setup. The '''EXPN''' button will not work as described in the section(s) below. To use the '''EXPN''' button as described below, on a wireless cab, plug the cab in such that it is not using wireless.
+
#The '''EXPN''' button on ProCabs is reserved for wireless setup. The '''EXPN''' button will not work as described in the section(s) below. To use the '''EXPN''' button as described below, on a wireless cab, plug the cab in such that it is not using wireless.
# Normally, when the '''Horn/Whistle''' button is pressed, the appropriately assigned function status is changed to active on the LCD for the duration during which the '''Horn/Whistle''' button is held down. Because the NCE wireless system provides less communications bandwidth than when running wired, this feature is disabled in wireless mode. This helps to improve overall performance.
+
#Normally, when the '''Horn/Whistle''' button is pressed, the appropriately assigned function status is changed to active on the LCD for the duration during which the '''Horn/Whistle''' button is held down. Because the NCE wireless system provides less communications bandwidth than when running wired, this feature is disabled in wireless mode. This helps to improve overall performance.
# Custom graphics, such as the bell, whistle, and superscript numbers are not displayed. The NCE wireless system does not support custom graphics when operating in wireless mode.
+
#Custom graphics, such as the bell, whistle, and superscript numbers are not displayed. The NCE wireless system does not support custom graphics when operating in wireless mode.
  
== Main LCD Screen ==
+
==Main LCD Screen==
 
The screen layout for ProCab support has been designed to closely match that of the original system(s). The general positioning of things such as the loco number, speed, direction, and active functions remain largely unchanged, while at the same time being enhanced to offer more information.
 
The screen layout for ProCab support has been designed to closely match that of the original system(s). The general positioning of things such as the loco number, speed, direction, and active functions remain largely unchanged, while at the same time being enhanced to offer more information.
  
Line 26: Line 26:
 
When a greater than four digit locomotive address is active, up to 12 total digits can be shown. The first four digits are always shown, however, the '''Enter''' key can be used to toggle between showing digits 5 through 12 or the clock.
 
When a greater than four digit locomotive address is active, up to 12 total digits can be shown. The first four digits are always shown, however, the '''Enter''' key can be used to toggle between showing digits 5 through 12 or the clock.
  
== Select Loco ==
+
==Select Loco==
 
The '''Select Loco''' button has been expanded to allow additional entry methods.
 
The '''Select Loco''' button has been expanded to allow additional entry methods.
 
{| class="wikitable"
 
{| class="wikitable"
Line 45: Line 45:
 
The additional entry methods are only available on cabs that have LCD's. For cabs without LCD's (Cab-04, Cab-06, etc…), address entry is always DCC mode and search is not supported.<blockquote>Support is under development for assigning a non-DCC address to a cab without an LCD through the '''ASSIGN LOCO->CAB''' programming menu on an LCD cab. This will be available through a software update that can be applied by the user.</blockquote>
 
The additional entry methods are only available on cabs that have LCD's. For cabs without LCD's (Cab-04, Cab-06, etc…), address entry is always DCC mode and search is not supported.<blockquote>Support is under development for assigning a non-DCC address to a cab without an LCD through the '''ASSIGN LOCO->CAB''' programming menu on an LCD cab. This will be available through a software update that can be applied by the user.</blockquote>
  
== Macro Button ==
+
==Macro Button==
 
The '''Macro''' key allows one to execute the traditional macros managed by the command station. However, it also allows for sending 64-bit LCC events. If the number entered exceeds the maximum Macro number supported, the menu heading will switch from '''MACRO''' to '''EVENT'''. Press '''Enter''' after all 16 hexadecimal digits of the event have been entered in order to send the LCC event number onto the LCC bus. While cumbersome for normal operations, the ability to manually enter and send a 16-digit hexadecimal LCC event can be a useful troubleshooting tool. The '''EXPN''' key can be pressed to enter hexadecimal digits A through F.
 
The '''Macro''' key allows one to execute the traditional macros managed by the command station. However, it also allows for sending 64-bit LCC events. If the number entered exceeds the maximum Macro number supported, the menu heading will switch from '''MACRO''' to '''EVENT'''. Press '''Enter''' after all 16 hexadecimal digits of the event have been entered in order to send the LCC event number onto the LCC bus. While cumbersome for normal operations, the ability to manually enter and send a 16-digit hexadecimal LCC event can be a useful troubleshooting tool. The '''EXPN''' key can be pressed to enter hexadecimal digits A through F.
 
<br />
 
<br />
  
== Select Accessory ==
+
==Select Accessory==
 
Upon entering an accessory address, the last known state of the accessory (N/ON or R/OFF) will be indicated with an arrow (< or >). If the last state is unknown, a question mark will be displayed.
 
Upon entering an accessory address, the last known state of the accessory (N/ON or R/OFF) will be indicated with an arrow (< or >). If the last state is unknown, a question mark will be displayed.
 
<br />
 
<br />
  
== Locomotive Functions ==
+
==Locomotive Functions==
 
Because the Command Station database supports associating locomotive specific functions types with a given function number (Bell, Horn, Whistle, etc…), the function number on the display can be substituted for an appropriate symbol or letter representing that function type.
 
Because the Command Station database supports associating locomotive specific functions types with a given function number (Bell, Horn, Whistle, etc…), the function number on the display can be substituted for an appropriate symbol or letter representing that function type.
 
When pressing the '''EXPN''' button, the user can view the status of all functions 0 through 28. Superscript characters are used in order to delimit functions 10 through 19 and 20 through 28.<br />
 
When pressing the '''EXPN''' button, the user can view the status of all functions 0 through 28. Superscript characters are used in order to delimit functions 10 through 19 and 20 through 28.<br />
  
== Emergency Stop ==
+
==Emergency Stop==
 
TODO
 
TODO
  
== Locomotive Names ==
+
==Locomotive Names==
 
TODO
 
TODO
  
== Supported Hardware ==
+
== Configuration Options ==
 +
TODO
 +
 
 +
==Supported Hardware==
 
{| class="wikitable"
 
{| class="wikitable"
 
|+
 
|+
Line 91: Line 94:
 
|}
 
|}
  
== Unsupported Features ==
+
==Unsupported Features==
 
{| class="wikitable"
 
{| class="wikitable"
 
|+
 
|+

Revision as of 16:44, 11 June 2022

Cab Bus is the name given to the throttle network that is used in the NCE, Ramtraxx, and SystemOne DCC systems. Electrically, Cab Bus is based around half duplex RS-485 and is a polled network running at 9600 baud. The CS-105 provides support for this bus protocol through the RJ12 port labeled "Auxiliary".

WARNING: Cab Bus Address 1 is reserved and should not be used.

CS-105 Support

While every effort has been made to provide a seamless user experience compared to Cab Bus throttles on their original system(s), a few features have been added in order to enhance the user experience further. Most of these added features are only available on NCE, Ramtraxx, and SystemOne Cabs with a 2x16 character LCD.

NCE Wireless System

The NCE wireless system is fully supported. Because of some intrinsic properties of the NCE wireless system, the behavior of throttles operating while wireless will differ as follows:

  1. The EXPN button on ProCabs is reserved for wireless setup. The EXPN button will not work as described in the section(s) below. To use the EXPN button as described below, on a wireless cab, plug the cab in such that it is not using wireless.
  2. Normally, when the Horn/Whistle button is pressed, the appropriately assigned function status is changed to active on the LCD for the duration during which the Horn/Whistle button is held down. Because the NCE wireless system provides less communications bandwidth than when running wired, this feature is disabled in wireless mode. This helps to improve overall performance.
  3. Custom graphics, such as the bell, whistle, and superscript numbers are not displayed. The NCE wireless system does not support custom graphics when operating in wireless mode.

Main LCD Screen

The screen layout for ProCab support has been designed to closely match that of the original system(s). The general positioning of things such as the loco number, speed, direction, and active functions remain largely unchanged, while at the same time being enhanced to offer more information.


The user experience of the main LCD screen has been enhanced. With these enhancements, It is now possible to view the status of up to 28 functions and display locomotive names that are longer than four digits. To rotate between displaying functions 0 - 9, 10 - 19, and 20 - 28 respectively, one can use the "sticky shift" key. Sticky shift is accessed by pressing the Headlight key while holding down the Shift key. The following example shows a traditional four digit locomotive address on the first row, as well as a system clock. The second row shows the current direction, with F for forward and R for reverse, the current speed, and functions 0(L), 9, 10, 15, 19, 20, and 28 turned on respectively. Note the '.' and ':' characters. When present, these denote which decade of functions is being shown.


The following example shows a greater than four digit locomotive name on the first row while the second row shows R for reverse, 035 for speed, and functions L, 9, 10, 15, 19, 20, and 28 turned on respectively. Note the superscript '1' and '2' numbers. When present, these denote which decade of functions is being shown. Because custom superscript graphics are not supported in wireless mode, they are not used when operating in wireless mode.


When a greater than four digit locomotive address is active, up to 12 total digits can be shown. The first four digits are always shown, however, the Enter key can be used to toggle between showing digits 5 through 12 or the clock.

Select Loco

The Select Loco button has been expanded to allow additional entry methods.

Number of times the Select Loco Key is pressed Action
1 Enter a two or for digit DCC address. To enter a four-digit address that is less than 128, add an extra leading zero. Example: to select long address 58, type in 058
2 Enter Märklin-Motorola address
3 Scrolling list of database search query results. Enter digits to filter the list. Use the INC/DEC buttons or thumbwheel encoder to scroll through the list.

The scrolling list search entry can be particularly useful when trying to use locomotive protocols that are not DCC or Märklin-Motorola. A direct wireless equipped locomotive designed to natively use the LCC protocol is one such example. Up and down arrows indicate which direction(s) the list can be scrolled. Because custom graphics are not supported in wireless mode, a '.' is used in their place for the up and down arrows when operating in wireless mode.

The additional entry methods are only available on cabs that have LCD's. For cabs without LCD's (Cab-04, Cab-06, etc…), address entry is always DCC mode and search is not supported.

Support is under development for assigning a non-DCC address to a cab without an LCD through the ASSIGN LOCO->CAB programming menu on an LCD cab. This will be available through a software update that can be applied by the user.

Macro Button

The Macro key allows one to execute the traditional macros managed by the command station. However, it also allows for sending 64-bit LCC events. If the number entered exceeds the maximum Macro number supported, the menu heading will switch from MACRO to EVENT. Press Enter after all 16 hexadecimal digits of the event have been entered in order to send the LCC event number onto the LCC bus. While cumbersome for normal operations, the ability to manually enter and send a 16-digit hexadecimal LCC event can be a useful troubleshooting tool. The EXPN key can be pressed to enter hexadecimal digits A through F.

Select Accessory

Upon entering an accessory address, the last known state of the accessory (N/ON or R/OFF) will be indicated with an arrow (< or >). If the last state is unknown, a question mark will be displayed.

Locomotive Functions

Because the Command Station database supports associating locomotive specific functions types with a given function number (Bell, Horn, Whistle, etc…), the function number on the display can be substituted for an appropriate symbol or letter representing that function type. When pressing the EXPN button, the user can view the status of all functions 0 through 28. Superscript characters are used in order to delimit functions 10 through 19 and 20 through 28.

Emergency Stop

TODO

Locomotive Names

TODO

Configuration Options

TODO

Supported Hardware

Device Comments
ProCab, PowerCab All ProCab throttles are fully supported. The NCE PowerCab is fully supported. This includes ProCabs from NCE, Ramtraxx, and SystemOne. Some older ProCabs do not support custom characters. To use these older cabs, custom character support needs to be disabled in the system configuration.
Cab04, Cab05, Cab06 All "engineering" cabs are fully supported.
NCE USB Adapter Limited functionality. Supports locomotive, accessory, and macro control. May be used with JMRI in order to provide WiThrottle Protocol support.
WifiTrax WFD-30/WFD-31 Fully supported. May be used in order to provide WiThrottle Protocol support.
ISE ProtoThrottle Fully supported. Requires the MRBW-CABBUS receiver.
NCE Auxiliary Input Unit (AIU) Support is under development and will be provided in a future software release which can be updated by the user.
NCE Mini Panel Support is under development and will be provided in a future software release which can be updated by the user.

Unsupported Features

Feature Comments
CONSIST Setup The Consist buttons (SETUP, CLEAR, ADD, DEL) on the ProCab/PowerCab are not supported. They do nothing when pressed. To setup a consist, use a native LCC throttle such as the UWT-100 or UWT-50. Cab Bus throttles can still operate consisted locomotives from the address of any consisted member. It is not yet determined if support for consist setup will be added in the future.
PROG The PROG function of the PROG/ESC button is not supported. It does nothing when pressed. The ESC function of this button does operate where appropriate, for example to exit a "SELECT LOCO" window. This is sometimes labeled PROG MODE on some older throttles.
21/128 The 28/128 button does nothing when pressed. This is sometimes labeled 14/28 on some older throttles.
MOMENTUM The MOMENTUM button does nothing when pressed.