doc
Signed-off-by: Frank Villaro-Dixon <frank@villaro-dixon.eu>
This commit is contained in:
parent
db0036a2bc
commit
e1eebd6971
2 changed files with 36 additions and 2 deletions
24
README.md
24
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)
|
||||
|
||||
<!-- cargo-rdme start -->
|
||||
|
||||
## 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);
|
||||
```
|
||||
|
||||
<!-- cargo-rdme end -->
|
||||
|
||||
WIP
|
||||
|
|
14
src/lib.rs
14
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;
|
||||
|
|
Loading…
Reference in a new issue