Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

change to the NEW-IN-V5-4 expansion #941

Merged
merged 2 commits into from
Nov 8, 2024
Merged

change to the NEW-IN-V5-4 expansion #941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c28d94
Merge pull request #147 from DCC-EX/v5.4.0-release-frightrisk1
flash62au Nov 8, 2024
f4da2d0
change to the NEW-IN-V5-4 expansion
flash62au Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ex-commandstation/accessories/signals/light-signals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If your signalling requires using different colours to the standard red/amber/gr
Signals with flashing amber
---------------------------

**New in 5.4.0**
|NEW-IN-5-4|

|EX-R| now has the ability to blink a vpin on and off at set intervals, which can also be utilised to creating a flashing or blinking amber signal.

Expand Down
2 changes: 1 addition & 1 deletion docs/ex-commandstation/advanced-setup/supported-wifi/wifi-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ If you don't change this setting and start up in AP mode instead, the default pa
#define WIFI_FORCE_AP
---------------------

**New in 5.4.0**
|NEW-IN-5-4|

**Default: commented out** - Uncomment this line if you wish to use a custom SSID for your WiFi in access point mode, otherwise defining a custom SSID will cause the WiFi to attempt to connect to an existing WiFi network is STA mode.

Expand Down
54 changes: 29 additions & 25 deletions docs/ex-rail/EX-RAIL-command-reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ Runs commands in IF block a random percentage of the time. This is handy for mor
ROUTE_CAPTION( id, "caption" ) - dynamically change the label of the Route button
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

Dynamically change the label of the Route button.

Expand Down Expand Up @@ -590,7 +590,7 @@ Dynamically change the label of the Route button.
ROUTE_ACTIVE( id ) - dynamically activate a Route
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0.**
|NEW-IN-5-4|

Dynamically flag a Route as active.

Expand All @@ -603,7 +603,7 @@ See example in ROUTE_CAPTION.
``ROUTE_INACTIVE( id, caption )`` - dynamically deactivate a Route
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0.**
|NEW-IN-5-4|

Dynamically flag a Route as inactive.

Expand All @@ -616,7 +616,7 @@ See example in ROUTE_CAPTION.
ROUTE_HIDDEN( id ) - hide a Route from display
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0.**
|NEW-IN-5-4|

Dynamically hide a Route.

Expand All @@ -627,14 +627,14 @@ Dynamically hide a Route.
ROUTE_DISABLED( id ) - disable a Route
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

|hr-dashed|

STASH( stashId ) - Stashes the current loco/invert in the numbered stash
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

.. note::

Expand All @@ -645,21 +645,25 @@ STASH( stashId ) - Stashes the current loco/invert in the numbered stash
CLEAR_STASH( stashId ) - Zeroes the specified stash
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

|hr-dashed|

CLEAR_ALL_STASH - Zeroes all stashes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

TBA

|hr-dashed|

PICKUP_STASH( stashId ) - Retrieves and sets the loco/invert from the specified stash
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

TBA

|hr-dashed|

Expand Down Expand Up @@ -734,7 +738,7 @@ Create a HAL device in myAutomation.h rather than needing to use myHal.cpp
HAL_IGNORE_DEFAULTS - Disable default MCP23017 and PCA9685 HAL devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|



Expand Down Expand Up @@ -779,7 +783,7 @@ Define a DCC accessory signal. Control the colour or aspect of these via the def
DCCX_SIGNAL( Address, redAspect, amberAspect, greenAspect ) - This defines a signal (with id same as dcc address)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|

This defines a signal (with id same as dcc address) that can be operated
by the RED/AMBER/GREEN commands. In each case the command uses the signal address to refer to the signal and the aspect chosen depends on the use of the RED AMBER or GREEN command sent. Other aspects may be sent but will require the direct use of the ASPECT command.
Expand Down Expand Up @@ -831,7 +835,7 @@ RED( signal_id ) - Set defined signal to Red (See SIGNAL)
ASPECT( address, aspect ) - Command for DCC Extended Accessories.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|

This command sends an extended accessory packet to the track, normally used to set
a signal aspect. Aspect numbers are undefined as standards except for 0 which is
Expand Down Expand Up @@ -979,7 +983,7 @@ THROW( id ) - Throw a defined turnout/point
TOGGLE_TURNOUT( id ) - Toggle a defined turnout/point between CLOSE/THROW
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

Toggles the state of the specified turnout/point between closed and thrown.

Expand Down Expand Up @@ -1040,7 +1044,7 @@ Detects a rotary encoder has changed position
Turntable features
^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

.. contents:: In This Section
:depth: 4
Expand Down Expand Up @@ -1151,11 +1155,11 @@ Sensors/Inputs - Reading and Responding
JMRI_SENSOR(vpin [,count]) - Creates <S> type sensors visible to JMRI.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|*

