hid-cli 0.1.0

Simple CLI for reading and writing to HID reports
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



pub use hidapi::{HidApi, HidDevice};

use structopt::StructOpt;

#[derive(Clone, PartialEq, Debug, StructOpt)]
#[structopt(name = "hidpal", about = "USB HID device helper")]
pub struct Filter {
    #[structopt(long, default_value="1209", parse(try_from_str=u16_parse_hex), env="USB_VID")]
    /// USB Device Vendor ID (VID) in hex
    pub vid: u16,

    #[structopt(long, default_value="fff0", parse(try_from_str=u16_parse_hex), env="USB_PID")]
    /// USB Device Product ID (PID) in hex
    pub pid: u16,

    #[structopt(long, env = "USB_SERIAL")]
    /// USB Device Serial
    pub serial: Option<String>,
}


pub fn u16_parse_hex(s: &str) -> Result<u16, std::num::ParseIntError> {
    u16::from_str_radix(s, 16)
}

pub fn u8_parse_hex(s: &str) -> Result<u8, std::num::ParseIntError> {
    u8::from_str_radix(s, 16)
}

#[derive(Clone, PartialEq, Debug)]
pub struct Info {
    manufacturer: Option<String>,
    product: Option<String>,
    serial: Option<String>,
}

pub trait Device {
    fn connect(vid: u16, pid: u16, serial: Option<&str>) -> Result<Self, anyhow::Error> where Self: Sized;
    fn info(&mut self) -> Result<Info, anyhow::Error>;
}

impl Device for HidDevice {
    /// Connect to an HID device using vid/pid(/serial)
    fn connect(vid: u16, pid: u16, serial: Option<&str>) -> Result<Self, anyhow::Error> {
        // Create new HID API instance
        let api = HidApi::new()?;

        // Attempt to connect to device
        let hid_device = match &serial {
            Some(s) => api.open_serial(vid, pid, s),
            None => api.open(vid, pid),
        }?;

        Ok(hid_device)
    }

    /// Fetch information for the connected device
    fn info(&mut self) -> Result<Info, anyhow::Error> {
        let manufacturer = self.get_manufacturer_string()?;
        let product = self.get_product_string()?;
        let serial = self.get_serial_number_string()?;

        Ok(Info{ manufacturer, product, serial })
    }
}