mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-13 17:14:25 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

1.3.28 updates

Browse source
This commit is contained in:
Garth Vander Houwen 2022-08-02 22:29:52 -07:00
parent 30c61c2df2
commit 967b95ae12
2 changed files with 24 additions and 174 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -15,14 +15,18 @@ Enabling WiFi will disable bluetooth. Only one connection method will work at a
ESP32 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. ESP32 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.
:::note 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.
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.
## WiFi Config Values ## WiFi Config Values
### 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.
### WiFi Password
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.
### Software Access Point (AP) ### Software Access Point (AP)
A boolean value that toggles the [Software Access Point](#software-access-point) A boolean value that toggles the [Software Access Point](#software-access-point)
@ -37,14 +41,6 @@ Acceptable values are `true` or `false`
If set, the node AP will broadcast as a hidden SSID If set, the node AP will broadcast as a hidden 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.
### WiFi Password
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.
:::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.
::: :::
@ -88,19 +84,19 @@ No WiFi config options are available in the python CLI.
| wifi.ssid | string | `""` | | wifi.ssid | string | `""` |
```shell title="Enable / Disable SoftAP" ```shell title="Enable / Disable SoftAP"
meshtastic --set wifi_ap_mode true meshtastic --set wifi.ap_mode true
meshtastic --set wifi_ap_mode false meshtastic --set wifi.ap_mode false
``` ```
```shell title="Make Access Point Hidden" ```shell title="Make Access Point Hidden"
meshtastic --set wifi_ap_hidden false meshtastic --set wifi.ap_hidden false
``` ```
```shell title="Set WiFi SSID" ```shell title="Set WiFi SSID"
meshtastic --set wifi_ssid mynetwork meshtastic --set wifi.ssid mynetwork
// With spaces // With spaces
meshtastic --set wifi_ssid "my network" meshtastic --set wifi.ssid "my network"
``` ```
```shell title="Set WiFi password" ```shell title="Set WiFi password"
@ -126,7 +122,7 @@ All WiFI config options are available in the Web UI.
</TabItem> </TabItem>
</Tabs> </Tabs>
## Details ## Examples
### Software Access Point ### Software Access Point
@ -186,150 +182,3 @@ 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.ap_mode` to `false`, and both `wifi.ssid` & `wifi.password` to an empty string `""`. 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="web"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Enabling WiFi 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:
```shell title="Example with spaces"
meshtastic --set wifi.ssid "my wifi ssid" --set wifi.password "my wifi password"
```
:::
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
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'},
]}>
<TabItem value="cli">
```shell title="Software Access Point Example"
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:
```shell title="Example with spaces"
meshtastic --set wifi.ssid "my wifi ssid" --set wifi.password "my wifi password"
```
:::
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
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'},
]}>
<TabItem value="cli">
```shell title="Example - Disabling WiFi"
meshtastic --set wifi.ap_mode false --set wifi.ssid "" --set wifi.password ""
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>

15
docs/software/other/1.3-enthusiast.mdx
View file

@ -39,12 +39,13 @@ https://github.com/meshtastic/Meshtastic-device/issues
## Meshtastic 1.3 - python ## Meshtastic 1.3 - python
In progress, a few basic commands work (--info, --nodes and --noproto) help wanted! Many more CLI commands are now working, documentation has been updated but the --help has not
https://meshtastic.org/docs/settings/config/
Where to file bugs: Where to file bugs:
TBD https://github.com/meshtastic/Meshtastic-python/issues
## Meshtastic 1.3 - Android ## Meshtastic 1.3 - Android
@ -68,8 +69,6 @@ TestFlight
## Meshtastic 1.3 - iOS ## Meshtastic 1.3 - iOS
Both the Meshtastic iOS 1.2 and 1.3 builds are available in TestFlight. Please select the 1.3 build.
https://testflight.apple.com/join/c8nNl8q1 https://testflight.apple.com/join/c8nNl8q1
Where to file bugs: Where to file bugs:
@ -78,11 +77,13 @@ TestFlight
## Meshtastic 1.3 - Web ## Meshtastic 1.3 - Web
TBD - Not yet available available at meshtastic.local once your device is on your WiFi network
You can connect your device to WiFI using the apple apps or the python CLI
Where to file bugs: Where to file bugs:
TBD https://github.com/meshtastic/meshtastic-web/issues
## Meshtastic 1.3 - Flasher ## Meshtastic 1.3 - Flasher