Ben Bass  committed bea32e8

update version to 0.10.3, various doc updates

  • Participants
  • Parent commits 927fe8f
  • Branches default

Comments (0)

Files changed (7)

 pylibftdi changes
+ * lots more documentation, cleaned up, on readthedocs. Still in progress though.
+ * Experimental support for multi-device interfaces ``Device(interface=1)``
  * include examples subpackage
  * ensure examples work under Python3
 # built documents.
 # The short X.Y version.
-version = '0.10.2'
+version = '0.10.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.10.2'
+release = '0.10.3'
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

File doc/introduction.rst

- - Currently only one port per device is used; I've not tested with dual
-   port devices yet.
  - The API might change prior to reaching a 1.0 release.

File doc/quickstart.rst

 Though hopefully with a different serial number, or else you've either
 stolen mine, or you are me...
-Test some actual IO (well, at least O)
+Test some actual IO
+Output example
 Connect an LED between D0 of your bit-bang capable device and ground, via a
 330 - 1K ohm resistor as appropriate.
     $ python -m pylibftdi.examples.led_flash
 The LED should now flash at approximately 1Hz.
+Input example
+To test some input, remove any connections from the port lines initially,
+then run the following, which reads and prints the status of the input lines
+    $ python -m pylibftdi.examples.pin_read
+The ``pin_read`` example is a complete command line application which can
+be used to monitor for particular values on the attached device pins, and
+output an appropriate error code on match. Repeat the above with a trailing
+``--help`` for info.

File pylibftdi/

 rather than a problem with the libftdi library.
-__VERSION__ = "0.10.2"
+__VERSION__ = "0.10.3"
 __AUTHOR__ = "Ben Bass"
-    version="0.10.2",
+    version="0.10.3",
     description="Pythonic interface to FTDI devices using libftdi",
     author="Ben Bass",