rbxii3/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-12-23 03:00:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add high level end-user todos

Browse Source
This commit is contained in:
geeksville
2020-02-20 14:05:18 -08:00
parent b060c518a2
commit e9279c6daa
3 changed files with 34 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/README.md
View File

@@ -8,6 +8,22 @@ 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.
### Uses
* Outdoor sports where cellular coverage is limited. (Hiking, Skiing, Paragliding etc..)
* Applications where closed source GPS communicators just won't cut it (it is easy to add features for pilots etc...)
* Secure long-range communication within groups without depending on cellular providers
### Features
(Not all of these features are fully implemented yet - see below)
* Very long battery life (should be about 8 days with the beta software)
* Built in GPS and LORA radio, but we manage the radio automatically for you
* Shows direction and distance to all members of your channel
* Open and extensible codebase supporting multiple hardware vendors - no lock in to one vendor
* Communication API for bluetooth devices (such as our Android app) to use the mesh
* Eventually (within a couple of months) we should have a modified version of Signal that works with this project.
Typical time between recharging the radios should be about eight days.
This project is currently pre-alpha, but if you have questions please join our chat [![Join the chat at https://gitter.im/Meshtastic/community](https://badges.gitter.im/Meshtastic/community.svg)](https://gitter.im/Meshtastic/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
@@ -40,3 +56,17 @@ We don't yet distribute prebuilt binaries. But soon (by Feb 22) we will have a
For a nice TTGO 3D printable case see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
For a nice Heltec 3D printable case see this [design](https://www.thingiverse.com/thing:3125854) by [ornotermes](https://www.thingiverse.com/ornotermes).
# Disclaimers
This project is still pretty young but moving at a pretty good pace. Not all features are fully implemented in the current alpha builds.
Most of these problems should be solved by the beta release:
* Encryption is turned off for now
* A number of software work items have to be completed before battery life matches our measurements, currently battery life is about two days
* The current Android GUI is pretty ugly still
* The Android API needs to be documented better
* The Bluetooth API needs to be documented better
* The mesh protocol is turned off for now, currently we only send packets one hop distant
For more details see the [device software TODO](https://github.com/geeksville/Meshtastic-esp32/blob/master/TODO.md) or the Android app [TODO](https://github.com/geeksville/Meshtastic-Android/blob/master/TODO.md).