You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ex-commandstation/advanced-setup/supported-wifi/wifi-config_v5_7.rst
+50-29Lines changed: 50 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,15 +28,15 @@ Also see `WiFi configuration (CSB1 or ESP32 ONLY) <https://dcc-ex.com/mkdocs-tes
28
28
Background
29
29
===========
30
30
31
-
Prior to version 5.7.0, WiFi configuration for |EX-CS| was done through options in the ``config.h`` file. This method required users to modify the firmware source code and recompile it for their specific WiFi settings, which could be cumbersome and error-prone.
31
+
Prior to version 5.7.0, WiFi configuration for |EX-CS| was done through options in the ``config.h`` file. This method required users to modify the firmware (by editing `config.h``) and recompile it for their specific WiFi settings.
32
32
33
-
From version 5.7.0, config.h options for WiFi configuration in ``config.h`` ignored by CSB1 or ESP32 EX-CommandStations.
33
+
From version 5.7.0, WiFi configuration options in ``config.h`` are *ignored* by the CSB1 or ESP32 EX-CommandStations.
34
34
35
-
It is now necessary to use the new WiFi configuration method, which involves connecting to the |EX-CS| *after you have flashed the firmware.* You do so by connecting to the |EX-CS| via USB or by connecting to the WiFi Access Point network of the CS. (Note that the WiFi Access Point network approach has limitations.)
35
+
It is now necessary to use a new WiFi configuration method, which involves connecting to the |EX-CS| *after you have flashed the firmware.* You do so by connecting to the |EX-CS| via USB or by connecting to the WiFi Access Point network of the CS. (Note that the WiFi Access Point network approach has limitations. See below.)
36
36
37
37
The advantage of this is that it is independent of the flashing process, and will remember your WiFi settings across firmware updates and changes.
38
38
39
-
You can configuring WiFi settings through:
39
+
From version 5.7.0, you must configure the WiFi settings through one of the following methods:
40
40
41
41
a) |EX-WT| (via USB),
42
42
b) |EX-TB| (via USB or over WiFi),
@@ -45,61 +45,77 @@ d) any wifi throttle or app that can send the appropriate commands to the |EX-CS
45
45
46
46
|EX-WT| and |EX-TB| provide a user-friendly interface for configuring WiFi settings, while the serial monitor method allows for more direct access to the configuration process but requires more technical knowledge.
47
47
48
-
The different modes
49
-
====================
48
+
The WiFi different modes
49
+
=========================
50
50
51
-
WiFi on the |EX-CS| has two operating modes:
51
+
WiFi on the |EX-CS| has two possible operating modes:
52
52
53
-
* **Access point (AP) mode** means the Command station acts as its own private WiFi network so throttle devices must connect first to the Command Station WiFi network.
53
+
* **Access point (AP) mode** means the Command Station acts as its own private WiFi network so throttle devices must connect first to the Command Station's own WiFi network.
54
54
55
55
* **Station (STA) 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.
56
56
57
-
The are some additional settings that are not mode but effect the wifi connection:
57
+
There are some additional settings that are not modes but effect the wifi connection:
58
58
59
-
* **Hidden AP mode**: When enabled, the Command Station's WiFi network will not be visible in the list of available networks on devices. This can enhance security by making it less obvious to potential attackers, but it also means that users will need to manually enter the network name (SSID) to connect.
59
+
* **Channel**: If you need to use an alternate channel in Access Point mode(we recommend using only 1,6, or 11) you may change it.
60
60
61
-
* **Temporary STA mode**: When enabled, the Command Stationwill start in Station mode and connect to an existing Wifi network. But will forget this setting the next time the |EX-CS| is restarted.
61
+
* **Hidden AP mode**: If enabled, the Command Station's WiFi network will not be visible in the list of available networks on devices. This can enhance security by making it less obvious to potential attackers, but it also means that users will need to manually enter the network name (SSID) to connect.
62
62
63
-
* The **HOSTNAME** setting allows you to set the name that appears in you Throttle app, once you have connected to the appropriate network for the Command Station.
63
+
Note that this does not provide any performance advantages.
64
64
65
-
Accessing via USB vs WiFi
66
-
==========================
65
+
* **Temporary STA mode**: If enabled, the Command Station will start in Station mode and connect to an existing Wifi network. But will forget this setting the next time the |EX-CS| is restarted.
67
66
68
-
Only **Station (STA) mode** and the **HOSTNAME** can be changed over WiFi.
67
+
This may be useful if visiting a location with a different WiFi network which you would like to connect to without changing the permanent WiFi settings on the Command Station.
69
68
70
-
**Access Point (AP)** mode changes require a serial/USB connection.
69
+
* The **HOSTNAME** setting allows you to set the name that appears in your Throttle app, once you have connected to the appropriate network for the Command Station.
70
+
71
+
----
72
+
73
+
Using USB vs WiFi - Limitations of WiFi
74
+
=========================================
75
+
76
+
Only **Station (STA) mode** and the **HOSTNAME** can be changed over WiFi.
77
+
78
+
**Access Point (AP)** mode changes require a serial/USB connection.
79
+
This is a security feature. If you could change AP mode settings over WiFi, then anyone who could connect to the Command Station's WiFi network could change the AP settings and potentially lock you out of your Command Station. By requiring a USB connection for AP mode changes, we ensure that only someone with physical access to the Command Station can modify these critical settings.
71
80
72
81
----
73
82
74
83
Changing the settings
75
84
======================
76
85
77
-
EX-WebThrotttle
78
-
-----------------
86
+
Using EX-WebThrotttle
87
+
----------------------
79
88
80
89
1. Connect your PC to the |EX-CS| via USB. Open the |EX-WT| and select the appropriate COM port for your |EX-CS|. You should see the current WiFi settings displayed in the interface. See :doc:`EX-WebThrottle </ex-webthrottle/index>` for more details.
81
90
82
91
2. Go to the ``Wifi Setup`` page from the menu or the toolbar buttons.
83
92
84
93
- To set the **Access Point (AP) mode**, enter the SSID and password for the Command Station's WiFi network and click the :guilabel:`Set Access Point` button. You can optional set a channel for the AP mode, but it is not required, and generally not recommended.
85
94
86
-
The Command Station will restart and create its own WiFi network with the specified SSID and password.
95
+
The Command Station will restart and create its own WiFi network with the specified SSID and password.
87
96
88
-
To set the **Station (STA) mode**, enter the SSID and password for your existing WiFi network (eg your home router) and click the :guilabel:`Set Station Mode` button. The Command Station will attempt to connect to the specified WiFi network. If the connection is successful, it will operate in Station mode. If the connection fails, it will revert to Access Point mode.
97
+
To set the **Station (STA) mode**, enter the SSID and password for your existing WiFi network (eg your home router) and click the :guilabel:`Set Station Mode` button. The Command Station will attempt to connect to the specified WiFi network. If the connection is successful, it will operate in Station mode. If the connection fails, it will revert to Access Point mode.
89
98
90
-
- To set the **Temporary Station (STA) mode**, enter the SSID and password for your existing WiFi network and click the :guilabel:`Set Temporary Station Mode` button. The Command Station will attempt to connect to the specified WiFi network. If the connection is successful, it will operate in Station mode. If the connection fails, it will revert to Access Point mode.
99
+
- To set the **Temporary Station (STA) mode**, enter the SSID and password for your existing WiFi network and click the :guilabel:`Set Temporary Station Mode` button. The Command Station will attempt to connect to the specified WiFi network.
100
+
101
+
If the connection is successful, it will operate in Station mode. If the connection fails, it will revert to Access Point mode.
91
102
92
103
- To set the **Hostname**, enter the desired hostname and click the :guilabel:`Set Hostname` button. The Command Station will update its hostname, which will be visible in your Throttle app when connected to the appropriate network.
93
104
94
-
In every case above, the Command Station will restart to apply the new settings. You will need to reconnecting to the Command Station in the |EX-WT| interface.
105
+
This is useful if you have more than one |EX-CS| on your network to make them show up with different names.
95
106
96
107
**Resetting the Wifi settings**
97
108
98
109
The :guilabel:`Reset WiFi Settings` button on the WiFi Setup page will reset all WiFi settings to their default values. This will cause the Command Station to restart and create its own WiFi network in Access Point mode with the default SSID and password.
99
110
100
-
----
111
+
.. note::
101
112
102
-
EX-Toolbox
113
+
In every case above, the Command Station will restart to apply the new settings. You will need to reconnect to the Command Station in the |EX-WT| interface.
114
+
115
+
116
+
|HR-DASHED|
117
+
118
+
Using EX-Toolbox
103
119
-----------------
104
120
105
121
|EX-TB| provides a similar interface to the |EX-WT| for configuring WiFi settings, but it can be accessed either via USB or over WiFi. The process for changing WiFi settings in the |EX-TB| is essentially the same as in the |EX-WT|, with the same options for AP mode, STA mode, Temporary STA mode and Hostname.
@@ -111,16 +127,21 @@ EX-Toolbox
111
127
112
128
Note: Only **Station (STA) mode** and the **HOSTNAME** can be changed over WiFi. **Access Point (AP) mode** changes require a USB connection.
113
129
114
-
In every case above, the Command Station will restart to apply the new settings. You will need to reconnecting to the Command Station in the |EX-TB| interface.
130
+
.. note::
115
131
116
-
----
132
+
In every case above, the Command Station will restart to apply the new settings. You will need to reconnect to the Command Station in the |EX-TB| interface.
117
133
118
-
EX-Installer, Arduino IDE, VSC, throttle apps
119
-
----------------------------------------------
134
+
|HR-DASHED|
135
+
136
+
Using EX-Installer, Arduino IDE, VSC, throttle apps
The process for configuring WiFi settings using the serial monitor or device monitor on any of the EX-Installer, Arduino IDE, VSC or WiFi throttle apps are esentially the same.
122
140
123
-
In every case below, the Command Station will restart to apply the new settings. You will need to reconnecting to the Command Station in the app's interface.
141
+
142
+
.. note::
143
+
144
+
In every case below, the Command Station will restart to apply the new settings. You will need to reconnect to the Command Station in the app's interface.
0 commit comments