Reticulum/Roadmap.md

112 lines
5.4 KiB
Markdown
Raw Normal View History

2022-11-17 12:25:48 +01:00
# Reticulum Development Roadmap
2022-12-29 14:04:11 +01:00
This document outlines the currently established development roadmap for Reticulum.
1. [Currently Active Work Areas](#currently-active-work-areas)
2. [Primary Efforts](#primary-efforts)
- [Comprehensibility](#comprehensibility)
- [Universality](#universality)
2022-12-29 14:06:28 +01:00
- [Functionality](#functionality)
2022-12-29 14:42:45 +01:00
- [Usability & Utility](#usability--utility)
2022-12-29 14:06:28 +01:00
- [Interfaceability](#interfaceability)
2023-01-14 10:22:21 +01:00
3. [Auxillary Efforts](#auxillary-efforts)
4. [Release History](#release-history)
2022-12-29 14:04:11 +01:00
## Currently Active Work Areas
For each release cycle of Reticulum, improvements and additions from the five [Primary Efforts](#primary-efforts) are selected as active work areas, and can be expected to be included in the upcoming releases within that cycle. While not entirely set in stone for each release cycle, they serve as a pointer of what to expect in the near future.
2023-03-08 14:10:56 +01:00
- The current `0.5.x` release cycle aims at completing
2023-05-19 11:31:43 +02:00
- [x] Reach feature-completion of the Reticulum API
- [x] Improve performance and efficiency of the `Buffer` and `Channel` API
2023-03-08 12:35:41 +01:00
- [ ] Overhauling and updating the documentation
- [ ] Performance and memory optimisations of the Python reference implementation
- [ ] Fixing potential bugs
2023-03-08 12:34:09 +01:00
- [ ] Add automatic retries to all use cases of the `Request` API
2022-12-29 14:04:11 +01:00
## Primary Efforts
2022-11-17 12:35:21 +01:00
The development path for Reticulum is currently laid out in five distinct areas: *Comprehensibility*, *Universality*, *Functionality*, *Usability & Utility* and *Interfaceability*. Conceptualising the development of Reticulum into these areas serves to advance the implementation and work towards the Foundational Goals & Values of Reticulum.
2022-11-17 12:25:48 +01:00
2022-12-29 14:04:11 +01:00
### Comprehensibility
2022-11-17 12:25:48 +01:00
These efforts are aimed at improving the ease of which Reticulum is understood, and lowering the barrier to entry for people who wish to start building systems on Reticulum.
- Improving [the manual](https://markqvist.github.io/Reticulum/manual/) with tutorials specifically for beginners
- Updating the documentation to reflect recent changes and improvements
- Update descriptions of protocol mechanics
- Update announce description
- Add in-depth explanation of the IFAC system
- Software
- Update Sideband screenshots
- Update Sideband description
- Update NomadNet screenshots
- Update Sideband screenshots
- Installation
- Add a *Reticulum On Raspberry Pi* section
- Update *Reticulum On Android* section if necessary
- Update Android install documentation.
- Communications hardware section
- Add information about RNode external displays.
- Packet radio modems.
- Possibly add other relevant types here as well.
- Setup *Best Practices For...* / *Installation Examples* section.
- Home or office (example)
- Vehicles (example)
- No-grid/solar/remote sites (example)
2022-12-29 14:04:11 +01:00
### Universality
2022-11-17 12:25:48 +01:00
These efforts seek to broaden the universality of the Reticulum software and hardware ecosystem by continously diversifying platform support, and by improving the overall availability and ease of deployment of the Reticulum stack.
- OpenWRT support
- Create a standalone RNS Daemon app for Android
- A lightweight and portable C implementation for microcontrollers, µRNS
- A portable, high-performance Reticulum implementation in C/C++, see [#21](https://github.com/markqvist/Reticulum/discussions/21)
- Performance and memory optimisations of the Python implementation
- Bindings for other programming languages
2022-12-29 14:04:11 +01:00
### Functionality
2022-11-17 12:25:48 +01:00
These efforts aim to expand and improve the core functionality and reliability of Reticulum.
2023-02-09 14:07:30 +01:00
- Add automatic retries to all use cases of the `Request` API
2022-11-17 12:25:48 +01:00
- Network-wide path balancing
- Distributed Destination Naming System
- Globally routable multicast
2023-01-04 17:43:29 +01:00
- Destination proxying
2022-11-17 12:25:48 +01:00
- [Metric-based path selection and multiple paths](https://github.com/markqvist/Reticulum/discussions/86)
2022-12-29 14:04:11 +01:00
### Usability & Utility
2022-11-17 12:25:48 +01:00
These effors seek to make Reticulum easier to use and operate, and to expand the utility of the stack on deployed systems.
- Add bluetooth pairing code output to rnodeconf
- Easy way to share interface configurations, see [#19](https://github.com/markqvist/Reticulum/discussions/19)
- Transit traffic display in rnstatus
- rnsconfig utility
2022-12-29 14:04:11 +01:00
### Interfaceability
2022-11-17 12:25:48 +01:00
These efforts aim to expand the types of physical and virtual interfaces that Reticulum can natively use to transport data.
- Filesystem interface
- Plain ESP32 devices (ESP-Now, WiFi, Bluetooth, etc.)
- More LoRa transceivers
- AT-compatible modems
- Direct SDR Support
- Optical mediums
- IR Transceivers
- AWDL / OWL
- HF Modems
- GNU Radio
- CAN-bus
- Raw SPI
- Raw i²c
- MQTT
- XBee
- Tor
2022-12-29 14:09:47 +01:00
2023-01-14 10:22:21 +01:00
## Auxillary Efforts
The Reticulum ecosystem is enriched by several other software and hardware projects, and the support and improvement of these, in symbiosis with the core Reticulum project helps expand the reach and utility of Reticulum itself.
This section lists, in no particular order, various important efforts that would be beneficial to the goals of Reticulum.
- The [RNode](https://unsigned.io/rnode/) project
- [ ] Create a WebUSB-based bootstrapping utility, and integrate this directly into the [RNode Bootstrap Console](#), both on-device, and on an Internet-reachable copy. This will make it much easier to create new RNodes for average users.
2022-12-29 14:09:47 +01:00
## Release History
2022-12-29 14:35:55 +01:00
Please see the [Changelog](./Changelog.md) for a complete release history and changelog of Reticulum.