miniThrottle: A model railroad WiFi throttle.
The full list of commands can viewed using the "help" or "help summary" commands at the serial console. The name of a command can be given as a parameter to help if you want more details about a specific command, eg: "help add". The console is case sensitive so that "A" and "a" are different. Some of the more useful commands are shown below:
In a WiThrottle system, the JMRI computer will provide your throttle with lists of locomotives, turnouts or routes. Although DCC-Ex allows rosters, and switches to be stored, many users may find defining them in miniThrottle easier to manage. miniThrottle does not check DCC-Ex for roster or turnout information set in the DCC-Ex controller. When using WiThrottle the programming of CVs is done though JMRI web interface, the wiThrottle interface does not allow for easy CV programming. But they can be set using miniThrottle and DCC-Ex.
Full command set may vary depending on compilation options selected:
add loco <dcc-address> <description>
add turnout <name> {DCC|SERVO|VPIN} <dcc-definition>
add route <name> {<turnout-name> <state>} {<turnout-name> <state>}...
Add a locomotive, turnout or route to DCC-Ex roster
where for turnouts, definitions may be:
DCC <linear-address>
DCC <address> <sub-address>
SERVO <pin> <throw-posn> <closed-posn> <profile>
VPIN <pin-number>
Servo profile: 0=immediate, 1=0.5 secs, 2=1 sec, 3=2 secs, 4=bounce
And where for routes, turn-out state is one of:
C - Closed
T - Thrown
permanent setting, DCC-Ex only, restart required
backlight [0-255]
Display backlight intensity setting
permanent setting, default 200
[no]bidirectional
turn bidirectional (AKA "train set") mode on/off as default setting
permanent setting, default nobidirectional
brake [<up-rate> <down-rate>]
Set "brake pressure" increase and decrease
Increase is constant rate over time
Decrease is (1/n * pressure) per step decrease in speed
permanent setting
[no]buttonstop
permit/prevents encoder button doing a stop operation when driving locos
permanent setting
config
Show current configuration settings
info only
cpuspeed [{240|160|80|0}]
Set CPU speed in MHz, lower speeds conserve power but are less responsive
Use zero to use speed selected at install time
permanent setting, restart required
debug [<0-3>]
Set console message verboseness between 0 - terse, 3 - verbose
del {loco|turnout|route} <dcc-address|name>
Delete a locomotive or turnout from DCC-Ex roster
permanent setting, DCC-Ex only, restart required
detentcount [<n>]
Set the number or rotary encoder clicks per up/down movement
permanent setting
diag
Start diagnostic port if not already started
temporary setting
dump {loco|turnout|turnoutstate|route|routestate}
Dump memory structures of objects
info only
export
export commands required to replicate this throttle's configuration
info only
file dir
file del <filename>
file download <URL> <filename>
file list <filename>
file replay <filename>
file write <filename>
Various file system management commands to:
dir: get directory listing
del: delete the named file. NB: filenames are case sensitive
download: download the named file from the URL, no spaces in URL
list: list the contents of the named file.
replay: replay the contents of the named file as a set of configuration commands
write: write the named file from the command prompt, NB no editing facility.
font [index]
Display or set font
Permanent setting
help [summary|all|<command>]
Print this help menu
info only
locos|turnouts
List known locomotives or turnouts
info only
mdns [on|off|<name>]
Use mDNS to search for wiThrottle on network, or locate service <name>
Permanent setting or info
memory
Show system memory usage
info only
name [<name>]
Set the name of the throttle
permanent setting
nvs [{<namespace>|*}]
Show contents of Non-Volatile-Storage (NVS) namespace(s)
info only
ota [status|update|revert]
Manage Over The Air (OTA) updates to firmware
NB: does not check hardware compatibility, use with care!
permanent setting
pins
Show processor pin assignment
info only
protocol {withrot|dccex}
Select default protocol to use
permanent setting, default withrottle
restart
Restart throttle
temporary setting
rotatedisplay [direction]
Rotate screen orientation
permanent setting
routedelay [mS_delay]
Set interval between setting each turnout in a route
permanent setting
sendcmd <data for CS>
Send a packet of data to the command station
For testing and diagnotics only, use with care!
server [<index> <IP-address|DNS-name> [<port-number>]]
Set the server address and port
permanent setting
set [<variable> <value>]
Set most NVS variables to a value, use with care limited checking
Without parameters set will dump all settable settings
permanent setting
[no]showkeepalive
Show network packets received and transmitted
temporary setting
[no]showkeypad
Show keypad keystrokes to console
temporary setting
[no]showpackets
Show network packets received and transmitted
temporary setting
[no]showweb
Show web server headers received and transmitted
temporary setting
[no]sortdata
sort lists of locos and turnouts
permanent setting, default sortdata
speedstep [<1-9>]
Set the speed change set be each thottle click
permanent setting
warnspeed [<50-101>]
change speed graph color when percentage warnspeed is exceeded
permanent setting
webpass [password]
change web user password for web authentication
permanent setting
webuser [User-Name]
change web user for web authentication
permanent setting
wifi [<index> <ssid> [<password>]]
Set WiFi SSID and password for a known network
Leave password blank for open access points
permanent setting
wifimode [ap|sta|both]
Set WiFi mode to Access Point (AP), Station (sta) or both (both)
permanent setting
wifiscan [list|strength|any]
set wifi scanning technique
- list: use the list of known WiFi networks as listed by preference
- strength: use the strongest signal of known WiFi networks
- any: use the strongest signal even if unknown open access point
permanent setting
| Thank you for visiting this website | Home |