Commits

bjoern committed 4b6701a

added readme, license info

  • Participants
  • Parent commits 0fb8fa5

Comments (0)

Files changed (3)

+For ept-uploadr, see ept-uploadr/COPYRIGHT (GNU GPL2).
+
+For shell scripts and other files in top-level directory:
+Copyright (c) 2010, Regents of the University of California
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the University of California, Berkeley nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OVERVIEW
+========
+whiteboard-cam is a whiteboard capture system written as a set of bash shell scripts. The system takes a picture from an attached Canon still camera; corrects barrel-distortion, performs perspective transformation and contrast maximization; then uploads the image to a flickr account.
 
-1) plug in camera, power up
-2) run ./config.sh once (needs to be run once after each plug-in of camera before capturing)
-3) run ./capture.sh to capture and upload one new image
+whiteboard-cam glues together the following packages:
+gphoto2     - http://www.gphoto.org/
+ImageMagick - http://www.imagemagick.org/
+uploadr.py  - http://github.com/ept/uploadr.py (inlcuded)
 
-Script written for Canon SX100IS
-Relies on macports:
-* gphoto2 @2.4.5_0  (sudo port install gphoto2), 
+SETUP INSTRUCTIONS
+===================
+0) Configure flickr upload once (see below)
+
+1) plug in Canon camera via USB, power up
+
+2) run ./config.sh once.
+   This needs to be run once after each plug-in of the camera
+
+3) run ./capture.sh to capture and upload one new image.
+
+FLICKR SETUP
+============
+1) You will need a flickr API key and Secret for your account:
+http://www.flickr.com/services/apps/create/apply
+
+2) Create a file ./secret.sh of the following form:
+#!/bin/bash
+export FLICKR_UPLOADR_PY_API_KEY=...
+export FLICKR_UPLOADR_PY_SECRET=...
+
+3) Make the file executable (chmod u+x secret.sh)
+
+4) Create subdirectory ./images
+
+5) Then execute ./ept-uploadr/uploadr/uploadr.py to generate and save an authentication token
+
+DEPENDENCIES / TESTED CONFIGURATION
+===================================
+Written for Mac OS X (tested on 10.6), Canon SX100IS
+Tested with the following macports:
+* gphoto2 @2.4.5_0 
 * ImageMagick @6.6.1-5_0+no_x11+perl+q16 
-
-And http://github.com/ept/uploadr.py
 y3=1282
 x4=1976
 y4=337
-convert raw.jpg -matte -virtual-pixel black -distort Barrel "0.0 -0.01 0.0 1.01" -distort Perspective "$x1,$y1 0,0  $x2,$y2 0,1000   $x3,$y3 2000,1000   $x4,$y4 2000,0" -crop 2000x1000+0+0 -contrast-stretch 2%x80% images/whiteboard-${dat}.jpg
+convert raw.jpg -matte -virtual-pixel black -distort Barrel "0.0 -0.01 0.0 1.01" -distort Perspective "$x1,$y1 0,0  $x2,$y2 0,1000   $x3,$y3 2000,1000   $x4,$y4 2000,0" -crop 2000x1000+0+0 -contrast-stretch 2%x90% images/whiteboard-${dat}.jpg
 
 echo "(3) Delete raw file now that we're done with it"
 rm -f raw.jpg