taptap 0.1.1

An implementation of the Tigo TAP protocol
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
use clap::{Args, Parser, Subcommand};
use log::LevelFilter;
use std::collections::btree_map::Entry;
use std::collections::BTreeMap;
use std::io::{Read, Write};
use std::process::exit;
use taptap::gateway::physical::Connection;
use taptap::gateway::{physical, Frame, GatewayID};
use taptap::pv::application::{NodeTableResponseEntry, PowerReport, TopologyReport};
use taptap::pv::network::{NodeAddress, ReceivedPacketHeader};
use taptap::pv::{LongAddress, NodeID, PacketType, SlotCounter};
use taptap::{config, gateway, pv};

#[derive(Parser, Debug, Clone)]
#[command(version, about, long_about = None)]
#[command(propagate_version = true)]
struct Cli {
    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand, Debug, Clone)]
enum Commands {
    #[cfg(feature = "serialport")]
    ListSerialPorts,

    /// Observe the system, extracting data as it runs
    Observe {
        #[command(flatten)]
        source: Source,
    },

    /// Peek at the raw data flowing at the gateway physical layer
    PeekBytes {
        #[command(flatten)]
        source: Source,
        /// Print raw binary bytes without escaping
        #[arg(long)]
        raw: bool,
    },

    /// Peek at the assembled frames at the gateway link layer
    PeekFrames {
        #[command(flatten)]
        source: Source,
    },

    /// Peek at the gateway transport and PV application layer activity
    PeekActivity {
        #[command(flatten)]
        source: Source,
    },
}

#[derive(Args, Debug, Clone)]
#[group(required = true, multiple = false)]
struct Source {
    /// The name of the serial port (try `taptap list-serial-ports`)
    #[arg(long, group = "mode", value_name = "SERIAL-PORT")]
    #[cfg(feature = "serialport")]
    serial: Option<String>,

    /// The IP or hostname which is providing serial-over-TCP service
    #[arg(long, group = "mode", value_name = "DESTINATION")]
    tcp: Option<String>,

    // If --tcp is specified, the port to which to connect
    #[arg(long, requires = "tcp", default_value_t = 7160)]
    port: u16,
}

impl Source {
    fn open(&self) -> Box<dyn physical::Connection> {
        let src = config::SourceConfig::from(self.clone());
        match src.open() {
            Ok(s) => s,
            Err(e) => {
                log::error!("error opening source: {}", e);
                exit(2);
            }
        }
    }
}

impl From<Source> for config::SourceConfig {
    fn from(value: Source) -> Self {
        #[cfg(feature = "serialport")]
        if let Some(name) = value.serial {
            return config::SerialSourceConfig { name }.into();
        }

        match (value.tcp,) {
            (Some(name),) => config::TcpConnectionConfig {
                hostname: name,
                port: value.port,
                mode: config::ConnectionMode::ReadOnly,
            }
            .into(),
            _ => {
                // clap assertions should prevent this
                panic!("a source must be specified");
            }
        }
    }
}

fn main() {
    let cli = Cli::parse();
    env_logger::Builder::new()
        .filter_level(LevelFilter::Info)
        .parse_default_env()
        .init();

    match cli.command {
        Commands::PeekBytes { source, raw } => {
            let source = source.open();
            peek_bytes(source, raw);
        }

        Commands::PeekFrames { source } => {
            let source = source.open();
            peek_frames(source);
        }

        Commands::PeekActivity { source } => {
            let source = source.open();
            peek_activity(source);
        }

        #[cfg(feature = "serialport")]
        Commands::ListSerialPorts => {
            list_serial_ports();
        }

        Commands::Observe { source } => {
            let source = source.open();
            observe(source)
        }
    }
}

