Merge branch 'master' into update-rak-hardware-sensors

This commit is contained in:
Thomas Göttgens 2022-12-15 08:53:32 +01:00 committed by GitHub
commit b1cb763b3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 34 deletions

View file

@ -13,7 +13,7 @@ This site (which has a great search function) is the preferred place for up-to-d
### How can I contribute to Meshtastic? ### How can I contribute to Meshtastic?
Everyone contributes in a different way. Join the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](/docs/developers) menu on the left. Everyone contributes in a different way. Join the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Development](/docs/developers) menu on the left.
<!-- Android Client--> <!-- Android Client-->
@ -21,48 +21,42 @@ Everyone contributes in a different way. Join the [Meshtastic Discord](https://d
### What versions of Android does the Meshtastic Android App require? ### What versions of Android does the Meshtastic Android App require?
Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable. Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however at least Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable. While Android 5/6 are officially supported by Meshtastic, it is *not* recommended that you purchase devices with these versions due to their limited OS support and limited battery life due to age. Many newer models exist that are very affordable. A good resource to use when researching affordable devices is the [LineageOS Supported Devices List](https://wiki.lineageos.org/devices/).
### What's the cloud icon next to the message? ### What is the cloud icon next to the message?
- Empty Cloud - Queued on the app to be sent to your device. - Empty Cloud - Queued on the device to be sent over the mesh.
- Up Arrow - Queued on the device to be sent over the mesh. - Up Arrow - Queued on the app to be sent to your device.
- Check Mark - At least one other device on the mesh confirmed it received the message. - Check Mark - At least one other node on the mesh acknowledged the message.
- Cross Mark - No confirmation was received after the default three retransmissions. - Cross Mark - Not acknowledged or message error.
### How can I clear the message history? ### How can I clear the message history?
Long press any message to select and show the menu with "delete" and "select all" buttons. Long press any message to select and show the menu with "delete" and "select all" buttons.
<!-- iOS Client--> ### After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?
## iOS Client Try forgetting the Bluetooth connection from the Android Bluetooth Settings menu. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.
### What version of iOS does the Meshtastic iOS App Require? <!-- Apple Clients-->
The iOS app requires iOS v16. ## Apple Clients
### How do I get the Meshtastic iOS App? ### What version of iOS/iPadOS/macOS does the Meshtastic App Require?
See [iOS App](/docs/software/apple/installation) The Meshtastic App on Apple Clients require the following minimum OS versions: iOS 16, iPadOS 16, and macOS 13.
### After updating firmware, my node is not connecting via Bluetooth. What should I do? ### How do I get the Apple Meshtastic App?
Try forgetting the Bluetooth connection from the iOS System Settings. Re-pair and try again. See [Apple Apps](/docs/software/apple/installation)
<!-- Web Client--> ### After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?
## Web Client Try forgetting the Bluetooth connection from the iOS/iPadOS/macOS System Settings. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.
### How do I access the network from my web browser? ### Do the Apple applications provide an indication if the message was acknowledged on the mesh?
Visit http://meshtastic.local (Note: This is a work in progress.) Yes, when the message is sent you will first see a `Waiting to be acknowledged...` status beneath the message. If the message is acknowledged by a node on the mesh this will update to `Acknowledged`, but if no nodes have responded it will indicate `Max Retransmission Reached`. If there is an error, the status will update to the appropriate error. Additionally, you can long press on the message and select `Message Details` to view the date/time sent, if ack was received and the time ack was received or the error (if there was one).
### I've Flashed my device but I can't access the Web UI
Ensure you have used the included `device-install` script to flash your device, and that the file `spiffs-*.bin` is present in the same folder as your firmware at the time of flashing.
Note: Currently only Chrome and Chromium based browsers offer reliable support for the Web UI.
<!-- Channels --> <!-- Channels -->
@ -70,7 +64,7 @@ Note: Currently only Chrome and Chromium based browsers offer reliable support f
### How do I share my Meshtastic Channel with other people? ### How do I share my Meshtastic Channel with other people?
Your Meshtastic client (Android, Web, or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel. Note: This feature is not yet available on the iOS app. Your Meshtastic client (Android, Apple, Web, or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel.
<!-- Python --> <!-- Python -->

View file

@ -44,22 +44,31 @@ It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https
_Google Play and the Google Play logo are trademarks of Google LLC._ _Google Play and the Google Play logo are trademarks of Google LLC._
### Install by Sideloading
<p float="center">
<a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest">
<img alt="Download at https://github.com/meshtastic/Meshtastic-Android/releases/latest"
src="/img/android/get-it-on-github.png"
width="49%"/>
</a>
</p>
The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page.
If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's [GitHub page](https://github.com/meshtastic/Meshtastic-Android)
### Install with Obtainium ### Install with Obtainium
1. Download and Install the Obtanium app from [Github](https://github.com/ImranR98/Obtainium). 1. Download and Install the Obtanium app from [Github](https://github.com/ImranR98/Obtainium).
2. Open the Obtanium app and navigate to `+ Add App`. 2. Open the Obtanium app and navigate to `+ Add App`.
3. Enter the Meshtastic Android Github Releases address as follows: `https://github.com/meshtastic/Meshtastic-Android/releases`. 3. You can easily search for the Android repo with the search field by typing `Meshtastic-Android` and selecting the `Meshtastic/Meshtastic-Android` repo. You may also manually enter the Meshtastic Android Github Releases address as follows: `https://github.com/meshtastic/Meshtastic-Android/releases`.
4. Under `Additional Options for Github` toggle as desired `Include prereleases`* or `Fallback to older releases` and press `Add`. 4. Under `Additional Options for Github` toggle as desired `Include prereleases`* or `Fallback to older releases` and press `Add`.
5. The first time you add an application, obtainium will prompt you for permission to install unknown apps, you will need to toggle `Allow from this source` and press back. Obtainium will download the Android .APK from the Github release page. 5. The first time you add an application, obtainium will prompt you for permission to install unknown apps, you will need to toggle `Allow from this source` and press back. Obtainium will download the Android .APK from the Github release page.
6. Press `Install`. Android Installer will prompt "Do you want to install this app?" press `Install`. 6. Press `Install`. Android Installer will prompt "Do you want to install this app?" press `Install`.
7. Press `Open`. 7. Press `Open`.
Obtanium will provide notifications when a new release version of the Meshtastic App is available and allow you to update it from within the app. Obtainium allows you to install and update Open-Source Apps directly from their releases pages, and receive notifications when new releases are made available.
*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions. *Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions.
### Install by Sideloading
The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page.
If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's [GitHub page](https://github.com/meshtastic/Meshtastic-Android)

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.3 KiB