diff --git a/README.md b/README.md index 65105895..6b559aa6 100644 --- a/README.md +++ b/README.md @@ -33,85 +33,11 @@ ## What is Meshtastic? - - - - -

Meshtastic® is a project that lets you use inexpensive GPS mesh radios as an extensible, super long battery life mesh GPS communicator. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of your private mesh can always see the location and distance of all other members and any text messages sent to your group chat.

The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.

-
-## Getting started -###### Description, should mention: - -You will require atleast one of [these](https://github.com/meshtastic/meshtastic-device#supported-hardware) devices - -- Link to device compatability table on `meshtastic/meshtastic-device` -- Link to flashing instructions - -## Community - -###### Description, should mention: - -- Discussions tab: https://github.com/meshtastic/Meshtastic/discussions -- Forum -- Slack -- unofficial/international communities -- Maybe have an `awesome-meshtastic` page, have all of the apps and extensions ppl have made - -## Software - -###### Description - -#### Meshtastic App - - - - - -
-

-The official Meshtastic Android app, It provides messaging, channel configuration and a real time map. It also has inbuilt functionality for updating device firmware over Bluetooth -

-
- -#### Meshtastic Device - - - - - -
-

-The paramount Meshtastic project, the device firmware itself. Runs on supported hardware that allows the creation of mesh networks at any scale -

-
- -#### Meshtastic.js - - - - - -
-

-TypeScript library for interfacting with Meshtastic -

-
- -#### Meshtastic-python - - - - - -
-

-Description about product -

-
+

Please see our website for more information about Meshtastic

\ No newline at end of file diff --git a/website/docs/software/android/installation.md b/website/docs/software/android/installation.md index c910ffab..c70b1188 100644 --- a/website/docs/software/android/installation.md +++ b/website/docs/software/android/installation.md @@ -3,12 +3,16 @@ id: android-installation title: Android application installation sidebar_label: Installation --- -Our Android application is available to download on Google Play. +~Our Android application is available to download on Google Play.~ Our Google Play listing has been removed by google due to a recent policy change by them with respect to the background location accesss (which our app needs). We've started the 'appeal' process, but for now you'll need to get the app from other places. -

Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh

+The app is also available on the Amazon [Appstore](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q). You will need to install the Amazon Appstore onto your phone in order to install the Meshtastic application. + +

Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh - Download at https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q

The application may not be found if your phone/Android version are too old. The minimum Android version is 5.0 (Lollipop 2014, first BLE support). However Android 6, Marshmallow 2015, is recommended as the Bluetooth is more stable. +The app can also be sideloaded by downloading the .apk from the GitHub releases page. If you wish to view the code or contribute to development of the app, please visit the app's GitHub page. + On installing the Meshtastic app, load it and navigate to the settings page. The app will ask you to give it permissions to access your location. This is needed for any app to use bluetooth, as the app is then able to scan the local area for bluetooth devices and, in theory, could triangulate your location based the devices it sees. If you give location permissions "only while using the app", the app will only be able to use bluetooth while it is open and visible to the user. This means if the screen is locked, or you are using another app, Meshtastic will not be able to use bluetooth, and will not be able to receive any messages from the node. [![Messages page](/img/android/android-messages-sm.png)](/img/android/android-messages-sm.png) [![Nodes page](/img/android/android-nodes-sm.png)](/img/android/android-nodes.png) [![Channel page](/img/android/android-channel-sm.png)](/img/android/android-channel.png) [![Settings page](/img/android/android-settings-sm.png)](/img/android/android-settings.png) [![Debug page](/img/android/android-debug-sm.png)](/img/android/android-debug.png) diff --git a/website/docs/software/device/device.md b/website/docs/software/device/device.md index f58f03b3..97c1c410 100644 --- a/website/docs/software/device/device.md +++ b/website/docs/software/device/device.md @@ -8,6 +8,7 @@ The device firmware runs on the nodes to build the mesh for communication. Each The current firmware has support for a screen to display received messages, along with information about nodes on the mesh, and more detailed information about the device on which it is running. +The latest firmware can be downloaded from the GibHut releases page, which also contains the release notes for each version. If you wish to view the code or contribute to development of the firmware, please visit the device code GitHub page. ### Buttons A number of devices support buttons that can be used to interact with the firmware. These buttons have a number of different functions: diff --git a/website/docs/software/js/getting-started.md b/website/docs/software/js/getting-started.md index 190a401c..6f01b702 100644 --- a/website/docs/software/js/getting-started.md +++ b/website/docs/software/js/getting-started.md @@ -12,6 +12,8 @@ Full API docummentation is avaliable at [js.meshtastic.org](https://js.meshtasti Meshtastic.js is a JavaScript library that provides an interface to Meshtastic devices. It can be used to build applications to interface with a Meshtastic network. Currently HTTP(S) and Bluetooth connections are supported. +If you wish to view the code or contribute to development of the library, please visit the JavaScript code GitHub page. + ## Connection methods ### HTTP(S) diff --git a/website/docs/software/python/installation.md b/website/docs/software/python/installation.md index 8b19c678..74fbad96 100644 --- a/website/docs/software/python/installation.md +++ b/website/docs/software/python/installation.md @@ -10,6 +10,8 @@ This is a python library for using Meshtastic devices. This small library (and e [Full documentation](https://meshtastic.github.io/Meshtastic-python) for the library, including examples, is available. +If you wish to view the code or contribute to development of the python library or the command line interface, please visit the Meshtastic python GitHub page. + Installation is easily done through the [Python package installer pip](https://pypi.org/project/meshtastic/) (note, you must use pip version 20 or later): @@ -119,5 +122,28 @@ Installation is easily done through the [Python package installer pip](https://p pip3 install --upgrade meshtastic ``` + + +* Install [Termux](https://f-droid.org/en/packages/com.termux/) from the F-Droid app store (Google play does not currently support the latest builds) +* Load Termux and update the package list + ``` + pkg update + ``` +* Upgrade the installed packages + ``` + pkg upgrade + ``` +* Install python + ``` + pkg install python + ``` +* Upgrade pip and installed meshtastic and its dependancies + ``` + pip install --upgrade pip pytap2 wheel mesthtastic + ``` + +:::note +Be aware that currently the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over wifi using the `--host x.x.x.x` option with the device IP address. However, only ESP32 devices can use wifi currently. +::: \ No newline at end of file diff --git a/website/static/img/amazon-fire-button.png b/website/static/img/amazon-fire-button.png new file mode 100644 index 00000000..b581f7ee Binary files /dev/null and b/website/static/img/amazon-fire-button.png differ