WIP

Author: Bergmann89

.github/workflows/main.yml

@@ -0,0 +1,54 @@
+name: Main
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: check
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+
+    - uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cargo/bin/
+          ~/.cargo/registry/index/
+          ~/.cargo/registry/cache/
+          ~/.cargo/git/db/
+          target/
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: rust environment
+      run: rustc --version && cargo --version
+
+    - name: cargo clippy
+      run: cargo clippy --all-targets --all-features -- --deny "warnings"
+
+    - name: cargo fmt
+      run: cargo fmt --all --check
+
+    - name: cargo test
+      run: cargo test
+
+    - name: cargo doc
+      run: cargo doc --no-deps
+      env:
+        RUSTDOCFLAGS: '-D warnings'
+
+    - name: cargo build
+      run: cargo build --release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Lumeo, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,24 @@
+# HighFlowNext
+
+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.
+
+## Features
+
+- Reading the settings frame (**done**)
+- Writing the settings frame (**planned**)
+- Reading / Writing the strings frame (**planned**)
+- Reading sensor values
+- Writing ambient color data (**planned**)
+- Writing sound data (**planned**)
+
+## Use Cases
+
+HighFlowNext is intended as a building block for an OpenRGB integration. By decoding the device’s settings and sensor values, it becomes straightforward to surface flow rate, temperatures, and conductivity within the OpenRGB UI or its plugins.
+
+Planned write-paths for ambient color and sound data aim to let OpenRGB drive RGBpx lighting effects on the high flow NEXT directly, coordinating lighting with the rest of a system’s devices.
+
+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.
+
+## License
+
+This crate is licensed under the MIT License.