use bacnet_types::enums::{ObjectType, PropertyIdentifier};
use bacnet_types::error::Error;
use bacnet_types::primitives::{BACnetTimeStamp, ObjectIdentifier, PropertyValue, StatusFlags};
use std::borrow::Cow;
use crate::common::{self, read_common_properties};
use crate::event::{ChangeOfStateDetector, EventStateChange};
use crate::traits::BACnetObject;
pub struct MultiStateInputObject {
oid: ObjectIdentifier,
name: String,
description: String,
present_value: u32,
number_of_states: u32,
out_of_service: bool,
status_flags: StatusFlags,
reliability: u32,
state_text: Vec<String>,
alarm_values: Vec<u32>,
fault_values: Vec<u32>,
event_detector: ChangeOfStateDetector,
}
impl MultiStateInputObject {
pub fn new(
instance: u32,
name: impl Into<String>,
number_of_states: u32,
) -> Result<Self, Error> {
let oid = ObjectIdentifier::new(ObjectType::MULTI_STATE_INPUT, instance)?;
Ok(Self {
oid,
name: name.into(),
description: String::new(),
present_value: 1,
number_of_states,
out_of_service: false,
status_flags: StatusFlags::empty(),
reliability: 0,
state_text: (1..=number_of_states)
.map(|i| format!("State {i}"))
.collect(),
alarm_values: Vec::new(),
fault_values: Vec::new(),
event_detector: ChangeOfStateDetector::default(),
})
}
pub fn set_alarm_values(&mut self, values: Vec<u32>) {
self.alarm_values = values.clone();
self.event_detector.alarm_values = values;
}
pub fn set_fault_values(&mut self, values: Vec<u32>) {
self.fault_values = values;
}
pub fn set_present_value(&mut self, value: u32) {
self.present_value = value;
}
pub fn set_description(&mut self, desc: impl Into<String>) {
self.description = desc.into();
}
}
impl BACnetObject for MultiStateInputObject {
fn object_identifier(&self) -> ObjectIdentifier {
self.oid
}
fn object_name(&self) -> &str {
&self.name
}
fn supports_cov(&self) -> bool {
true
}
fn evaluate_intrinsic_reporting(&mut self) -> Option<EventStateChange> {
self.event_detector.evaluate(self.present_value)
}
fn read_property(
&self,
property: PropertyIdentifier,
array_index: Option<u32>,
) -> Result<PropertyValue, Error> {
if property == PropertyIdentifier::STATUS_FLAGS {
return Ok(common::compute_status_flags(
self.status_flags,
self.reliability,
self.out_of_service,
self.event_detector.event_state.to_raw(),
));
}
if let Some(result) = read_common_properties!(self, property, array_index) {
return result;
}
match property {
p if p == PropertyIdentifier::OBJECT_TYPE => Ok(PropertyValue::Enumerated(
ObjectType::MULTI_STATE_INPUT.to_raw(),
)),
p if p == PropertyIdentifier::PRESENT_VALUE => {
Ok(PropertyValue::Unsigned(self.present_value as u64))
}
p if p == PropertyIdentifier::EVENT_STATE => Ok(PropertyValue::Enumerated(
self.event_detector.event_state.to_raw(),
)),
p if p == PropertyIdentifier::NUMBER_OF_STATES => {
Ok(PropertyValue::Unsigned(self.number_of_states as u64))
}
p if p == PropertyIdentifier::STATE_TEXT => match array_index {
None => Ok(PropertyValue::List(
self.state_text
.iter()
.map(|s| PropertyValue::CharacterString(s.clone()))
.collect(),
)),
Some(0) => Ok(PropertyValue::Unsigned(self.state_text.len() as u64)),
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => Ok(
PropertyValue::CharacterString(self.state_text[(idx - 1) as usize].clone()),
),
_ => Err(common::invalid_array_index_error()),
},
p if p == PropertyIdentifier::ALARM_VALUES => Ok(PropertyValue::List(
self.alarm_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::FAULT_VALUES => Ok(PropertyValue::List(
self.fault_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::EVENT_ENABLE => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.event_enable << 5],
}),
p if p == PropertyIdentifier::ACKED_TRANSITIONS => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.acked_transitions << 5],
}),
p if p == PropertyIdentifier::NOTIFICATION_CLASS => Ok(PropertyValue::Unsigned(
self.event_detector.notification_class as u64,
)),
_ => Err(common::unknown_property_error()),
}
}
fn write_property(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
_priority: Option<u8>,
) -> Result<(), Error> {
if property == PropertyIdentifier::PRESENT_VALUE {
if !self.out_of_service {
return Err(common::write_access_denied_error());
}
if let PropertyValue::Unsigned(v) = value {
if v < 1 || v > self.number_of_states as u64 {
return Err(common::value_out_of_range_error());
}
self.present_value = v as u32;
return Ok(());
}
return Err(common::invalid_data_type_error());
}
if property == PropertyIdentifier::STATE_TEXT {
match array_index {
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => {
if let PropertyValue::CharacterString(s) = value {
self.state_text[(idx - 1) as usize] = s;
return Ok(());
}
return Err(common::invalid_data_type_error());
}
None => return Err(common::write_access_denied_error()),
_ => return Err(common::invalid_array_index_error()),
}
}
if let Some(result) =
common::write_out_of_service(&mut self.out_of_service, property, &value)
{
return result;
}
if let Some(result) = common::write_object_name(&mut self.name, property, &value) {
return result;
}
if let Some(result) = common::write_description(&mut self.description, property, &value) {
return result;
}
Err(common::write_access_denied_error())
}
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]> {
static PROPS: &[PropertyIdentifier] = &[
PropertyIdentifier::OBJECT_IDENTIFIER,
PropertyIdentifier::OBJECT_NAME,
PropertyIdentifier::DESCRIPTION,
PropertyIdentifier::OBJECT_TYPE,
PropertyIdentifier::PRESENT_VALUE,
PropertyIdentifier::STATUS_FLAGS,
PropertyIdentifier::EVENT_STATE,
PropertyIdentifier::OUT_OF_SERVICE,
PropertyIdentifier::NUMBER_OF_STATES,
PropertyIdentifier::RELIABILITY,
PropertyIdentifier::STATE_TEXT,
PropertyIdentifier::ALARM_VALUES,
PropertyIdentifier::FAULT_VALUES,
];
Cow::Borrowed(PROPS)
}
}
pub struct MultiStateOutputObject {
oid: ObjectIdentifier,
name: String,
description: String,
present_value: u32,
number_of_states: u32,
out_of_service: bool,
status_flags: StatusFlags,
priority_array: [Option<u32>; 16],
relinquish_default: u32,
reliability: u32,
state_text: Vec<String>,
alarm_values: Vec<u32>,
fault_values: Vec<u32>,
event_detector: ChangeOfStateDetector,
value_source: common::ValueSourceTracking,
}
impl MultiStateOutputObject {
pub fn new(
instance: u32,
name: impl Into<String>,
number_of_states: u32,
) -> Result<Self, Error> {
let oid = ObjectIdentifier::new(ObjectType::MULTI_STATE_OUTPUT, instance)?;
Ok(Self {
oid,
name: name.into(),
description: String::new(),
present_value: 1,
number_of_states,
out_of_service: false,
status_flags: StatusFlags::empty(),
priority_array: [None; 16],
relinquish_default: 1,
reliability: 0,
state_text: (1..=number_of_states)
.map(|i| format!("State {i}"))
.collect(),
alarm_values: Vec::new(),
fault_values: Vec::new(),
event_detector: ChangeOfStateDetector::default(),
value_source: common::ValueSourceTracking::default(),
})
}
pub fn set_description(&mut self, desc: impl Into<String>) {
self.description = desc.into();
}
fn recalculate_present_value(&mut self) {
self.present_value =
common::recalculate_from_priority_array(&self.priority_array, self.relinquish_default);
}
}
impl BACnetObject for MultiStateOutputObject {
fn object_identifier(&self) -> ObjectIdentifier {
self.oid
}
fn object_name(&self) -> &str {
&self.name
}
fn supports_cov(&self) -> bool {
true
}
fn evaluate_intrinsic_reporting(&mut self) -> Option<EventStateChange> {
self.event_detector.evaluate(self.present_value)
}
fn read_property(
&self,
property: PropertyIdentifier,
array_index: Option<u32>,
) -> Result<PropertyValue, Error> {
if property == PropertyIdentifier::STATUS_FLAGS {
return Ok(common::compute_status_flags(
self.status_flags,
self.reliability,
self.out_of_service,
self.event_detector.event_state.to_raw(),
));
}
if let Some(result) = read_common_properties!(self, property, array_index) {
return result;
}
match property {
p if p == PropertyIdentifier::OBJECT_TYPE => Ok(PropertyValue::Enumerated(
ObjectType::MULTI_STATE_OUTPUT.to_raw(),
)),
p if p == PropertyIdentifier::PRESENT_VALUE => {
Ok(PropertyValue::Unsigned(self.present_value as u64))
}
p if p == PropertyIdentifier::EVENT_STATE => Ok(PropertyValue::Enumerated(
self.event_detector.event_state.to_raw(),
)),
p if p == PropertyIdentifier::NUMBER_OF_STATES => {
Ok(PropertyValue::Unsigned(self.number_of_states as u64))
}
p if p == PropertyIdentifier::VALUE_SOURCE => {
Ok(self.value_source.value_source.clone())
}
p if p == PropertyIdentifier::LAST_COMMAND_TIME => Ok(PropertyValue::Unsigned(
match self.value_source.last_command_time {
BACnetTimeStamp::SequenceNumber(n) => n,
_ => 0,
},
)),
p if p == PropertyIdentifier::PRIORITY_ARRAY => {
common::read_priority_array!(self, array_index, |v: u32| PropertyValue::Unsigned(
v as u64
))
}
p if p == PropertyIdentifier::RELINQUISH_DEFAULT => {
Ok(PropertyValue::Unsigned(self.relinquish_default as u64))
}
p if p == PropertyIdentifier::CURRENT_COMMAND_PRIORITY => {
Ok(common::current_command_priority(&self.priority_array))
}
p if p == PropertyIdentifier::STATE_TEXT => match array_index {
None => Ok(PropertyValue::List(
self.state_text
.iter()
.map(|s| PropertyValue::CharacterString(s.clone()))
.collect(),
)),
Some(0) => Ok(PropertyValue::Unsigned(self.state_text.len() as u64)),
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => Ok(
PropertyValue::CharacterString(self.state_text[(idx - 1) as usize].clone()),
),
_ => Err(common::invalid_array_index_error()),
},
p if p == PropertyIdentifier::ALARM_VALUES => Ok(PropertyValue::List(
self.alarm_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::FAULT_VALUES => Ok(PropertyValue::List(
self.fault_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::EVENT_ENABLE => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.event_enable << 5],
}),
p if p == PropertyIdentifier::ACKED_TRANSITIONS => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.acked_transitions << 5],
}),
p if p == PropertyIdentifier::NOTIFICATION_CLASS => Ok(PropertyValue::Unsigned(
self.event_detector.notification_class as u64,
)),
_ => Err(common::unknown_property_error()),
}
}
fn write_property(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
priority: Option<u8>,
) -> Result<(), Error> {
{
let num_states = self.number_of_states;
common::write_priority_array_direct!(self, property, array_index, value, |v| {
if let PropertyValue::Unsigned(u) = v {
if u < 1 || u > num_states as u64 {
Err(common::value_out_of_range_error())
} else {
Ok(u as u32)
}
} else {
Err(common::invalid_data_type_error())
}
});
}
if property == PropertyIdentifier::PRESENT_VALUE {
let num_states = self.number_of_states;
return common::write_priority_array!(self, value, priority, |v| {
if let PropertyValue::Unsigned(u) = v {
if u < 1 || u > num_states as u64 {
Err(common::value_out_of_range_error())
} else {
Ok(u as u32)
}
} else {
Err(common::invalid_data_type_error())
}
});
}
if property == PropertyIdentifier::STATE_TEXT {
match array_index {
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => {
if let PropertyValue::CharacterString(s) = value {
self.state_text[(idx - 1) as usize] = s;
return Ok(());
}
return Err(common::invalid_data_type_error());
}
None => return Err(common::write_access_denied_error()),
_ => return Err(common::invalid_array_index_error()),
}
}
if let Some(result) =
common::write_out_of_service(&mut self.out_of_service, property, &value)
{
return result;
}
if let Some(result) = common::write_object_name(&mut self.name, property, &value) {
return result;
}
if let Some(result) = common::write_description(&mut self.description, property, &value) {
return result;
}
Err(common::write_access_denied_error())
}
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]> {
static PROPS: &[PropertyIdentifier] = &[
PropertyIdentifier::OBJECT_IDENTIFIER,
PropertyIdentifier::OBJECT_NAME,
PropertyIdentifier::DESCRIPTION,
PropertyIdentifier::OBJECT_TYPE,
PropertyIdentifier::PRESENT_VALUE,
PropertyIdentifier::STATUS_FLAGS,
PropertyIdentifier::EVENT_STATE,
PropertyIdentifier::OUT_OF_SERVICE,
PropertyIdentifier::NUMBER_OF_STATES,
PropertyIdentifier::PRIORITY_ARRAY,
PropertyIdentifier::RELINQUISH_DEFAULT,
PropertyIdentifier::CURRENT_COMMAND_PRIORITY,
PropertyIdentifier::RELIABILITY,
PropertyIdentifier::STATE_TEXT,
PropertyIdentifier::ALARM_VALUES,
PropertyIdentifier::FAULT_VALUES,
];
Cow::Borrowed(PROPS)
}
}
pub struct MultiStateValueObject {
oid: ObjectIdentifier,
name: String,
description: String,
present_value: u32,
number_of_states: u32,
out_of_service: bool,
status_flags: StatusFlags,
priority_array: [Option<u32>; 16],
relinquish_default: u32,
reliability: u32,
state_text: Vec<String>,
alarm_values: Vec<u32>,
fault_values: Vec<u32>,
event_detector: ChangeOfStateDetector,
value_source: common::ValueSourceTracking,
}
impl MultiStateValueObject {
pub fn new(
instance: u32,
name: impl Into<String>,
number_of_states: u32,
) -> Result<Self, Error> {
let oid = ObjectIdentifier::new(ObjectType::MULTI_STATE_VALUE, instance)?;
Ok(Self {
oid,
name: name.into(),
description: String::new(),
present_value: 1,
number_of_states,
out_of_service: false,
status_flags: StatusFlags::empty(),
priority_array: [None; 16],
relinquish_default: 1,
reliability: 0,
state_text: (1..=number_of_states)
.map(|i| format!("State {i}"))
.collect(),
alarm_values: Vec::new(),
fault_values: Vec::new(),
event_detector: ChangeOfStateDetector::default(),
value_source: common::ValueSourceTracking::default(),
})
}
pub fn set_description(&mut self, desc: impl Into<String>) {
self.description = desc.into();
}
fn recalculate_present_value(&mut self) {
self.present_value =
common::recalculate_from_priority_array(&self.priority_array, self.relinquish_default);
}
}
impl BACnetObject for MultiStateValueObject {
fn object_identifier(&self) -> ObjectIdentifier {
self.oid
}
fn object_name(&self) -> &str {
&self.name
}
fn supports_cov(&self) -> bool {
true
}
fn evaluate_intrinsic_reporting(&mut self) -> Option<EventStateChange> {
self.event_detector.evaluate(self.present_value)
}
fn read_property(
&self,
property: PropertyIdentifier,
array_index: Option<u32>,
) -> Result<PropertyValue, Error> {
if property == PropertyIdentifier::STATUS_FLAGS {
return Ok(common::compute_status_flags(
self.status_flags,
self.reliability,
self.out_of_service,
self.event_detector.event_state.to_raw(),
));
}
if let Some(result) = read_common_properties!(self, property, array_index) {
return result;
}
match property {
p if p == PropertyIdentifier::OBJECT_TYPE => Ok(PropertyValue::Enumerated(
ObjectType::MULTI_STATE_VALUE.to_raw(),
)),
p if p == PropertyIdentifier::PRESENT_VALUE => {
Ok(PropertyValue::Unsigned(self.present_value as u64))
}
p if p == PropertyIdentifier::EVENT_STATE => Ok(PropertyValue::Enumerated(
self.event_detector.event_state.to_raw(),
)),
p if p == PropertyIdentifier::NUMBER_OF_STATES => {
Ok(PropertyValue::Unsigned(self.number_of_states as u64))
}
p if p == PropertyIdentifier::VALUE_SOURCE => {
Ok(self.value_source.value_source.clone())
}
p if p == PropertyIdentifier::LAST_COMMAND_TIME => Ok(PropertyValue::Unsigned(
match self.value_source.last_command_time {
BACnetTimeStamp::SequenceNumber(n) => n,
_ => 0,
},
)),
p if p == PropertyIdentifier::PRIORITY_ARRAY => {
common::read_priority_array!(self, array_index, |v: u32| PropertyValue::Unsigned(
v as u64
))
}
p if p == PropertyIdentifier::RELINQUISH_DEFAULT => {
Ok(PropertyValue::Unsigned(self.relinquish_default as u64))
}
p if p == PropertyIdentifier::CURRENT_COMMAND_PRIORITY => {
Ok(common::current_command_priority(&self.priority_array))
}
p if p == PropertyIdentifier::STATE_TEXT => match array_index {
None => Ok(PropertyValue::List(
self.state_text
.iter()
.map(|s| PropertyValue::CharacterString(s.clone()))
.collect(),
)),
Some(0) => Ok(PropertyValue::Unsigned(self.state_text.len() as u64)),
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => Ok(
PropertyValue::CharacterString(self.state_text[(idx - 1) as usize].clone()),
),
_ => Err(common::invalid_array_index_error()),
},
p if p == PropertyIdentifier::ALARM_VALUES => Ok(PropertyValue::List(
self.alarm_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::FAULT_VALUES => Ok(PropertyValue::List(
self.fault_values
.iter()
.map(|v| PropertyValue::Unsigned(*v as u64))
.collect(),
)),
p if p == PropertyIdentifier::EVENT_ENABLE => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.event_enable << 5],
}),
p if p == PropertyIdentifier::ACKED_TRANSITIONS => Ok(PropertyValue::BitString {
unused_bits: 5,
data: vec![self.event_detector.acked_transitions << 5],
}),
p if p == PropertyIdentifier::NOTIFICATION_CLASS => Ok(PropertyValue::Unsigned(
self.event_detector.notification_class as u64,
)),
_ => Err(common::unknown_property_error()),
}
}
fn write_property(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
priority: Option<u8>,
) -> Result<(), Error> {
{
let num_states = self.number_of_states;
common::write_priority_array_direct!(self, property, array_index, value, |v| {
if let PropertyValue::Unsigned(u) = v {
if u < 1 || u > num_states as u64 {
Err(common::value_out_of_range_error())
} else {
Ok(u as u32)
}
} else {
Err(common::invalid_data_type_error())
}
});
}
if property == PropertyIdentifier::PRESENT_VALUE {
let num_states = self.number_of_states;
return common::write_priority_array!(self, value, priority, |v| {
if let PropertyValue::Unsigned(u) = v {
if u < 1 || u > num_states as u64 {
Err(common::value_out_of_range_error())
} else {
Ok(u as u32)
}
} else {
Err(common::invalid_data_type_error())
}
});
}
if property == PropertyIdentifier::STATE_TEXT {
match array_index {
Some(idx) if idx >= 1 && (idx as usize) <= self.state_text.len() => {
if let PropertyValue::CharacterString(s) = value {
self.state_text[(idx - 1) as usize] = s;
return Ok(());
}
return Err(common::invalid_data_type_error());
}
None => return Err(common::write_access_denied_error()),
_ => return Err(common::invalid_array_index_error()),
}
}
if let Some(result) =
common::write_out_of_service(&mut self.out_of_service, property, &value)
{
return result;
}
if let Some(result) = common::write_object_name(&mut self.name, property, &value) {
return result;
}
if let Some(result) = common::write_description(&mut self.description, property, &value) {
return result;
}
Err(common::write_access_denied_error())
}
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]> {
static PROPS: &[PropertyIdentifier] = &[
PropertyIdentifier::OBJECT_IDENTIFIER,
PropertyIdentifier::OBJECT_NAME,
PropertyIdentifier::DESCRIPTION,
PropertyIdentifier::OBJECT_TYPE,
PropertyIdentifier::PRESENT_VALUE,
PropertyIdentifier::STATUS_FLAGS,
PropertyIdentifier::EVENT_STATE,
PropertyIdentifier::OUT_OF_SERVICE,
PropertyIdentifier::NUMBER_OF_STATES,
PropertyIdentifier::PRIORITY_ARRAY,
PropertyIdentifier::RELINQUISH_DEFAULT,
PropertyIdentifier::CURRENT_COMMAND_PRIORITY,
PropertyIdentifier::RELIABILITY,
PropertyIdentifier::STATE_TEXT,
];
Cow::Borrowed(PROPS)
}
}
#[cfg(test)]
mod tests;