bacnet-objects 0.13.0

BACnet object model: traits, database, and standard object types
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

//! Car_Assigned_Direction, Car_Door_Zone, Car_Mode, Next_Stopping_Floor and
//! Car_Drive_Status, the Lift's single-valued car-state rows (Clause 12.59,
//! Table 12-77; #1052): set by the application in service and written over
//! the network only while the Lift is out of service.

use super::super::*;
use super::{
    assert_invalid_data_type, assert_property_error, assert_value_out_of_range, set_out_of_service,
};
use bacnet_types::enums::{ErrorCode, LiftCarDirection, LiftCarDriveStatus, LiftCarMode};

type P = PropertyIdentifier;

/// The five rows this suite covers, with a well-typed value for each that a
/// new Lift doesn't already hold.
fn rows() -> [(P, PropertyValue); 5] {
    [
        (
            P::CAR_ASSIGNED_DIRECTION,
            PropertyValue::Enumerated(LiftCarDirection::UP_AND_DOWN.to_raw()),
        ),
        (P::CAR_DOOR_ZONE, PropertyValue::Boolean(true)),
        (
            P::CAR_MODE,
            PropertyValue::Enumerated(LiftCarMode::FIREFIGHTER_CONTROL.to_raw()),
        ),
        (P::NEXT_STOPPING_FLOOR, PropertyValue::Unsigned(255)),
        (
            P::CAR_DRIVE_STATUS,
            PropertyValue::Enumerated(LiftCarDriveStatus::MULTI_FLOOR_JUMP.to_raw()),
        ),
    ]
}

#[test]
fn lift_car_state_rows_start_unknown_and_follow_the_setters() {
    let mut lift = LiftObject::new(1, "LIFT-1", 3).unwrap();
    for (p, expected) in [
        (P::CAR_ASSIGNED_DIRECTION, PropertyValue::Enumerated(0)),
        (P::CAR_DOOR_ZONE, PropertyValue::Boolean(false)),
        (P::CAR_MODE, PropertyValue::Enumerated(0)),
        (P::NEXT_STOPPING_FLOOR, PropertyValue::Unsigned(1)),
        (P::CAR_DRIVE_STATUS, PropertyValue::Enumerated(0)),
    ] {
        assert_eq!(lift.read_property(p, None).unwrap(), expected, "{p:?}");
        assert!(!lift.is_array_property(p), "{p:?}");
    }
    lift.set_car_assigned_direction(LiftCarDirection::DOWN)
        .unwrap();
    lift.set_car_door_zone(true);
    lift.set_car_mode(LiftCarMode::OCCUPANT_EVACUATION).unwrap();
    lift.set_next_stopping_floor(9);
    lift.set_car_drive_status(LiftCarDriveStatus::BRAKING)
        .unwrap();
    assert_eq!(lift.car_assigned_direction(), LiftCarDirection::DOWN);
    assert!(lift.car_door_zone());
    assert_eq!(lift.car_mode(), LiftCarMode::OCCUPANT_EVACUATION);
    assert_eq!(lift.next_stopping_floor(), 9);
    assert_eq!(lift.car_drive_status(), LiftCarDriveStatus::BRAKING);
    for (p, expected) in [
        (P::CAR_ASSIGNED_DIRECTION, PropertyValue::Enumerated(4)),
        (P::CAR_DOOR_ZONE, PropertyValue::Boolean(true)),
        (P::CAR_MODE, PropertyValue::Enumerated(13)),
        (P::NEXT_STOPPING_FLOOR, PropertyValue::Unsigned(9)),
        (P::CAR_DRIVE_STATUS, PropertyValue::Enumerated(2)),
    ] {
        assert_eq!(lift.read_property(p, None).unwrap(), expected, "{p:?}");
    }
}

#[test]
fn lift_car_state_setters_take_named_and_proprietary_values() {
    let mut lift = LiftObject::new(1, "LIFT-1", 3).unwrap();
    for &(_, direction) in LiftCarDirection::ALL_NAMED {
        lift.set_car_assigned_direction(direction).unwrap();
        assert_eq!(lift.car_assigned_direction(), direction);
    }
    for &(_, mode) in LiftCarMode::ALL_NAMED {
        lift.set_car_mode(mode).unwrap();
        assert_eq!(lift.car_mode(), mode);
    }
    for &(_, status) in LiftCarDriveStatus::ALL_NAMED {
        lift.set_car_drive_status(status).unwrap();
        assert_eq!(lift.car_drive_status(), status);
    }
    for raw in [1024, 65_535] {
        lift.set_car_assigned_direction(LiftCarDirection::from_raw(raw))
            .unwrap();
        lift.set_car_mode(LiftCarMode::from_raw(raw)).unwrap();
        lift.set_car_drive_status(LiftCarDriveStatus::from_raw(raw))
            .unwrap();
        for p in [P::CAR_ASSIGNED_DIRECTION, P::CAR_MODE, P::CAR_DRIVE_STATUS] {
            assert_eq!(
                lift.read_property(p, None).unwrap(),
                PropertyValue::Enumerated(raw)
            );
        }
    }
}

