mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-09 23:24:10 -08:00
1.2 End of Life (#400)
* Start of 1.2 EOL cleanup * initial docs updates * Move more 1.2 files * Move remaining 1.2 files * Fix links * Fix links * More links * The rest of the broken links * Missed a couple of links * Really last link * Links to the final 1.2 firmare and android app * add last flasher * fix gps_disabled * update enthusiast page * Delete 1.2 from apple apps * Fix error in module index
This commit is contained in:
Garth Vander Houwen
GitHub
parent
7ce1a09920
commit
429dbac089
15
docs/1.2-End-of-life/index.mdx
Normal file
15
docs/1.2-End-of-life/index.mdx
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
id: 1.2_EOL
|
||||
title: Version 1.2 End of life (EOL)
|
||||
sidebar_label: 1.2 End of life (EOL)
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
1.2 is a beta version that has been replaced by 1.3 which is not compatible with 1.2.
|
||||
|
||||
1.2 is end of life but may continue to be useful for networks with Android only users, or users of ATAK until the forwarder is updated.
|
||||
|
||||
* Last 1.2 Python api version install: pip install meshtastic==1.2.95
|
||||
* Final 1.2 Meshtastic Flasher instal: pip install meshtastic-flasher=1.0.106
|
||||
* [Final 1.2 Device Firmware](https://github.com/meshtastic/Meshtastic-device/releases/tag/v1.2.65.0adc5ce)
|
||||
* [Final 1.2 Android App](https://github.com/meshtastic/Meshtastic-Android/releases/tag/1.2.67)
|
||||
|
|
@ -1,9 +1,12 @@
|
|||
---
|
||||
id: modules
|
||||
title: 1.2 Plugin Configuration
|
||||
sidebar_label: 1.2 Plugin Config
|
||||
id: 1.2_EOL
|
||||
title: 1.2 Module Config
|
||||
sidebar_label: 1.2 Module Config
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
Modules are included in the firmware and allow users to extend the functionality of their mesh or device.
|
||||
Plugins are included in the firmware and allow users to extend the functionality of their mesh or device.
|
||||
|
||||
The list of current modules is as follows:
|
||||
|
||||
|
|
@ -6,7 +6,6 @@ sidebar_label: Range Test Plugin
|
|||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||
|
||||
## Overview
|
||||
|
||||
|
|
@ -183,10 +182,6 @@ Also be mindful of your space usage on the file system. It has protections from
|
|||
Leaving this plugin on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](/docs/developers/protobufs/api#portnumsproto) are sent on.
|
||||
:::
|
||||
|
||||
### Accessing your CSV
|
||||
|
||||
Connect to your device over WiFi, either using the [software access point](/docs/settings/wifi#software-access-point) or [WiFi Client](/docs/settings/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.
|
||||
|
||||
```plaintext title="Example URLs"
|
||||
http://meshtastic.local
|
||||
http://198.168.0.15
|
||||
|
|
@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
|
|||
:::info
|
||||
Currently only available for ESP32 based devices with external PSRAM. Requires the device to be set as a router.
|
||||
|
||||
**Don't enable Store and Forward Plugin on multiple [routers](/docs/settings/router).**
|
||||
**Don't enable Store and Forward Plugin on multiple nodes.**
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
|
@ -306,10 +306,10 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly
|
|||
### Router setup
|
||||
|
||||
:::warning
|
||||
Don't enable the Store and Forward plugin on multiple routers!
|
||||
Don't enable the Store and Forward plugin on multiple nodes!
|
||||
:::
|
||||
|
||||
- Configure your device as a [meshtastic router](/docs/settings/router).
|
||||
- Configure your device as a router.
|
||||
- Name your router node something that makes it easily identifiable, aka "Router".
|
||||
- Configure the Store and Forward plugin
|
||||
```shell title="Required - Enable the plugin"
|
||||
|
|
@ -9,8 +9,8 @@ The Meshtastic ecosystem is highly extensible, and a number of community project
|
|||
|
||||
Current community projects:
|
||||
|
||||
- [1.2 Meshtastic module for ATAK](/docs/software/community/community-atak) (Android Team Awareness Kit)
|
||||
- [1.2 PyGUI](/docs/software/community/community-pygui) - Platform independent graphical user interface for Meshtastic devices
|
||||
- [1.2 Go CLI](/docs/software/community/community-go) - A command line interface using Go that requires no pre-requisites to be installed
|
||||
- [1.2 Meshtastic module for ATAK](/docs/1.2-End-of-life/software/community/community-atak) (Android Team Awareness Kit)
|
||||
- [1.2 PyGUI](/docs/1.2-End-of-life/software/community/community-pygui) - Platform independent graphical user interface for Meshtastic devices
|
||||
- [1.2 Go CLI](/docs/1.2-End-of-life/software/community/community-go) - A command line interface using Go that requires no pre-requisites to be installed
|
||||
|
||||
Support for these projects should be sought from their respective authors.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
:::important
|
||||
|
||||
<span>
|
||||
The name of ths option changed between Meshtastic 1.2 and 1.3. This
|
||||
documentaton already reflects the 1.3 syntax. Please substitute '{props.name}'
|
||||
prefix with '{props.rename}' to get the 1.2 compatible command name.
|
||||
</span>
|
||||
:::
|
||||
|
|
@ -34,7 +34,7 @@ The [Meshtastic-device](https://github.com/meshtastic/Meshtastic-device) is wher
|
|||
|
||||
## Device Support
|
||||
|
||||
The [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) is typically where the first device interaction takes place, but that is not a requirement. This repo has a command line utility that allows you to interact with most functionality with the devices. This python library can also be consumed for other applications. See [Community applications](/docs/software/community) for other Meshtastic applications.
|
||||
The [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) is typically where the first device interaction takes place, but that is not a requirement. This repo has a command line utility that allows you to interact with most functionality with the devices. This python library can also be consumed for other applications.
|
||||
|
||||
## Web Application
|
||||
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
id: bluetooth
|
||||
title: FAQs - Bluetooth
|
||||
sidebar_label: Bluetooth
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
### How do I pair my phone to the device if my device doesn't have a screen?
|
||||
|
||||
Use [Wifi](/docs/settings/wifi) or Bluetooth with screenless pairing: before you initiate pairing, double click on the device button. The LED will blink 3 times in confirmation and the PIN will be set temporarily to `123456`.
|
||||
|
||||
### Can I have Bluetooth enabled and use WiFi radio?
|
||||
|
||||
No. Only one method will work at a time.
|
||||
|
||||
### How do I disable WiFi so Bluetooth will work?
|
||||
|
||||
Ensure the wifi_ssid and wifi_password values are blank.
|
||||
|
|
@ -30,9 +30,9 @@ Once the node wakes up from sleep, your phone will relay any delayed messages th
|
|||
|
||||
Hold down the left PWR button for about 10 seconds and the display should turn off.
|
||||
|
||||
### How do I turn on an ESP32 t-beam based device?
|
||||
### How do I turn on a t-beam?
|
||||
|
||||
Push the left PWR button for about 1 second.
|
||||
Push the left PWR button for about 10 seconds.
|
||||
|
||||
### How can I tell the device not to sleep?
|
||||
|
||||
|
|
@ -41,4 +41,4 @@ Push the left PWR button for about 1 second.
|
|||
|
||||
### Why does only one RAK Meshtastic Starter kit show up in my node list?
|
||||
|
||||
There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a [factory reset](/docs/settings/misc#factory_reset), disconnect and reconnect the board and run `meshtastic --info`.
|
||||
There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`.
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
id: wifi
|
||||
title: FAQs - WiFi
|
||||
sidebar_label: WiFi
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
### How do I turn on the WiFI radio?
|
||||
|
||||
[See our guide here](/docs/settings/wifi).
|
||||
|
||||
### When I turn on WiFi, Bluetooth turns off. Why is this?
|
||||
|
||||
Currently WiFi and Bluetooth can not be enabled at the same time.
|
||||
|
||||
### Why does my device lose connection to WiFi?
|
||||
|
||||
It could be a couple of things. First, check that the node connects to WiFi on battery power. There are sometimes issues if your power supply is not compatible. Another possibility is [misconfigured DTIM](https://homenetworkadmin.com/what-is-dtim/) on the WiFi network.
|
||||
|
|
@ -338,13 +338,4 @@ Further information on the RAK1906 can be found on the [RAK Documentation Center
|
|||
## RAK Wireless' Resources
|
||||
|
||||
- RAK's Wisblock [Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock)
|
||||
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
|
||||
|
||||
## MAC Address Conflict
|
||||
|
||||
Some of the RAK Meshtastic starter kits that come pre-installed with Meshtastic have an error where the same MAC address is applied to more than one unit. If you have a number of RAK devices but are unable to connect to more than one of them, or they will not talk to each other despite being on the same mesh, please try a [factory reset](/docs/settings/misc#factory_reset) using the Meshtastic CLI, and then restart the device. This reset will wipe all settings on the device back to their defaults including the stored MAC address. If you have already configured your node and wish to keep the configuration, then please export it first:
|
||||
|
||||
- `meshtastic --export-config > settings_file.txt` - This will save the node's settings to the file `settings_file.txt`
|
||||
- `meshtastic --set factory_reset true` - This will reset the device and wipe the configuration
|
||||
- Power cycle the device
|
||||
- `meshtastic --configure settings_files.txt` - This will restore the settings saved in the file `settings_file.txt`
|
||||
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
|
||||
|
|
@ -6,7 +6,6 @@ sidebar_label: Bluetooth
|
|||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||
|
||||
The bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: config
|
||||
title: 1.3 Configuration Sections
|
||||
sidebar_label: 1.3 Config Sections
|
||||
title: Configuration Sections
|
||||
sidebar_label: Config Sections
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@ Position data from GPS is provided by either the radio or your paired phone. Pos
|
|||
|
||||
## Position Config Values
|
||||
|
||||
### GPS Enabled
|
||||
### GPS Disabled
|
||||
Acceptable values: `true` or `false`
|
||||
|
||||
Enabled by default. Should the device GPS be enabled for this node?
|
||||
Defaults to false. Should the device GPS be disabled for this node?
|
||||
|
||||
### GPS Update Interval
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ All Position config conmmands are available in the python CLI. Example commands
|
|||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |
|
||||
| position.gps_enabled | `true`, `false` | `true` |
|
||||
| position.gps_disabled | `true`, `false` | `false` |
|
||||
| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds |
|
||||
| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds |
|
||||
| position.fixed_position | `true`, `false` | `false` |
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: module-config
|
||||
title: 1.3 Module Configuration
|
||||
sidebar_label: 1.3 Module Config
|
||||
title: Module Configuration
|
||||
sidebar_label: Module Config
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ Leaving this module on can slow down your mesh. Currently, the messages are sent
|
|||
|
||||
### Accessing your CSV
|
||||
|
||||
Connect to your device over WiFi, either using the [software access point](/docs/settings/wifi#software-access-point) or [WiFi Client](/docs/settings/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/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.
|
||||
|
||||
```plaintext title="Example URLs"
|
||||
http://meshtastic.local
|
||||
|
|
|
|||
|
|
@ -103,10 +103,6 @@ You can test changing channels with the QR code shown below.
|
|||
|
||||
|
||||
|
||||
### Configure a channel
|
||||
|
||||
Various data-rates are selectable when configuring a channel and are inversely proportional to the theoretical range of the devices. See [modem config](/docs/settings/channel#modem_config) for more information.
|
||||
|
||||
### Send a message
|
||||
|
||||
[](/img/android/android-messages.png)
|
||||
|
|
|
|||
|
|
@ -11,6 +11,4 @@ There are lesss than 1000 remaining beta spaces available and there are no codes
|
|||
|
||||
iOS 15 or macOS 12 is required and you can sign up by opening the following link on any iOS, iPadOS or macOS device with TestFlight installed.
|
||||
|
||||
Both 1.2 Legacy and 1.3 Preview builds are available for iOS and iPadOS.
|
||||
|
||||
https://testflight.apple.com/join/c8nNl8q1
|
||||
|
|
|
|||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
id: device-power
|
||||
title: 1.2 Power Management State Machine
|
||||
sidebar_label: 1.2 Power Management
|
||||
---
|
||||
|
||||
Long battery life is one of the main goals of this project. Based on initial measurements, the current code should run for about three days between charging (assuming using a t-beam with a 3500mAh 18650 battery). This will hopefully be increased to around eight days in the future.
|
||||
|
||||
## States
|
||||
|
||||
From lower to higher power consumption.
|
||||
|
||||
- Super-Deep-Sleep (SDS) - Everything is off, CPU, radio, Bluetooth, and GPS. It only wakes due to timer or button press. We enter this mode only after no radio comms for a few hours - used to put the device into what is effectively "off" mode.
|
||||
- onEntry: setBluetoothOn(false), call doDeepSleep
|
||||
- onExit: (standard bootup code, starts in DARK)
|
||||
- Deep-Sleep (DS) - CPU is off, radio is on, Bluetooth and GPS are off. Note: This mode is never used currently, because it only saves 1.5mA vs Light-Sleep - (Not currently used).
|
||||
- Light-Sleep (LS) - CPU is suspended (RAM stays alive), radio is on, Bluetooth is off, and GPS is off. Note: currently GPS is not turned off during light sleep, but there is a TODO item to fix this.
|
||||
- NOTE: On NRF52 platforms (because CPU current draw is so low), light-sleep state is never used.
|
||||
- onEntry: setBluetoothOn(false), setGPSPower(false), doLightSleep()
|
||||
- onIdle: (if we wake because our led blink timer has expired) blink the led then go back to sleep until we sleep for ls_secs
|
||||
- onExit: setGPSPower(true), start trying to get GPS lock: gps.startLock(), once lock arrives service.sendPosition(BROADCAST)
|
||||
- No Bluetooth (NB) - CPU is running, radio is on, GPS is on, Bluetooth is off, and screen is off.
|
||||
- onEntry: setBluetoothOn(false)
|
||||
- onExit:
|
||||
- Running Dark (DARK) - Everything is on except screen.
|
||||
- onEntry: setBluetoothOn(true)
|
||||
- onExit:
|
||||
- Serial API usage (SERIAL) - Screen is on, device doesn't sleep, and Bluetooth is off.
|
||||
- onEntry: setBluetooth off, screen on
|
||||
- onExit:
|
||||
- Full On (ON) - Everything is on, can eventually timeout and transition to a lower power state.
|
||||
- onEntry: setBluetoothOn(true), screen.setOn(true)
|
||||
- onExit: screen->setOn(false)
|
||||
- Has Power (POWER) - Screen is on, device doesn't sleep, Bluetooth on, and will stay in this state as long as we have power.
|
||||
- onEntry: setBluetooth off, screen on
|
||||
- onExit:
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: device-remote-admin
|
||||
title: 1.2 Remote node administration
|
||||
sidebar_label: 1.2 Remote node administration
|
||||
title: Remote node administration
|
||||
sidebar_label: Remote node administration
|
||||
---
|
||||
|
||||
This feature will allow you to use the multiple channels feature to enable remote administration of Meshtastic nodes. This will let you talk through the mesh to some far away node and change that node's settings. This is an advanced feature that (currently) few users would need. Also, keep in mind it is possible (if you are not careful) to assign settings to that remote node that cause it to completely drop off of your mesh. We advise network admins have a test node to test settings with before applying changes to a remote node to prevent this.
|
||||
|
|
|
|||
|
|
@ -4,20 +4,7 @@ title: 1.3 Enthusiast
|
|||
sidebar_label: 1.3 Enthusiast
|
||||
---
|
||||
|
||||
Meshtastic 1.3 is currently highly experimental. While we believe that it's stable-ish,
|
||||
it's not yet complete.
|
||||
|
||||
*** WARNING ***
|
||||
|
||||
Meshtastic 1.3 Experimental!
|
||||
|
||||
*** WARNING ***
|
||||
|
||||
If you're reading this and want to experiment with Meshtastic 1.3, you must be an
|
||||
enthusiast and are OK with being fustrated and things not working.
|
||||
|
||||
Once Meshtastic 1.3 is stable, we will make the first public and generally available
|
||||
version Meshtastic 2.0. If you want the latest and greatest and something stable, please wait for Meshtastic 2.0.
|
||||
Meshtastic 1.3 has not been released as a beta.
|
||||
|
||||
This page will function as a cheat-sheet to keep our notes on how to work with Meshtastic 1.3.
|
||||
|
||||
|
|
@ -39,9 +26,7 @@ https://github.com/meshtastic/Meshtastic-device/issues
|
|||
|
||||
## Meshtastic 1.3 - Python
|
||||
|
||||
When upgrading to the 1.3 version of the python cli from pip, you must add the `--pre` argument.
|
||||
|
||||
Many more CLI commands are now working, documentation has been updated but the --help has not
|
||||
Most CLI commands are now working, documentation has been updated but the --help has not
|
||||
|
||||
https://meshtastic.org/docs/settings/config/
|
||||
|
||||
|
|
@ -51,7 +36,7 @@ https://github.com/meshtastic/Meshtastic-python/issues
|
|||
|
||||
## Meshtastic 1.3 - Android
|
||||
|
||||
Android App 1.3 debug apk available here
|
||||
Android App 1.3 apk available here
|
||||
|
||||
https://github.com/meshtastic/Meshtastic-Android/releases
|
||||
|
||||
|
|
@ -79,7 +64,7 @@ TestFlight
|
|||
|
||||
## Meshtastic 1.3 - Web
|
||||
|
||||
available at meshtastic.local once your device is on your WiFi network
|
||||
Hosted version available at client.meshtastic.org, we are still working to get the new webui running locally on the device firmware.
|
||||
|
||||
You can connect your device to WiFI using the apple apps or the python CLI
|
||||
|
||||
|
|
@ -89,8 +74,8 @@ https://github.com/meshtastic/meshtastic-web/issues
|
|||
|
||||
## Meshtastic 1.3 - Flasher
|
||||
|
||||
Not yet available, dependant on the CLI being completed
|
||||
Currently flashing and setting region are available
|
||||
|
||||
Where to file bugs:
|
||||
https://github.com/meshtastic/Meshtastic-gui-installer/issues
|
||||
|
||||
TBD
|
||||
Have fun!
|
||||
|
|
@ -76,7 +76,7 @@ If the message received contains valid JSON in the payload, the JSON is deserial
|
|||
|
||||
### Basic Configuration
|
||||
|
||||
Check out [MQTT Settings](/docs/settings/mqtt) for full information. For quick start instructions, read on.
|
||||
Check out [MQTT Settings](/docs/settings/moduleconfig/mqtt) for full information. For quick start instructions, read on.
|
||||
|
||||
- Connect your gateway node to wifi, by setting the `wifi_ssid` and `wifi_password` preferences.
|
||||
- Configure your broker settings: `mqtt_server`, `mqtt_username`, and `mqtt_password`. If all are left blank, the device will connect to the Meshtastic broker.
|
||||
|
|
@ -120,7 +120,6 @@ This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1
|
|||
- A text messaging bridge when a node in the mesh can gateway to the internet. Issue #[353](https://github.com/meshtastic/Meshtastic-device/issues/353) and this nicely documented [android issue](https://github.com/meshtastic/Meshtastic-Android/issues/2).
|
||||
- An easy way to let desktop app developers remotely control GPIOs. Issue #[182](https://github.com/meshtastic/Meshtastic-device/issues/182)
|
||||
- Remote attribute access (to change settings of distant nodes). Issue #182
|
||||
- Be sure to checkout [MQTT Settings](/docs/settings/mqtt)
|
||||
|
||||
## Short term goals
|
||||
|
||||
|
|
|
|||
|
|
@ -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/wifi#wifi-client) and [SoftAP](/docs/settings/wifi#software-access-point)
|
||||
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)
|
||||
|
||||
### Bluetooth
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue