vcontrol 0.5.0

A library for communication with Viessmann heating controllers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use std::{fmt, io};

use crate::Optolink;

mod vs1;
use self::vs1::Vs1;

mod vs2;
use self::vs2::Vs2;

#[derive(Debug, Clone, Copy)]
pub enum Protocol {
  Vs1,
  Vs2,
}

impl Protocol {
  /// Try detecting the protocol automatically.
  pub async fn detect(o: &mut Optolink) -> Option<Self> {
    if Vs2::negotiate(o).await.is_ok() {
      return Some(Self::Vs2);
    }

    if Vs1::negotiate(o).await.is_ok() {
      return Some(Self::Vs1);
    }

    None
  }

  /// Negotiate the protocol.
  pub async fn negotiate(&self, o: &mut Optolink) -> Result<(), io::Error> {
    match self {
      Self::Vs1 => Vs1::negotiate(o).await,
      Self::Vs2 => Vs2::negotiate(o).await,
    }
  }

  /// Reads the value at the address `addr` into `buf`.
  pub async fn get(&self, o: &mut Optolink, addr: u16, buf: &mut [u8]) -> Result<(), io::Error> {
    match self {
      Self::Vs1 => Vs1::get(o, addr, buf).await,
      Self::Vs2 => Vs2::get(o, addr, buf).await,
    }
  }

  /// Writes the given value `value` to the the address `addr`.
  pub async fn set(&self, o: &mut Optolink, addr: u16, value: &[u8]) -> Result<(), io::Error> {
    match self {
      Self::Vs1 => Vs1::set(o, addr, value).await,
      Self::Vs2 => Vs2::set(o, addr, value).await,
    }
  }
}

impl fmt::Display for Protocol {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match self {
      Self::Vs1 => "VS1",
      Self::Vs2 => "VS2",
    }
    .fmt(f)
  }
}