mirror of
https://github.com/G2-Games/cross-usb.git
synced 2025-04-19 05:12:53 -05:00
Update README.md
This commit is contained in:
parent
9790653260
commit
ff2d6f89da
1 changed files with 36 additions and 0 deletions
36
README.md
36
README.md
|
@ -25,6 +25,42 @@ For native USB, the crate utilizies [nusb](https://github.com/kevinmehall/nusb),
|
|||
|
||||
For WASM, this crate utilizes [web-sys](https://crates.io/crates/web-sys) which gives access to browser API calls, and in this case is used to interact with [WebUSB](https://developer.mozilla.org/en-US/docs/Web/API/WebUSB_API)
|
||||
|
||||
## Example
|
||||
To learn about how USB communciations work, check out [USB in a NutShell](https://www.beyondlogic.org/usbnutshell/usb1.shtml).
|
||||
|
||||
```rust
|
||||
use cross_usb::prelude::*;
|
||||
use cross_usb::usb::{Recipient, ControlType, ControlIn};
|
||||
use cross_usb::device_filter;
|
||||
|
||||
// Obtain a device descriptor using a DeviceFilter,
|
||||
// in this case with its VendorID and ProductID
|
||||
let filters = vec![
|
||||
device_filter!{vendor_id: 0x054c, product_id: 0x00c9}
|
||||
];
|
||||
let dev_descriptor = cross_usb::get_device(filters).await.expect("Failed to find device");
|
||||
|
||||
// Open the device that the descriptor is describing
|
||||
let dev = dev_descriptor.open().await.expect("Failed to open device");
|
||||
|
||||
// Obtain an interface of the device
|
||||
let interface = dev.open_interface(0).await.expect("Failed to open interface");
|
||||
|
||||
// Send a Control transfer to the device, obtaining
|
||||
// the result and storing it in `result`
|
||||
let result = interface.control_in(ControlIn {
|
||||
control_type: ControlType::Vendor,
|
||||
recipient: Recipient::Interface,
|
||||
request: 0x01,
|
||||
value: 0,
|
||||
index: 0,
|
||||
length: 4,
|
||||
})
|
||||
.await
|
||||
.expect("Sending control transfer failed");
|
||||
```
|
||||
Check out the [documentation](https://docs.rs/cross_usb/latest/) as well!
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Add choice for native backend between `libusb` wrapper and pure rust `nusb`
|
||||
|
|
Loading…
Reference in a new issue