voltage_modbus 0.5.1

A high-performance industrial Modbus library for Rust with TCP and RTU support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use std::fmt::Write;
use std::sync::Arc;

/// Format bytes as hex string efficiently
///
/// Uses direct string writing for better performance than collect/join.
#[inline]
fn format_hex(data: &[u8]) -> String {
    if data.is_empty() {
        return String::new();
    }
    let mut result = String::with_capacity(data.len() * 3 - 1);
    for (i, b) in data.iter().enumerate() {
        if i > 0 {
            result.push(' ');
        }
        let _ = write!(result, "{:02X}", b);
    }
    result
}

/// Log levels for the callback logging system
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LogLevel {
    /// Error messages
    Error,
    /// Warning messages
    Warn,
    /// Informational messages
    Info,
    /// Debug messages
    Debug,
}

/// Logging mode for packet display
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LoggingMode {
    /// Show raw packet data only
    Raw,
    /// Show interpreted packet data with field descriptions
    Interpreted,
    /// Show both raw and interpreted data
    Both,
}

impl LogLevel {
    /// Convert log level to string
    pub fn as_str(&self) -> &'static str {
        match self {
            LogLevel::Error => "ERROR",
            LogLevel::Warn => "WARN",
            LogLevel::Info => "INFO",
            LogLevel::Debug => "DEBUG",
        }
    }
}

/// Type alias for log callback functions
///
/// The callback receives a log level and message string
pub type LogCallback = Box<dyn Fn(LogLevel, &str) + Send + Sync>;

/// Logger that uses callbacks for flexible logging
#[derive(Clone)]
pub struct CallbackLogger {
    callback: Option<Arc<LogCallback>>,
    min_level: LogLevel,
    mode: LoggingMode,
}

impl CallbackLogger {
    /// Create a new callback logger
    pub fn new(callback: Option<LogCallback>, min_level: LogLevel) -> Self {
        Self {
            callback: callback.map(Arc::new),
            min_level,
            mode: LoggingMode::Interpreted,
        }
    }

    /// Create a new callback logger with specific mode
    pub fn with_mode(
        callback: Option<LogCallback>,
        min_level: LogLevel,
        mode: LoggingMode,
    ) -> Self {
        Self {
            callback: callback.map(Arc::new),
            min_level,
            mode,
        }
    }

    /// Create a logger with default console output
    pub fn console() -> Self {
        let callback: LogCallback = Box::new(|level, message| {
            use std::time::SystemTime;
            let now = SystemTime::now()
                .duration_since(SystemTime::UNIX_EPOCH)
                .unwrap_or_default();
            let secs = now.as_secs();
            let millis = now.subsec_millis();
            match level {
                LogLevel::Error => eprintln!("[{}.{:03}] ERROR: {}", secs, millis, message),
                LogLevel::Warn => eprintln!("[{}.{:03}] WARN: {}", secs, millis, message),
                LogLevel::Info => println!("[{}.{:03}] INFO: {}", secs, millis, message),
                LogLevel::Debug => println!("[{}.{:03}] DEBUG: {}", secs, millis, message),
            }
        });
        Self::new(Some(callback), LogLevel::Info)
    }

    /// Create a logger that outputs nothing (disabled)
    pub fn disabled() -> Self {
        Self::new(None, LogLevel::Error)
    }

    /// Set logging mode
    pub fn set_mode(&mut self, mode: LoggingMode) {
        self.mode = mode;
    }

    /// Get current logging mode
    pub fn get_mode(&self) -> LoggingMode {
        self.mode
    }

    /// Log a message at the specified level
    pub fn log(&self, level: LogLevel, message: &str) {
        if self.should_log(level) {
            if let Some(ref callback) = self.callback {
                callback(level, message);
            }
        }
    }

    /// Log an error message
    pub fn error(&self, message: &str) {
        self.log(LogLevel::Error, message);
    }

    /// Log a warning message
    pub fn warn(&self, message: &str) {
        self.log(LogLevel::Warn, message);
    }

    /// Log an info message
    pub fn info(&self, message: &str) {
        self.log(LogLevel::Info, message);
    }

    /// Log a debug message
    pub fn debug(&self, message: &str) {
        self.log(LogLevel::Debug, message);
    }

    /// Check if a message at the given level should be logged
    fn should_log(&self, level: LogLevel) -> bool {
        self.callback.is_some() && level as u8 <= self.min_level as u8
    }

    /// Log packet data with hex dump
    pub fn log_packet(&self, level: LogLevel, direction: &str, data: &[u8]) {
        if !self.should_log(level) {
            return;
        }

        let hex_data = format_hex(data);
        let message = format!("{} packet ({} bytes): {}", direction, data.len(), hex_data);
        self.log(level, &message);
    }

