WiFi configuration (CSB1 or ESP32 ONLY)¶
PLEASE NOTE: config.h options for WiFi configuration from previous versions are now ignored by CSB1 or ESP32 command stations.
WiFi has two operating modes:
- AP (Access point) means the Command station acts as its own private WiFi network so throttle devices must connect first to the Command Station WiFi network.
- STA (Station mode) means the command station connects to your WiFi router and appears as a device on that network. If the WiFi is configured for STA mode, but fails to connect to your router, it will fall back to AP mode in much the same way as smart plugs, lights etc.
As shipped, or without prior configuration, the ESP32 WiFi default to operate in AP mode with an ssid/Password combination generated from the internal chip (mac) address. The ssid and password will be shown on the oled display (typically "DCCEX_123abc" and "PASS_123abc") so you can connect you phone or tablet immediately and start running.
Later, you may wish to reset the connection to use your home router as this avoids the need to reconnect your normal phone WiFi before using a throttle.
WiFi configuration changes are made by running commands from the USB serial (IDE, PaltformIO, EXWebThrottle) or from a connected WiFi throttle such as Engine Driver or EXToolbox.
The commands below are stored on the ESP32 (except for the TEMP command). Please be aware that if you issue a command to change the WiFi settings from a WiFi device, this will mean you lose connection and need to reconnect before continuing.
Its is recommended that you don't do this while running trains.
Changing to Station Mode (ie your home router)¶
<C WIFI "routerSSID" "routerPassword">
The command station will attempt this connection immediately, and on each rerstart. If it fails to connect, it will revert to AP mode.
Changing the Access Point defaults¶
To give the Access point a known name and a password that will not be revealed on the OLED use the command:
<C WIFI AP "MyCSB1" "SpamWonderfulSpam">
The AP mode password must be at least 8 characters long.
The default channel is set to "11". Use a phone WiFi analyser app to see which channels are relatively quiet in your area. If you need to use an alternate channel (we recommend using only 1,6, or 11) you may change it here.
<C WIFI AP "MyCSB1" "SpamWonderfulSpam" 6>
In some environments you may want to hide the SSID from phones scanning for access points. If you do hide the SSID, it is still possible to connect by entering the SSID manually on the phone/tablet.
<C WIFI HIDDENAP "MyCSB1" "SpamWonderfulSpam" 6>
Configuring the Host Name¶
The default is "DCCEX" but you can change this if you have more than one CS on you home router to make them show up with different names on the network. Host names starting with "DCCEX" are more readily found by WiFi throttles.
<C WIFI HOSTNAME "DCCEX-MYCSB1">
Turning WiFi On/Off¶
<C WIFI OFF>
or
<C WIFI ON>
WARNING If you switch WiFi OFF you will only be able to switch it on again over the USB serial connection.
Clearing WiFi settings¶
<C WIFI DEFAULT>
WiFi will revert to the internally generated ssid and password.
Visiting another router¶
Should you wish to visit a friend and temporarily connect to their home network you can use the TEMP setting that will be checked first but only until the ESP32 is powered off. After that it will revert to your regular settings.
<C WIFI TEMP "fredsRouter" "Wilmer!!">
Displaying WiFi settings¶
<D WIFI SHOW>