Skip to content

Commit 7a4c7f5

Browse files
committed
WIP
1 parent fa0d317 commit 7a4c7f5

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
HighFlowNext is a Rust library for communicating with the [Aquacomputer high flow NEXT](https://shop.aquacomputer.de/Monitoring-and-Controlling/Sensors/Flow-sensor-high-flow-NEXT-G1-4::3953.html) device. It provides strongly typed access to the device’s binary protocol, allowing you to interact with sensor values, settings, and configuration in a safe and structured way. The primary goal of this project is to enable clean integration of the high flow NEXT into [OpenRGB](https://openrgb.org/), so that device data and lighting controls can be accessed and managed alongside other RGB hardware.
44

5+
> **Notice**: This is **not an official implementation** from Aquacomputer.
6+
7+
> **Warning**: No guarantees are given regarding correctness, completeness, or stability of the protocol description. Use it at your own risk.
8+
59
## Features
610

711
- Reading the settings frame (**done**)
@@ -19,6 +23,12 @@ Planned write-paths for ambient color and sound data aim to let OpenRGB drive RG
1923

2024
Beyond OpenRGB, the crate can also support monitoring, logging, and automation workflows where you want to read configuration, calibrations, and live telemetry and then act on it in your own services or dashboards.
2125

26+
## Protocol Specification
27+
28+
If you are only interested in the details of the communication protocol itself,
29+
please have a look at the included [specification file](https://github.com/Bergmann89/HighFlowNext/blob/master/protocol/SPECIFICATION). It describes the binary
30+
layout of settings, frames, effects, colors, and source control mappings.
31+
2232
## License
2333

2434
This crate is licensed under the MIT License.

0 commit comments

Comments
 (0)