README

   1 This package provides Python control of stepper motors.  See Jones'
   2 `Control of Stepping Motors`_ for an excellent stepper overview.
   3 Supports full and half stepping of motors with one or two power lines
   4 and 4 drains, or one or two drains and 4 power lines.  Basically any
   5 motor with 4 variable lines, and it would be easy to extend it to
   6 other cases.
   7
   8
   9 Installation
  10 ============
  11
  12 Packages
  13 --------
  14
  15 Gentoo
  16 ~~~~~~
  17
  18 I've packaged stepper for Gentoo.  You need layman_ and my `wtk
  19 overlay`_.  Install with::
  20
  21     # emerge -av app-portage/layman
  22     # layman --add wtk
  23     # emerge -av sci-libs/stepper
  24
  25
  26 Dependencies
  27 ------------
  28
  29 Stepper has no explicit dependencies outside of the core Python
  30 modules, but for real-world results you will need a way to drive the
  31 stepper's digital control lines.  A general way to do this is with the
  32 pycomedi wrapper around the Comedilib_ library, as shown in the
  33 Stepper doctest.
  34
  35 You will also need nose for testing.
  36
  37 ===========  =================  =====================
  38 Package      Debian_            Gentoo_
  39 ===========  =================  =====================
  40 Nose_        python-nose        dev-python/nose
  41 Pycomedi_                       dev-python/pycomedi
  42 ===========  =================  =====================
  43
  44
  45 Installing by hand
  46 ------------------
  47
  48 Stepper is available as a Git_ repository::
  49
  50     $ git clone git://tremily.us/stepper.git
  51
  52 See the homepage_ for details.  To install the checkout, run the
  53 standard::
  54
  55     $ python setup.py install
  56
  57
  58 Usage
  59 =====
  60
  61 See the module docstrings for simple examples.
  62
  63
  64 Testing
  65 =======
  66
  67 Run internal unit tests with::
  68
  69     $ nosetests --with-doctest --doctest-tests stepper.py
  70
  71
  72 Licence
  73 =======
  74
  75 This project is distributed under the `GNU General Public License
  76 Version 3`_ or greater.
  77
  78
  79 Author
  80 ======
  81
  82 W. Trevor King
  83 wking@tremily.us
  84 Copyright 2008-2012
  85
  86
  87 .. _Control of Stepping Motors: http://www.cs.uiowa.edu/~jones/step/
  88 .. _layman: http://layman.sourceforge.net/
  89 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  90 .. _Debian: http://www.debian.org/
  91 .. _Gentoo: http://www.gentoo.org/
  92 .. _Comedilib: http://www.comedi.org/
  93 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
  94 .. _Pycomedi: http://blog.tremily.us/posts/pycomedi/
  95 .. _Git: http://git-scm.com/
  96 .. _homepage: http://blog.tremily.us/posts/stepper/
  97 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt