ghpascon-rust 1.0.5

A personal Rust utility library
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
use std::sync::{
    Arc, Mutex,
    atomic::{AtomicBool, Ordering},
};

use super::config::{ConnectionType, ParamMap, X714Config};
use super::parser::parse_line_to_events;
use super::transport::{SharedEventHandler, default_event_handler, dispatch_event};
use super::types::X714Event;

/// Shared mutable runtime state. Lives inside an `Arc` so background tasks
/// (read loop, monitor, ping) can access the same state as the user-facing `X714`.
pub(crate) struct X714Shared {
    pub is_connected: AtomicBool,
    pub is_reading: AtomicBool,
    pub serial_number: Mutex<Option<String>>,
    /// Generic async writer – holds OwnedWriteHalf (TCP) or WriteHalf<SerialStream> (Serial).
    pub writer: tokio::sync::Mutex<Option<Box<dyn tokio::io::AsyncWrite + Send + Unpin>>>,
    /// BLE write channel – set by run_ble_loop, None for Serial/TCP.
    pub ble_write_tx: tokio::sync::Mutex<Option<tokio::sync::mpsc::UnboundedSender<Vec<u8>>>>,
    /// Set to `false` by `close()` to break reconnection loops.
    pub running: AtomicBool,
}

impl X714Shared {
    pub fn new() -> Arc<Self> {
        Arc::new(Self {
            is_connected: AtomicBool::new(false),
            is_reading: AtomicBool::new(false),
            serial_number: Mutex::new(None),
            writer: tokio::sync::Mutex::new(None),
            ble_write_tx: tokio::sync::Mutex::new(None),
            running: AtomicBool::new(true),
        })
    }
}

/// X714 RFID reader.
///
/// `clone()` is cheap – all runtime state is behind an `Arc` so clones share
/// the same connection.  Typical pattern:
///
/// ```rust,no_run
/// # use ghpascon_rust::devices::rfid::x714::X714;
/// # #[tokio::main] async fn main() {
/// let reader = X714::default();
/// let bg = reader.clone();
/// tokio::spawn(async move { bg.connect().await; }); // reconnects automatically
/// reader.write("#READ:ON").await.ok();
/// # }
/// ```
pub struct X714 {
    pub config: X714Config,
    pub on_event: SharedEventHandler,
    pub(crate) shared: Arc<X714Shared>,
}

impl Clone for X714 {
    fn clone(&self) -> Self {
        Self {
            config: self.config.clone(),
            on_event: Arc::clone(&self.on_event),
            shared: Arc::clone(&self.shared),
        }
    }
}

impl Default for X714 {
    fn default() -> Self {
        Self::new(X714Config::default())
    }
}

impl X714 {
    pub fn new(config: X714Config) -> Self {
        Self {
            config,
            on_event: default_event_handler(),
            shared: X714Shared::new(),
        }
    }

    pub fn from_map(params: ParamMap) -> Result<Self, String> {
        Ok(Self::new(X714Config::from_map(params)?))
    }

    pub fn with_event_handler(mut self, handler: SharedEventHandler) -> Self {
        self.on_event = handler;
        self
    }

    pub fn set_event_handler(&mut self, handler: SharedEventHandler) {
        self.on_event = handler;
    }

    // ─── Runtime state ────────────────────────────────────────────────────────

    pub fn is_connected(&self) -> bool {
        self.shared.is_connected.load(Ordering::Relaxed)
    }

    pub fn is_reading(&self) -> bool {
        self.shared.is_reading.load(Ordering::Relaxed)
    }

    pub fn serial_number(&self) -> Option<String> {
        self.shared.serial_number.lock().unwrap().clone()
    }

    // ─── Config helpers ───────────────────────────────────────────────────────

    pub fn to_map(&self) -> ParamMap {
        self.config.to_map()
    }

