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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use crate::{Command, Device, Error, Optolink, OutputValue, Protocol, Value};

/// Representation of an `Optolink` connection to a specific `Device` using a specific `Protocol`.
#[derive(Debug)]
pub struct VControl {
  optolink: Optolink,
  device: &'static Device,
  connected: bool,
  protocol: Protocol,
}

impl VControl {
  async fn renegotiate(&mut self) -> Result<(), Error> {
    log::trace!("VControl::reneogiate()");

    if self.connected {
      log::trace!("VControl::reneogiate(): already connected");
      return Ok(());
    }

    let mut reinitialized = false;
    loop {
      match self.protocol.negotiate(&mut self.optolink).await {
        Ok(()) => {
          self.connected = true;
          return Ok(());
        },
        Err(err) if reinitialized => return Err(err.into()),
        Err(err) => {
          match self.optolink.reinitialize().await {
            Ok(()) => {
              log::info!("Optolink port successfully re-initialized after error.");
              reinitialized = true;
              continue;
            },
            Err(err) => {
              log::warn!("Failed to re-initialize Optolink port after error: {err}");
            },
          }

          return Err(err.into());
        },
      }
    }
  }

  /// Automatically detect the `Device` and `Protocol` and connect to it.
  pub async fn connect(mut optolink: Optolink) -> Result<Self, Error> {
    log::trace!("VControl::connect(…)");

    let (connected, protocol) = if let Some(protocol) = Protocol::detect(&mut optolink).await {
      log::debug!("Protocol detected: {protocol}");
      (true, protocol)
    } else {
      let protocol = Protocol::Vs1;
      log::warn!("No protocol detected, defaulting to {protocol}.");
      (false, protocol)
    };

    let (device_id, device_id_f0) = match crate::commands::system::DEVICE_ID.get(&mut optolink, protocol).await? {
      Value::DeviceId(device_id) => {
        let device_id_f0 = match crate::commands::system::DEVICE_ID_F0.get(&mut optolink, protocol).await {
          Ok(Value::DeviceIdF0(device_id_f0)) => Some(device_id_f0),
          Ok(Value::Empty) => None,
          Ok(value) => unreachable!("expected DeviceIdF0, got {:?}", value),
          // TODO: Check for more specific error type.
          Err(err) => {
            log::debug!("Failed to get `device_id_f0`: {}", err);
            None
          },
        };

        if let Some(device) = Device::detect(device_id, device_id_f0) {
          log::debug!("Device detected: {}", device.name());

          let mut vcontrol = VControl { optolink, device, connected, protocol };
          vcontrol.renegotiate().await?;
          return Ok(vcontrol);
        }

        (device_id, device_id_f0)
      },
      value => unreachable!("expected DeviceId, got {:?}", value),
    };

    Err(Error::UnsupportedDevice(device_id, device_id_f0))
  }

  pub fn device(&self) -> &'static Device {
    self.device
  }

  pub fn protocol(&mut self) -> Protocol {
    self.protocol
  }

  pub fn optolink(&mut self) -> &mut Optolink {
    &mut self.optolink
  }

  fn command_by_name(&self, command: &str) -> Result<&'static Command, Error> {
    if let Some(system_command) = crate::commands::system_command(command) {
      Ok(system_command)
    } else if let Some(device_command) = self.device.command(command) {
      Ok(device_command)
    } else {
      Err(Error::UnsupportedCommand(command.to_owned()))
    }
  }

  /// Gets the value for the given command.
  pub async fn get(&mut self, command: &str) -> Result<OutputValue, Error> {
    log::trace!("VControl::get({command:?})");

    let command = self.command_by_name(command)?;

    self.renegotiate().await?;
    match command.get(&mut self.optolink, self.protocol).await {
      Ok(value) => {
        let mapping = if let Value::Error(ref _error) = value {
          Some(self.device.errors())
        } else if let Some(ref mapping) = command.mapping {
          Some(mapping)
        } else {
          None
        };

        Ok(OutputValue { value, unit: command.unit, mapping })
      },
      Err(err) => {
        self.connected = false;
        Err(err)
      },
    }
  }

  /// Sets the value for the given command.
  pub async fn set(&mut self, command: &str, input: Value) -> Result<(), Error> {
    log::trace!("VControl::set({command:?}, {input:?})");

    let command = self.command_by_name(command)?;

    self.renegotiate().await?;
    match command.set(&mut self.optolink, self.protocol, input).await {
      Ok(()) => Ok(()),
      Err(err) => {
        self.connected = false;
        Err(err)
      },
    }
  }
}