From e1eebd6971893a7dd33560fc412283e4bff1cfb0 Mon Sep 17 00:00:00 2001 From: Frank Villaro-Dixon Date: Mon, 4 Mar 2024 20:46:42 +0100 Subject: [PATCH] doc Signed-off-by: Frank Villaro-Dixon --- README.md | 24 +++++++++++++++++++++++- src/lib.rs | 14 +++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98d214f..b7639ae 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,27 @@ This project interfaces with Daikin Altherma LAN adapters (BRP069A61 BRP069A62). This is a Rust port of the excellent [python-daikin-altherma](https://github.com/Frankkkkk/python-daikin-altherma) + + +## API to Daikin Altherma LAN Adapters + +This rust crate interfaces with Daikin Altherma LAN adapteros. + +There are two firmware versions of the LAN adapters: +- Cloud connected +- LAN only + +This library only supports the second one for the moment. +### Usage +Using this library is rather easy: +```rust + let mut client = DaikinAlthermaClient::new("192.168.11.100".to_string()).unwrap(); + + let hp = client.get_heating_parameters().unwrap(); + println!("Heating: {:?}", hp); + + client.set_heating_setpoint_temperature(20.0); +``` + + -WIP diff --git a/src/lib.rs b/src/lib.rs index f259aaf..eec28b4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,10 +1,22 @@ //! # API to Daikin Altherma LAN Adapters //! -//! This rust crate interfaces with Daikin Altherma LAN adapters. +//! This rust crate interfaces with Daikin Altherma LAN adapteros. +//! //! There are two firmware versions of the LAN adapters: //! - Cloud connected //! - LAN only +//! //! This library only supports the second one for the moment. +//! ## Usage +//! Using this library is rather easy: +//! ``` +//! let mut client = DaikinAlthermaClient::new("192.168.11.100".to_string()).unwrap(); +//! +//! let hp = client.get_heating_parameters().unwrap(); +//! println!("Heating: {:?}", hp); +//! +//! client.set_heating_setpoint_temperature(20.0); +//! ``` use std::net::TcpStream; use uuid::Uuid;