    pub fn connect_instruction(&self) -> String {
        match self.config.connection_type {
            ConnectionType::Serial => format!(
                "SERIAL {} @ {} (VID={:#06x}, PID={:#06x})",
                self.config.serial.port,
                self.config.serial.baudrate,
                self.config.serial.vid,
                self.config.serial.pid
            ),
            ConnectionType::Tcp => format!("TCP {}:{}", self.config.tcp.ip, self.config.tcp.port),
            ConnectionType::Ble => {
                if let Some(address) = &self.config.ble.address {
                    format!("BLE {} ({})", self.config.ble.name, address)
                } else {
                    format!("BLE {} (auto-discovery)", self.config.ble.name)
                }
            }
        }
    }

    // ─── Connection ───────────────────────────────────────────────────────────

    /// Run the connection + reconnection loop forever (until `close()` is called).
    ///
    /// Spawn this as a background task:
    /// ```rust,no_run
    /// # use ghpascon_rust::devices::rfid::x714::X714;
    /// # #[tokio::main] async fn main() {
    /// let reader = X714::default();
    /// let bg = reader.clone();
    /// tokio::spawn(async move { bg.connect().await; });
    /// # }
    /// ```
    pub async fn connect(&self) {
        self.shared.running.store(true, Ordering::Relaxed);
        match self.config.connection_type {
            ConnectionType::Serial => self.run_serial_loop().await,
            ConnectionType::Tcp => self.run_tcp_loop().await,
            ConnectionType::Ble => self.run_ble_loop().await,
        }
    }

    /// Stop all connection loops and clean up resources.
    pub async fn close(&self) {
        self.shared.running.store(false, Ordering::Relaxed);
        self.shared.is_connected.store(false, Ordering::Relaxed);
        self.shared.is_reading.store(false, Ordering::Relaxed);
        *self.shared.serial_number.lock().unwrap() = None;
        *self.shared.writer.lock().await = None;
        *self.shared.ble_write_tx.lock().await = None;
        dispatch_event(
            &self.on_event,
            &self.config.name,
            &X714Event::Connection(false),
        );
    }

    // ─── Write ────────────────────────────────────────────────────────────────

    /// Send a command string over the current transport (appends `\n`).
    /// Handles Serial/TCP (stream writer) and BLE (unbounded channel) transparently.
    /// BLE operations are serialized to avoid concurrent write conflicts.
    pub async fn write(&self, command: &str) -> Result<(), String> {
        let payload_ble = command.trim().as_bytes().to_vec();
        let frame_stream = format!("{}\n", command.trim()).into_bytes();

        // BLE path: send through the mpsc channel to the BLE write task with small delay after send.
        {
            let guard = self.shared.ble_write_tx.lock().await;
            if let Some(sender) = guard.as_ref() {
                // Throttling is handled by the 150 ms delay inside the BLE write task.
                return sender
                    .send(payload_ble)
                    .map_err(|e| format!("BLE write channel closed: {e}"));
            }
        }

        // Serial / TCP path: write directly to the async stream.
        use tokio::io::AsyncWriteExt;
        let mut guard = self.shared.writer.lock().await;
        if let Some(writer) = guard.as_mut() {
            writer
                .write_all(&frame_stream)
                .await
                .map_err(|e| format!("write error: {e}"))
        } else {
            Err("not connected".to_string())
        }
    }

    // ─── Receive / parse ──────────────────────────────────────────────────────

    /// Process one raw line received from the reader.
    /// Updates internal state and dispatches events through the registered handler.
    pub fn on_receive(&self, data: &str) {
        let events = parse_line_to_events(data);
        for event in &events {
            self.apply_event_to_state(event);
            dispatch_event(&self.on_event, &self.config.name, event);
        }
    }

