use super::{ColorObject, ColorTemperatureObject};
use std::borrow::Cow;
use bacnet_types::enums::PropertyIdentifier as P;
use crate::property_metadata::{
PropertyConformance::{Optional, RequiredRead},
PropertyMetadata,
PropertyWriteCapability::{Always, ReadOnly},
};
const COLOR_BASE: &[PropertyMetadata] = &[
PropertyMetadata::new(P::OBJECT_IDENTIFIER, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::OBJECT_NAME, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::DESCRIPTION, Optional, None, Always),
PropertyMetadata::new(P::OBJECT_TYPE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::PRESENT_VALUE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::TRACKING_VALUE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::COLOR_COMMAND, RequiredRead, None, Always),
PropertyMetadata::new(P::IN_PROGRESS, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_COLOR, Optional, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_FADE_TIME, RequiredRead, None, Always),
PropertyMetadata::new(P::TRANSITION, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::STATUS_FLAGS, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::EVENT_STATE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::OUT_OF_SERVICE, RequiredRead, None, Always),
PropertyMetadata::new(P::RELIABILITY, Optional, None, ReadOnly),
PropertyMetadata::new(P::PROPERTY_LIST, RequiredRead, None, ReadOnly),
];
const COLOR_TEMPERATURE_BASE: &[PropertyMetadata] = &[
PropertyMetadata::new(P::OBJECT_IDENTIFIER, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::OBJECT_NAME, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::DESCRIPTION, Optional, None, Always),
PropertyMetadata::new(P::OBJECT_TYPE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::PRESENT_VALUE, RequiredRead, None, Always),
PropertyMetadata::new(P::TRACKING_VALUE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::COLOR_COMMAND, RequiredRead, None, Always),
PropertyMetadata::new(P::IN_PROGRESS, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_COLOR_TEMPERATURE, Optional, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_FADE_TIME, Optional, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_RAMP_RATE, Optional, None, ReadOnly),
PropertyMetadata::new(P::DEFAULT_STEP_INCREMENT, Optional, None, ReadOnly),
PropertyMetadata::new(P::TRANSITION, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::MIN_PRES_VALUE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::MAX_PRES_VALUE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::STATUS_FLAGS, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::EVENT_STATE, RequiredRead, None, ReadOnly),
PropertyMetadata::new(P::OUT_OF_SERVICE, RequiredRead, None, Always),
PropertyMetadata::new(P::RELIABILITY, Optional, None, ReadOnly),
PropertyMetadata::new(P::PROPERTY_LIST, RequiredRead, None, ReadOnly),
];
pub(super) fn for_color_object(_object: &ColorObject) -> Cow<'_, [PropertyMetadata]> {
Cow::Borrowed(COLOR_BASE)
}
pub(super) fn for_color_temperature_object(
_object: &ColorTemperatureObject,
) -> Cow<'_, [PropertyMetadata]> {
Cow::Borrowed(COLOR_TEMPERATURE_BASE)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::property_metadata::PropertyWriteCapability;
use crate::traits::BACnetObject;
use bacnet_types::enums::{ErrorClass, ErrorCode};
use bacnet_types::error::Error;
use bacnet_types::primitives::PropertyValue;
use std::collections::HashSet;
fn assert_error(error: Error, expected: ErrorCode) {
assert!(
matches!(error, Error::Protocol { class, code }
if class == ErrorClass::PROPERTY.to_raw() as u32
&& code == expected.to_raw() as u32),
"expected {expected:?}, got {error:?}"
);
}
fn assert_exact_sets(object: &dyn BACnetObject, all: &[P], required: &[P]) {
let metadata = object.property_metadata();
assert!(matches!(metadata, Cow::Borrowed(_)));
assert_eq!(metadata.len(), all.len() + 1);
assert_eq!(object.property_list().as_ref(), all);
assert_eq!(object.required_properties().as_ref(), required);
assert_eq!(
metadata
.iter()
.map(|row| row.property_identifier)
.collect::<HashSet<_>>()
.len(),
metadata.len()
);
assert!(!object.is_createable());
assert!(object.is_deleteable());
assert!(object.supports_cov());
for row in metadata.iter() {
assert_eq!(row.presence_condition, None);
let expected = if required.contains(&row.property_identifier) {
RequiredRead
} else {
Optional
};
assert_eq!(row.conformance, expected, "{:?}", row.property_identifier);
object.read_property(row.property_identifier, None).unwrap();
}
}
fn assert_indexed_property_list(object: &dyn BACnetObject, all: &[P]) {
let wire: Vec<_> = all
.iter()
.filter(|&&p| !matches!(p, P::OBJECT_IDENTIFIER | P::OBJECT_NAME | P::OBJECT_TYPE))
.map(|p| PropertyValue::Enumerated(p.to_raw()))
.collect();
assert!(object.is_array_property(P::PROPERTY_LIST));
assert_eq!(
object.read_property(P::PROPERTY_LIST, None).unwrap(),
PropertyValue::List(wire.clone())
);
assert_eq!(
object.read_property(P::PROPERTY_LIST, Some(0)).unwrap(),
PropertyValue::Unsigned(wire.len() as u64)
);
for (index, value) in wire.iter().enumerate() {
assert_eq!(
object
.read_property(P::PROPERTY_LIST, Some(index as u32 + 1))
.unwrap(),
*value
);
}
for index in [wire.len() as u32 + 1, u32::MAX] {
assert_error(
object
.read_property(P::PROPERTY_LIST, Some(index))
.unwrap_err(),
ErrorCode::INVALID_ARRAY_INDEX,
);
}
}
#[test]
fn property_metadata_color_exact_sets_readable_rows_and_indexed_list() {
let object = ColorObject::new(1, "CLR-1").unwrap();
let all = [
P::OBJECT_IDENTIFIER,
P::OBJECT_NAME,
P::DESCRIPTION,
P::OBJECT_TYPE,
P::PRESENT_VALUE,
P::TRACKING_VALUE,
P::COLOR_COMMAND,
P::IN_PROGRESS,
P::DEFAULT_COLOR,
P::DEFAULT_FADE_TIME,
P::TRANSITION,
P::STATUS_FLAGS,
P::EVENT_STATE,
P::OUT_OF_SERVICE,
P::RELIABILITY,
];
let required = [
P::OBJECT_IDENTIFIER,
P::OBJECT_NAME,
P::OBJECT_TYPE,
P::PRESENT_VALUE,
P::TRACKING_VALUE,
P::COLOR_COMMAND,
P::IN_PROGRESS,
P::DEFAULT_FADE_TIME,
P::TRANSITION,
P::STATUS_FLAGS,
P::EVENT_STATE,
P::OUT_OF_SERVICE,
P::PROPERTY_LIST,
];
assert_exact_sets(&object, &all, &required);
assert_indexed_property_list(&object, &all);
assert_eq!(
object.read_property(P::PRESENT_VALUE, None).unwrap(),
PropertyValue::List(vec![
PropertyValue::Real(0.3127),
PropertyValue::Real(0.3290),
])
);
assert_eq!(
object.read_property(P::TRACKING_VALUE, None).unwrap(),
PropertyValue::List(vec![
PropertyValue::Real(0.3127),
PropertyValue::Real(0.3290),
])
);
assert_eq!(
object.read_property(P::DEFAULT_COLOR, None).unwrap(),
PropertyValue::List(vec![
PropertyValue::Real(0.3127),
PropertyValue::Real(0.3290),
])
);
assert_eq!(
object.read_property(P::COLOR_COMMAND, None).unwrap(),
PropertyValue::ApplicationData(vec![0x09, 0x00])
);
assert!(!object.is_array_property(P::PRESENT_VALUE));
assert!(!object.is_array_property(P::TRACKING_VALUE));
assert!(!object.is_array_property(P::COLOR_COMMAND));
}
#[test]
fn property_metadata_color_temperature_exact_sets_readable_rows_and_indexed_list() {
let object = ColorTemperatureObject::new(1, "CT-1").unwrap();
let all = [
P::OBJECT_IDENTIFIER,
P::OBJECT_NAME,
P::DESCRIPTION,
P::OBJECT_TYPE,
P::PRESENT_VALUE,
P::TRACKING_VALUE,
P::COLOR_COMMAND,
P::IN_PROGRESS,
P::DEFAULT_COLOR_TEMPERATURE,
P::DEFAULT_FADE_TIME,
P::DEFAULT_RAMP_RATE,
P::DEFAULT_STEP_INCREMENT,
P::TRANSITION,
P::MIN_PRES_VALUE,
P::MAX_PRES_VALUE,
P::STATUS_FLAGS,
P::EVENT_STATE,
P::OUT_OF_SERVICE,
P::RELIABILITY,
];
let required = [
P::OBJECT_IDENTIFIER,
P::OBJECT_NAME,
P::OBJECT_TYPE,
P::PRESENT_VALUE,
P::TRACKING_VALUE,
P::COLOR_COMMAND,
P::IN_PROGRESS,
P::TRANSITION,
P::MIN_PRES_VALUE,
P::MAX_PRES_VALUE,
P::STATUS_FLAGS,
P::EVENT_STATE,
P::OUT_OF_SERVICE,
P::PROPERTY_LIST,
];
assert_exact_sets(&object, &all, &required);
assert_indexed_property_list(&object, &all);
assert_eq!(
object.read_property(P::PRESENT_VALUE, None).unwrap(),
PropertyValue::Unsigned(4000)
);
assert_eq!(
object.read_property(P::TRACKING_VALUE, None).unwrap(),
PropertyValue::Unsigned(4000)
);
assert_eq!(
object.read_property(P::MIN_PRES_VALUE, None).unwrap(),
PropertyValue::Unsigned(1000)
);
assert_eq!(
object.read_property(P::MAX_PRES_VALUE, None).unwrap(),
PropertyValue::Unsigned(30000)
);
assert_eq!(
object
.read_property(P::DEFAULT_COLOR_TEMPERATURE, None)
.unwrap(),
PropertyValue::Unsigned(4000)
);
assert!(!object.is_array_property(P::PRESENT_VALUE));
assert!(!object.is_array_property(P::COLOR_COMMAND));
}
#[test]
fn property_metadata_color_pair_write_capabilities_match_dispatch() {
type WriteCase = (fn() -> Box<dyn BACnetObject>, &'static [P]);
let cases: [WriteCase; 2] = [
(
|| Box::new(ColorObject::new(1, "CLR-1").unwrap()),
&[
P::DESCRIPTION,
P::OUT_OF_SERVICE,
P::COLOR_COMMAND,
P::DEFAULT_FADE_TIME,
],
),
(
|| Box::new(ColorTemperatureObject::new(1, "CT-1").unwrap()),
&[
P::DESCRIPTION,
P::OUT_OF_SERVICE,
P::PRESENT_VALUE,
P::COLOR_COMMAND,
],
),
];
for (make, writable) in cases {
for out_of_service in [false, true] {
let mut object = make();
object
.write_property(
P::OUT_OF_SERVICE,
None,
PropertyValue::Boolean(out_of_service),
None,
)
.unwrap();
let original = object.property_metadata().into_owned();
for row in &original {
let p = row.property_identifier;
let capability = if writable.contains(&p) {
PropertyWriteCapability::Always
} else {
PropertyWriteCapability::ReadOnly
};
assert_eq!(row.write_capability, capability, "{p:?}");
assert_eq!(
object.is_writable_property(p),
capability.is_writable(),
"{p:?}"
);
let value = if p == P::COLOR_COMMAND {
PropertyValue::ApplicationData(vec![0x09, 0x06])
} else {
object.read_property(p, None).unwrap()
};
let result = object.write_property(p, None, value, None);
if capability.is_writable() {
result.unwrap();
} else {
assert_error(result.unwrap_err(), ErrorCode::WRITE_ACCESS_DENIED);
}
}
assert!(!object.is_writable_property(P::OBJECT_NAME));
assert_error(
object
.write_property(
P::OBJECT_NAME,
None,
PropertyValue::CharacterString("renamed".into()),
None,
)
.unwrap_err(),
ErrorCode::WRITE_ACCESS_DENIED,
);
assert_eq!(object.property_metadata().as_ref(), original);
}
}
}
#[test]
fn property_metadata_color_writes_store_with_fade_time_gate() {
for out_of_service in [false, true] {
let mut object = ColorObject::new(1, "CLR-1").unwrap();
object
.write_property(
P::OUT_OF_SERVICE,
None,
PropertyValue::Boolean(out_of_service),
None,
)
.unwrap();
let command = PropertyValue::ApplicationData(vec![0x09, 0x06]);
object
.write_property(P::COLOR_COMMAND, None, command.clone(), None)
.unwrap();
assert_eq!(
object.read_property(P::COLOR_COMMAND, None).unwrap(),
command
);
object
.write_property(
P::DEFAULT_FADE_TIME,
None,
PropertyValue::Unsigned(86_400_000),
None,
)
.unwrap();
assert_eq!(
object.read_property(P::DEFAULT_FADE_TIME, None).unwrap(),
PropertyValue::Unsigned(86_400_000)
);
assert_error(
object
.write_property(
P::DEFAULT_FADE_TIME,
None,
PropertyValue::Unsigned(86_400_001),
None,
)
.unwrap_err(),
ErrorCode::VALUE_OUT_OF_RANGE,
);
assert_eq!(
object.read_property(P::DEFAULT_FADE_TIME, None).unwrap(),
PropertyValue::Unsigned(86_400_000)
);
for (p, value) in [
(P::COLOR_COMMAND, PropertyValue::Unsigned(1)),
(P::DEFAULT_FADE_TIME, PropertyValue::Real(1000.0)),
(P::DESCRIPTION, PropertyValue::Unsigned(1)),
(P::OUT_OF_SERVICE, PropertyValue::Unsigned(1)),
] {
assert_error(
object.write_property(p, None, value, None).unwrap_err(),
ErrorCode::INVALID_DATA_TYPE,
);
}
assert!(!object.is_writable_property(P::PRESENT_VALUE));
let present = object.read_property(P::PRESENT_VALUE, None).unwrap();
assert_error(
object
.write_property(P::PRESENT_VALUE, None, present, None)
.unwrap_err(),
ErrorCode::WRITE_ACCESS_DENIED,
);
for p in [
P::TRACKING_VALUE,
P::DEFAULT_COLOR,
P::TRANSITION,
P::IN_PROGRESS,
P::STATUS_FLAGS,
P::EVENT_STATE,
P::RELIABILITY,
] {
let value = object.read_property(p, None).unwrap();
assert_error(
object.write_property(p, None, value, None).unwrap_err(),
ErrorCode::WRITE_ACCESS_DENIED,
);
assert!(!object.is_writable_property(p));
}
}
}
#[test]
fn property_metadata_color_temperature_writes_clamp_to_min_max() {
for out_of_service in [false, true] {
let mut object = ColorTemperatureObject::new(1, "CT-1").unwrap();
object
.write_property(
P::OUT_OF_SERVICE,
None,
PropertyValue::Boolean(out_of_service),
None,
)
.unwrap();
for value in [1000, 30000] {
object
.write_property(P::PRESENT_VALUE, None, PropertyValue::Unsigned(value), None)
.unwrap();
assert_eq!(
object.read_property(P::PRESENT_VALUE, None).unwrap(),
PropertyValue::Unsigned(value)
);
assert_eq!(
object.read_property(P::TRACKING_VALUE, None).unwrap(),
PropertyValue::Unsigned(value)
);
}
for value in [999, 30001, u32::MAX as u64] {
assert_error(
object
.write_property(
P::PRESENT_VALUE,
None,
PropertyValue::Unsigned(value),
None,
)
.unwrap_err(),
ErrorCode::VALUE_OUT_OF_RANGE,
);
}
assert_error(
object
.write_property(
P::PRESENT_VALUE,
None,
PropertyValue::Unsigned(0x1_0000_03E8),
None,
)
.unwrap_err(),
ErrorCode::VALUE_OUT_OF_RANGE,
);
assert_eq!(
object.read_property(P::PRESENT_VALUE, None).unwrap(),
PropertyValue::Unsigned(30000)
);
let command = PropertyValue::ApplicationData(vec![0x09, 0x04]);
object
.write_property(P::COLOR_COMMAND, None, command.clone(), None)
.unwrap();
assert_eq!(
object.read_property(P::COLOR_COMMAND, None).unwrap(),
command
);
for (p, value) in [
(P::PRESENT_VALUE, PropertyValue::Real(4000.0)),
(P::COLOR_COMMAND, PropertyValue::Unsigned(1)),
(P::DESCRIPTION, PropertyValue::Unsigned(1)),
(P::OUT_OF_SERVICE, PropertyValue::Unsigned(1)),
] {
assert_error(
object.write_property(p, None, value, None).unwrap_err(),
ErrorCode::INVALID_DATA_TYPE,
);
}
for p in [
P::DEFAULT_COLOR_TEMPERATURE,
P::DEFAULT_FADE_TIME,
P::DEFAULT_RAMP_RATE,
P::DEFAULT_STEP_INCREMENT,
] {
let value = object.read_property(p, None).unwrap();
assert_error(
object.write_property(p, None, value, None).unwrap_err(),
ErrorCode::WRITE_ACCESS_DENIED,
);
assert!(!object.is_writable_property(p));
}
}
}
#[test]
fn property_metadata_color_pair_unserved_rows_stay_unknown() {
fn assert_unserved(object: &mut dyn BACnetObject, p: P) {
assert!(!object.is_writable_property(p));
assert_error(
object.read_property(p, None).unwrap_err(),
ErrorCode::UNKNOWN_PROPERTY,
);
assert_error(
object
.write_property(p, None, PropertyValue::Null, None)
.unwrap_err(),
ErrorCode::UNKNOWN_PROPERTY,
);
}
let mut color = ColorObject::new(1, "CLR-1").unwrap();
assert_unserved(&mut color, P::PRIORITY_ARRAY);
assert_unserved(&mut color, P::COV_INCREMENT);
assert_unserved(&mut color, P::DEVICE_TYPE);
let mut temperature = ColorTemperatureObject::new(1, "CT-1").unwrap();
assert_unserved(&mut temperature, P::PRIORITY_ARRAY);
assert_unserved(&mut temperature, P::COV_INCREMENT);
assert_unserved(&mut temperature, P::DEVICE_TYPE);
}
}