X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=4638b7728a557ede6b0863599a50e5248dd1e490;hb=662d41cab204fc90a6789358ca3adb0a1f2bd4d8;hp=66127e44b879342e838761ab3cdfb1c02df8b438;hpb=e0716ab3f9765422616c13487d29ca6d6fe4167a;p=usb-relay-hid.git diff --git a/README.md b/README.md index 66127e4..4638b77 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,43 @@ usb-relay-hid ============= -The goal of this project is to provide open-source API for Chinese low-cost USB HID relays -(search on eBay for "5V USB Relay Programmable Computer Control For Smart Home"). - ![](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. -Unfortunatey, the vendors currently offer only API library for Windows, and only in binary form. +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. + -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, however, contains only the host side software. License ------- -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 software free; free even from restrictions associated with the GPL. 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. +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 find any copyright information in the software package offered by the eBay sellers. No source code was reused from this package, besides of the C API declaration (the .h file). +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) and Windows. +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.9. Tested on RH and Ubuntu. +- 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). -To do: -------- - * Reconstruct the API library, which will be binary compatible with the original software package. - * Move the Linux variant to modern libusb (1.x) - * Make bindings for Python and Java - * Maybe, reconstruct the GUI utility