Skip to content

Commit 6bf390e

Browse files
authored
Merge pull request #1250 from flash62au/sphinx
Update command-summary-consolidated.rst
2 parents e70146b + 73952b2 commit 6bf390e

1 file changed

Lines changed: 43 additions & 4 deletions

File tree

docs/reference/software/command-summary-consolidated.rst

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1440,23 +1440,62 @@ By design, for safety reasons, the NMRA specification prevents locos from respon
14401440
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14411441

14421442
*Response:* |BR|
1443-
|_| ``<r -cab>`` |BR|
1444-
|_| > **cab:** |BR|
1443+
|_| ``<r address>`` |BR|
1444+
|_| > **address:** |BR|
14451445
|_| |_| |_| |_| • DCC Address of the decoder/loco. The short (1-127) or long (128-10293) address of the engine decoder |BR|
14461446
|_| |_| |_| |_| • -1 = failed read |BR|
14471447
|_| |BR|
14481448
|_| *Example Responses:* |BR|
1449-
|_| Response (successful): **<r cab>** |BR|
1449+
|_| Response (successful): **<r 3>** |BR|
14501450
|_| Response (fail): **<r -1>**
14511451

14521452
*Notes:*
14531453

1454-
**IMPORTANT:** If the loco is on a consist, the address returned will be the consist address
1454+
**IMPORTANT:** If the loco is in a consist (CV19), the address returned will be the consist address.
14551455

14561456
When combined with the ``<D ACK ON>`` Command, the ``<R>`` Command (with or without parameters) can be used for diagnostics, for example when you get a "-1" response. (See `Diagnosing Issues <https://github.com/DCC-EX/CommandStation-EX/wiki/Diagnosing-Issues>`_\ ** for more help)
14571457

14581458
|hr-dashed|
14591459

1460+
.. _native-command-r-locoid:
1461+
1462+
``<R LOCOID>`` - Read DCC decoder (cab) address
1463+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1464+
1465+
*Response:* |BR|
1466+
|_| ``<r LOCOID address>`` |BR|
1467+
|_| > **address:** |BR|
1468+
|_| |_| |_| |_| • DCC Address of the decoder/loco. The short (1-127) or long (128-10293) address of the engine decoder |BR|
1469+
|_| |_| |_| |_| • -1 = failed read |BR|
1470+
|_| |BR|
1471+
|_| *Example Responses:* |BR|
1472+
|_| Response (successful): **<r LOCOID 3>** |BR|
1473+
|_| Response (fail): **<r LOCOID -1>**
1474+
1475+
*Notes:*
1476+
1477+
**IMPORTANT:** Unlike `<R>` If the loco is in a consist, the address returned will be the actual address.
1478+
1479+
1480+
|hr-dashed|
1481+
1482+
.. _native-command-r-consist:
1483+
1484+
``<R CONSIST>`` - Read DCC decoder consist (CV19) address
1485+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1486+
1487+
*Response:* |BR|
1488+
|_| ``<r CONSIST address>`` |BR|
1489+
|_| > **address:** |BR|
1490+
|_| |_| |_| |_| • DCC Consost (CV19)Address of the decoder/loco. |BR|
1491+
|_| |_| |_| |_| • -1 = failed read |BR|
1492+
|_| |BR|
1493+
|_| *Example Responses:* |BR|
1494+
|_| Response (successful): **<r CONSIST 3>** |BR|
1495+
|_| Response (fail): **<r CONSIST -1>**
1496+
1497+
|hr-dashed|
1498+
14601499
.. _native-command-v-cv-bit-onoff:
14611500

14621501
``<V cv bit onOff>`` - Verify/Read bit of Configuration Variable (CV) with guessed value

0 commit comments

Comments
 (0)