    /// Log a Modbus request with different modes
    ///
    /// # Arguments
    ///
    /// * `transaction_id` - Optional transaction ID for TCP (None for RTU/ASCII)
    /// * `slave_id` - The Modbus slave/unit ID
    /// * `function_code` - The Modbus function code
    /// * `address` - The starting address
    /// * `quantity` - The quantity of registers/coils
    /// * `data` - Additional data bytes
    pub fn log_request(
        &self,
        transaction_id: Option<u16>,
        slave_id: u8,
        function_code: u8,
        address: u16,
        quantity: u16,
        data: &[u8],
    ) {
        match self.mode {
            LoggingMode::Raw => {
                let raw_packet = self.build_raw_request_packet(
                    transaction_id.unwrap_or(1),
                    slave_id,
                    function_code,
                    address,
                    quantity,
                    data,
                );
                let hex_data = format_hex(&raw_packet);
                let message = format!("Modbus Request -> Raw: {}", hex_data);
                self.info(&message);
            }
            LoggingMode::Interpreted => {
                let function_name = self.get_function_name(function_code);
                let message = format!(
                    "Modbus Request -> Slave: {}, Function: {} (0x{:02X}), Address: {}, Quantity: {}",
                    slave_id, function_name, function_code, address, quantity
                );
                self.info(&message);
            }
            LoggingMode::Both => {
                // Log interpreted first
                let function_name = self.get_function_name(function_code);
                let interpreted = format!(
                    "Modbus Request -> Slave: {}, Function: {} (0x{:02X}), Address: {}, Quantity: {}",
                    slave_id, function_name, function_code, address, quantity
                );
                self.info(&interpreted);

                // Then log raw
                let raw_packet = self.build_raw_request_packet(
                    transaction_id.unwrap_or(1),
                    slave_id,
                    function_code,
                    address,
                    quantity,
                    data,
                );
                let hex_data = format_hex(&raw_packet);
                let raw_message = format!("Modbus Request -> Raw: {}", hex_data);
                self.debug(&raw_message);
            }
        }
    }

    /// Log a Modbus response with different modes
    ///
    /// # Arguments
    ///
    /// * `transaction_id` - Optional transaction ID for TCP (None for RTU/ASCII)
    /// * `slave_id` - The Modbus slave/unit ID
    /// * `function_code` - The Modbus function code
    /// * `data` - Response data bytes
    pub fn log_response(
        &self,
        transaction_id: Option<u16>,
        slave_id: u8,
        function_code: u8,
        data: &[u8],
    ) {
        match self.mode {
            LoggingMode::Raw => {
                let raw_packet = self.build_raw_response_packet(
                    transaction_id.unwrap_or(1),
                    slave_id,
                    function_code,
                    data,
                );
                let hex_data = format_hex(&raw_packet);
                let message = format!("Modbus Response <- Raw: {}", hex_data);
                self.info(&message);
            }
            LoggingMode::Interpreted => {
                let function_name = self.get_function_name(function_code);
                let interpreted_data = self.interpret_response_data(function_code, data);
                let message = format!(
                    "Modbus Response <- Slave: {}, Function: {} (0x{:02X}), {}",
                    slave_id, function_name, function_code, interpreted_data
                );
                self.info(&message);
            }
            LoggingMode::Both => {
                // Log interpreted first
                let function_name = self.get_function_name(function_code);
                let interpreted_data = self.interpret_response_data(function_code, data);
                let interpreted = format!(
                    "Modbus Response <- Slave: {}, Function: {} (0x{:02X}), {}",
                    slave_id, function_name, function_code, interpreted_data
                );
                self.info(&interpreted);

                // Then log raw
                let raw_packet = self.build_raw_response_packet(
                    transaction_id.unwrap_or(1),
                    slave_id,
                    function_code,
                    data,
                );
                let hex_data = format_hex(&raw_packet);
                let raw_message = format!("Modbus Response <- Raw: {}", hex_data);
                self.debug(&raw_message);
            }
        }
    }

    /// Build raw request packet for logging
    fn build_raw_request_packet(
        &self,
        transaction_id: u16,
        slave_id: u8,
        function_code: u8,
        address: u16,
        quantity: u16,
        data: &[u8],
    ) -> Vec<u8> {
        let mut packet = Vec::new();
        // TCP MBAP header
        packet.extend_from_slice(&transaction_id.to_be_bytes()); // Transaction ID
        packet.extend_from_slice(&[0x00, 0x00]); // Protocol ID
        packet.extend_from_slice(&[0x00, (6 + data.len()) as u8]); // Length
        packet.push(slave_id);
        packet.push(function_code);
        packet.extend_from_slice(&address.to_be_bytes());
        packet.extend_from_slice(&quantity.to_be_bytes());
        packet.extend_from_slice(data);
        packet
    }

