meshtastic/docs/software/web/config.md
2022-01-02 23:53:45 -07:00

68 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
id: web-config-software
title: Initial configuration
sidebar_label: Configuration
---
## Manual Installation
Pre-requisite: You have Meshtastic Device firmware between version 1.0.32 - 1.1.50. A client for version 1.2.x will be released shortly and the documentation will be updated accordingly.
We do realize this installation method is not "easy" and are exploring ways to simplify this in the future, ideally rolling it out as part of the device firmware.
Once you have your device loaded with the Meshtastic Device firmware you need to connect to it's Wifi and then manually upload the web interface files.
### Connect to device Wifi
The easiest way to turn on the device Wifi is to do the following after the device has been powered on:
* Hold down the user button
* Press and release the reset button
* Count to 2
* Let go of the user button
:::note
Some devices call this the “prog” button. On devices with two buttons where one is a reset button — its usually the other one. On T-beam devices it is the middle button.
:::
The device will now go into WiFi SoftAP Admin Mode. In this mode, your device will broadcast the following credentials on a built in Access Point:
* SSID: meshtasticAdmin
* Password: 12345678
:::note
The first time your device restarts after enabling WiFi, 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.
:::
### Upload web interface files
* Updated (Nov 20, 2021) - The process to use the web interface will soon be included in the default builds downloaded from the usual places. This document will be updated soon. Hang tight :)
### Wifi configuration
To enable WiFi to access the web interface, you must at minimum set two preferences:
`wifi_ssid`
`wifi_password`
For the Wifi features to be enabled, those two properties must be set.
To turn it off, either preference must be set as an empty string, that is a pair of double quotes each:
`wifi_ssid ""`
`wifi_password ""`
Alternatively, you can enable the internal Soft Access Point:
`wifi_ap_mode true`
With that enabled, we will broadcast a new Wifi network with the SSID and password you set. In AP mode, your device will act as a Captive Portal with a built in DNS server that resolves all name requests back to the device. Additionally, Apple Captive Portal Assistant is implemented -- if you're on an Apple device, the web interface will pop up automagically.
To turn it off, simply reboot the device.
Right now, the only way to set those preference is through the Meshtastic-python command line tool. At some point, we will be able to configure this from your mobile phone over Bluetooth.
:::note
The first time your device restarts after enabling WiFi, 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.
:::