https://github.com/nanoframework/system.device.usbclient
https://github.com/nanoframework/system.device.usbclient
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nanoframework/system.device.usbclient
- Owner: nanoframework
- License: mit
- Created: 2022-10-03T20:47:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T00:31:45.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:06:18.094Z (about 1 year ago)
- Language: C#
- Size: 75.2 KB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.UsbClient) [](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.UsbClient) [](https://www.nuget.org/packages/nanoFramework.System.Device.UsbStream/) [](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [](https://discord.gg/gCyBu8T)
-----
# Welcome to the .NET **nanoFramework** USB Client repository
## Build status
| Component | Build Status | NuGet Package |
|:-|---|---|
| System.Device.UsbStream | [](https://dev.azure.com/nanoframework/System.Device.UsbClient/_build/latest?definitionId=99&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.System.Device.UsbStream/) |
## Usage
### USB Stream
`UsbStream` class provides a seamless interface to a stream that can read from and write to an USB Device that's enumerated as a WinUSB device.
This allows shipping your .NET nanoFramework device as an USB device without the need for any INF file or specific driver instalation.
#### Creating an UsbStream
Creating an `UsbStream` requries 2 parameters: a `Guid` that will be used as the Device Interface ID and a `string` which will be used as the device description for the USB device.
```csharp
private static Guid deviceInterfaceId = new Guid("9e48651c-fa68-4b39-8731-1ee84659aac5");
private static string deviceDescription = "nanoDevice";
// create USB Stream
var usbStream = UsbClient.CreateUsbStream(deviceInterfaceId, deviceDescription);
```
#### Writing to the `UsbStream`
To write to the `UsbStream` just call the `Write()` method just like any other .NET stream. Like this:
```csharp
// buffer with dummy data
var bufer = new byte[] { 1, 2, 3 };
usbStream.Write(bufer, 0, bufer.Length);
```
## Debug hints
USB can be hard. Be prepared for that!
There are a number of issues that are prone to cause frustration. Follows some (hopefully valuable) advice.
* If you need to debug device enumeration issues and check what's being passed from the devices, install a tool such as [USB Device Tree Viewer](https://www.uwe-sieber.de/usbtreeview_e.html) from Uwe Sieber. With it you can peruse into every bit of detail about USB device, their interfaces, end points, strings, etc.
* Another great tool is [USBDeview](https://www.nirsoft.net/utils/usb_devices_view.html) from NirSoft. This tool lists all USB devices that currently connected to your computer, as well as all USB devices that you previously used. Extended information is displayed for each USB device. It's possible to uninstall/disable and enable USB devices from the tool.
* Windows caches enumeration of USB devices. What's the problem with that? During development, if the enumeration fails at some point, the device most likely will be marked as being enumerated and on the next connection Windows won't do it again. This can cause the enumeration data to be wrong or incomplete. To fix this and truly force the enumeration to happen from scratch, make sure that:
1. Delete the device from the Device Manager.
1. Delete the entry from the enumeration cache in Registry. This lives at `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\usbflags\vvvvpppprrrr`
Where `vvvv` is the vendor id, `pppp` is the PID and `rrrr` is the device release number.
## Feedback and documentation
For documentation, providing feedback, issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).
Join our Discord community [here](https://discord.gg/gCyBu8T).
## Credits
The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md).
## License
The **nanoFramework** Class Libraries are licensed under the [MIT license](LICENSE.md).
## Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
## .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).