mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-01-24 12:11:41 -08:00
updates to the updates again
This commit is contained in:
sigmahour
parent
18fb999121
commit
933197b133
|
|
@ -113,7 +113,7 @@ Remember, by doing this you are self certifying that you are licensed operate in
|
|||
|
||||
## Use the Python CLI
|
||||
|
||||
Meshtastic is designed to be used without a radio operator license. If you do have a license you can set your operator ID and turn off encryption with the [Python CLI](/docs/software/python/cli/python-cli-usage#ham-radio-support):
|
||||
Meshtastic is designed to be used without a radio operator license. If you do have a license you can set your operator ID and turn off encryption with the [Python CLI](/docs/software/python/cli/usage#ham-radio-support):
|
||||
|
||||
```shell title="Expected Output"
|
||||
# You should see a result similar to this:
|
||||
|
|
|
|||
|
|
@ -99,11 +99,11 @@ Your Meshtastic client (Android, Web, or Python) will provide you a URL or QR co
|
|||
|
||||
### How do I find out more about installing (and using) Meshtastic via command line?
|
||||
|
||||
[See our guide here](/docs/software/python/cli/python-installation).
|
||||
[See our guide here](/docs/software/python/cli/installation).
|
||||
|
||||
### How do I find out more about using python to interact?
|
||||
|
||||
[See our guide here](/docs/software/python/cli/python-cli-usage).
|
||||
[See our guide here](/docs/software/python/cli/usage).
|
||||
|
||||
<!-- Devices -->
|
||||
|
||||
|
|
@ -148,7 +148,7 @@ Push the left PWR button for about 10 seconds.
|
|||
### How can I tell the device not to sleep?
|
||||
|
||||
- Android instructions see: [Android Usage](/docs/software/android/android-usage#configuration-options)
|
||||
- Python CLI instructions see: [Python Usage](/docs/software/python/cli/python-cli-usage#changing-settings)
|
||||
- Python CLI instructions see: [Python Usage](/docs/software/python/cli/usage#changing-settings)
|
||||
|
||||
### Why does only one RAK Meshtastic Starter kit show up in my node list?
|
||||
|
||||
|
|
@ -182,7 +182,7 @@ If you use your HAM radio license with Meshtastic, consider both the privileges
|
|||
|
||||
### How do I set my HAM call sign?
|
||||
|
||||
Please see instructions for [Enabling HAM License from the Python CLI](/docs/software/python/cli/python-cli-usage#ham-radio-support)
|
||||
Please see instructions for [Enabling HAM License from the Python CLI](/docs/software/python/cli/usage#ham-radio-support)
|
||||
|
||||
<!-- Flasher -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
|
|||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::info
|
||||
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [meshtastic flasher](/docs/software/python/meshtastic-flasher) or [manually flashing](/docs/getting-started/flashing-firmware/esp32/flashing-esp32)
|
||||
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [meshtastic flasher](/docs/software/python/flasher) or [manually flashing](/docs/getting-started/flashing-firmware/esp32/flashing-esp32)
|
||||
:::
|
||||
|
||||
:::caution
|
||||
|
|
@ -53,7 +53,7 @@ Disconnect your USB to Serial Adapter from the computer before starting this pro
|
|||
|
||||
### Flashing
|
||||
|
||||
After following the steps above, your device should be in flash mode. You can flash your device using the [Meshtastic flasher](/docs/software/python/meshtastic-flasher) or [manual method](https://meshtastic.org/docs/getting-started/flashing-firmware/flashing-esp32)
|
||||
After following the steps above, your device should be in flash mode. You can flash your device using the [Meshtastic flasher](/docs/software/python/flasher) or [manual method](https://meshtastic.org/docs/getting-started/flashing-firmware/flashing-esp32)
|
||||
|
||||
Example using the Meshtastic Flasher
|
||||
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ import TabItem from '@theme/TabItem';
|
|||
|
||||
## Recommended Flashing Method for ESP32 Devices
|
||||
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.) we recommend using the [web based installer](https://flasher.meshtastic.org) or the [Meshtastic Flasher application](/docs/software/python/meshtastic-flasher). The flasher application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.) we recommend using the [web based installer](https://flasher.meshtastic.org) or the [Meshtastic Flasher application](/docs/software/python/flasher). The flasher application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
|
|
@ -16,7 +16,7 @@ Make sure not to power the radio on without first attaching the antenna! You cou
|
|||
|
||||
If you have RAK NRF based devices or a LilyGO T-Echo, [the drag and drop firmware installation process](/docs/getting-started/flashing-firmware/nrf52/flashing-nrf52) is the easiest solution.
|
||||
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.) we recommend using the [web based installer](https://flasher.meshtastic.org) or the [Meshtastic Flasher application](/docs/software/python/meshtastic-flasher). The flasher application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.) we recommend using the [web based installer](https://flasher.meshtastic.org) or the [Meshtastic Flasher application](/docs/software/python/flasher). The flasher application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
|
||||
## Manual Firmware Installation
|
||||
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ values={[
|
|||
|
||||
All User config options are available in the python CLI. Example commands are below:
|
||||
|
||||
Please see instructions for [Enabling HAM License](/docs/software/python/cli/python-cli-usage#ham-radio-support)
|
||||
Please see instructions for [Enabling HAM License](/docs/software/python/cli/usage#ham-radio-support)
|
||||
|
||||
```shell title="Set the LongName Value"
|
||||
meshtastic --set-owner 'your node name'
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ GPIO access is fundamentally dangerous because invalid options can physically da
|
|||
This feature uses a preinstalled module in the device code and associated command line flags/classes in the python code. You'll need to be running at least version 1.2.23 (or later) of the python and device code to use this feature.
|
||||
:::
|
||||
|
||||
You can get the latest python tool/library with `pip3 install --upgrade meshtastic` on Windows/Linux/OS-X. See the [python section](/docs/software/python/cli/python-installation) for more details.
|
||||
You can get the latest python tool/library with `pip3 install --upgrade meshtastic` on Windows/Linux/OS-X. See the [python section](/docs/software/python/cli/installation) for more details.
|
||||
|
||||
## Supported operations in the initial release
|
||||
|
||||
|
|
@ -133,7 +133,7 @@ By default, the pin may be "off" or "on". (It will most likely "off".) See the s
|
|||
|
||||
## Doing GPIO operations
|
||||
|
||||
You can programmatically do operations from your own python code by using the Meshtastic `RemoteHardwareClient` class. See the [python API](/docs/software/python/cli/python-installation) documentation for more details.
|
||||
You can programmatically do operations from your own python code by using the Meshtastic `RemoteHardwareClient` class. See the [python API](/docs/software/python/cli/installation) documentation for more details.
|
||||
|
||||
## Using GPIOs from the python CLI
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: python-development
|
||||
id: development
|
||||
title: Meshtastic Python Development
|
||||
sidebar_label: Development
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: python-installation
|
||||
id: installation
|
||||
title: Meshtastic-python installation
|
||||
sidebar_label: Installation
|
||||
sidebar_position: 1
|
||||
|
|
|
|||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
id: python-stream
|
||||
title: Meshtastic-python stream protocol
|
||||
sidebar_label: Stream Protocol
|
||||
---
|
||||
|
||||
# Stream protocol
|
||||
|
||||
Documentation on how out protobufs get encoded when placed onto any stream transport (i.e. TCP or serial, but not UDP or BLE)
|
||||
|
||||
## Wire encoding
|
||||
|
||||
When sending protobuf packets over serial or TCP each packet is preceded by uint32 sent in network byte order (big endian).
|
||||
The upper 16 bits must be 0x94C3. The lower 16 bits are packet length (this encoding gives room to eventually allow quite large packets).
|
||||
|
||||
Implementations validate length against the maximum possible size of a BLE packet (our lowest common denominator) of 512 bytes. If the
|
||||
length provided is larger than that we assume the packet is corrupted and begin again looking for 0x4403 framing.
|
||||
|
||||
The packets flowing towards the device are ToRadio protobufs, the packets flowing from the device are FromRadio protobufs.
|
||||
The 0x94C3 marker can be used as framing to (eventually) resync if packets are corrupted over the wire.
|
||||
|
||||
Note: the 0x94C3 framing was chosen to prevent confusion with the 7 bit ascii character set. It also doesn't collide with any valid utf8 encoding. This makes it a bit easier to start a device outputting regular debug output on its serial port and then only after it has received a valid packet from the PC, turn off unencoded debug printing and switch to this
|
||||
packet encoding.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: python-cli-usage
|
||||
id: usage
|
||||
title: Using the Meshtastic CLI
|
||||
sidebar_label: Usage
|
||||
sidebar_position: 2
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: meshtastic-flasher
|
||||
id: flasher
|
||||
title: Using Meshtastic Flasher
|
||||
sidebar_label: Meshtastic Flasher
|
||||
sidebar_position: 1
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ The method with the least platform support, uses the [Web Serial API](https://we
|
|||
|
||||
## Updating
|
||||
|
||||
The web interface is now included in firmware releases. There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/software/python/meshtastic-flasher) to update your device to the current stable build which includes the web interface.
|
||||
The web interface is now included in firmware releases. There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/software/python/flasher) to update your device to the current stable build which includes the web interface.
|
||||
|
||||
:::warning
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ The first time your device restarts after enabling WiFi, it will take an additio
|
|||
### Problem: File not found: /static/index.html
|
||||
|
||||
:::note
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/software/python/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/software/python/flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
:::
|
||||
|
||||
Cause: This most likely means that the file system for the web server has not been loaded. You probably used esphome-flasher or some other GUI tool to flash the firmware.
|
||||
|
|
@ -82,7 +82,7 @@ Option 3) Flash the device with the SPIFFS instructions in platform.io.
|
|||
### Insufficient space to upload new files
|
||||
|
||||
:::note
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/software/python/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/software/python/flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
:::
|
||||
|
||||
Cause: Typically a small partition has been set aside from previous firmware installed on the module. Instructions for how to fix this can be found on the [ESP32-Partitions](/docs/software/web/web-partitions-software) page.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: ESP32 partitions
|
|||
---
|
||||
|
||||
:::caution
|
||||
It has been reported that some of this information is out of date. Flashing the device with [Meshtastic-flasher](/docs/software/python/meshtastic-flasher) should fix these partition issues and update you to the current web interface.
|
||||
It has been reported that some of this information is out of date. Flashing the device with [Meshtastic-flasher](/docs/software/python/flasher) should fix these partition issues and update you to the current web interface.
|
||||
|
||||
FIXME - Investigate and rewrite document to reflect the current ESP32 Partition mitigation.
|
||||
:::
|
||||
|
|
|
|||
Loading…
Reference in a new issue