Innovative Model Railroad Control System

User Tools

Site Tools

Trace:
actions-en

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
actions-en [2020/02/09 16:41] – [Notes:] cdsactions-en [2024/01/20 17:34] (current) – [Notes:] rjversluis
Line 6: Line 6:
  
  \\  \\
 +
 =====Index===== =====Index=====
 {{:actions:actions-index-en.png}} {{:actions:actions-index-en.png}}
 ====Table column headers==== ====Table column headers====
 **ID:** The unique action ID\\ **ID:** The unique action ID\\
-**Description:** This is a free text to describe the action more clearly.\\+**Description:** This is a free text to describe the action more clearly. In case of no description this column will be used to Command::Parameter. \\
 **Type:** The type abbreviation (see table below). The type is set in the tab Definition.\\ **Type:** The type abbreviation (see table below). The type is set in the tab Definition.\\
  
Line 93: Line 94:
 | Block      | bk | Block      | schedule, schedule_manual, tour, unlock, white, yellow, green, red, setloco, event, open, closed, acceptident, dispatch, go, reserve, class | //schedule/tour ID//, //loco ID//, //sensor ID// \\ unlock //loco ID// or * \\ schedule_manual: Start in half automatic mode | The color commands will set the main forward signal defined for this block. | | Block      | bk | Block      | schedule, schedule_manual, tour, unlock, white, yellow, green, red, setloco, event, open, closed, acceptident, dispatch, go, reserve, class | //schedule/tour ID//, //loco ID//, //sensor ID// \\ unlock //loco ID// or * \\ schedule_manual: Start in half automatic mode | The color commands will set the main forward signal defined for this block. |
 | Staging block | sb | Staging block | unlock, white, yellow, green, red, open, closed, exitopen, exitclosed, compress | //unlock ID// | The color commands will set the exit signal defined for this block. \\ open/closed are for enter side. | | Staging block | sb | Staging block | unlock, white, yellow, green, red, open, closed, exitopen, exitclosed, compress | //unlock ID// | The color commands will set the exit signal defined for this block. \\ open/closed are for enter side. |
-| Locomotive | lc | Locomotive | go, stop, velocity, velocity2, percent dispatch, swap, blockside, carcount, min, mid, cruise, max, consist, assigntrain, releasetrain, binstate_on, binstate_off, class, x-go, pomwrite, Vvar | //go: tour, schedule, location or block ID (A variable can also be used instead of a fixed name.)\\ velocity¹: percentage of current set velocity¹\\ velocity2: speed of secondary decoder\\ carcount: number of cars or reset to 0\\ consist: locoID[,locoID]...\\ binstate: output number \\ x-go: comma separated list of loco addresses or ID's hard coded or with variables.\\ pomwrite: cv,value\\ Vvar: user automobile velocity// | Leave the parameter field empty to reset a consist. \\  If no loco is found and the parameter field contains a #variable a loco will be searched by address. This option disable further parameters. \\ In case a destination is set at the GO action: __**[[:automatic-en#running_to_a_defined_destination|Read this!]]**__ | +| Locomotive | lc | Locomotive | go, govirtual, stop, velocity, velocity2, percent dispatch, swap, blockside, carcount, min, mid, cruise, max, consist, assigntrain, releasetrain, binstate_on, binstate_off, class, x-go, pomwrite, Vvar, shuntingon, shuntingoff | //go, govirtual: tour, schedule, location or block ID (A variable can also be used instead of a fixed name.)\\ velocity¹: percentage of current set velocity¹\\ velocity2: speed of secondary decoder\\ carcount: number of cars or reset to 0\\ consist: locoID[,locoID]...\\ binstate: output number \\ x-go: comma separated list of loco addresses or ID's hard coded or with variables.\\ pomwrite: cv,value\\ Vvar: user automobile velocity// | Leave the parameter field empty to reset a consist. \\  If no loco is found and the parameter field contains a #variable a loco will be searched by address. This option disable further parameters. \\ In case a destination is set at the GO action: __**[[:automatic-en#running_to_a_defined_destination|Read this!]]**__ | 
-| Function   | fn | Locomotive\\ Car\\ Operator³ | on, off, flip | //function number (just the number, like 1, not f1 for function 1) or the __**[[loc-fun-en#description|function text (Description)]]**__ (Case sensitive).//\\ A function csv list like "1,2,3". If the list starts with a question mark, "?1,2,3", it will pick randomly one function. (Do not include the quots in the action definition.)| Only one active timed function is supported. Multiple will show unpredictable results. Flip will turn on the function when it was off and vice versa. Flip does noet support timed functions. |+| Function   | fn | Locomotive\\ Car\\ Operator³ | on, off, flip | //function number (just the number, like 1, not f1 for function 1) or the __**[[loc-fun-en#description|function text (Description)]]**__ (Case sensitive).//\\ A function csv list like "1,2,3". If the list starts with a question mark, "?1,2,3", it will pick randomly one function. (Do not include the quots in the action definition.) \\ Prefix the list with a '!' to activate Shift.(Can not be used in combination with '?'.) | Only one active timed function is supported. Multiple will show unpredictable results. Flip will turn on the function when it was off and vice versa. Flip does noet support timed functions. |
 | Turntable   | tt | Turntable | 0...47, 180, on, off, lighton, lightoff | //track number (0...47) or function (on/off)// | | | Turntable   | tt | Turntable | 0...47, 180, on, off, lighton, lightoff | //track number (0...47) or function (on/off)// | |
 | Fiddle Yard   | seltab | Fiddle Yard | goto | //track number// | | | Fiddle Yard   | seltab | Fiddle Yard | goto | //track number// | |
