stop
Bring a locomotive to a controlled stop at speed 0% by specifying its DCC address. Use for normal halts like end of run or waiting at a signal.
Instructions
Bring a locomotive to a controlled stop (speed 0%), like releasing the throttle.
Args: address: The locomotive's DCC address. Acquires the throttle automatically if this session doesn't already hold it.
For a panic/safety stop (derailment risk, collision course, or any
"stop it NOW") use emergency_stop instead — JMRI treats it as a
distinct decoder command (an immediate power cut to the motor), not
just "speed 0". Use this stop tool for a normal, intentional halt
(end of a run, waiting at a signal, user just says "stop the 3").
Safe to call repeatedly, including when the loco is already stopped: JMRI silently ignores a redundant "already at this speed" request instead of replying, and this tool's client keeps a local speed cache continuously refreshed by JMRI's own state broadcasts (which fire for ANY client's changes, not just this tool's), so a repeat call still returns the correct current speed_percent (very likely 0) without hanging or erroring.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes |