razberry 0.3.0

An HTTP client library for the Razberry Z-Wave Hub
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

// Copyright (c) 2017 Brandon Thomas <bt@brand.io, echelon@gmail.com>

use chrono::NaiveDateTime;
use chrono::UTC;
use chrono::datetime::DateTime;
use device_update::DeviceUpdate;
use error::RazberryError;
use rustc_serialize::json::Json;
use std::fmt;

/**
 * Represents a sensor with a binary state.
 */
#[derive(Debug)]
pub struct SensorBinary {
  // TODO: Keep more data, such as sensor update time, previous value, etc.
  level: bool,
  level_updated: DateTime<UTC>,
}

impl SensorBinary {
  // TODO(MERGE-BLOCKER): Test.
  /// Construct a SensorBinary command class.
  pub fn initialize_from_json(json: &Json)
      -> Result<SensorBinary, RazberryError> {
    // TODO: Multiple instances within the command class.
    // Not sure what the various hardware support for these are. Perhaps they're
    // predefined indices, given that Aeotec seems to use consistent "IDs".
    // FIXME: Also, I'm not sure where Rust's json parser is getting "data" in
    // the path from. It doesn't even look like it's a key at this level!
    let level = json.find_path(&["data", "1", "level", "value"])
        .and_then(|j| j.as_boolean())
        .ok_or(RazberryError::BadResponse)?;

    let timestamp = json.find_path(&["data", "1", "level", "updateTime"])
        .and_then(|j| j.as_i64())
        .ok_or(RazberryError::BadResponse)?;

    let dt = NaiveDateTime::from_timestamp(timestamp, 0);
    let utc = DateTime::from_utc(dt, UTC);

    let sensor = SensorBinary {
      level: level,
      level_updated: utc,
    };

    Ok(sensor)
  }

  /// Get the sensor's state.
  pub fn get_level(&self) -> bool {
    self.level
  }

  /// Process the updates from the client.
  /// Should not be publicly used.
  pub fn process_update(&mut self, update: &DeviceUpdate)
      -> Result<(), RazberryError> {
    if update.path.get(4) != Some(&"data") {
      return Ok(()); // Irrelevant update.
    }

    let level = update.data.find_path(&["level", "value"])
        .and_then(|j| j.as_boolean())
        .ok_or(RazberryError::BadResponse)?;

    let timestamp = update.data.find_path(&["level", "updateTime"])
        .and_then(|j| j.as_i64())
        .ok_or(RazberryError::BadResponse)?;

    let dt = NaiveDateTime::from_timestamp(timestamp, 0);

    self.level = level;
    self.level_updated = DateTime::from_utc(dt, UTC);

    Ok(())
  }
}

impl fmt::Display for SensorBinary {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    write!(f, "SensorBinary(level: {}, updated:{})",
      self.level, self.level_updated)
  }
}


#[cfg(test)]
mod tests {
  use super::*;
  use chrono::UTC;

  #[test]
  fn test_initialize_from_json() {
    // A subset of the JSON for a binary sensor.
    let json = r#"
      {
        "name": "SensorBinary",
        "data": {
          "value": null,
          "1": {
            "value": null,
            "type": "empty",
            "sensorTypeString": {
              "value": "General purpose",
              "type": "string",
              "invalidateTime": 1456552384,
              "updateTime": 1456552385
            },
            "level": {
              "value": false,
              "type": "bool",
              "invalidateTime": 1456552384,
              "updateTime": 1465265727
            },
            "invalidateTime": 1456552384,
            "updateTime": 1465265727
          },
          "invalidateTime": 1456552382,
          "updateTime": 1456552383
        }
      }
    "#;

    let json = Json::from_str(json).unwrap();
    let sensor = SensorBinary::initialize_from_json(&json).unwrap();

    assert_eq!(false, sensor.get_level())
  }

  #[test]
  fn test_process_update() {
    let mut sensor = SensorBinary {
      level: true,
      level_updated: UTC::now(),
    };

    assert_eq!(true, sensor.get_level());

    let json = r#"
      {
        "value": null,
        "type": "empty",
        "sensorTypeString": {
          "value": "General purpose",
          "type": "string",
          "invalidateTime": 1487401953,
          "updateTime": 1487401954
        },
        "level": {
          "value": false,
          "type": "bool",
          "invalidateTime": 1489636200,
          "updateTime": 1491289442
        },
        "invalidateTime": 1487401953,
        "updateTime": 1491289442
      }
    "#;

    let json = Json::from_str(json).unwrap();

    let update = DeviceUpdate {
      path: vec!["instances", "0", "commandClasses", "48", "data", "1"],
      data: &json,
    };

    sensor.process_update(&update);

    assert_eq!(false, sensor.get_level());
  }
}