@huddly/device-api-usb/README.md

Huddly SDK device api which uses node-usb wrapper responsible for handling the transport layer of the communication and discovering the physical device/camera

<p>
  <a href="https://travis-ci.com/Huddly/device-api-usb"><img src="https://travis-ci.com/Huddly/device-api-usb.svg?branch=master" alt="Build Status"></a>
  <a href="https://www.npmjs.com/package/@huddly/device-api-usb"><img src="https://badge.fury.io/js/%40huddly%2Fdevice-api-usb.svg" alt="npm badge"></a>
  <a href="https://img.shields.io/david/Huddly/device-api-usb"><img src="https://img.shields.io/david/Huddly/device-api-usb.svg" alt="npm dependencies"></a>
  <a href="https://img.shields.io/david/dev/Huddly/device-api-usb"><img src="https://img.shields.io/david/dev/Huddly/device-api-usb.svg" alt="npm devDependencies"></a>
  <a href="https://npmcharts.com/compare/@huddly/device-api-usb?minimal=true"><img src="https://img.shields.io/npm/dm/@huddly/device-api-usb.svg?style=flat" alt="NPM Downloads"></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
  <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen badge"></a>
</p>

# Huddly SDK - Device Api USB


## Development

First clone the repo.

Then you need to init and update the submodules
```
  git submodule init
  git submodule update
```

Setup dependcies
```
npm i
```


## Windows
Then you need to make sure you have build tools for windows


# Huddly SDK - Device Api USB

### Development setup
If you want to local development together with the @huddly/sdk here is the recommend setup

- Checkout Device Api USB repo and the sdk repo
- run npm install in both repos, use the same node version recommend v10.12
- Go into the Device Api USB repo, run ```npm link``` this will create a symlink to this repo in the npm cache
- Then start the typescript compiler watcher ```npm run watch-ts```
- Open a new tab
- Go to the SDK repo folder, run ```npm link @huddly/device-api-usb```.
- Start the typescript watcher ```npm run watch-ts```

Now you can change things in the sdk and the Device Api USB folder and your changes will be reflected in the compiled code in the sdk.


## Licence
[MIT](LICENCE)
Note that the compiled Node extension includes Libusb, and is thus subject to the LGPL.