Contributing
Table of contents
- Development setup
- Build commands
- Pre-push checklist
- External references
- Manual testing
- Pull request process
- Project status
Development setup
git clone https://github.com/discostu105/lox
cd lox
cargo build
cargo test
No live Miniserver is needed for development. All unit tests use pure functions or mocked data.
The repository is a Cargo workspace: the lox CLI at the root and two library crates. loxone-client talks to the Miniserver, and the network-free loxone-config reads and writes program files and runs loxl. Read crates/loxone-config/AGENTS.md before changing loxone-config: format facts are documented, never guessed, and real configs are never committed.
Build commands
cargo build # debug build
cargo build --release # production binary
cargo test # run all tests (lox and both library crates)
cargo test -p loxone-config # only the loxone-config crate
cargo run -- ls # run lox from source
cargo run -- tui --demo # the TUI against a demo house
cargo clippy -- -D warnings # lint (warnings are errors)
cargo fmt --check # check formatting
Pre-push checklist
All four checks must pass before pushing (mirrors CI):
cargo fmt --check
cargo clippy -- -D warnings
cargo build --release
cargo test
External references
The official Loxone API documents and the community sources are listed in references.json (links only; the PDFs are Loxone’s). Download them for local reading with tools/fetch-refs.py (into refs/, gitignored); --check reports any document Loxone has changed since it was pinned.
Real configs for testing: crates/loxone-config/tools/fetch-corpus.py downloads the public corpus (~150 configs) as pinned in its manifest; the redistributable ones are in the example library.
Manual testing
To test against a real Miniserver:
- Loxone Miniserver (Gen 1 or Gen 2) on your local network
- Configure credentials:
lox setup set --host ... --user ... --pass ... - Verify:
lox status
Pull request process
- One feature or fix per PR
- Tests expected for new logic
- Run
cargo fmtandcargo clippybefore submitting - Add a changelog entry as a new file in
changelog.d/(seechangelog.d/README.md); don’t editCHANGELOG.md
Project status
This is an experimental project. Contributions welcome — especially for:
- Testing with different Miniserver configurations
- New control type support
- Bug reports and fixes
- Documentation improvements