#[test]
fn lift_car_state_setters_refuse_values_outside_their_enumerations() {
    let mut lift = LiftObject::new(1, "LIFT-1", 3).unwrap();
    lift.set_car_assigned_direction(LiftCarDirection::UP)
        .unwrap();
    lift.set_car_mode(LiftCarMode::NORMAL).unwrap();
    lift.set_car_drive_status(LiftCarDriveStatus::STATIONARY)
        .unwrap();
    // The first reserved value of each, the top of the reserved range, and
    // values past 65535.
    for raw in [1023, 65_536, u32::MAX] {
        assert_value_out_of_range(
            lift.set_car_assigned_direction(LiftCarDirection::from_raw(raw)),
            &format!("direction {raw}"),
        );
        assert_value_out_of_range(
            lift.set_car_mode(LiftCarMode::from_raw(raw)),
            &format!("mode {raw}"),
        );
        assert_value_out_of_range(
            lift.set_car_drive_status(LiftCarDriveStatus::from_raw(raw)),
            &format!("drive status {raw}"),
        );
    }
    assert_value_out_of_range(
        lift.set_car_assigned_direction(LiftCarDirection::from_raw(6)),
        "direction 6",
    );
    assert_value_out_of_range(lift.set_car_mode(LiftCarMode::from_raw(14)), "mode 14");
    assert_value_out_of_range(
        lift.set_car_drive_status(LiftCarDriveStatus::from_raw(10)),
        "drive status 10",
    );
    assert_eq!(lift.car_assigned_direction(), LiftCarDirection::UP);
    assert_eq!(lift.car_mode(), LiftCarMode::NORMAL);
    assert_eq!(lift.car_drive_status(), LiftCarDriveStatus::STATIONARY);
}

#[test]
fn lift_car_state_rows_take_simulation_writes_only_out_of_service() {
    let mut lift = LiftObject::new(1, "LIFT-1", 3).unwrap();
    for (p, value) in rows() {
        assert!(lift.is_writable_property(p), "{p:?}");
        let before = lift.read_property(p, None).unwrap();
        assert_property_error(
            lift.write_property(p, None, value, None),
            ErrorCode::WRITE_ACCESS_DENIED,
            &format!("{p:?} in service"),
        );
        assert_eq!(lift.read_property(p, None).unwrap(), before, "{p:?}");
    }
    set_out_of_service(&mut lift, true);
    for (p, value) in rows() {
        lift.write_property(p, None, value.clone(), None)
            .unwrap_or_else(|e| panic!("{p:?}: {e:?}"));
        assert_eq!(lift.read_property(p, None).unwrap(), value, "{p:?}");
    }
    // Proprietary values of the extensible enumerations round-trip too.
    for p in [P::CAR_ASSIGNED_DIRECTION, P::CAR_MODE, P::CAR_DRIVE_STATUS] {
        lift.write_property(p, None, PropertyValue::Enumerated(2048), None)
            .unwrap();
        assert_eq!(
            lift.read_property(p, None).unwrap(),
            PropertyValue::Enumerated(2048)
        );
    }
    assert_eq!(
        lift.car_assigned_direction(),
        LiftCarDirection::from_raw(2048)
    );
    assert!(lift.car_door_zone());
    assert_eq!(lift.next_stopping_floor(), 255);
    // The simulated values stay once the Lift is back in service, and
    // writes are refused again.
    set_out_of_service(&mut lift, false);
    for (p, value) in rows() {
        assert_property_error(
            lift.write_property(p, None, value, None),
            ErrorCode::WRITE_ACCESS_DENIED,
            &format!("{p:?} back in service"),
        );
    }
    assert_eq!(lift.car_mode(), LiftCarMode::from_raw(2048));
}

#[test]
fn lift_car_state_writes_refuse_bad_values_atomically() {
    let mut lift = LiftObject::new(1, "LIFT-1", 3).unwrap();
    set_out_of_service(&mut lift, true);
    let before: Vec<_> = rows()
        .iter()
        .map(|(p, _)| lift.read_property(*p, None).unwrap())
        .collect();
    for (p, raw) in [
        (P::CAR_ASSIGNED_DIRECTION, 6u32),
        (P::CAR_ASSIGNED_DIRECTION, 65_536),
        (P::CAR_MODE, 14),
        (P::CAR_MODE, 1023),
        (P::CAR_DRIVE_STATUS, 10),
        (P::CAR_DRIVE_STATUS, u32::MAX),
    ] {
        assert_value_out_of_range(
            lift.write_property(p, None, PropertyValue::Enumerated(raw), None),
            &format!("{p:?} {raw}"),
        );
    }
    assert_value_out_of_range(
        lift.write_property(
            P::NEXT_STOPPING_FLOOR,
            None,
            PropertyValue::Unsigned(256),
            None,
        ),
        "Next_Stopping_Floor 256",
    );
    for (p, value) in [
        (P::CAR_ASSIGNED_DIRECTION, PropertyValue::Unsigned(3)),
        (P::CAR_DOOR_ZONE, PropertyValue::Enumerated(1)),
        (P::CAR_MODE, PropertyValue::Unsigned(1)),
        (P::NEXT_STOPPING_FLOOR, PropertyValue::Enumerated(2)),
        (P::CAR_DRIVE_STATUS, PropertyValue::Boolean(true)),
    ] {
        assert_invalid_data_type(lift.write_property(p, None, value, None), &format!("{p:?}"));
    }
    let after: Vec<_> = rows()
        .iter()
        .map(|(p, _)| lift.read_property(*p, None).unwrap())
        .collect();
    assert_eq!(after, before);
}