fn peek_bytes(mut conn: Box<dyn physical::Connection>, raw: bool) {
    let mut buffer = [0u8; 1024];
    let mut last_was_7e = false;

    loop {
        let slice = match conn.read(&mut buffer) {
            Ok(n) => &buffer[0..n],
            Err(e) => {
                log::error!("error reading: {}", e);
                exit(1);
            }
        };

        if slice.is_empty() {
            return;
        }

        let mut out = std::io::stdout().lock();
        if raw {
            out.write_all(slice).unwrap();
        } else {
            let mut formatted = Vec::with_capacity(4 * slice.len());
            for byte in slice {
                let sep = if last_was_7e && *byte == 0x08 {
                    '\n'
                } else {
                    ' '
                };
                write!(&mut formatted, "{:02X}{}", byte, sep).unwrap();
                last_was_7e = *byte == 0x7e;
            }

            out.write_all(formatted.as_slice()).unwrap();
        }
        out.flush().unwrap();
    }
}

fn peek_frames(mut conn: Box<dyn physical::Connection>) {
    let mut buffer = [0u8; 1024];

    struct Sink;
    impl taptap::gateway::link::Sink for Sink {
        fn frame(&mut self, frame: Frame) {
            println!("{:?}", frame);
        }
    }

    let mut rx = taptap::gateway::link::Receiver::new(Sink);

    loop {
        let slice = match conn.read(&mut buffer) {
            Ok(n) => &buffer[0..n],
            Err(e) => {
                log::error!("error reading: {}", e);
                exit(1);
            }
        };

        if slice.is_empty() {
            return;
        }

        rx.extend_from_slice(slice);
    }
}