    /// Build raw response packet for logging
    fn build_raw_response_packet(
        &self,
        transaction_id: u16,
        slave_id: u8,
        function_code: u8,
        data: &[u8],
    ) -> Vec<u8> {
        let mut packet = Vec::new();
        // TCP MBAP header
        packet.extend_from_slice(&transaction_id.to_be_bytes()); // Transaction ID
        packet.extend_from_slice(&[0x00, 0x00]); // Protocol ID
        packet.extend_from_slice(&[0x00, (2 + data.len()) as u8]); // Length
        packet.push(slave_id);
        packet.push(function_code);
        packet.extend_from_slice(data);
        packet
    }

    /// Simple hex encoding helper (no spaces between bytes)
    fn hex_encode(data: &[u8]) -> String {
        // Pre-allocate: 2 hex chars per byte
        let mut result = String::with_capacity(data.len() * 2);
        for b in data {
            let _ = write!(result, "{:02X}", b);
        }
        result
    }

    /// Get human-readable function name
    fn get_function_name(&self, function_code: u8) -> &'static str {
        match function_code {
            0x01 => "Read Coils",
            0x02 => "Read Discrete Inputs",
            0x03 => "Read Holding Registers",
            0x04 => "Read Input Registers",
            0x05 => "Write Single Coil",
            0x06 => "Write Single Register",
            0x0F => "Write Multiple Coils",
            0x10 => "Write Multiple Registers",
            _ => "Unknown Function",
        }
    }

    /// Interpret response data based on function code
    fn interpret_response_data(&self, function_code: u8, data: &[u8]) -> String {
        if data.is_empty() {
            return "No data".to_string();
        }

        match function_code {
            0x01 | 0x02 => {
                // Coils or discrete inputs
                if data.len() >= 2 {
                    let byte_count = data[0];
                    let mut coils = Vec::new();
                    for i in 1..=byte_count as usize {
                        if i < data.len() {
                            for bit in 0..8 {
                                coils.push((data[i] & (1 << bit)) != 0);
                            }
                        }
                    }
                    format!(
                        "Byte count: {}, Coils: {:?}",
                        byte_count,
                        &coils[..coils.len().min(16)]
                    )
                } else {
                    format!("Data: {}", Self::hex_encode(data))
                }
            }
            0x03 | 0x04 => {
                // Holding registers or input registers
                if data.len() >= 3 {
                    let byte_count = data[0];
                    let mut registers = Vec::new();
                    for i in (1..data.len()).step_by(2) {
                        if i + 1 < data.len() {
                            let value = u16::from_be_bytes([data[i], data[i + 1]]);
                            registers.push(value);
                        }
                    }
                    format!(
                        "Byte count: {}, Registers: {:?}",
                        byte_count,
                        &registers[..registers.len().min(8)]
                    )
                } else {
                    format!("Data: {}", Self::hex_encode(data))
                }
            }
            0x05 => {
                // Write single coil response
                if data.len() >= 4 {
                    let address = u16::from_be_bytes([data[0], data[1]]);
                    let value = u16::from_be_bytes([data[2], data[3]]);
                    format!(
                        "Address: {}, Value: 0x{:04X} ({})",
                        address,
                        value,
                        if value == 0xFF00 { "ON" } else { "OFF" }
                    )
                } else {
                    format!("Data: {}", Self::hex_encode(data))
                }
            }
            0x06 => {
                // Write single register response
                if data.len() >= 4 {
                    let address = u16::from_be_bytes([data[0], data[1]]);
                    let value = u16::from_be_bytes([data[2], data[3]]);
                    format!("Address: {}, Value: {} (0x{:04X})", address, value, value)
                } else {
                    format!("Data: {}", Self::hex_encode(data))
                }
            }
            0x0F | 0x10 => {
                // Write multiple coils/registers response
                if data.len() >= 4 {
                    let address = u16::from_be_bytes([data[0], data[1]]);
                    let quantity = u16::from_be_bytes([data[2], data[3]]);
                    format!("Address: {}, Quantity: {}", address, quantity)
                } else {
                    format!("Data: {}", Self::hex_encode(data))
                }
            }
            _ => {
                format!("Data: {}", Self::hex_encode(data))
            }
        }
    }
}

impl Default for CallbackLogger {
    fn default() -> Self {
        Self::disabled()
    }
}

/// Convenience macro for creating a simple console logger
#[macro_export]
macro_rules! console_logger {
    () => {
        $crate::logging::CallbackLogger::console()
    };
}

/// Convenience macro for creating a custom logger
#[macro_export]
macro_rules! custom_logger {
    ($callback:expr) => {
        $crate::logging::CallbackLogger::new(Some($callback), $crate::logging::LogLevel::Info)
    };
    ($callback:expr, $level:expr) => {
        $crate::logging::CallbackLogger::new(Some($callback), $level)
    };
    ($callback:expr, $level:expr, $mode:expr) => {
        $crate::logging::CallbackLogger::with_mode(Some($callback), $level, $mode)
    };
}