rship-skaarhoj
| Crates.io | rship-skaarhoj |
| lib.rs | rship-skaarhoj |
| version | 0.1.0 |
| created_at | 2025-07-28 21:01:09.213876+00 |
| updated_at | 2025-07-28 21:01:09.213876+00 |
| description | rship executor for controlling SKAARHOJ panels using Raw Panel Protocol V2 |
| homepage | |
| repository | https://github.com/ignition-is-go/rship-skaarhoj |
| max_upload_size | |
| id | 1771561 |
| size | 191,548 |
(lucid-max)
documentation
https://docs.rs/rship-skaarhoj
README
rship-skaarhoj
rship executor for controlling SKAARHOJ panels using Raw Panel Protocol V2. Bridges rship with SKAARHOJ hardware controllers for remote panel control.
Quickstart
git clone https://github.com/ignition-is-go/rship-skaarhoj
cd rship-skaarhoj
cp .env.example .env
cargo run
Configuration
Configure the connection using environment variables:
export PANEL_ADDRESS=192.168.1.100
export PANEL_PORT=9923
export RSHIP_ADDRESS=dev.rship.io
export RSHIP_PORT=5155
cargo run
Or edit the .env file:
PANEL_ADDRESS=192.168.1.100
PANEL_PORT=9923
RSHIP_ADDRESS=dev.rship.io
RSHIP_PORT=5155
Development
cargo fmt --all # Format code
cargo clippy --all-targets --all-features # Lint code (CI runs with -D warnings)
cargo test # Run tests
cargo run # Run the service
Dependencies
- rship-sdk: rship integration framework
- prost: Protocol Buffers implementation for Rust
- tokio: Async runtime for Rust
Protocol Details
The application implements SKAARHOJ's Raw Panel Protocol V2:
- Uses TCP with Protocol Buffer message encoding
- Establishes binary mode through initial handshake
- All messages use little-endian 4-byte length prefixes
- Supports bidirectional communication for events and state updates
Resources
License
This project follows the same licensing as the rship ecosystem.