Project Website | Code Documentation | Donate | Sponsor | Buy

Turpial Firmware

Welcome, and thank you for your visit. Here you can find the main firmware for the Turpial device, compatible with Locha Mesh and be aware of our development process.

About Locha Mesh

The Locha Mesh network is a secure radio network for off-grid messaging, Bitcoin and other cryptocurrencies transactions without access to the Internet. The main objective is a long range network for everyone and everywhere. For this reason, we are working not only in a protocol, but also in the firmware for affordable devices like our Turpial.

If you want to learn more about Locha Mesh, feel free to read the Locha Mesh main repository or take a look at our website locha.io.

Sponsor

If you want to support this project you can make a donation to the Locha Mesh effort to build private censorship-resistant mesh network devices for Bitcoin and other cryptocurrencies transactions without Internet.

Here are some places if you want to support us:

• Donate: https://locha.io/donate
• Buy Turpial devices: https://locha.io/buy

Supported ESP32 boards

Currently we use the ESP-WROVER-KIT development board to test the code and the radio module, although other ESP32 boards can be used as long as it fits on the flash memory. It should work on both the WROOM and WROVER chips without changes on the code.

The board connects over UART to the SimpleLink CC1312R radio module, the pinout is yet to be decided in the final complete board design. See the radio-firmware repository for more information on the radio module we use.

Table of Contents

Turpial Firmware

About Locha Mesh

Sponsor

Supported ESP32 boards

• Getting Started
  • Development Workflow.
  • Installing RIOS-OS.
  • Clone this repository
  • Compiling.
  • Flashing the Firmware
  • Compiling Documentation.

License

Getting Started

Since this is an open source project you can contribute with your code and knowledge, or by making changes to the documentation. We invite and welcome all contributions. Below is a brief description on how to work with the code and to compile

Development Workflow

Development happens in the dev branch. All Pull-Requests should be pointed to that branch. Please, make sure you follow the CONTRIBUTING.md guidelines. All Pull-Requests require that at least two developers review them first before merging to dev branch.

Installing RIOT-OS

RIOT is a real-time multi-threading operating system that supports a range of devices that are typically found in the Internet of Things (IoT): 8-bit, 16-bit and 32-bit microcontrollers.

currently only it is only compatible with linux (Debian / Ubuntu) for Mac OS you can search for alternatives like docker here we leave you a detailed guide check by riot team.

Clone this repository

`git clone git@github.com:btcven/turpial-firmware.git`

Compiling

1. cd turpial-firmware
2. git submodule init
3. git submodule update
4. make

Flashing the Firmware

To upload the binary to the ESP32 you have connected to your computer, you need to use the following command:

  make -p PORT flash 

Where PORT specifies on what port you have connected your ESP32 development board.

Compiling Documentation

You can compile the code documentation by installing the following tools:

1. Doxygen
2. Python 3
3. pip install -U sphinx
4. pip install -U sphinx-rtd-theme
5. pip install -U breathe

Now you can just checkout to the doc/ directory and run:

make html

The documentation will reside in doc/build/_html/, from there you can open index.html.

License

Copyright © 2019 Bitcoin Venezuela and Locha Mesh developers.

Licensed under the Apache License, Version 2.0

---

A text quote is shown below

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---

Read the full text: Locha Mesh Apache License 2.0