use std::collections::BTreeMap;
use std::fmt;
use bacnet_encoding::primitives::charset;
use bacnet_objects::database::ObjectDatabase;
use bacnet_objects::traits::BACnetObject;
use bacnet_types::bitstring::ServicesSupported;
use bacnet_types::enums::{ObjectType, PropertyIdentifier, ServiceSupported};
use bacnet_types::primitives::PropertyValue;
use bacnet_types::{PROTOCOL_REVISION, PROTOCOL_VERSION};
use crate::local_device::announcement_device;
use crate::server::ServerConfig;
#[derive(Debug, Clone)]
pub struct Pics {
pub vendor_info: VendorInfo,
pub device_profile: DeviceProfile,
pub supported_object_types: Vec<ObjectTypeSupport>,
pub supported_services: Vec<ServiceSupport>,
pub data_link_layers: Vec<DataLinkSupport>,
pub network_layer: NetworkLayerSupport,
pub character_sets: Vec<CharacterSet>,
pub special_functionality: Vec<String>,
}
#[derive(Debug, Clone)]
pub struct VendorInfo {
pub vendor_id: u16,
pub vendor_name: String,
pub model_name: String,
pub firmware_revision: String,
pub application_software_version: String,
pub protocol_version: u16,
pub protocol_revision: u16,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum DeviceProfile {
BAac,
BAsc,
BOws,
BBc,
BOp,
BRouter,
BGw,
BSc,
Custom(String),
}
impl fmt::Display for DeviceProfile {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::BAac => f.write_str("B-AAC"),
Self::BAsc => f.write_str("B-ASC"),
Self::BOws => f.write_str("B-OWS"),
Self::BBc => f.write_str("B-BC"),
Self::BOp => f.write_str("B-OP"),
Self::BRouter => f.write_str("B-ROUTER"),
Self::BGw => f.write_str("B-GW"),
Self::BSc => f.write_str("B-SC"),
Self::Custom(s) => f.write_str(s),
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct PropertyAccess {
pub readable: bool,
pub writable: bool,
pub optional: bool,
}
impl fmt::Display for PropertyAccess {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let r = if self.readable { "R" } else { "" };
let w = if self.writable { "W" } else { "" };
let o = if self.optional { "O" } else { "" };
write!(f, "{r}{w}{o}")
}
}
#[derive(Debug, Clone)]
pub struct PropertySupport {
pub property_id: PropertyIdentifier,
pub access: PropertyAccess,
pub written_through: Option<PropertyIdentifier>,
}
#[derive(Debug, Clone)]
pub struct ObjectTypeSupport {
pub object_type: ObjectType,
pub createable: bool,
pub creation_only_properties: Vec<PropertyIdentifier>,
pub deleteable: bool,
pub supported_properties: Vec<PropertySupport>,
}
#[derive(Debug, Clone)]
pub struct ServiceSupport {
pub service_name: String,
pub initiator: bool,
pub executor: bool,
}
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum DataLinkSupport {
BipV4,
BipV4NatTraversal,
BipV6,
Mstp,
Ethernet,
BacnetSc,
}
impl fmt::Display for DataLinkSupport {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::BipV4 => f.write_str("BACnet/IP (Annex J)"),
Self::BipV4NatTraversal => f.write_str("BACnet/IP with NAT traversal (Annex J.7.5)"),
Self::BipV6 => f.write_str("BACnet/IPv6 (Annex U)"),
Self::Mstp => f.write_str("MS/TP (Clause 9)"),
Self::Ethernet => f.write_str("BACnet Ethernet (Clause 7)"),
Self::BacnetSc => f.write_str("BACnet/SC (Annex AB)"),
}
}
}
#[derive(Debug, Clone)]
pub struct NetworkLayerSupport {
pub router: bool,
pub bbmd: bool,
pub foreign_device: bool,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[repr(u8)]
pub enum CharacterSet {
Utf8 = charset::UTF8,
IbmMicrosoftDbcs = charset::IBM_MICROSOFT_DBCS,
JisX0208 = charset::JIS_X_0208,
Ucs4 = charset::UCS4,
Ucs2 = charset::UCS2,
Iso8859_1 = charset::ISO_8859_1,
}
impl CharacterSet {
pub const ALL: [Self; 6] = [
Self::Utf8,
Self::IbmMicrosoftDbcs,
Self::JisX0208,
Self::Ucs4,
Self::Ucs2,
Self::Iso8859_1,
];
pub const fn code(self) -> u8 {
self as u8
}
}
impl fmt::Display for CharacterSet {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(match self {
Self::Utf8 => "ISO 10646 (UTF-8)",
Self::IbmMicrosoftDbcs => "IBM/Microsoft DBCS",
Self::JisX0208 => "JIS X 0208",
Self::Ucs4 => "ISO 10646 (UCS-4)",
Self::Ucs2 => "ISO 10646 (UCS-2)",
Self::Iso8859_1 => "ISO 8859-1",
})
}
}
#[derive(Debug, Clone)]
pub struct PicsConfig {
pub device_profile: DeviceProfile,
pub data_link_layers: Vec<DataLinkSupport>,
pub network_layer: NetworkLayerSupport,
pub character_sets: Vec<CharacterSet>,
pub special_functionality: Vec<String>,
}
impl Default for PicsConfig {
fn default() -> Self {
Self {
device_profile: DeviceProfile::BAsc,
data_link_layers: vec![DataLinkSupport::BipV4],
network_layer: NetworkLayerSupport {
router: false,
bbmd: false,
foreign_device: false,
},
character_sets: vec![CharacterSet::Utf8],
special_functionality: Vec::new(),
}
}
}
pub struct PicsGenerator<'a> {
db: &'a ObjectDatabase,
server_config: &'a ServerConfig,
pics_config: &'a PicsConfig,
served: bool,
}
impl<'a> PicsGenerator<'a> {
pub fn new(
db: &'a ObjectDatabase,
server_config: &'a ServerConfig,
pics_config: &'a PicsConfig,
) -> Self {
Self {
db,
server_config,
pics_config,
served: false,
}
}
pub(crate) fn for_server(mut self) -> Self {
self.served = true;
self
}
pub fn generate(&self) -> Pics {
Pics {
vendor_info: self.build_vendor_info(),
device_profile: self.pics_config.device_profile.clone(),
supported_object_types: self.build_object_types(),
supported_services: self.build_services(),
data_link_layers: self.pics_config.data_link_layers.clone(),
network_layer: self.pics_config.network_layer.clone(),
character_sets: self.pics_config.character_sets.clone(),
special_functionality: self.pics_config.special_functionality.clone(),
}
}
fn build_vendor_info(&self) -> VendorInfo {
let device = (self.served)
.then(|| announcement_device(self.db, &self.server_config.device))
.flatten()
.or_else(|| self.db.selected_device())
.and_then(|oid| self.db.get(&oid));
let view = crate::device_view::DeviceReadContext::new(
self.db,
crate::device_view::DeviceExecution::FullServer,
)
.with_identity(self.served.then_some(&self.server_config.device));
let read = |property| device.map(|d| view.object(d).read_property(property, None));
let unsigned = |property, fallback| match read(property) {
Some(Ok(PropertyValue::Unsigned(raw))) => u16::try_from(raw).unwrap_or(fallback),
_ => fallback,
};
let text = |property| match read(property) {
Some(Ok(PropertyValue::CharacterString(value))) => value,
_ => String::new(),
};
VendorInfo {
vendor_id: unsigned(
PropertyIdentifier::VENDOR_IDENTIFIER,
self.server_config.device.vendor_id(),
),
vendor_name: text(PropertyIdentifier::VENDOR_NAME),
model_name: text(PropertyIdentifier::MODEL_NAME),
firmware_revision: text(PropertyIdentifier::FIRMWARE_REVISION),
application_software_version: text(PropertyIdentifier::APPLICATION_SOFTWARE_VERSION),
protocol_version: unsigned(PropertyIdentifier::PROTOCOL_VERSION, PROTOCOL_VERSION),
protocol_revision: unsigned(PropertyIdentifier::PROTOCOL_REVISION, PROTOCOL_REVISION),
}
}
fn build_object_types(&self) -> Vec<ObjectTypeSupport> {
let mut by_type: BTreeMap<u32, Vec<&dyn bacnet_objects::traits::BACnetObject>> =
BTreeMap::new();
for (_oid, obj) in self.db.iter_objects() {
by_type
.entry(obj.object_identifier().object_type().to_raw())
.or_default()
.push(obj);
}
let mut result = Vec::with_capacity(by_type.len());
for (raw_type, objects) in &by_type {
let object_type = ObjectType::from_raw(*raw_type);
let representative = objects[0];
let view = (self.served && object_type == ObjectType::DEVICE).then(|| {
crate::device_view::DeviceReadContext::new(
self.db,
crate::device_view::DeviceExecution::FullServer,
)
.with_identity(Some(&self.server_config.device))
});
let supported_properties =
Self::union_property_support(objects.iter().flat_map(|object| {
if let Some(view) = &view {
Self::object_property_support(&view.object(*object))
} else {
Self::object_property_support(*object)
}
}));
let createable = representative.is_createable();
let deleteable = representative.is_deleteable();
let written_through = |property: &PropertyIdentifier| {
supported_properties
.iter()
.any(|row| row.property_id == *property && row.written_through.is_some())
};
let creation_only_properties = if createable {
let mut properties = representative.creation_only_properties().to_vec();
properties.retain(|property| !written_through(property));
properties
} else {
Vec::new()
};
result.push(ObjectTypeSupport {
object_type,
createable,
creation_only_properties,
deleteable,
supported_properties,
});
}
result
}
fn object_property_support(
object: &dyn bacnet_objects::traits::BACnetObject,
) -> Vec<PropertySupport> {
let metadata = object.property_metadata();
if metadata.is_empty() {
let all_props = object.property_list();
let required = object.required_properties();
all_props
.iter()
.map(|&property_id| PropertySupport {
property_id,
access: PropertyAccess {
readable: true,
writable: object.is_writable_property(property_id),
optional: !required.contains(&property_id),
},
written_through: None,
})
.collect()
} else {
metadata
.iter()
.map(|row| PropertySupport {
property_id: row.property_identifier,
access: PropertyAccess {
readable: true,
writable: row.write_capability.is_writable(),
optional: !row.is_required(),
},
written_through: row.write_capability.written_through(),
})
.collect()
}
}
fn union_property_support(
rows: impl IntoIterator<Item = PropertySupport>,
) -> Vec<PropertySupport> {
let mut properties: BTreeMap<u32, PropertySupport> = BTreeMap::new();
for row in rows {
properties
.entry(row.property_id.to_raw())
.and_modify(|existing| {
existing.access.readable |= row.access.readable;
existing.access.writable |= row.access.writable;
existing.access.optional &= row.access.optional;
existing.written_through = existing.written_through.or(row.written_through);
})
.or_insert(row);
}
properties.into_values().collect()
}
pub const INITIATED_SERVICES: &'static [ServiceSupported] = &[
ServiceSupported::I_AM,
ServiceSupported::I_HAVE,
ServiceSupported::CONFIRMED_COV_NOTIFICATION,
ServiceSupported::CONFIRMED_EVENT_NOTIFICATION,
ServiceSupported::UNCONFIRMED_COV_NOTIFICATION,
ServiceSupported::UNCONFIRMED_EVENT_NOTIFICATION,
ServiceSupported::CONFIRMED_COV_NOTIFICATION_MULTIPLE,
ServiceSupported::UNCONFIRMED_COV_NOTIFICATION_MULTIPLE,
ServiceSupported::CONFIRMED_AUDIT_NOTIFICATION,
ServiceSupported::UNCONFIRMED_AUDIT_NOTIFICATION,
ServiceSupported::READ_PROPERTY,
ServiceSupported::WRITE_PROPERTY,
ServiceSupported::WHO_IS,
];
fn build_services(&self) -> Vec<ServiceSupport> {
let effective_executed = (!self.served)
.then(|| {
let device = self.db.get(&self.db.selected_device()?)?;
match device
.read_property(PropertyIdentifier::PROTOCOL_SERVICES_SUPPORTED, None)
.ok()?
{
PropertyValue::BitString { data, .. } => {
Some(ServicesSupported::from_bacnet(&data))
}
_ => None,
}
})
.flatten();
let mut service_map: BTreeMap<&'static str, (bool, bool)> = BTreeMap::new();
let clock_available = self.db.clock_frame().is_some();
let executed: Box<dyn Iterator<Item = ServiceSupported> + '_> = match &effective_executed {
Some(services) => Box::new(services.iter()),
None => {
Box::new(crate::device_view::DeviceExecution::FullServer.services(clock_available))
}
};
for service in executed {
service_map
.entry(service_display_name(service).unwrap_or("Unknown"))
.or_default()
.1 = true;
}
for service in Self::INITIATED_SERVICES {
service_map
.entry(service_display_name(*service).unwrap_or("Unknown"))
.or_default()
.0 = true;
}
service_map
.into_iter()
.map(|(name, (initiator, executor))| ServiceSupport {
service_name: name.to_string(),
initiator,
executor,
})
.collect()
}
}
pub fn generate_pics(
db: &ObjectDatabase,
server_config: &ServerConfig,
pics_config: &PicsConfig,
) -> Pics {
PicsGenerator::new(db, server_config, pics_config).generate()
}
pub fn service_display_name(service: ServiceSupported) -> Option<&'static str> {
Some(match service.to_raw() {
0 => "AcknowledgeAlarm",
1 => "ConfirmedCOVNotification",
2 => "ConfirmedEventNotification",
3 => "GetAlarmSummary",
4 => "GetEnrollmentSummary",
5 => "SubscribeCOV",
6 => "AtomicReadFile",
7 => "AtomicWriteFile",
8 => "AddListElement",
9 => "RemoveListElement",
10 => "CreateObject",
11 => "DeleteObject",
12 => "ReadProperty",
14 => "ReadPropertyMultiple",
15 => "WriteProperty",
16 => "WritePropertyMultiple",
17 => "DeviceCommunicationControl",
18 => "ConfirmedPrivateTransfer",
19 => "ConfirmedTextMessage",
20 => "ReinitializeDevice",
21 => "VT-Open",
22 => "VT-Close",
23 => "VT-Data",
26 => "I-Am",
27 => "I-Have",
28 => "UnconfirmedCOVNotification",
29 => "UnconfirmedEventNotification",
30 => "UnconfirmedPrivateTransfer",
31 => "UnconfirmedTextMessage",
32 => "TimeSynchronization",
33 => "WhoHas",
34 => "WhoIs",
35 => "ReadRange",
36 => "UTCTimeSynchronization",
37 => "LifeSafetyOperation",
38 => "SubscribeCOVProperty",
39 => "GetEventInformation",
40 => "WriteGroup",
41 => "SubscribeCOVPropertyMultiple",
42 => "ConfirmedCOVNotificationMultiple",
43 => "UnconfirmedCOVNotificationMultiple",
44 => "ConfirmedAuditNotification",
45 => "AuditLogQuery",
46 => "UnconfirmedAuditNotification",
47 => "Who-Am-I",
48 => "You-Are",
_ => return None,
})
}
mod device_text;
mod render;
#[cfg(test)]
mod tests;
#[cfg(test)]
mod property_metadata_tests;
#[cfg(test)]
mod acked_transitions_policy_tests;
#[cfg(test)]
mod truth_source_tests;
#[cfg(test)]
mod protocol_revision_tests;
#[cfg(test)]
mod identity_text_tests;
#[cfg(test)]
mod property_union_tests;
#[cfg(test)]
mod character_set_tests;
#[cfg(test)]
mod selected_device_tests;
#[cfg(test)]
mod creation_only_tests;
#[cfg(test)]
mod data_link_tests;
#[cfg(test)]
mod initiated_tests;