mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 15:44:18 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'meshtastic:master' into master

Browse source
This commit is contained in:
Jm Casler 2022-09-22 17:59:24 -07:00 committed by GitHub
parent 9a4bf72742 4cce5f3cd7
commit 1d9d63806f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 77 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/settings/config/index.mdx
View file

@ -17,4 +17,4 @@ Default settings values are prefered whenever possible as they consume no bandwi
| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. | | [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. |
| [Power](power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. | | [Power](power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. |
| [User](user) | The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. | | [User](user) | The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. |
| [WiFi](wifi) | WiFi config options are: Enabled, SSID, PSK and WiFi Mode. | | [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. |

100
docs/settings/config/wifi.mdx
View file

@ -1,13 +1,13 @@
--- ---
id: wifi id: network
title: WiFi Configuration title: Network Configuration
sidebar_label: WiFi sidebar_label: Network
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; 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 :::info
Enabling WiFi will disable bluetooth. Only one connection method will work at a time. 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. 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** (Max Length: 33)
Default: `0.pool.ntp.org`
The NTP server used if WiFi is conneced.
### Wifi Enabled ### Wifi Enabled
Enables WiFi. Type: **bool**
Default: `false` (Disabled)
Enables and Disables WiFi.
### WiFi SSID ### 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, Max Length: 33)
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 ### 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, Max Length: 64)
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 ### WiFi Mode
Type: **enum**
Default: `Client`
#### Acceptable values #### Acceptable values
| Value | Description | | Value | Description |
| :-------: | :--------------------------: | | :-------: | :--------------------------: |
| `client` | Client | | `CLIENT` | Client |
| `accessPoint` | [Software Access Point](#software-access-point) | | `ACCESS_POINT` | [Software Access Point](#software-access-point) |
| `AccessPointHidden` | Software Access Point (Hidden) | | `ACCESS_POINT_HIDDEN` | Software Access Point (Hidden) |
:::tip :::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. 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 <Tabs
groupId="settings" groupId="settings"
@ -57,69 +86,80 @@ values={[
{label: 'Flasher', value: 'flasher'}, {label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'}, {label: 'Web', value: 'web'},
]}> ]}>
<TabItem value="android"> <TabItem value="android">
:::info :::info
WiFi config is not available for Android. Network config is not available for Android.
::: :::
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
:::info :::info
WiFi config is not available on Apple OS's. Network config is not available on Apple OS's.
::: :::
</TabItem> </TabItem>
<TabItem value="cli"> <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 | | Setting | Acceptable Values | Default |
| :-----------: | :---------------: | :-----: | | :-----------: | :---------------: | :-----: |
| wifi.enabled | `true`, `false` | `false` | | network.ntp_server | string | `0.pool.ntp.org` |
| wifi.psk | string | `""` | | network.wifi_enabled | `true`, `false` | `false` |
| wifi.ssid | string | `""` | | network.wifi_psk | string | `""` |
| wifi.mode | `client`, `accessPoint`, `accessPointHidden` | `client` | | 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" ```shell title="Enable / Disable WiFi"
meshtastic --set wifi.enabled true meshtastic --set network.wifi_enabled true
meshtastic --set wifi.enabled false meshtastic --set network.wifi_enabled false
``` ```
```shell title="Make Access Point Hidden" ```shell title="Make Access Point Hidden"
meshtastic --set wifi.mode accessPointHidden meshtastic --set network.wifi_mode ACCESS_POINT_HIDDEN
``` ```
```shell title="Set WiFi SSID" ```shell title="Set WiFi SSID"
meshtastic --set wifi.ssid mynetwork meshtastic --set network.wifi_ssid mynetwork
// With spaces // With spaces
meshtastic --set wifi.ssid "my network" meshtastic --set network.wifi_ssid "my network"
``` ```
```shell title="Set WiFi password" ```shell title="Set WiFi password"
meshtastic --set wifi.psk mypassword meshtastic --set network.wifi_psk mypassword
// With spaces // With spaces
meshtastic --set wifi.psk "my password" meshtastic --set network.wifi_psk "my password"
``` ```
</TabItem> </TabItem>
<TabItem value="flasher"> <TabItem value="flasher">
:::info :::info
All WiFi config options are available in the Flasher. All Network config options are available in the Flasher.
::: :::
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
:::info :::info
All WiFI config options are available in the Web UI. All Network config options are available in the Web UI.
::: :::
</TabItem> </TabItem>
</Tabs> </Tabs>
## Examples ## Examples
@ -165,7 +205,7 @@ You should then be able to connect to the node using either the displayed IP add
### WiFi Client ### 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: 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 ### Disable WiFi
To disable WiFi completely, set `wifi.enabled` to `false`. To disable WiFi completely, set `network.wifi_enabled` to `false`.

2
docs/settings/index.mdx
View file

@ -16,7 +16,7 @@ Default settings values are prefered whenever possible as they consume no bandwi
## Config Sections ## Config Sections
Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power), [User](settings/config/user) and [WiFi](settings/config/wifi). Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power), [User](settings/config/user) and [Network](settings/config/network).
## Module Config ## Module Config

2
docs/settings/moduleconfig/range-test.mdx
View file

@ -112,7 +112,7 @@ Leaving this module on can slow down your mesh. Currently, the messages are sent
### Accessing your CSV ### Accessing your CSV
Connect to your device over WiFi, either using the [software access point](/docs/settings/config/wifi#software-access-point) or [WiFi Client](/docs/settings/config/wifi#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages. Connect to your device over WiFi, either using the [software access point](/docs/settings/config/network#software-access-point) or [WiFi Client](/docs/settings/config/network#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages.
```plaintext title="Example URLs" ```plaintext title="Example URLs"
http://meshtastic.local http://meshtastic.local

2
docs/software/web/index.mdx
View file

@ -31,7 +31,7 @@ This can be found on the screen of the device, via your router's DHCP lease page
::: :::
You have two primary options for accessing your device over HTTP, those being [Client](/docs/settings/config/wifi#wifi-client) and [SoftAP](/docs/settings/config/wifi#software-access-point) You have two primary options for accessing your device over HTTP, those being [Client](/docs/settings/config/network#wifi-client) and [SoftAP](/docs/settings/config/network#software-access-point)
### Bluetooth ### Bluetooth