fn peek_activity(mut conn: Box<dyn physical::Connection>) {
    #[derive(Default)]
    struct Sink {
        slot_counters: BTreeMap<GatewayID, SlotCounter>,
    }
    impl gateway::transport::Sink for Sink {
        fn enumeration_started(&mut self, enumeration_gateway_id: GatewayID) {
            log::info!("enumeration started (at {:?})", enumeration_gateway_id);
        }

        fn gateway_identity_observed(&mut self, gateway_id: GatewayID, address: LongAddress) {
            log::info!(
                "gateway identity observed: {:?} = {:?}",
                gateway_id,
                address
            );
        }

        fn gateway_version_observed(&mut self, gateway_id: GatewayID, version: &str) {
            log::info!("gateway version observed: {:?} = {:?}", gateway_id, version);
        }

        fn enumeration_ended(&mut self, gateway_id: GatewayID) {
            log::info!("enumeration ended: {:?}", gateway_id);
        }

        fn gateway_slot_counter_captured(&mut self, _gateway_id: GatewayID) {}

        fn gateway_slot_counter_observed(
            &mut self,
            gateway_id: GatewayID,
            slot_counter: SlotCounter,
        ) {
            let print = match self.slot_counters.entry(gateway_id) {
                Entry::Vacant(e) => {
                    e.insert(slot_counter);
                    true
                }
                Entry::Occupied(mut e) => {
                    let last = e.get();
                    let print = last.epoch() != slot_counter.epoch()
                        || (last.0.get() & 0x3fff) / 1000 != (slot_counter.0.get() & 0x3fff) / 1000;
                    e.insert(slot_counter);
                    print
                }
            };

            if print {
                log::info!("slot counter: {:?} {:?}", gateway_id, slot_counter)
            }
        }

        fn packet_received(
            &mut self,
            gateway_id: GatewayID,
            header: &ReceivedPacketHeader,
            data: &[u8],
        ) {
            match header.packet_type {
                PacketType::STRING_RESPONSE
                | PacketType::POWER_REPORT
                | PacketType::TOPOLOGY_REPORT => return,
                _ => {}
            }
            log::info!("packet received: {:?} {:?} {:?}", gateway_id, header, data);
        }

        fn command_executed(
            &mut self,
            gateway_id: GatewayID,
            request: (PacketType, &[u8]),
            response: (PacketType, &[u8]),
        ) {
            match request.0 {
                PacketType::STRING_REQUEST => return,
                PacketType::NODE_TABLE_REQUEST => return,
                _ => {}
            }

            log::info!(
                "command executed: {:?} {:?} {:?} => {:?} {:?}",
                gateway_id,
                request.0,
                request.1,
                response.0,
                response.1
            );
        }
    }
    impl pv::application::Sink for Sink {
        fn string_request(&mut self, gateway_id: GatewayID, pv_node_id: NodeID, request: &str) {
            log::info!(
                "string request: {:?} {:?} {:?}",
                gateway_id,
                pv_node_id,
                request
            );
        }

        fn string_response(&mut self, gateway_id: GatewayID, pv_node_id: NodeID, response: &str) {
            log::info!(
                "string response: {:?} {:?} {:?}",
                gateway_id,
                pv_node_id,
                response
            );
        }

        fn node_table_page(
            &mut self,
            gateway_id: GatewayID,
            start_address: NodeAddress,
            nodes: &[NodeTableResponseEntry],
        ) {
            log::info!(
                "node table page: {:?} start {:?} {:?}",
                gateway_id,
                start_address,
                nodes
            );
        }

        fn topology_report(
            &mut self,
            gateway_id: GatewayID,
            pv_node_id: NodeID,
            topology_report: &TopologyReport,
        ) {
            log::info!(
                "topology report: {:?} {:?} {:?}",
                gateway_id,
                pv_node_id,
                topology_report
            );
        }

        fn power_report(
            &mut self,
            gateway_id: GatewayID,
            pv_node_id: NodeID,
            power_report: &PowerReport,
        ) {
            log::info!(
                "power report: {:?} {:?} {:?}",
                gateway_id,
                pv_node_id,
                power_report
            );
        }
    }

    let mut rx = gateway::link::Receiver::new(gateway::transport::Receiver::new(
        pv::application::Receiver::new(Sink::default()),
    ));

    let mut buffer = [0u8; 1024];
    loop {
        let slice = match conn.read(&mut buffer) {
            Ok(n) => &buffer[0..n],
            Err(e) => {
                log::error!("error reading: {}", e);
                exit(1);
            }
        };

        if slice.is_empty() {
            return;
        }

        rx.extend_from_slice(slice);
    }
}
#[cfg(feature = "serialport")]
fn list_serial_ports() {
    use serialport::SerialPortType;

    let mut ports = match physical::serialport::PortInfo::list() {
        Ok(ports) => ports,
        Err(e) => {
            log::error!("error listing serial ports: {}", e);
            exit(1);
        }
    };

    ports.sort_by_cached_key(|port| port.name().to_owned());

    if ports.is_empty() {
        println!("No serial ports detected.")
    } else {
        println!("Detected:");
    }

    for port in ports {
        println!("    --serial {}", port.name());
        match port.port_type() {
            SerialPortType::UsbPort(usb) if usb.manufacturer.is_some() && usb.product.is_some() => {
                println!(
                    "      USB {:04x}:{:04x} ({} {})",
                    usb.pid,
                    usb.vid,
                    usb.manufacturer.as_ref().unwrap(),
                    usb.product.as_ref().unwrap()
                );
            }
            SerialPortType::UsbPort(usb) => {
                println!("      USB {:04x}:{:04x}", usb.pid, usb.vid);
            }
            SerialPortType::BluetoothPort => {
                println!("      Bluetooth");
            }
            _ => {}
        }
    }
}

fn observe(mut conn: Box<dyn Connection>) {
    let observer = taptap::observer::Observer::default();
    let mut rx = gateway::link::Receiver::new(gateway::transport::Receiver::new(
        pv::application::Receiver::new(observer),
    ));

    let mut buffer = [0u8; 1024];
    loop {
        let slice = match conn.read(&mut buffer) {
            Ok(n) => &buffer[0..n],
            Err(e) => {
                log::error!("error reading: {}", e);
                exit(1);
            }
        };

        if slice.is_empty() {
            return;
        }

        rx.extend_from_slice(slice);
    }
}