8.8 KiB
| id | title | sidebar_label |
|---|---|---|
| wifi | WiFi Settings | WiFi |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Overview
The ESP32 based devices have the ability to connect to WiFi as a client and also are able to create a software based access point (SoftAP). See below for more details.
:::note The device can be either a WiFi client or a software access point. It cannot operate as both at the same time. :::
:::note The first time your device restarts after enabling the WiFi access point, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse. :::
Settings
| Setting | Acceptable Values | Default |
|---|---|---|
| wifi_ap_mode | true, false |
false |
| wifi_password | string | "" |
| wifi_ssid | string | "" |
:::note
wifi_ssid & wifi_password are both case sensitive values.
:::
wifi_ap_mode
A boolean value that toggles the Software Access Point
Enable/Disable Software Access Point
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_ap_mode true
meshtastic --set wifi_ap_mode false
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
wifi_password
In SoftAP mode, this is the password to access your device's WiFi. In Client mode, this is your WiFi Networks password. This string is case sensitive.
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_password mypassword
meshtastic --set wifi_password "my password"
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
wifi_ssid
In SoftAP mode, this is the SSID broadcast to access your device's WiFi. In Client mode, this is your WiFi Networks SSID. This string is case sensitive.
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_ssid mynetwork
meshtastic --set wifi_ssid "my network"
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
Details
Software Access Point
With the SoftAP enabled, a DNS server will run on the device. The DNS server will respond to all DNS requests with the IP address of your device. This will simplify device discovery because you will not have to remember the device's IP – any unencrypted HTTP request will direct you to the right location.
Force SoftAP
You can also enable the SoftAP by following these directions:
- Hold down the user button
- Press and release the reset button
- Count to two
- Let go of the user button
This will reboot the device with the SSID set to meshtasticAdmin and the password set to 12345678. Using the Force SoftAP method, once you reboot, the SoftAP will be turned off.
WiFi Client
With wifi_ssid & wifi_password populated, the device will now to connect to your network. Make sure you are in range of your WiFi. If you have a single device on your local network it's easy to connect to your device http://meshtastic.local. If you have multiple devices you will need to connect using their respective IP addresses.
To disable WiFi completely, set wifi_ap_mode to false, and both wifi_ssid & wifi_password to an empty string "".
Examples
Enable WiFi (as client)
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword
:::note
If your wifi_ssid or wifi_password contain spaces, be sure to put quotation marks around the whole thing:
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
:::
TODO
In the above example, the device will join a network with the SSID mywifissid and the password mywifipassword.
Enable WiFi (as SoftAP)
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword
:::note
If your wifi_ssid or wifi_password contain spaces, be sure to put quotation marks around the whole thing:
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
:::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
In the above example, the device will broadcast a network with the SSID mywifissid and the password mywifipassword.
Disable WiFi Completely
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password ""
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::
:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::