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

use super::super::*;
use crate::event::{
    EventStateChange, EventTransition, EventTransitionCommit, EventTransitionCommitError,
};
use bacnet_encoding::primitives::decode_timestamp_choice;
use bacnet_types::enums::Reliability;
use bacnet_types::primitives::BACnetTimeStamp;

fn timestamp_at(object: &EventEnrollmentObject, index: u32) -> BACnetTimeStamp {
    let PropertyValue::ApplicationData(bytes) = object
        .read_property(PropertyIdentifier::EVENT_TIME_STAMPS, Some(index))
        .unwrap()
    else {
        panic!("Event_Time_Stamps slot must be encoded application data");
    };
    let (timestamp, end) = decode_timestamp_choice(&bytes, 0).unwrap();
    assert_eq!(end, bytes.len());
    timestamp
}

fn snapshot(object: &EventEnrollmentObject) -> [PropertyValue; 5] {
    [
        object
            .read_property(PropertyIdentifier::RELIABILITY, None)
            .unwrap(),
        object
            .read_property(PropertyIdentifier::STATUS_FLAGS, None)
            .unwrap(),
        object
            .read_property(PropertyIdentifier::EVENT_STATE, None)
            .unwrap(),
        object
            .read_property(PropertyIdentifier::ACKED_TRANSITIONS, None)
            .unwrap(),
        object
            .read_property(PropertyIdentifier::EVENT_TIME_STAMPS, None)
            .unwrap(),
    ]
}

fn transition(from: EventState, to: EventState, timestamp: u16) -> EventTransitionCommit {
    EventTransitionCommit {
        change: EventStateChange { from, to },
        coordinate: EventTransition::for_target_state(to),
        ack_required: true,
        timestamp: BACnetTimeStamp::SequenceNumber(timestamp),
        message_text: None,
    }
}

#[test]
fn stock_reliability_commit_is_atomic_across_fault_reentry_and_recovery() {
    let mut object =
        EventEnrollmentObject::new(31, "EE-reliability", EventType::CHANGE_OF_BITSTRING).unwrap();

    object
        .commit_event_enrollment_reliability_internal(EventEnrollmentReliabilityCommit {
            reliability: Reliability::UNDER_RANGE,
            transition: Some(transition(EventState::NORMAL, EventState::FAULT, 11)),
        })
        .unwrap();
    assert_eq!(
        object
            .read_property(PropertyIdentifier::RELIABILITY, None)
            .unwrap(),
        PropertyValue::Enumerated(Reliability::UNDER_RANGE.to_raw())
    );
    assert_eq!(
        object
            .read_property(PropertyIdentifier::STATUS_FLAGS, None)
            .unwrap(),
        PropertyValue::BitString {
            unused_bits: 4,
            data: vec![0xC0],
        }
    );
    assert_eq!(
        timestamp_at(&object, 2),
        BACnetTimeStamp::SequenceNumber(11)
    );
    assert_eq!(
        object
            .read_property(PropertyIdentifier::ACKED_TRANSITIONS, None)
            .unwrap(),
        PropertyValue::BitString {
            unused_bits: 5,
            data: vec![0xA0],
        }
    );

    object
        .commit_event_enrollment_reliability_internal(EventEnrollmentReliabilityCommit {
            reliability: Reliability::OVER_RANGE,
            transition: Some(transition(EventState::FAULT, EventState::FAULT, 12)),
        })
        .unwrap();
    assert_eq!(
        timestamp_at(&object, 2),
        BACnetTimeStamp::SequenceNumber(12)
    );

    object
        .commit_event_enrollment_reliability_internal(EventEnrollmentReliabilityCommit {
            reliability: Reliability::NO_FAULT_DETECTED,
            transition: Some(transition(EventState::FAULT, EventState::NORMAL, 13)),
        })
        .unwrap();
    assert_eq!(
        object
            .read_property(PropertyIdentifier::STATUS_FLAGS, None)
            .unwrap(),
        PropertyValue::BitString {
            unused_bits: 4,
            data: vec![0],
        }
    );
    assert_eq!(
        timestamp_at(&object, 3),
        BACnetTimeStamp::SequenceNumber(13)
    );
    assert_eq!(
        object
            .read_property(PropertyIdentifier::ACKED_TRANSITIONS, None)
            .unwrap(),
        PropertyValue::BitString {
            unused_bits: 5,
            data: vec![0x80],
        }
    );
}

#[test]
fn rejected_stock_reliability_commit_changes_nothing() {
    let mut object =
        EventEnrollmentObject::new(32, "EE-reliability-reject", EventType::CHANGE_OF_BITSTRING)
            .unwrap();
    let before = snapshot(&object);

    let mut invalid = transition(EventState::NORMAL, EventState::FAULT, 99);
    invalid.coordinate = EventTransition::ToNormal;
    assert_eq!(
        object.commit_event_enrollment_reliability_internal(EventEnrollmentReliabilityCommit {
            reliability: Reliability::CONFIGURATION_ERROR,
            transition: Some(invalid),
        }),
        Err(EventTransitionCommitError::CoordinateTargetMismatch {
            coordinate: EventTransition::ToNormal,
            target: EventState::FAULT,
        })
    );
    assert_eq!(snapshot(&object), before);
}

#[test]
fn network_reliability_write_remains_denied() {
    let mut object =
        EventEnrollmentObject::new(33, "EE-network-reliability", EventType::CHANGE_OF_BITSTRING)
            .unwrap();
    assert!(object
        .write_property(
            PropertyIdentifier::RELIABILITY,
            None,
            PropertyValue::Enumerated(Reliability::OVER_RANGE.to_raw()),
            None,
        )
        .is_err());
    assert_eq!(
        object
            .read_property(PropertyIdentifier::RELIABILITY, None)
            .unwrap(),
        PropertyValue::Enumerated(Reliability::NO_FAULT_DETECTED.to_raw())
    );
}