Skip to main content

spodes_rs/classes/
gprs_modem_setup.rs

1use crate::interface::InterfaceClass;
2use crate::obis::ObisCode;
3use crate::types::attrs::QualityOfService;
4use crate::types::{BerError, CosemDataType};
5use serde::{Deserialize, Serialize};
6use std::any::Any;
7
8/// Configuration structure used to build a [`GprsModemSetup`] object.
9#[derive(Clone, Serialize, Deserialize, Debug)]
10pub struct GprsModemSetupConfig {
11    /// Attribute 1: the object's logical name (OBIS code).
12    pub logical_name: ObisCode,
13    /// Attribute 2: access point name (octet-string).
14    pub apn: Vec<u8>,
15    /// Attribute 3: PIN code.
16    pub pin_code: u16,
17    /// Attribute 4: `quality_of_service` structure (default and requested).
18    pub quality_of_service: QualityOfService,
19}
20
21/// `GPRS modem setup` interface class (class_id = 45, version = 0) per
22/// IEC 62056-6-2 ยง4.7.7. Configures the GPRS modem (APN, PIN, quality of service).
23///
24/// This class defines no specific methods.
25#[derive(Clone, Serialize, Deserialize, Debug)]
26pub struct GprsModemSetup {
27    logical_name: ObisCode,
28    apn: Vec<u8>,
29    pin_code: u16,
30    quality_of_service: QualityOfService,
31}
32
33impl GprsModemSetup {
34    /// Builds a new [`GprsModemSetup`] from its configuration.
35    pub fn new(config: GprsModemSetupConfig) -> Self {
36        GprsModemSetup {
37            logical_name: config.logical_name,
38            apn: config.apn,
39            pin_code: config.pin_code,
40            quality_of_service: config.quality_of_service,
41        }
42    }
43}
44
45impl InterfaceClass for GprsModemSetup {
46    fn class_id(&self) -> u16 {
47        45
48    }
49
50    fn version(&self) -> u8 {
51        0
52    }
53
54    fn logical_name(&self) -> &ObisCode {
55        &self.logical_name
56    }
57
58    fn attributes(&self) -> Vec<(u8, CosemDataType)> {
59        vec![
60            (1, CosemDataType::OctetString(self.logical_name.to_bytes())),
61            (2, CosemDataType::OctetString(self.apn.clone())),
62            (3, CosemDataType::LongUnsigned(self.pin_code)),
63            (4, CosemDataType::from(self.quality_of_service.clone())),
64        ]
65    }
66
67    fn methods(&self) -> Vec<(u8, String)> {
68        // The GPRS modem setup class defines no specific methods.
69        vec![]
70    }
71
72    fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError> {
73        let mut seq_buf = Vec::new();
74        CosemDataType::LongUnsigned(self.class_id()).serialize_ber(&mut seq_buf)?;
75        for (_, attr) in self.attributes() {
76            attr.serialize_ber(&mut seq_buf)?;
77        }
78        buf.push(0x02); // structure [2]
79        write_length(1 + self.attributes().len(), buf); // length = element count
80        buf.extend_from_slice(&seq_buf);
81        Ok(())
82    }
83
84    fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError> {
85        let (tlv, rest) = CosemDataType::deserialize_ber(data)?;
86        if !rest.is_empty() {
87            return Err(BerError::InvalidTag);
88        }
89        let CosemDataType::Structure(seq) = tlv else {
90            return Err(BerError::InvalidTag);
91        };
92        // class_id + 4 attributes.
93        if seq.len() != 5 {
94            return Err(BerError::InvalidLength);
95        }
96        if let CosemDataType::LongUnsigned(class_id) = seq[0] {
97            if class_id != self.class_id() {
98                return Err(BerError::InvalidValue);
99            }
100        } else {
101            return Err(BerError::InvalidTag);
102        }
103        if let CosemDataType::OctetString(obis) = &seq[1] {
104            if obis.len() == 6 {
105                self.logical_name = ObisCode::new(obis[0], obis[1], obis[2], obis[3], obis[4], obis[5]);
106            } else {
107                return Err(BerError::InvalidLength);
108            }
109        } else {
110            return Err(BerError::InvalidTag);
111        }
112        self.apn = match &seq[2] {
113            CosemDataType::OctetString(v) => v.clone(),
114            _ => return Err(BerError::InvalidTag),
115        };
116        self.pin_code = match seq[3] {
117            CosemDataType::LongUnsigned(v) => v,
118            _ => return Err(BerError::InvalidTag),
119        };
120        self.quality_of_service = QualityOfService::try_from(&seq[4]).map_err(|_| BerError::InvalidValue)?;
121        Ok(())
122    }
123
124    fn invoke_method(&mut self, method_id: u8, _params: Option<CosemDataType>) -> Result<CosemDataType, String> {
125        Err(format!("Method {method_id} not supported for GPRS modem setup (no specific methods)"))
126    }
127
128    fn as_any(&self) -> &dyn Any {
129        self
130    }
131}
132
133/// Writes a BER length octet (short or long form).
134#[allow(clippy::cast_possible_truncation)] // length < 128 and num_octets in 1..=8 always fit u8
135fn write_length(length: usize, buf: &mut Vec<u8>) {
136    if length < 128 {
137        buf.push(length as u8);
138    } else {
139        let bytes = (length as u64).to_be_bytes();
140        let first_non_zero = bytes.iter().position(|&b| b != 0).unwrap_or(7);
141        let num_octets = 8 - first_non_zero;
142        buf.push(0x80 | num_octets as u8);
143        buf.extend_from_slice(&bytes[first_non_zero..]);
144    }
145}
146
147#[cfg(test)]
148mod tests {
149    use super::*;
150    use crate::types::attrs::{GsmServiceParameter, QualityOfService};
151
152    fn sample() -> GprsModemSetup {
153        let zero_param = GsmServiceParameter {
154            delay_class: 0,
155            reliability_class: 0,
156            precedence_class: 0,
157            peak_throughput: 0,
158            mean_throughput: 0,
159        };
160        GprsModemSetup::new(GprsModemSetupConfig {
161            logical_name: ObisCode::new(0, 0, 25, 4, 0, 255),
162            apn: b"internet".to_vec(),
163            pin_code: 0,
164            quality_of_service: QualityOfService { default: zero_param.clone(), requested: zero_param },
165        })
166    }
167
168    #[test]
169    fn class_id_and_attributes() {
170        let obj = sample();
171        assert_eq!(obj.class_id(), 45);
172        assert_eq!(obj.version(), 0);
173        assert_eq!(obj.attributes().len(), 4);
174        assert!(obj.methods().is_empty());
175    }
176
177    #[test]
178    fn round_trip() {
179        let obj = sample();
180        let mut buf = Vec::new();
181        obj.serialize_ber(&mut buf).unwrap();
182        let mut decoded = sample();
183        decoded.pin_code = 9999;
184        decoded.deserialize_ber(&buf).unwrap();
185        assert_eq!(decoded.attributes(), obj.attributes());
186    }
187}