    /// Process a raw chunk from stream transports (Serial/TCP) and emit complete
    /// frames as soon as they can be recognized.
    pub(crate) fn process_incoming_chunk(&self, chunk: &str, buffer: &mut String) {
        buffer.push_str(chunk);
        buffer.retain(|c| c != '\0');

        loop {
            let next_lf = buffer.find('\n');
            let next_cr = buffer.find('\r');
            let pos = match (next_lf, next_cr) {
                (Some(a), Some(b)) => a.min(b),
                (Some(a), None) => a,
                (None, Some(b)) => b,
                (None, None) => break,
            };

            if pos == 0 {
                buffer.drain(..=pos);
                continue;
            }

            let line: String = buffer.drain(..=pos).collect();
            let trimmed = line.trim_matches(|c| c == '\r' || c == '\n').trim();
            if !trimmed.is_empty() {
                self.on_receive(trimmed);
            }
        }

        // Some firmwares concatenate frames without delimiters: "#f1#f2...".
        loop {
            let Some(first_hash) = buffer.find('#') else {
                buffer.clear();
                break;
            };

            if first_hash > 0 {
                buffer.drain(..first_hash);
            }

            let rest = &buffer[1..];
            let Some(next_rel) = rest.find('#') else {
                break;
            };
            let split_at = 1 + next_rel;

            let frame = buffer[..split_at].trim();
            if !frame.is_empty() {
                self.on_receive(frame);
            }

            buffer.drain(..split_at);
        }

        // Also accept full single-frame chunks without CR/LF.
        let trimmed = buffer.trim();
        let lower = trimmed.to_lowercase();
        let looks_complete_tag = if let Some(payload) = lower.strip_prefix("#t+@") {
            let payload = payload.trim();
            let simple_hex = !payload.is_empty()
                && payload.len() >= 8
                && payload.chars().all(|c| c.is_ascii_hexdigit());
            payload.contains('|') || simple_hex
        } else {
            false
        };
        let looks_complete_meta = lower.starts_with("#read:")
            || lower.starts_with("#start_reading:")
            || lower.starts_with("#name:")
            || lower == "#setup_done"
            || lower == "#tags_cleared"
            || lower == "#pong";

        if !trimmed.is_empty() && (looks_complete_tag || looks_complete_meta) {
            self.on_receive(trimmed);
            buffer.clear();
        }
    }

    /// Same as `on_receive` but also returns the parsed events (useful for tests/examples).
    pub fn parse_line(&self, input: &str) -> Vec<X714Event> {
        let events = parse_line_to_events(input);
        for event in &events {
            self.apply_event_to_state(event);
            dispatch_event(&self.on_event, &self.config.name, event);
        }
        events
    }

    pub(crate) fn apply_event_to_state(&self, event: &X714Event) {
        match event {
            X714Event::Reading(v) => self.shared.is_reading.store(*v, Ordering::Relaxed),
            X714Event::SerialNumber(s) => {
                *self.shared.serial_number.lock().unwrap() = Some(s.clone());
            }
            _ => {}
        }
    }

    // ─── Connection hooks ─────────────────────────────────────────────────────

    /// Called by each transport loop right after a successful connection.
    /// Mirrors Python's `on_connected()`.
    pub(crate) async fn on_connected(&self) {
        self.shared.is_connected.store(true, Ordering::Relaxed);
        dispatch_event(
            &self.on_event,
            &self.config.name,
            &X714Event::Connection(true),
        );
        self.config_reader().await.ok();
        if self.config.start_reading && !self.config.gpi_start {
            self.start_inventory().await.ok();
        }
    }

    pub(crate) fn on_disconnected(&self) {
        self.shared.is_connected.store(false, Ordering::Relaxed);
        self.shared.is_reading.store(false, Ordering::Relaxed);
        *self.shared.serial_number.lock().unwrap() = None;
        dispatch_event(
            &self.on_event,
            &self.config.name,
            &X714Event::Connection(false),
        );
    }

    pub fn on_start(&self) {
        self.shared.is_reading.store(true, Ordering::Relaxed);
        dispatch_event(&self.on_event, &self.config.name, &X714Event::Reading(true));
    }

