Driver-controlled circuit breaker
Add the possibility for a driver to control the circuit breaker of the locomotive(s).
Discussion: http://
Roadmap: https:/
How does it work ?
===============
Default circuit breakers :
-------
There is 2 default circuit breakers included in OR : the automatic one and the manual one.
The automatic one works as before. The manual one can be control by the driver.
ENG file parameter :
-------
The automatic circuit breaker is selected by default.
In order to select the default manual circuit breaker, write this parameter in the Engine section :
ORTSCircuitBreaker( Manual )
You can also put the name of a script file in this parameter :
ORTSCircuitBreaker( SNCFCircuitBrea
(the script above is now available on my Github repository)
The file must be located in the SCRIPT directory of the locomotive.
The ORTSCircuitBrea
For example, the delay is near 2 seconds on a French train :
ORTSCircuitBrea
Key assignments :
-------
2 new key assignments are available :
- O for a circuit breaker closing order button or switch
- I for a circuit breaker opening order button
- Shift + O for a circuit breaker closing authorization (not used in the default circuit breakers)
A combination of those can be defined in the scripts.
For example, the default manual circuit breaker uses only the O key while the SNCF circuit breaker uses the O and Shift+O key.
CabView controls :
-------
8 new cabview controls are available.
3 controls can be used by the driver (by mouse or keyboard) :
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
The style of these controls must be set to PRESSED, WHILE_PRESSED or ONOFF.
For example, on SNCF locomotives, the closing order is set on PRESSED and the closing authorization is set to ONOFF.
5 controls can be used as state display :
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
- ORTS_CIRCUIT_
Sound triggers :
-------
9 sound triggers are available :
- 150 : Circuit breaker open
- 151 : Circuit breaker closing
- 152 : Circuit breaker closed
- 153 : Circuit breaker closing order on
- 154 : Circuit breaker closing order off
- 155 : Circuit breaker opening order on
- 156 : Circuit breaker opening order off
- 157 : Circuit breaker closing authorization on
- 158 : Circuit breaker closing authorization off
Blueprint information
- Status:
- Complete
- Approver:
- James Ross
- Priority:
- Medium
- Drafter:
- Cédric GNIEWEK
- Direction:
- Approved
- Assignee:
- Cédric GNIEWEK
- Definition:
- Approved
- Series goal:
- None
- Implementation:
- Implemented
- Milestone target:
- 1.2
- Started by
- Cédric GNIEWEK
- Completed by
- James Ross
Related branches
Related bugs
Sprints
Whiteboard
Work Items
Work items:
ENG parameter ORTSCircuitBreaker : DONE
Commands : DONE
Confirmations : DONE
Key binding : DONE
Scripting interface modification : DONE
Manual Circuit Breaker : DONE
Automatic Circuit Breaker : DONE
Cabview Controls : DONE
Sound triggers : DONE
Testing : DONE