README

h1. Pic USB Servo Controller

Control a servo (Mystery S0009) by a PIC18F13K50 via USB.

The USB firmware (https://github.com/holgero/PicUsbFirmware) is used as a
git submodule in this project.

h2. Project Setup

Clone the sources and initialize the submodule:
$ git clone git://github.com/holgero/PicUsbServo.git
$ cd PicUsbServo
$ git submodule init
$ git submodule update

h2. Building

To build: Run make in the top level directory like this:
$ make

Needs to compile: make, gcc++, javac, maven, gputils
Needs at runtime: java, libusb-1.0 (on Linux), WinUSB driver (on Windows)

You will find the firmware under device/PicUsbServo.hex, flash
your PIC with it. (See https://github.com/holgero/PicUsbBootloader).

h2. Contents

Directories:
firmware		git submodule contains the USB firmware
device			main routine and USB descriptor for this device
java/servo		java host program (tested on Linux)

See also the file CREDITS.

Branches:
master:		main branch, uses PIC18F13K50

h2. Binaries Download and CI Build

A CI build of this project runs at CloudBees: https://xfd.ci.cloudbees.com/

You can download the latest snapshot build results from there.

h2. License

    Copyright (C) 2013  Holger Oehm

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.