    pub fn on_stop(&self) {
        self.shared.is_reading.store(false, Ordering::Relaxed);
        dispatch_event(
            &self.on_event,
            &self.config.name,
            &X714Event::Reading(false),
        );
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use serde_json::{Number, Value};

    use super::*;

    #[test]
    fn from_map_builds_reader_and_antennas() {
        let params = HashMap::from([
            (
                "connection_type".to_string(),
                Value::String("tcp".to_string()),
            ),
            ("ip".to_string(), Value::String("10.0.0.40".to_string())),
            ("tcp_port".to_string(), Value::Number(Number::from(23))),
            (
                "active_ant".to_string(),
                Value::Array(vec![
                    Value::Number(Number::from(1)),
                    Value::Number(Number::from(3)),
                ]),
            ),
            ("read_power".to_string(), Value::Number(Number::from(25))),
        ]);

        let reader = X714::from_map(params).expect("valid map");
        assert_eq!(reader.config.connection_type, ConnectionType::Tcp);
        assert_eq!(reader.config.tcp.ip, "10.0.0.40");
        assert!(reader.config.ant_dict.get("1").expect("ant1").active);
        assert!(!reader.config.ant_dict.get("2").expect("ant2").active);
        assert!(reader.config.ant_dict.get("3").expect("ant3").active);
        assert_eq!(reader.config.ant_dict.get("4").expect("ant4").power, 25);
    }

    #[test]
    fn parse_tag_line() {
        let reader = X714::default();
        let events = reader.parse_line("#T+@E28011|E20033|2|58|LOCKED");
        assert_eq!(events.len(), 1);

        match &events[0] {
            X714Event::Tag(tag) => {
                assert_eq!(tag.epc.as_deref(), Some("e28011"));
                assert_eq!(tag.tid.as_deref(), Some("e20033"));
                assert_eq!(tag.ant, 2);
                assert_eq!(tag.rssi, -58);
                assert_eq!(tag.protected.as_deref(), Some("locked"));
            }
            _ => panic!("unexpected event"),
        }
    }

    #[test]
    fn reading_state_updated_by_parse_line() {
        let reader = X714::default();
        assert!(!reader.is_reading());
        reader.parse_line("#read:on");
        assert!(reader.is_reading());
        reader.parse_line("#read:off");
        assert!(!reader.is_reading());
    }

    #[test]
    fn serial_number_updated_by_parse_line() {
        let reader = X714::default();
        reader.parse_line("#name:X714-ABC123");
        assert_eq!(reader.serial_number().as_deref(), Some("x714-abc123"));
    }

    #[test]
    fn clone_shares_runtime_state() {
        let reader = X714::default();
        let clone = reader.clone();
        reader.parse_line("#read:on");
        assert!(clone.is_reading()); // same AtomicBool via Arc
    }

    #[test]
    fn config_commands_include_core_flags() {
        let mut reader = X714::default();
        reader.config.session = 2;
        reader.config.start_reading = true;

        let cmds = reader.config_commands();
        assert!(cmds.iter().any(|c| c == "#session:2"));
        assert!(cmds.iter().any(|c| c == "#start_reading:on"));
        assert!(cmds.iter().any(|c| c == "#setup_reader"));
    }

    #[test]
    fn process_incoming_chunk_parses_cr_delimited_frames() {
        let reader = X714::default();
        let mut buffer = String::new();

        reader.process_incoming_chunk("#read:on\r#name:X714-ABC\r", &mut buffer);

        assert!(reader.is_reading());
        assert_eq!(reader.serial_number().as_deref(), Some("x714-abc"));
        assert!(buffer.is_empty());
    }

    #[test]
    fn process_incoming_chunk_parses_concatenated_hash_frames() {
        let reader = X714::default();
        let mut buffer = String::new();

        reader.process_incoming_chunk("#read:on#read:off", &mut buffer);

        assert!(!reader.is_reading());
        assert!(buffer.is_empty());
    }
}