use bacnet_types::error::Error;
use bacnet_types::primitives::{BACnetTimeStamp, Date, ObjectIdentifier, PropertyValue, Time};
use bytes::{BufMut, BytesMut};
use crate::tags::{self, app_tag, TagClass};
pub fn encode_unsigned(buf: &mut BytesMut, value: u64) {
if value <= 0xFF {
buf.put_u8(value as u8);
} else if value <= 0xFFFF {
buf.put_u16(value as u16);
} else if value <= 0xFF_FFFF {
buf.put_u8((value >> 16) as u8);
buf.put_u16(value as u16);
} else if value <= 0xFFFF_FFFF {
buf.put_u32(value as u32);
} else if value <= 0xFF_FFFF_FFFF {
buf.put_u8((value >> 32) as u8);
buf.put_u32(value as u32);
} else if value <= 0xFFFF_FFFF_FFFF {
buf.put_u16((value >> 32) as u16);
buf.put_u32(value as u32);
} else if value <= 0xFF_FFFF_FFFF_FFFF {
buf.put_u8((value >> 48) as u8);
buf.put_u16((value >> 32) as u16);
buf.put_u32(value as u32);
} else {
buf.put_u64(value);
}
}
pub fn unsigned_len(value: u64) -> u32 {
if value <= 0xFF {
1
} else if value <= 0xFFFF {
2
} else if value <= 0xFF_FFFF {
3
} else if value <= 0xFFFF_FFFF {
4
} else if value <= 0xFF_FFFF_FFFF {
5
} else if value <= 0xFFFF_FFFF_FFFF {
6
} else if value <= 0xFF_FFFF_FFFF_FFFF {
7
} else {
8
}
}
pub fn decode_unsigned(data: &[u8]) -> Result<u64, Error> {
if data.is_empty() || data.len() > 8 {
return Err(Error::Decoding {
offset: 0,
message: format!("unsigned requires 1-8 bytes, got {}", data.len()),
});
}
let mut value: u64 = 0;
for &b in data {
value = (value << 8) | b as u64;
}
Ok(value)
}
pub fn encode_signed(buf: &mut BytesMut, value: i32) {
let n = signed_len(value);
let bytes = value.to_be_bytes();
buf.put_slice(&bytes[4 - n as usize..]);
}
pub fn signed_len(value: i32) -> u32 {
if (-128..=127).contains(&value) {
1
} else if (-32768..=32767).contains(&value) {
2
} else if (-8_388_608..=8_388_607).contains(&value) {
3
} else {
4
}
}
pub fn decode_signed(data: &[u8]) -> Result<i32, Error> {
if data.is_empty() || data.len() > 4 {
return Err(Error::Decoding {
offset: 0,
message: format!("signed requires 1-4 bytes, got {}", data.len()),
});
}
let sign_extend = if data[0] & 0x80 != 0 { 0xFF } else { 0x00 };
let mut bytes = [sign_extend; 4];
bytes[4 - data.len()..].copy_from_slice(data);
Ok(i32::from_be_bytes(bytes))
}
pub fn encode_real(buf: &mut BytesMut, value: f32) {
buf.put_f32(value);
}
pub fn decode_real(data: &[u8]) -> Result<f32, Error> {
if data.len() != 4 {
return Err(Error::decoding(
0,
format!("Real expects exactly 4 bytes, got {}", data.len()),
));
}
Ok(f32::from_be_bytes([data[0], data[1], data[2], data[3]]))
}
pub fn encode_double(buf: &mut BytesMut, value: f64) {
buf.put_f64(value);
}
pub fn decode_double(data: &[u8]) -> Result<f64, Error> {
if data.len() != 8 {
return Err(Error::decoding(
0,
format!("Double expects exactly 8 bytes, got {}", data.len()),
));
}
let bytes: [u8; 8] = [
data[0], data[1], data[2], data[3], data[4], data[5], data[6], data[7],
];
Ok(f64::from_be_bytes(bytes))
}
pub mod charset {
pub const UTF8: u8 = 0;
pub const IBM_MICROSOFT_DBCS: u8 = 1;
pub const JIS_X_0208: u8 = 2;
pub const UCS4: u8 = 3;
pub const UCS2: u8 = 4;
pub const ISO_8859_1: u8 = 5;
}
pub fn encode_character_string(buf: &mut BytesMut, value: &str) {
buf.put_u8(charset::UTF8);
buf.put_slice(value.as_bytes());
}
pub fn character_string_len(value: &str) -> Result<u32, Error> {
u32::try_from(value.len())
.ok()
.and_then(|n| n.checked_add(1))
.ok_or_else(|| Error::Encoding("CharacterString too long for BACnet encoding".into()))
}
pub fn decode_character_string(data: &[u8]) -> Result<String, Error> {
if data.is_empty() {
return Err(Error::Decoding {
offset: 0,
message: "CharacterString requires at least 1 byte for charset".into(),
});
}
let charset_id = data[0];
let payload = &data[1..];
match charset_id {
charset::UTF8 => String::from_utf8(payload.to_vec()).map_err(|e| Error::Decoding {
offset: 1,
message: format!("invalid UTF-8: {e}"),
}),
charset::UCS2 => {
if !payload.len().is_multiple_of(2) {
return Err(Error::Decoding {
offset: 1,
message: "UCS-2 data must have even length".into(),
});
}
let mut s = String::new();
for (i, chunk) in payload.chunks_exact(2).enumerate() {
let code_point = u16::from_be_bytes([chunk[0], chunk[1]]);
if let Some(c) = char::from_u32(code_point as u32) {
s.push(c);
} else {
return Err(Error::Decoding {
offset: 1 + i * 2,
message: "invalid UCS-2 code point".into(),
});
}
}
Ok(s)
}
charset::ISO_8859_1 => Ok(payload.iter().map(|&b| b as char).collect()),
charset::IBM_MICROSOFT_DBCS | charset::JIS_X_0208 | charset::UCS4 => Err(Error::Decoding {
offset: 0,
message: format!("unsupported charset: {charset_id}"),
}),
other => Err(Error::Decoding {
offset: 0,
message: format!("unknown charset: {other}"),
}),
}
}
pub fn encode_bit_string(buf: &mut BytesMut, unused_bits: u8, data: &[u8]) {
buf.put_u8(unused_bits);
buf.put_slice(data);
}
pub fn decode_bit_string(data: &[u8]) -> Result<(u8, Vec<u8>), Error> {
if data.is_empty() {
return Err(Error::Decoding {
offset: 0,
message: "BitString requires at least 1 byte for unused-bits count".into(),
});
}
let unused = data[0];
if unused > 7 {
return Err(Error::Decoding {
offset: 0,
message: format!("BitString unused_bits must be 0-7, got {unused}"),
});
}
Ok((unused, data[1..].to_vec()))
}
pub fn encode_app_null(buf: &mut BytesMut) {
tags::encode_tag(buf, app_tag::NULL, TagClass::Application, 0);
}
pub fn encode_app_boolean(buf: &mut BytesMut, value: bool) {
tags::encode_tag(
buf,
app_tag::BOOLEAN,
TagClass::Application,
if value { 1 } else { 0 },
);
}
pub fn encode_app_unsigned(buf: &mut BytesMut, value: u64) {
let len = unsigned_len(value);
tags::encode_tag(buf, app_tag::UNSIGNED, TagClass::Application, len);
encode_unsigned(buf, value);
}
pub fn encode_app_signed(buf: &mut BytesMut, value: i32) {
let len = signed_len(value);
tags::encode_tag(buf, app_tag::SIGNED, TagClass::Application, len);
encode_signed(buf, value);
}
pub fn encode_app_real(buf: &mut BytesMut, value: f32) {
tags::encode_tag(buf, app_tag::REAL, TagClass::Application, 4);
encode_real(buf, value);
}
pub fn encode_app_double(buf: &mut BytesMut, value: f64) {
tags::encode_tag(buf, app_tag::DOUBLE, TagClass::Application, 8);
encode_double(buf, value);
}
pub fn encode_app_octet_string(buf: &mut BytesMut, data: &[u8]) {
let data_len = u32::try_from(data.len()).unwrap_or(u32::MAX);
tags::encode_tag(buf, app_tag::OCTET_STRING, TagClass::Application, data_len);
buf.put_slice(data);
}
pub fn encode_app_character_string(buf: &mut BytesMut, value: &str) -> Result<(), Error> {
let len = character_string_len(value)?;
tags::encode_tag(buf, app_tag::CHARACTER_STRING, TagClass::Application, len);
encode_character_string(buf, value);
Ok(())
}
pub fn encode_app_bit_string(buf: &mut BytesMut, unused_bits: u8, data: &[u8]) {
let data_len = u32::try_from(data.len()).unwrap_or(u32::MAX);
let len = data_len.saturating_add(1);
tags::encode_tag(buf, app_tag::BIT_STRING, TagClass::Application, len);
encode_bit_string(buf, unused_bits, data);
}
pub fn encode_app_enumerated(buf: &mut BytesMut, value: u32) {
let len = unsigned_len(value as u64);
tags::encode_tag(buf, app_tag::ENUMERATED, TagClass::Application, len);
encode_unsigned(buf, value as u64);
}
pub fn encode_app_date(buf: &mut BytesMut, date: &Date) {
tags::encode_tag(buf, app_tag::DATE, TagClass::Application, 4);
buf.put_slice(&date.encode());
}
pub fn encode_app_time(buf: &mut BytesMut, time: &Time) {
tags::encode_tag(buf, app_tag::TIME, TagClass::Application, 4);
buf.put_slice(&time.encode());
}
pub fn encode_app_object_id(buf: &mut BytesMut, oid: &ObjectIdentifier) {
tags::encode_tag(buf, app_tag::OBJECT_IDENTIFIER, TagClass::Application, 4);
buf.put_slice(&oid.encode());
}
pub fn encode_ctx_unsigned(buf: &mut BytesMut, tag: u8, value: u64) {
let len = unsigned_len(value);
tags::encode_tag(buf, tag, TagClass::Context, len);
encode_unsigned(buf, value);
}
pub fn encode_ctx_signed(buf: &mut BytesMut, tag: u8, value: i32) {
let len = signed_len(value);
tags::encode_tag(buf, tag, TagClass::Context, len);
encode_signed(buf, value);
}
pub fn encode_ctx_real(buf: &mut BytesMut, tag: u8, value: f32) {
tags::encode_tag(buf, tag, TagClass::Context, 4);
encode_real(buf, value);
}
pub fn encode_ctx_double(buf: &mut BytesMut, tag: u8, value: f64) {
tags::encode_tag(buf, tag, TagClass::Context, 8);
encode_double(buf, value);
}
pub fn encode_ctx_enumerated(buf: &mut BytesMut, tag: u8, value: u32) {
let len = unsigned_len(value as u64);
tags::encode_tag(buf, tag, TagClass::Context, len);
encode_unsigned(buf, value as u64);
}
pub fn encode_ctx_boolean(buf: &mut BytesMut, tag: u8, value: bool) {
tags::encode_tag(buf, tag, TagClass::Context, 1);
buf.put_u8(if value { 1 } else { 0 });
}
pub fn encode_ctx_object_id(buf: &mut BytesMut, tag: u8, oid: &ObjectIdentifier) {
tags::encode_tag(buf, tag, TagClass::Context, 4);
buf.put_slice(&oid.encode());
}
pub fn encode_ctx_octet_string(buf: &mut BytesMut, tag: u8, data: &[u8]) {
let data_len = u32::try_from(data.len()).unwrap_or(u32::MAX);
tags::encode_tag(buf, tag, TagClass::Context, data_len);
buf.put_slice(data);
}
pub fn encode_ctx_character_string(buf: &mut BytesMut, tag: u8, value: &str) -> Result<(), Error> {
let len = character_string_len(value)?;
tags::encode_tag(buf, tag, TagClass::Context, len);
encode_character_string(buf, value);
Ok(())
}
pub fn encode_ctx_date(buf: &mut BytesMut, tag: u8, date: &Date) {
tags::encode_tag(buf, tag, TagClass::Context, 4);
buf.put_slice(&date.encode());
}
pub fn encode_ctx_bit_string(buf: &mut BytesMut, tag: u8, unused_bits: u8, data: &[u8]) {
let data_len = u32::try_from(data.len()).unwrap_or(u32::MAX);
let len = data_len.saturating_add(1);
tags::encode_tag(buf, tag, TagClass::Context, len);
encode_bit_string(buf, unused_bits, data);
}
pub fn decode_application_value(
data: &[u8],
offset: usize,
) -> Result<(PropertyValue, usize), Error> {
let (tag, new_offset) = tags::decode_tag(data, offset)?;
if tag.class != TagClass::Application {
return Err(Error::decoding(
offset,
format!("expected application tag, got context tag {}", tag.number),
));
}
if tag.is_opening || tag.is_closing {
return Err(Error::decoding(offset, "unexpected opening/closing tag"));
}
let content_start = new_offset;
let content_len = tag.length as usize;
let content_end = content_start
.checked_add(content_len)
.ok_or_else(|| Error::decoding(content_start, "length overflow"))?;
if tag.number == app_tag::BOOLEAN {
return Ok((PropertyValue::Boolean(tag.length != 0), content_start));
}
if data.len() < content_end {
return Err(Error::buffer_too_short(content_end, data.len()));
}
let content = &data[content_start..content_end];
let value = match tag.number {
app_tag::NULL => PropertyValue::Null,
app_tag::UNSIGNED => PropertyValue::Unsigned(decode_unsigned(content)?),
app_tag::SIGNED => PropertyValue::Signed(decode_signed(content)?),
app_tag::REAL => PropertyValue::Real(decode_real(content)?),
app_tag::DOUBLE => PropertyValue::Double(decode_double(content)?),
app_tag::OCTET_STRING => PropertyValue::OctetString(content.to_vec()),
app_tag::CHARACTER_STRING => {
PropertyValue::CharacterString(decode_character_string(content)?)
}
app_tag::BIT_STRING => {
let (unused, bits) = decode_bit_string(content)?;
PropertyValue::BitString {
unused_bits: unused,
data: bits,
}
}
app_tag::ENUMERATED => PropertyValue::Enumerated(decode_unsigned(content)? as u32),
app_tag::DATE => PropertyValue::Date(Date::decode(content)?),
app_tag::TIME => PropertyValue::Time(Time::decode(content)?),
app_tag::OBJECT_IDENTIFIER => {
PropertyValue::ObjectIdentifier(ObjectIdentifier::decode(content)?)
}
other => {
return Err(Error::decoding(
offset,
format!("unknown application tag number {other}"),
));
}
};
Ok((value, content_end))
}
pub fn encode_property_value(buf: &mut BytesMut, value: &PropertyValue) -> Result<(), Error> {
match value {
PropertyValue::Null => encode_app_null(buf),
PropertyValue::Boolean(v) => encode_app_boolean(buf, *v),
PropertyValue::Unsigned(v) => encode_app_unsigned(buf, *v),
PropertyValue::Signed(v) => encode_app_signed(buf, *v),
PropertyValue::Real(v) => encode_app_real(buf, *v),
PropertyValue::Double(v) => encode_app_double(buf, *v),
PropertyValue::OctetString(v) => encode_app_octet_string(buf, v),
PropertyValue::CharacterString(v) => encode_app_character_string(buf, v)?,
PropertyValue::BitString { unused_bits, data } => {
encode_app_bit_string(buf, *unused_bits, data)
}
PropertyValue::Enumerated(v) => encode_app_enumerated(buf, *v),
PropertyValue::Date(v) => encode_app_date(buf, v),
PropertyValue::Time(v) => encode_app_time(buf, v),
PropertyValue::ObjectIdentifier(v) => encode_app_object_id(buf, v),
PropertyValue::List(values) => {
for v in values {
encode_property_value(buf, v)?;
}
}
}
Ok(())
}
pub fn encode_timestamp(buf: &mut BytesMut, tag_number: u8, ts: &BACnetTimeStamp) {
tags::encode_opening_tag(buf, tag_number);
match ts {
BACnetTimeStamp::Time(t) => {
tags::encode_tag(buf, 0, TagClass::Context, 4);
buf.put_slice(&t.encode());
}
BACnetTimeStamp::SequenceNumber(n) => {
encode_ctx_unsigned(buf, 1, *n);
}
BACnetTimeStamp::DateTime { date, time } => {
tags::encode_opening_tag(buf, 2);
encode_app_date(buf, date);
encode_app_time(buf, time);
tags::encode_closing_tag(buf, 2);
}
}
tags::encode_closing_tag(buf, tag_number);
}
pub fn decode_timestamp(
data: &[u8],
offset: usize,
tag_number: u8,
) -> Result<(BACnetTimeStamp, usize), Error> {
let (tag, pos) = tags::decode_tag(data, offset)?;
if !tag.is_opening_tag(tag_number) {
return Err(Error::decoding(
offset,
format!("expected opening tag {tag_number} for BACnetTimeStamp"),
));
}
let (inner_tag, inner_pos) = tags::decode_tag(data, pos)?;
let (ts, after_inner) = if inner_tag.is_context(0) {
let end = inner_pos
.checked_add(inner_tag.length as usize)
.ok_or_else(|| Error::decoding(inner_pos, "BACnetTimeStamp Time length overflow"))?;
if end > data.len() {
return Err(Error::decoding(inner_pos, "BACnetTimeStamp Time truncated"));
}
let t = Time::decode(&data[inner_pos..end])?;
(BACnetTimeStamp::Time(t), end)
} else if inner_tag.is_context(1) {
let end = inner_pos
.checked_add(inner_tag.length as usize)
.ok_or_else(|| {
Error::decoding(inner_pos, "BACnetTimeStamp SequenceNumber length overflow")
})?;
if end > data.len() {
return Err(Error::decoding(
inner_pos,
"BACnetTimeStamp SequenceNumber truncated",
));
}
let n = decode_unsigned(&data[inner_pos..end])?;
(BACnetTimeStamp::SequenceNumber(n), end)
} else if inner_tag.is_opening_tag(2) {
let (date_tag, date_pos) = tags::decode_tag(data, inner_pos)?;
if date_tag.class != TagClass::Application || date_tag.number != app_tag::DATE {
return Err(Error::decoding(
inner_pos,
"BACnetTimeStamp DateTime expected Date",
));
}
let date_end = date_pos
.checked_add(date_tag.length as usize)
.ok_or_else(|| {
Error::decoding(date_pos, "BACnetTimeStamp DateTime Date length overflow")
})?;
if date_end > data.len() {
return Err(Error::decoding(
date_pos,
"BACnetTimeStamp DateTime Date truncated",
));
}
let date = Date::decode(&data[date_pos..date_end])?;
let (time_tag, time_pos) = tags::decode_tag(data, date_end)?;
if time_tag.class != TagClass::Application || time_tag.number != app_tag::TIME {
return Err(Error::decoding(
date_end,
"BACnetTimeStamp DateTime expected Time",
));
}
let time_end = time_pos
.checked_add(time_tag.length as usize)
.ok_or_else(|| {
Error::decoding(time_pos, "BACnetTimeStamp DateTime Time length overflow")
})?;
if time_end > data.len() {
return Err(Error::decoding(
time_pos,
"BACnetTimeStamp DateTime Time truncated",
));
}
let time = Time::decode(&data[time_pos..time_end])?;
let (close_tag, close_pos) = tags::decode_tag(data, time_end)?;
if !close_tag.is_closing_tag(2) {
return Err(Error::decoding(
time_end,
"BACnetTimeStamp DateTime missing closing tag 2",
));
}
(BACnetTimeStamp::DateTime { date, time }, close_pos)
} else {
return Err(Error::decoding(
pos,
"BACnetTimeStamp: unexpected inner choice tag",
));
};
let (close, final_pos) = tags::decode_tag(data, after_inner)?;
if !close.is_closing_tag(tag_number) {
return Err(Error::decoding(
after_inner,
format!("expected closing tag {tag_number} for BACnetTimeStamp"),
));
}
Ok((ts, final_pos))
}
#[cfg(test)]
mod tests;