sforkowany z mirror/meshtastic-firmware
README is now good enough for prealpha
geeksville
rodzic
0b085aafcc
commit
526409be2f
19
README.md
19
README.md
|
|
@ -11,14 +11,13 @@ will optionally work with your phone, but no phone is required.
|
||||||
|
|
||||||
Typical time between recharging the radios should be about eight days.
|
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: [](https://gitter.im/Meshtastic/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
|
This project is currently pre-alpha, but if you have questions please join our chat [](https://gitter.im/Meshtastic/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
|
||||||
|
|
||||||
This software is 100% open source and developed by a group of hobbyist experimenters. No warranty is provided, if you'd like to improve it - we'd love your help. Please post in the chat.
|
This software is 100% open source and developed by a group of hobbyist experimenters. No warranty is provided, if you'd like to improve it - we'd love your help. Please post in the chat.
|
||||||
|
|
||||||
## Meshtastic Android app
|
## Meshtastic Android app
|
||||||
The source code for the Meshtastic Android app is [here](https://github.com/geeksville/Meshtastic-Android).
|
The source code for the Meshtastic Android app is [here](https://github.com/geeksville/Meshtastic-Android).
|
||||||
Soon our first alpha release of will be released here:
|
Soon our first alpha release of will be released here:
|
||||||
|
|
||||||
[](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub%26utm_medium%3Desp32-readme%26utm_campaign%3Dmeshtastic-esp32%2520readme%26anid%3Dadmob&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)
|
[](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub%26utm_medium%3Desp32-readme%26utm_campaign%3Dmeshtastic-esp32%2520readme%26anid%3Dadmob&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)
|
||||||
|
|
||||||
## Supported hardware
|
## Supported hardware
|
||||||
|
|
@ -28,21 +27,21 @@ is optional, but highly recommended.
|
||||||
|
|
||||||
We don't yet distribute prebuilt binaries. But soon (by Feb 22) we will have a file that you can fairly easilly install on your radio via USB. Once our software is installed, all future software updates happen over bluetooth from your phone.
|
We don't yet distribute prebuilt binaries. But soon (by Feb 22) we will have a file that you can fairly easilly install on your radio via USB. Once our software is installed, all future software updates happen over bluetooth from your phone.
|
||||||
|
|
||||||
For a nice 3D printable case see [this design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
|
For a nice 3D printable case see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
|
||||||
|
|
||||||
# Development
|
# Development
|
||||||
The following sections are probably only interesting if you want to join us in developing the software.
|
The following sections are probably only interesting if you want to join us in developing the software.
|
||||||
|
|
||||||
## Power measurements
|
## Power measurements
|
||||||
Since one of the main goals of this project is long battery life, it is important to consider that in our software/protocol design. Based on initial measurements it seems that the current source base should run about three days between charging, and with a bit more software work (see the [TODO list](TODO.md)) a battery life of eight days should be quite doable. Our current power measurements/model is in [this spreadsheet](https://docs.google.com/spreadsheets/d/1ft1bS3iXqFKU8SApU8ZLTq9r7QQEGESYnVgdtvdT67k/edit?usp=sharing).
|
Since one of the main goals of this project is long battery life, it is important to consider that in our software/protocol design. Based on initial measurements it seems that the current code should run about three days between charging, and with a bit more software work (see the [TODO list](TODO.md)) a battery life of eight days should be quite doable. Our current power measurements/model is in [this spreadsheet](https://docs.google.com/spreadsheets/d/1ft1bS3iXqFKU8SApU8ZLTq9r7QQEGESYnVgdtvdT67k/edit?usp=sharing).
|
||||||
|
|
||||||
## Build instructions
|
## Build instructions
|
||||||
This project uses the simple PlatformIO build system. You can use the IDE, but for brevity
|
This project uses the simple PlatformIO build system. You can use the IDE, but for brevity
|
||||||
in these instructions I describe use of their command line tool.
|
in these instructions I describe use of their command line tool.
|
||||||
|
|
||||||
1. Purchase a suitable radio (about $30 from aliexpress)
|
1. Purchase a suitable radio (see above)
|
||||||
2. Install [PlatformIO](https://platformio.org/).
|
2. Install [PlatformIO](https://platformio.org/platformio-ide)
|
||||||
3. Download this git repo and cd into it.
|
3. Download this git repo and cd into it
|
||||||
4. Plug the radio into your USB port.
|
4. Plug the radio into your USB port
|
||||||
4. Type "pio run -t upload" (This command will fetch dependencies, build the project and install it on the board via USB).
|
4. Type "pio run -t upload" (This command will fetch dependencies, build the project and install it on the board via USB)
|
||||||
5. Platform IO also installs a very nice VisualStudio Code based IDE, see their tutorial if you'd like to use it.
|
5. Platform IO also installs a very nice VisualStudio Code based IDE, see their [tutorial](https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html) if you'd like to use it
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue