meshtastic/docs/settings/wifi.md at bf0f5cf4ca26c94b4ba5de250c2533fa2a58e006

mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 07:34:11 -08:00

Foster Irwin c124d095ab consolidated wifi instructions to settings

2022-02-23 06:50:14 -07:00

11 KiB

Raw Blame History

id	title	sidebar_label
wifi	WiFi Settings	WiFi

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

:::info Enabling WiFi will disable bluetooth. Only one method will work at a time. :::

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). WiFi can be configured in either mode with the settings below. You can force the device to boot into SoftAP mode by rebooting the device with the program switch depressed. If forced into AP mode, it will revert to previous settings after a reboot.

:::note The device can be either a WiFi client or a software access point. It cannot operate as both at the same time. :::

:::info 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

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. :::

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.

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. :::

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.

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. :::

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.

If you set your SoftAP up using a client like the CLI and have a screen attached to your device, the final page will display something similar to the following:

WiFi: Software AP
IP: 192.168.42.1    (0/4)
SSID: myNetwork / PWD: myPassword (alternating)
http://meshtastic.local
      * * * * *

You should then be able to connect to the node using either the displayed IP address or the HTTP link.

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.

If you have a screen attached to your device, the final page will display something similar to the following:

WiFi: Software AP (Admin)
IP: 192.168.42.1    (0/4)
SSID: meshtasticAdmin / PWD: 12345678 (alternating)
http://meshtastic.local
      * * * * *

You should then be able to connect to the node using either the displayed IP address or the HTTP link.

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.

If you have a screen attached to your device, the final page will display something similar to the following:

WiFi: Software AP (Admin)
IP: 192.168.42.1    (0/4)
SSID: myNetwork
http://meshtastic.local
      * * * * *

You should then be able to connect to the node using either the displayed IP address or the HTTP link.

Disable WiFi

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)

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"

:::

:::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 join a network with the SSID mywifissid and the password mywifipassword.

Enable WiFi (as SoftAP)

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. :::

In the above example, the device will broadcast a network with the SSID mywifissid and the password mywifipassword.

Disable WiFi Completely

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. :::

11 KiB Raw Blame History Unescape Escape

Overview

Settings

wifi_ap_mode

Enable/Disable Software Access Point

wifi_password

wifi_ssid

Details

Software Access Point

Force SoftAP

WiFi Client

Disable WiFi

Examples

Enable WiFi (as client)

Enable WiFi (as SoftAP)

Disable WiFi Completely

11 KiB

Raw Blame History