https://github.com/akitaengineering/akita-meshtastic-traffic-class-plugin

The Akita Meshtastic Traffic Class Plugin is a Meshtastic plugin that introduces a sophisticated traffic class system, enabling enhanced network segmentation, quality of service (QoS), and reliability.
https://github.com/akitaengineering/akita-meshtastic-traffic-class-plugin

mesh-networks meshtastic networking networking-tools qos

Last synced: about 2 months ago
JSON representation

The Akita Meshtastic Traffic Class Plugin is a Meshtastic plugin that introduces a sophisticated traffic class system, enabling enhanced network segmentation, quality of service (QoS), and reliability.

• Host: GitHub
• URL: https://github.com/akitaengineering/akita-meshtastic-traffic-class-plugin
• Owner: AkitaEngineering
• License: gpl-3.0
• Created: 2025-03-12T20:29:01.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2025-03-12T20:48:40.000Z (2 months ago)
• Last Synced: 2025-03-12T21:29:12.659Z (2 months ago)
• Topics: mesh-networks, meshtastic, networking, networking-tools, qos
• Language: C++
• Homepage: https://akitaengineering.com
• Size: 29.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Akita-Meshtastic-Traffic-Class-Plugin - Meshtastic Plugin

## Overview

The Akita Meshtastic Traffic Class Plugin is a Meshtastic plugin that introduces a sophisticated traffic class system, enabling enhanced network segmentation, quality of service (QoS), and reliability. Designed with Akita Engineering's high standards in mind, this plugin provides advanced features such as dynamic fragmentation, retransmission logic, congestion control, and adaptive traffic management.

## Features

* **Traffic Class Segmentation:**

    * Logical separation of network traffic into different classes (e.g., data, critical alerts).

* **Quality of Service (QoS):**

    * Prioritization of traffic based on configurable traffic class priorities.

* **Reliable Transmission:**

    * Retransmission logic for reliable traffic classes, ensuring data delivery.

* **Congestion Control:**

    * Dynamic adjustment of congestion windows to prevent network overload.

* **Dynamic Fragmentation:**

    * Adaptive fragment size based on link quality.

* **Dynamic Traffic Class Adaptation:**

    * Automatic adjustment of traffic class parameters based on network conditions, battery level, node load, and queue length.

* **Routing Metric Adjustments:**

    * Adjusts routing metrics based on traffic class priority and link quality, with exponential backoff for poor links.

* **Error Correction and Forward Error Correction (FEC):**

    * Simplified XOR error correction and FEC. Replace with robust algorithms.

* **Encryption:**

    * Simplified XOR encryption. Replace with robust encryption.

* **Airtime Fairness:**

    * Simple round-robin airtime fairness.

* **Reassembly Timeout:**

    * Reassembly timers with cleanup mechanism for stale fragments.

* **Configuration Parameters:**

    * Configurable retries, FEC level, and congestion window settings.

## Installation

1.  **Clone the Repository:**

    ```bash

    git clone [repository URL]

    ```

2.  **Build the Plugin:**

    * Follow the Meshtastic plugin build instructions.

    * Place the `akita_traffic_class_plugin.cpp` file in the appropriate plugin directory.

    * Compile the plugin using the Meshtastic build system.

3.  **Install the Plugin:**

    * Copy the compiled plugin binary to the Meshtastic device's plugin directory.

    * Configure Meshtastic to load the plugin.

## Configuration

The plugin can be configured using the Meshtastic CLI or app.

### CLI Configuration Example

```bash

# Configure traffic class 1 with priority 5, reliable transmission, encryption, max fragment size 200, 3 retries, FEC level 2, congestion window 5

meshtastic --set plugin.akita_traffic_class.configure_class 1 5 true true 200 3 2 5

   ```

# Configuration Parameters

* **Traffic Class ID:** Unique identifier for the traffic class (e.g., 1-255).

* **Priority:** Priority level (higher values indicate higher priority).

* **Reliable:** Enable reliable transmission (retransmissions).

* **Encrypted:** Enable encryption (requires implementation).

* **Max Fragment Size:** Maximum fragment size in bytes.

* **Retries:** Number of retransmission attempts.

* **FEC Level:** Forward error correction level (requires implementation).

* **Congestion Window:** Initial congestion window size.

# Usage

Once installed and configured, the plugin will automatically manage traffic based on the configured traffic classes.

## Setting Traffic Class in Packets

To set the traffic class of a packet, use the appropriate Meshtastic API or CLI command.

## Example setting the traffic class of a message.

   ```Bash

meshtastic --sendtext "Hello Traffic Class 1" --dest !1 --traffic-class 1

   ```

# Important Considerations

* **Placeholders:** This code contains placeholders for critical functionalities. Implement these placeholders based on your specific needs.

# Further Development

* **Complete Placeholders:** Implement the TODO sections for encryption, FEC, routing metric updates, reassembly logic, QoS monitoring, and configuration loading.

* **Robust Error Handling:** Implement comprehensive error handling and logging.

* **Performance Optimization:** Profile and optimize the code for performance on resource-constrained devices.

* **Integration with Akita Ecosystem:** Explore integration with other Akita Engineering tools and platforms.

* **Battery Power Optimization:** Implement advanced power-saving strategies.

* **Firmware Over-the-Air (FOTA) Updates:** Design the plugin to support FOTA updates.

* **Link Quality Estimation Improvements:** Implement better link quality estimation.

* **Integration with External Systems:** Explore integration with external systems, such as MQTT brokers or cloud platforms.

# Contributing

Contributions are welcome! Please submit pull requests or open issues to report bugs or suggest enhancements.