Difference between revisions of "Command Station Macros"
TCSSoftware (talk | contribs) |
TCSSoftware (talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | == Overview == | + | ==Overview== |
The purpose of Command Station Macros is to allow users to easily perform multiple operations by a single action, such as lining up routes across yard ladders. It can also be used for creating simple automation scenarios, such as a shuttle service using a DCC locomotive (trolley). Both the TCS CS-105 and the TCS LT-50 support Command Station Macros, albeit with different capacity. | The purpose of Command Station Macros is to allow users to easily perform multiple operations by a single action, such as lining up routes across yard ladders. It can also be used for creating simple automation scenarios, such as a shuttle service using a DCC locomotive (trolley). Both the TCS CS-105 and the TCS LT-50 support Command Station Macros, albeit with different capacity. | ||
Macros can be triggered using TCS throttles, LCC connected buttons, or other LCC input devices such as a block detector. | Macros can be triggered using TCS throttles, LCC connected buttons, or other LCC input devices such as a block detector. | ||
| − | == Introduction == | + | ==Introduction== |
| − | '''What is a macro?''' <br/> | + | '''What is a macro?''' <br /> |
A macro is a list of steps. Each step can be configured by the user to do a specific layout operation. A macro can have up to 10 steps. When the macro is triggered, the steps start executing in quick succession from the beginning. Each macro is identified by a macro number in the command station. The CS-105 supports up to 300 macros, they are numbered 1 to 300. | A macro is a list of steps. Each step can be configured by the user to do a specific layout operation. A macro can have up to 10 steps. When the macro is triggered, the steps start executing in quick succession from the beginning. Each macro is identified by a macro number in the command station. The CS-105 supports up to 300 macros, they are numbered 1 to 300. | ||
| Line 19: | Line 19: | ||
'''How is a macro triggered?''' <br> | '''How is a macro triggered?''' <br> | ||
| − | |||
| − | |||
| − | |||
| + | *On the TCS throttles, starting with software release 3.0, a macro can be triggered by using Select Accessory, then entering 0, then the macro number, and pressing enter. For example to trigger macro 82, type [Accy][0][8][2][ENTER]. | ||
| + | *Each macro has a well-known LCC Event ID that triggers it. This Event ID is 09.00.99.FE.FF.FF.00.00 plus the macro number (use hex for the macro number), and it is the same across all TCS command stations and throttles. In the JMRI Configuration Dialog this Event ID is listed for the macro being edited, which allows it to be copy-pastes to other LCC Event Producers to trigger the macro. | ||
| + | *In addition, for each macro a custom LCC Event can be configured as a trigger. Whenever that Event gets produced on the LCC Bus, the macro will execute. | ||
| + | == How to view and edit macros == | ||
| + | Macros can be viewed and edited using the Command Station configuration. In JMRI there is a separate segment for Macros when opening the Configuration Dialog of the CS-105 or the LT-50. On the TCS throttles, select Menu > Settings > DCC System Settings > Macros. | ||
| + | |||
| + | At any point in time, only one macro is shown in the Macro Editor. To select which macro to show in the Macro Editor, type the Macro Number into the ''“Load Macro to Editor”'' field, hit Write, then refresh the Editor (in JMRI use the Refresh All button) to see the macro’s current definition and change it. | ||
| + | |||
| + | '''On the TCS throttles''' | ||
| + | |||
| + | # Select Menu > Settings > DCC System Settings > Macros | ||
| + | # Select [1] Load Macro to Editor | ||
| + | # Type in the macro number (e.g. [2][5]), then press ENTER or [..]Save | ||
| + | # Select [2] Macro Editor | ||
| + | # Select [7] Steps | ||
| + | # Select which step you want to modify and edit the settings of this step. | ||
| + | |||
| + | '''On JMRI / Configuration Editor''' | ||
| + | |||
| + | # Open the LCC Configuration of the CS-105 / LT-50 | ||
| + | # Expand ''“Segment: Macros”''. | ||
| + | # Enter the macro number into the ''“Load Macro to Editor”'' field. Press Write next to this field. | ||
| + | # Press the ''“Refresh All”'' button at the bottom of the page. '''This is very important!''' Otherwise you will have the old macro’s values on your screen, but you will be writing to the new macro’s storage. | ||
| + | # Verify that the correct macro is on your screen by checking the ''“Macro Number”'' field. This field is only for your information, it cannot be changed. | ||
| + | # Select the Step you want to modify from the tabbed group and edit the settings of that step. | ||
test test test | test test test | ||
Revision as of 19:22, 22 December 2024
Overview
The purpose of Command Station Macros is to allow users to easily perform multiple operations by a single action, such as lining up routes across yard ladders. It can also be used for creating simple automation scenarios, such as a shuttle service using a DCC locomotive (trolley). Both the TCS CS-105 and the TCS LT-50 support Command Station Macros, albeit with different capacity.
Macros can be triggered using TCS throttles, LCC connected buttons, or other LCC input devices such as a block detector.
Introduction
What is a macro?
A macro is a list of steps. Each step can be configured by the user to do a specific layout operation. A macro can have up to 10 steps. When the macro is triggered, the steps start executing in quick succession from the beginning. Each macro is identified by a macro number in the command station. The CS-105 supports up to 300 macros, they are numbered 1 to 300.
What is a step?
Each step in the macro can be configured by the user to perform a specific action on the layout. A typical action would be for example to set Turnout #175 to Normal/Closed. When configuring the step, select the action as “DCC Turnout Normal” and type in 175 to the parameter. See below for the detailed documentation of the possible steps.
What if more than 10 steps are needed?
A step in a macro can be configured to trigger another macro. Select the action “Link Macro” and type the macro number in the parameter box. Linked macros execute after the referencing macro completes all steps, or pauses due to a Delay step.
Where are macros stored?
Macros are stored in the internal storage of the command station, together with the locomotive roster and consists. This storage is persistent across power cycles. All changes to macros are saved immediately as the setting is written and are in effect as soon as the macro is next triggered. A factory reset of the command station erases all internal storage, including all macros. The remaining internal storage is visible in the DCC System Settings > Status > Free Storage. Macros are archived into the backup file when a Roster Backup from the Command Station is created.
How is a macro triggered?
- On the TCS throttles, starting with software release 3.0, a macro can be triggered by using Select Accessory, then entering 0, then the macro number, and pressing enter. For example to trigger macro 82, type [Accy][0][8][2][ENTER].
- Each macro has a well-known LCC Event ID that triggers it. This Event ID is 09.00.99.FE.FF.FF.00.00 plus the macro number (use hex for the macro number), and it is the same across all TCS command stations and throttles. In the JMRI Configuration Dialog this Event ID is listed for the macro being edited, which allows it to be copy-pastes to other LCC Event Producers to trigger the macro.
- In addition, for each macro a custom LCC Event can be configured as a trigger. Whenever that Event gets produced on the LCC Bus, the macro will execute.
How to view and edit macros
Macros can be viewed and edited using the Command Station configuration. In JMRI there is a separate segment for Macros when opening the Configuration Dialog of the CS-105 or the LT-50. On the TCS throttles, select Menu > Settings > DCC System Settings > Macros.
At any point in time, only one macro is shown in the Macro Editor. To select which macro to show in the Macro Editor, type the Macro Number into the “Load Macro to Editor” field, hit Write, then refresh the Editor (in JMRI use the Refresh All button) to see the macro’s current definition and change it.
On the TCS throttles
- Select Menu > Settings > DCC System Settings > Macros
- Select [1] Load Macro to Editor
- Type in the macro number (e.g. [2][5]), then press ENTER or [..]Save
- Select [2] Macro Editor
- Select [7] Steps
- Select which step you want to modify and edit the settings of this step.
On JMRI / Configuration Editor
- Open the LCC Configuration of the CS-105 / LT-50
- Expand “Segment: Macros”.
- Enter the macro number into the “Load Macro to Editor” field. Press Write next to this field.
- Press the “Refresh All” button at the bottom of the page. This is very important! Otherwise you will have the old macro’s values on your screen, but you will be writing to the new macro’s storage.
- Verify that the correct macro is on your screen by checking the “Macro Number” field. This field is only for your information, it cannot be changed.
- Select the Step you want to modify from the tabbed group and edit the settings of that step.
test test test