-| Text | tx | Text | update, __**[[variable-en#status_and_parameter_syntax|values]]**__ | Dynamic text variables will be replaced with real values. Available built-in variables see here:  __**[[[:text-en#variables|Variables]]**__ | Variables: __**[[:variable-en#status_and_parameter_syntax|Syntax]]**__ |+| Text | tx | Text | update, __**[[variable-en#status_and_parameter_syntax|values]]**__, on, off | Dynamic text variables will be replaced with real values. Available built-in variables see here:  __**[[[:text-en#variables|Variables]]**__ | Variables: __**[[:variable-en#status_and_parameter_syntax|Syntax]]**__ |
 | Sound | sound | - | play, straigh, turnout | Sound file name. | Set the sound player device in the interface tab. \\ (RocNet only!) | | Sound | sound | - | play, straigh, turnout | Sound file name. | Set the sound player device in the interface tab. \\ (RocNet only!) |
 | [[:variable-en|Variable]] | var | Variable | text, value, add, subtract, min, max, random, start, stop | The new value. | - | | [[:variable-en|Variable]] | var | Variable | text, value, add, subtract, min, max, random, start, stop | The new value. | - |
Line 122: Line 123:
 Extra parameters are ignored.\\ Extra parameters are ignored.\\
  
-==XML Script== +==XMLScript== 
-A XML script file, *.xml, can also be selected as external command to run.\\ +A XMLScript file, *.xml, can also be selected as external command to run.\\ 
-See: **[[xmlscripting-en|XML Scripting]]**\\+See: **[[xmlscripting-en|XMLScripting]]**\\
 Extra parameters are ignored.\\ Extra parameters are ignored.\\
  
-==Example: Sound playback with VLC==+==VLC== 
 +**Example: Sound playback with VLC** 
 Install **[[https://www.videolan.org/vlc/|VLC]]**.\\ Install **[[https://www.videolan.org/vlc/|VLC]]**.\\
 Define an action:\\ Define an action:\\
Line 133: Line 136:
 Leave default “Double quote” and “Asynchrone” unchanged.\\ Leave default “Double quote” and “Asynchrone” unchanged.\\
 Command: “C:\Program Files (x86)\VideoLAN\VLC\vlc.exe” or the path where VLC is installed.\\ Command: “C:\Program Files (x86)\VideoLAN\VLC\vlc.exe” or the path where VLC is installed.\\
-Parameter: “C:\sound\Aarau1_Irina.mp3 --play-and-exit --qt-start-minimized --qt-notification=0”.\\+Parameter: “C:\sound\Aarau1_Irina.mp3 ''-''''-''play-and-exit ''-''''-''qt-start-minimized ''-''''-''qt-notification=0”.\\ 
 + 
 +Explanation of the parameters:\\ 
 +''C:\sound\Aarau1_Irina.mp3'' - the Sounddatei (here a “mp3”) which shall be played.\\ 
 +''%%--%%play-and-exit'' - the program VLC is started, the sound played back and the program closed.\\ 
 +''%%--%%qt-start-minimized'' - no display of a window.\\ 
 +''%%--%%qt-notification=0'' - Windows plays back no other sound.\\
  
-Explanation of the parameters: +Further parameters:\\ 
-“C:\sound\Aarau1_Irina.mp3” - the Sounddatei (here a “mp3”) which shall be played.\\ +''%%--%%gain=x.xxx'' - playback volume, where x.xxx can be in the range 0.0 to 8.0.
-”--play-and-exit” - the program VLC is started, the sound played back and the program closed.\\ +
-”--qt-start-minimized” - no display of a window.\\ +
-”--qt-notification=0” - Windows plays back no other sound.\\+
  
 The action can be triggered by a block or a feedback.\\ The action can be triggered by a block or a feedback.\\
Line 195: Line 201:
   * Virtual   * Virtual
  
 + \\
 +=====Report=====
 +{{:actions:actions-overview-en.png?800}}\\
 +A double click will open the selected object.\\
 +====Generate====
 +Generates a report of all used actions in all objects.\\
  
actions-en.1581262901.txt.gz · Last modified: 2020/02/09 16:41 by cds