From daf626b65e9cb59c646d90129db2193e8438ce44 Mon Sep 17 00:00:00 2001 From: Rik Veenboer Date: Mon, 27 Oct 2014 21:55:40 +0000 Subject: [PATCH] Added project description from http://www.jraf.org/static/maven/sites/jlibibuddy/ --- LICENSE.md | 34 +++++++++++++++++++++++++ MAVEN.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 174 insertions(+) create mode 100644 LICENSE.md create mode 100644 MAVEN.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..deedbfa --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,34 @@ +# Project License # + +## Public domain ## + + This work is released to the Public Domain. + + http://creativecommons.org/licenses/publicdomain/ + + The person or persons who have associated work with this document (the + "Dedicator" or "Certifier") hereby either (a) certifies that, to the best of + his knowledge, the work of authorship identified is in the public domain of + the country from which the work is published, or (b) hereby dedicates + whatever copyright the dedicators holds in the work of authorship identified + below (the "Work") to the public domain. A certifier, moreover, dedicates any + copyright interest he may have in the associated work, and for these + purposes, is described as a "dedicator" below. + + A certifier has taken reasonable steps to verify the copyright status of this + work. Certifier recognizes that his good faith efforts may not shield him + from liability if in fact the work certified is not in the public domain. + + Dedicator makes this dedication for the benefit of the public at large and to + the detriment of the Dedicator's heirs and successors. Dedicator intends this + dedication to be an overt act of relinquishment in perpetuity of all present + and future rights under copyright law, whether vested or contingent, in the + Work. Dedicator understands that such relinquishment of all rights includes + the relinquishment of all rights to enforce (by lawsuit or otherwise) those + copyrights in the Work. + + Dedicator recognizes that, once placed in the public domain, the Work may be + freely reproduced, distributed, transmitted, used, modified, built upon, or + otherwise exploited by anyone for any purpose, commercial or non-commercial, + and in any way, including by methods that have not yet been invented or + conceived. \ No newline at end of file diff --git a/MAVEN.md b/MAVEN.md new file mode 100644 index 0000000..30bf046 --- /dev/null +++ b/MAVEN.md @@ -0,0 +1,65 @@ +## To use JLibIBuddy in your project + ## + + +## Libusb-win32 installation ## + +First of all you need to install libusb-win32. Follow the instructions there: [http://libusb-win32.sourceforge.net/#installation](http://libusb-win32.sourceforge.net/#installation). + +### If you don't use maven 2 ### + +- download and and extract jlibibuddy-1.1-dist.zip +- add jlibibuddy-1.1.jar and lib/*.jar to your project classpath +- copy lib/libusbjava-native-win32-0.2.3.0.dll to C:\Windows\System32 and rename it to LibusbJava.dll (it must have this name otherwise it won't work). + +##If you use maven 2 + + +- add the repository (where to find JLibIBuddy) to your pom: + + + JRAF.org + JRAF.org Maven Repository + http://www.JRAF.org/static/maven/2 + default + + + + +- add the dependency to JLibIBuddy to your pom: + + + org.jraf + jlibibuddy + 1.1 + compile + +- add this plugin to your pom: + + + org.apache.maven.plugins + maven-dependency-plugin + + + install-libusbjava-dll + install + + copy + + + + + libusbjava + libusbjava-native-win32 + 0.2.3.0 + dll + + + c:\windows\system32\ + LibusbJava2.dll + + + + + +This will copy the dll to the proper place when you invoke the install goal. Sorry I don't know if there is a way to do that in JLibIBuddy's pom directly so for now you have to do it in your own pom. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6fad005 --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ + +Fork of [http://www.jraf.org/static/maven/sites/jlibibuddy/](http://www.jraf.org/static/maven/sites/jlibibuddy/). + +---------- + +# JLibIBuddy # + +A Java library to control an i-Buddy (a 3-inch tall blinking and moving USB figureine, see http://www.i-buddy.com/ ). Currently it is only supported / tested under Windows. + +[I-BuddyShop](http://www.i-buddyshop.com/) + +In [.NET](http://ibuddylib.sourceforge.net/) or [python](https://code.google.com/p/pybuddy/) + +[JLibIBuddy](http://www.jraf.org/static/maven/sites/jlibibuddy/) + +Needs [Java libusb / libusb-win32](http://libusbjava.sourceforge.net/wp/?page_id=9) + +[Benoit Lubek](https://github.com/BoD "BoD") + + +Original maven repo http://www.jraf.org/static/maven/2/org/jraf/jlibibuddy/ + +We need to create backup archives for artifacts **org.jraf:jlibibuddy:1.1** ([see](http://libusbjava.sourceforge.net/wp/) and the [sourceforge](http://sourceforge.net/projects/libusbjava/)) and **libusbjava:libusbjava-native-win32:0.2.3.0** which are hosted on a [private maven repository](http://www.JRAF.org/static/maven/2). The Libusbjava code have been forked: + +- [https://github.com/Boukefalos/libusbjava.cpp](https://github.com/Boukefalos/libusbjava.cpp) +- [https://github.com/Boukefalos/libusbjava.java](https://github.com/Boukefalos/libusbjava.java) + + +tedious to get libusb working while porting to linux, use other project instead: + +- [https://github.com/tietomaakari/ibuddy-lkm](https://github.com/tietomaakari/ibuddy-lkm) + +still this git fork should once be done + +and we have te maven artifact in gradle + + +## Installation ## + +For linux, use [libusb](http://sourceforge.net/projects/libusb/)? + + + +## Usage ## + +Using the library is very simple as shown by this example: + + import org.jraf.jlibibuddy.IBuddy; + import org.jraf.jlibibuddy.IBuddyException; + import org.jraf.jlibibuddy.IBuddyUtils; + + + (...) + + + // get the i-Buddy + IBuddy iBuddy = IBuddy.getIBuddy(); + + // send some low level commands directly + iBuddy.sendHeadColor(IBuddy.Color.RED); + iBuddy.sendHeart(true); + + // use IBuddyUtils to send higher levels commands + IBuddyUtils.flap(iBuddy, 400, 7); + + + (...) + +## Credits ## + +Most of the USB code was done following the code posted by "Tom" at [http://cuntography.com/blog/?p=17](http://cuntography.com/blog/?p=17). (dead) + +## Contact ## +Contact the author: [BoD@JRAF.org](mailto:BoD@JRAF.org) . +