Updated readme

This commit is contained in:
Mark Qvist 2018-06-20 21:30:36 +02:00
parent c929ce3e13
commit 3a2c3bf1cc

View File

@ -1,11 +1,18 @@
RNode Firmware α
==========
# RNode Firmware
RNode is a LoRa-based radio interface designed for use with the Reticulum Network Stack.
## Intro
This is the firmware for RNode, a very flexible LoRa-based communication device. RNode can functions as a:
Reticulum is a cryptography-based networking stack for low-bandwidth, high-latency, wide-area networks built on cheap and readily available hardware. Reticulum allows you to build very wide-area networks with cheap off-the-shelf tools, and offers end-to-end encryption, cryptographically backed multi-hop transport, efficient addressing, resource caching, unforgeable packet acknowledgements and much more.
- Network adapter for [RNS](https://github.com/markqvist/Reticulum)
- LoRa interface for your computer (or any device with a USB or serial port)
- Packet sniffer for LoRa networks
- LoRa development board
- A flexible platform for experiementing with LoRa technology
For more info, see [unsigned.io/projects/reticulum](http://unsigned.io/projects/reticulum/)
RNode is controlled by a powerful ATmega1284p MCU, and is fully Arduino compatible. You can use this firmware, or it can be programmed any way you like, either from the Arduino IDE, or using any of the available tools for AVR development. This firmware can also be edited and compiled directly from the Arduino IDE.
For configuring an RNode with this firmware, please have a look at the [RNode Config Utility](https://github.com/markqvist/rnodeconfigutil).
## Current Status
The entire Reticulum project is currently in pre-alpha state. Even the master branch should be considered experimental. At this point the protocol may change without notice, and is made publicly available for development collaboration, previewing and testing features. Do not build anything serious with Reticulum yet. Stable alpha release will be at the end of May 2018.
The RNode firmware has not seen much real world testing, and should be considered beta at this point.