[usb-relay-hid.git] / README.md

usb-relay-hid
=============

![](http://vusb.wdfiles.com/local--files/project:driver-less-usb-relays-hid-interface/relay2.jpg)

The goal of this little project is to provide open-source API for low-cost USB HID relays 
(search on eBay for "5V USB Relay Programmable Computer Control For Smart Home").

The big advantage of HID-based interface is that no kernel drivers and no simulated COM-ports are needed. It is easy to detect and address the connected devices.

The vendors currently offer only an API library for Windows, and only in binary form.

We are not associated with the manufacturer(s) of these devices or author(s) of the original software offered by eBay sellers.
Our intent is to make this device work on Linux, 64-bit Windows and other platforms where we need it.

The main project web page is on the [V-USB wiki](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface "driver-less-usb-relays-hid-interface"). This is because the firmware of the device is based on [V-USB](http://www.obdev.at/products/vusb/index.html). V-USB enables amazingly simple and low-cost USB hardware solutions. This repository contains only the host side software.


License
-------

Currently we reuse some code from other V-USB projects, which is dual-licensed: GPL + commercial. Until we remove this code, we cannot set any other license. 

We could not locate any copyright information in the software package offered by the eBay sellers. No source code was reused from that package, besides of the C API header (the .h file).

Current state
-------------

A simple command-line utility for Linux (x86 or x64), Apple OS X and Windows.
This is enough for our own usage.

- Windows version builds with VC++ and WDK 7.1.
- Linux version builds with gcc and libusb v. 0.1. Tested on RH and Ubuntu.
- OS-X 10.9+ version builds with Xcode and plain IOKit libraries. 


TO-DOs, bugs and more
----------------------

This is in the wiki and issues in the [Github project](http://git.io/bGcxrQ).
Commit	Line	Data
3fef637d P	1	usb-relay-hid
	2	=============
	3
e0716ab3	4	![](http://vusb.wdfiles.com/local--files/project:driver-less-usb-relays-hid-interface/relay2.jpg)
e0716ab3	5
a73939ba	6	The goal of this little project is to provide open-source API for low-cost USB HID relays
	7	(search on eBay for "5V USB Relay Programmable Computer Control For Smart Home").
	8
e0716ab3	9	The big advantage of HID-based interface is that no kernel drivers and no simulated COM-ports are needed. It is easy to detect and address the connected devices.
e0716ab3	10
e399c19b	11	The vendors currently offer only an API library for Windows, and only in binary form.
e0716ab3	12
a73939ba	13	We are not associated with the manufacturer(s) of these devices or author(s) of the original software offered by eBay sellers.
728ea86e	14	Our intent is to make this device work on Linux, 64-bit Windows and other platforms where we need it.
a73939ba	15
728ea86e	16	The main project web page is on the [V-USB wiki](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface "driver-less-usb-relays-hid-interface"). This is because the firmware of the device is based on [V-USB](http://www.obdev.at/products/vusb/index.html). V-USB enables amazingly simple and low-cost USB hardware solutions. This repository contains only the host side software.
e0716ab3	17
a73939ba	18
a73939ba	19
e0716ab3	20	License
	21	-------
	22
a73939ba	23	Currently we reuse some code from other V-USB projects, which is dual-licensed: GPL + commercial. Until we remove this code, we cannot set any other license.
e0716ab3	24
b43921bb	25	We could not locate any copyright information in the software package offered by the eBay sellers. No source code was reused from that package, besides of the C API header (the .h file).
e0716ab3	26
	27	Current state
	28	-------------
	29
728ea86e	30	A simple command-line utility for Linux (x86 or x64), Apple OS X and Windows.
e0716ab3	31	This is enough for our own usage.
e0716ab3	32
a73939ba	33	- Windows version builds with VC++ and WDK 7.1.
b43921bb	34	- Linux version builds with gcc and libusb v. 0.1. Tested on RH and Ubuntu.
728ea86e	35	- OS-X 10.9+ version builds with Xcode and plain IOKit libraries.
e0716ab3	36
e0716ab3	37
728ea86e	38	TO-DOs, bugs and more
728ea86e	39	----------------------
b43921bb	40
728ea86e	41	This is in the wiki and issues in the [Github project](http://git.io/bGcxrQ).
b43921bb	42
b43921bb	43