This Macro causes the creation of JMRI <S> type sensors in a way that is simpler than repeating lines of <S> commands in mySetup.h.

- JMRI_SENSOR(100) is equenvelant to <S 100 100 1>
- JMRI_SENSOR(100) is equivalent to <S 100 100 1>
- JMRI_SENSOR(100,16) will create <S> type sensors for vpins 100-115.

AT( sensor_id ) - Causes a sequence to wait until a sensor is active/triggered
Expand Down Expand Up @@ -1311,7 +1315,7 @@ UNLATCH( sensor_id ) - Remove LATCH on sensor
ONBUTTON( vpin ) - Event handler for debounced button presses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

This new event handler is handy for mimic panel and other buttons that need to perform an action when a button is pressed, rather than having to create a sequence with a combination of ``AFTER`` and ``IF`` statements to debounce a button which quickly becomes very complicated.

Expand All @@ -1322,7 +1326,7 @@ Note that this works for active low buttons only.
ONSENSOR( sensor_id ) - Event handler for sensors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

A new event handler to perform actions when a sensor is activated. Like the other sensor triggers such as ``IF``, ``AT``, and ``AFTER``, a negative value can be used for an active high sensor.

Expand Down Expand Up @@ -1360,7 +1364,7 @@ FADE( pin, value, ms ) - Fade an LED on a servo driver to given value taking giv
BLINK( pin, onMs, offMs ) - Blink an output pin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

This will start a pin/Vpin blinking until such time as it is ``SET``, ``RESET``, or set via a signal operation.

Expand All @@ -1380,7 +1384,7 @@ LCN( "msg" ) - Send message to LCN Accessory Network
CONFIGURE_SERVO(vpin, pos1, pos2, profile) - Allows easy definition of LED's connected to PCA9685 boards
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|

This macro offsers a more convenient way of defining an LED connected to a PCA9685 pin, instead of performing the HAL call in halSetup.h

Expand Down Expand Up @@ -1531,7 +1535,7 @@ All the above "ON" commands are event handlers that trigger a sequence of comman
XFTOGGLE( cab, func ) - Toggle DCC function on specific cab
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

----

Expand Down Expand Up @@ -1635,7 +1639,7 @@ FOFF( func ) - Turn off loco function
FTOGGLE( func ) - Toggle the state of the current loco's function
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0**
|NEW-IN-5-4|

|hr-dashed|

Expand Down Expand Up @@ -1981,7 +1985,7 @@ Writes a message to DCC-EX clients (alias of ``PRINT``)
MESSAGE( "msg" ) - Writes a message to all clients
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|

Writes a message to all serial throttles and all WiThrottles.

Expand Down Expand Up @@ -2052,7 +2056,7 @@ If you are unsure on the impacts using anything in this section may have, please
STEALTH( code ) - include some C++ code in a ROUTE/SEQUENCE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0.**
|NEW-IN-5-4|

SERIOUS ENGINEERS ONLY |engineer|

Expand Down Expand Up @@ -2086,7 +2090,7 @@ Syntax:
STEALTH_GLOBAL( code )
^^^^^^^^^^^^^^^^^^^^^^

**New in 5.4.0.**
|NEW-IN-5-4|

SERIOUS ENGINEERS and ADVANCED C++ USERS ONLY |engineer|

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/hardware/servo-module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ The parameters required are:
- OnValue = The desired intensity (brightness) of the LED when turned on, with 0 being off, and 4095 being 100%
- OffValue = The desired intensity (brightness) of the LED when turned off

** New in V5.4.0 **
|NEW-IN-5-4|

There is now an option to configure these LED's from within the myAutomation.h file instead of the mySetup.h file. See CONFIGURE_SERVO in EXRAIL Command Reference.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/software/command-summary-consolidated.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,7 @@ NOTE: Both the following commands do the same thing. Pick the one that works for
<A address aspect> - Command for DCC Extended Accessories.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

** New in version 5.4.0 **
|NEW-IN-5-4|

This command sends an extended accessory packet to the track, normally used to set a signal aspect. Aspect numbers are undefined as sdtandards except for 0 which is always considered a stop.

Expand Down
2 changes: 1 addition & 1 deletion docs/throttles/tech-reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ A throttle needs to know which EX-RAIL Automations and Routes it can show the us
* ``<jA 13 A "description">`` - Returns the description for ID 13, and that it is an automation.
* ``<jA 13 X>`` - Indicates ID 13 is not found.

**New in 5.4.0**
|NEW-IN-5-4|

Route states can now also be broadcast via |EX-R|, allowing throttles to respond when they are active/inactive or hidden. Throttle developers should now respond to (or ignore if not implemented) the ``<jB ...>`` broadcasts.

Expand Down
Loading