mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 15:44:18 -08:00
updated docs for wifi/network config
This commit is contained in:
sigmahour
parent
ea87c21821
commit
b1bbd15901
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
id: wifi
|
||||
title: WiFi Configuration
|
||||
sidebar_label: WiFi
|
||||
id: network
|
||||
title: Network Configuration
|
||||
sidebar_label: Network
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The WiFi config options are: Enabled, SSID, PSK and WiFi Mode. WiFi config uses an admin message sending a `Config.WiFi` protobuf.
|
||||
The Network config options are: WiFi Enabled, WiFi Mode, WiFi SSID, WiFi PSK, and NTP Server. Network config uses an admin message sending a `Config.Network` protobuf.
|
||||
|
||||
:::info
|
||||
Enabling WiFi will disable bluetooth. Only one connection method will work at a time.
|
||||
|
|
@ -17,35 +17,64 @@ ESP32 devices have the ability to connect to WiFi as a client and also are able
|
|||
|
||||
You can [force the device to boot into SoftAP mode](#software-access-point) by rebooting the device with the program switch depressed. If forced into AP mode, it will revert to previous settings after a reboot. The device can be either a WiFi client or a software access point. It **cannot** operate as both at the same time.
|
||||
|
||||
## WiFi Config Values
|
||||
|
||||
## Network Config Values
|
||||
|
||||
### NTP Server
|
||||
|
||||
Type: **string**
|
||||
|
||||
Default: `0.pool.ntp.org`
|
||||
|
||||
The NTP server used if WiFi is conneced.
|
||||
|
||||
### Wifi Enabled
|
||||
|
||||
Enables WiFi.
|
||||
Type: **bool**
|
||||
|
||||
Default: `false` (Disabled)
|
||||
|
||||
Enables and Disables WiFi.
|
||||
|
||||
### WiFi SSID
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the SSID broadcast to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks SSID. This string is case sensitive.
|
||||
Type: **string** (Case Sensitive)
|
||||
|
||||
Default: `""` (Empty)
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the SSID broadcast to access your device's WiFi.
|
||||
|
||||
In [Client](#wifi-client) mode, this is your WiFi Networks SSID.
|
||||
|
||||
### WiFi PSK
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the password to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks password. This string is case sensitive.
|
||||
Type: **string** (Case Sensitive)
|
||||
|
||||
Default: `""` (Empty)
|
||||
|
||||
In [SoftAP](#software-access-point) mode, this is the password to access your device's WiFi.
|
||||
|
||||
In [Client](#wifi-client) mode, this is your WiFi Networks password.
|
||||
|
||||
### WiFi Mode
|
||||
|
||||
Type: **enum**
|
||||
|
||||
Default: `Client`
|
||||
|
||||
#### Acceptable values
|
||||
|
||||
| Value | Description |
|
||||
| :-------: | :--------------------------: |
|
||||
| `client` | Client |
|
||||
| `accessPoint` | [Software Access Point](#software-access-point) |
|
||||
| `AccessPointHidden` | Software Access Point (Hidden) |
|
||||
| `CLIENT` | Client |
|
||||
| `ACCESS_POINT` | [Software Access Point](#software-access-point) |
|
||||
| `ACCESS_POINT_HIDDEN` | Software Access Point (Hidden) |
|
||||
|
||||
:::tip
|
||||
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.
|
||||
:::
|
||||
|
||||
## WiFi Config Client Availability
|
||||
## Network Config Client Availability
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
|
|
@ -57,69 +86,80 @@ values={[
|
|||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
WiFi config is not available for Android.
|
||||
Network config is not available for Android.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
|
||||
WiFi config is not available on Apple OS's.
|
||||
Network config is not available on Apple OS's.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="cli">
|
||||
|
||||
No WiFi config options are available in the python CLI.
|
||||
All Network config options are available in the python CLI.
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-----------: | :---------------: | :-----: |
|
||||
| wifi.enabled | `true`, `false` | `false` |
|
||||
| wifi.psk | string | `""` |
|
||||
| wifi.ssid | string | `""` |
|
||||
| wifi.mode | `client`, `accessPoint`, `accessPointHidden` | `client` |
|
||||
| network.ntp_server | string | `0.pool.ntp.org` |
|
||||
| network.wifi_enabled | `true`, `false` | `false` |
|
||||
| network.wifi_psk | string | `""` |
|
||||
| network.wifi_ssid | string | `""` |
|
||||
| network.wifi_mode | `CLIENT`, `ACCESS_POINT`, `ACCESS_POINT_HIDDEN` | `CLIENT` |
|
||||
|
||||
```shell title="Set NTP Server"
|
||||
meshtastic --set network.ntp_server "0.pool.ntp.org"
|
||||
```
|
||||
|
||||
```shell title="Enable / Disable WiFi"
|
||||
meshtastic --set wifi.enabled true
|
||||
meshtastic --set wifi.enabled false
|
||||
meshtastic --set network.wifi_enabled true
|
||||
meshtastic --set network.wifi_enabled false
|
||||
```
|
||||
|
||||
```shell title="Make Access Point Hidden"
|
||||
meshtastic --set wifi.mode accessPointHidden
|
||||
meshtastic --set network.wifi_mode ACCESS_POINT_HIDDEN
|
||||
```
|
||||
|
||||
```shell title="Set WiFi SSID"
|
||||
|
||||
meshtastic --set wifi.ssid mynetwork
|
||||
meshtastic --set network.wifi_ssid mynetwork
|
||||
// With spaces
|
||||
meshtastic --set wifi.ssid "my network"
|
||||
meshtastic --set network.wifi_ssid "my network"
|
||||
```
|
||||
|
||||
```shell title="Set WiFi password"
|
||||
meshtastic --set wifi.psk mypassword
|
||||
meshtastic --set network.wifi_psk mypassword
|
||||
// With spaces
|
||||
meshtastic --set wifi.psk "my password"
|
||||
meshtastic --set network.wifi_psk "my password"
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="flasher">
|
||||
|
||||
:::info
|
||||
All WiFi config options are available in the Flasher.
|
||||
All Network config options are available in the Flasher.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
All WiFI config options are available in the Web UI.
|
||||
All Network config options are available in the Web UI.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
|
@ -165,7 +205,7 @@ You should then be able to connect to the node using either the displayed IP add
|
|||
|
||||
### WiFi Client
|
||||
|
||||
With `wifi.ssid` & `wifi.psk` 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.
|
||||
With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know 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:
|
||||
|
||||
|
|
@ -181,4 +221,4 @@ You should then be able to connect to the node using either the displayed IP add
|
|||
|
||||
### Disable WiFi
|
||||
|
||||
To disable WiFi completely, set `wifi.enabled` to `false`.
|
||||
To disable WiFi completely, set `network.wifi_enabled` to `false`.
|
||||
Loading…
Reference in a new issue