Bump to version 0.9

Changes since 0.8:
* Use generators, now that Cython supports them
* Don't use: from pycomedi cimport module as _module
* Use relative imports (or absolute imports for cimport)

These changes fix a:

  pycomedi ImportError: No module named chanspec

error reported by Lukas <dwisuu@gmail.com> [1].

[1]: id:51e4fc1f-b367-4a69-a59b-39adf383a961@googlegroups.com
     https://groups.google.com/forum/#!topic/comedi_list/5qo3u_Qjx2Q

Merge branch 'remove-implicit-relative-imports'

This fixes a:

  pycomedi ImportError: No module named chanspec

error reported by Lukas <dwisuu@gmail.com> [1].

[1]: id:51e4fc1f-b367-4a69-a59b-39adf383a961@googlegroups.com
     https://groups.google.com/forum/#!topic/comedi_list/5qo3u_Qjx2Q

* remove-implicit-relative-imports:
  Use generators, now that Cython supports them
  Don't use: from pycomedi cimport module as _module
  Use relative imports (or absolute imports for cimport)

Bump to version 0.8

This adds compatibility with comedilib 0.10.2 (2014-04-10).

Changes since 0.7:
* constant: Avoid non-integer values in _Enum
* constant: Use dir(comedi.wrapped) when comedi.wrapped exists
* MANIFEST.in: Distribute test.sh and the doc directory

constant: Avoid non-integer values in _Enum

When my lowercase names collide (e.g. for COMEDI_TO_PHYSICAL and
comedi_to_physical), we want to add the integer value to the enum, not
the function value.  This avoids:

  >>> from pycomedi.device import Device
  Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
    File "instruction.pxd", line 22, in init pycomedi.device (pycomedi/device.c:4532)
    File "instruction.pyx", line 25, in init pycomedi.instruction (pycomedi/instruction.c:2427)
    File "chanspec.pyx", line 20, in init pycomedi.chanspec (pycomedi/chanspec.c:2571)
    File "constant.pyx", line 469, in init pycomedi.constant (pycomedi/constant.c:10017)
    File "constant.pyx", line 244, in pycomedi.constant._Enum.__init__ (pycomedi/constant.c:3804)
    File "constant.pyx", line 260, in pycomedi.constant._Enum._add_item (pycomedi/constant.c:4305)
  TypeError: unorderable types: builtin_function_or_method() < int()

I'm not sure how I haven't bumped into this before.  Perhaps Cython
0.19.1 has stronger type-checking for its comparison operaters than my
old 0.17.4.

constant: Use dir(comedi.wrapped) when comedi.wrapped exists

Since 371dcc5 (swig: remove comedi_ prefix from the function names,
2014-01-31, released in comedilib 0.10.2), dir(comedi) no longer lists
the meaty-bits:

  >>> import comedi
  >>> comedi.CR_ALT_FILTER
  67108864
  >>> [attr for attr in dir(comedi) if attr.startswith('CR_')]

Instead, they have shifted to comedi.wrapped:

  >>> [attr for attr in dir(comedi.wrapped) if attr.startswith('CR_')]
  ['CR_ALT_FILTER', 'CR_ALT_SOURCE', 'CR_DEGLITCH', 'CR_DITHER', 'CR_EDGE',
   'CR_FLAGS_MASK', 'CR_INVERT']

This commit adjusts pycomedi to use comedi.wrapped when it exists, so
pycomedi will work with the new comedilib (and continue working with
the old comedilibs).

I also have to remove 'COMEDI_' from the prefixes that contain it to
catch up with 371dcc5:

  +%rename("%(strip:[COMEDI_])s", regextarget=1) "COMEDI_.*";

Reported-by: Colin Jermain <clj72@cornell.edu>

Use generators, now that Cython supports them

The Cython 0.15 release notes (2011-08-05) claim support for
generators [1].

[1]: http://wiki.cython.org/ReleaseNotes-0.15

Don't use: from pycomedi cimport module as _module

Stick with:

  from pycomedi.module import Class as _Class

to avoid things like:

  pycomedi/subdevice.pxd:24:5: '_subdevice_holder.pxd' not found

which is probably a bug in my Cython 0.16.

Use relative imports (or absolute imports for cimport)

The relative-import ticket is still open [1], but the Cython 0.15
release notes (2011-08-05) claim support for relative imports [2].
Relative cimports are not supported yet [3], but I've fixed them up to
use the full absolute import path.

[1]: http://trac.cython.org/cython_trac/ticket/542
[2]: http://wiki.cython.org/ReleaseNotes-0.15
[3]: http://thread.gmane.org/gmane.comp.python.cython.devel/14406

MANIFEST.in: Distribute test.sh

Like the docs, this script is useful to have in the distributed
tarball, even if it's not installed by setup.py.

Reported-by: Nuno Rombert Pinhão <npinhao@ctn.ist.utl.pt>

MANIFEST.in: Distribute the doc directory (but don't install it)

Put the docs in the distribution tarball, so folks don't need to
checkout the Git repository just to read the docs.

Reported-by: Nuno Rombert Pinhão <npinhao@ctn.ist.utl.pt>

Bump to version 0.7

Changes since 0.6:
* MANIFEST.in: Distribute *.pxd files
* channel: Fix to-physical setup in AnalogChannel._get_converter
* A few documentation fixes and updates

MANIFEST.in: Distribute *.pxd files

On Wed, Feb 06, 2013 at 07:35:31PM -0200, Mauricio de Alencar wrote:
> The package at pypi is incomplete (see below). I got the source from
> git and it builds OK.

README: Double-backtick code for proper ReST markup

channel: Fix to-physical setup in AnalogChannel._get_converter

This fixes a bug introduced by

  commit ac38a7987800c3982ac363af5b7780885c88d3a1
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 09:53:22 2012 -0400

    calibration: support to-physical-only softcal boards.

where the converter's _from_physical was only initialized if there was
an error trying to determine its value.  Obviously, we should only be
initializing it if there *wasn't* an error.

channel: Add docstring summaries to get_{hard,soft}cal_converter

setup.py: add explicit classifier for GPLv2+

Bump to version 0.6.

Major changes since v0.5:

* Python 3 compatibility
* Soft-calibration support (with help from Éric Piel) with new
  calibration classes: Caldac, CalibrationSetting, and Calibration

b89928: upgrade to Bugs Everywhere Directory v1.5

demo/aout: support also samples with only one channel

scipy.io.wavfile returns a one dimension array if the wav file is only one channel

.update-copyright.conf: update to pipe separators.

This brings the config file up to speed with the following
update-copyright commit:

  commit 3c68a1a48419d8b2bbc2ce0e7f1700b996ec30e9
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 21:52:48 2012 -0400

    project: for consistency, also separate ignored paths with pipes

Fix broken dependency linearization.

I had tried to break circular dependencies with:

  commit c19dd6ff6ce26beaf1b0ffc57d505b71898f8d0f
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 08:58:34 2012 -0400

    Break circular dependencies for Python 3 compatibility.

Which was causing errors like:

  Exception AttributeError:
    "'pycomedi.device.Device' object has no attribute 'device'"
    in 'pycomedi.subdevice.Subdevice._device'

because when you treat Device instances as Python objects, you cannot
access their private (C-only) attributes.  This commit avoids that
problem by adding low level classes (DeviceHolder and SubdeviceHolder)
that can be imported by both the high level classes (Device and
Subdevice) and their users (Subdevice and Channel), avoiding circular
dependencies while preserving critical C-only attributes.

Allow exceptions from other cdef functions.

send excpetions from get_softcal_converter and get_hardcal_converter

this allows to catch them from _get_converter()

calibration: support to-physical-only softcal boards.

This is a hack to fix Éric Piel's issue:

On Thu, Oct 18, 2012 at 12:10:49PM +0200, Éric Piel wrote:
> Unfortunately, with my device there seems to still be a problem with
> comedi_get_softcal_converter(), which returns -1 with direction
> from_physical. I get the same problem when using the SWIG wrapper, so
> it's probably not an error in pycomedi. So when I run cmd.py I get this
> error, but it works anyway as the _to_phys converter works:
> ./cmd.py -f /dev/comedi0 -s 0 -c 0 -a diff -N 1 -p
> Exception pycomedi.PyComediError:
> PyComediError('comedi_get_softcal_converter: Resource temporarily
> unavailable (-1)',) in
> 'pycomedi.channel.AnalogChannel.get_softcal_converter' ignored
> 0.220157

I feel like we should make an effort to invert the from_physical
polynomial, but as a stop-gap measure, we can just raise the original
exception and let the user decide what to do about it.

README: update to mention optional python-kmod dependency.

info.py: add optional kmod modinfo section.

The older info.py version only used comedilib to extract board
information, including the comedi version in use.  While the
out-of-kernel comedi module does bump their versions (occasionally ;),
the in-kernel staging drivers still claim version 0.7.76 (despite
being mostly equivalent to the out-of-tree module 0.10.1).  This makes
it useful to differentiate between in-kernel and out-of-kernel modules
by printing some modinfo details, for which I'm using the kmod Python
bindings (python-kmod).

I'm currently using my Cython branch of python-kmod, which is pending
a merge upstream [1].

[1]: https://github.com/agrover/python-kmod/pull/3

Update to `except ... as ...` syntax for Python 3.

Break circular dependencies for Python 3 compatibility.

cmd.py: importing matplotlib without X can raise RuntimeErrors.

For example, with the GTKAgg backend selected in
~/.matplotlib/matplotlibrc, running cmd.py without X raises:

  Traceback (most recent call last):
    File "./cmd.py", line 32, in <module>
      from matplotlib import pyplot as _pyplot
    ...
  RuntimeError: could not create GdkCursor object

calibration: fix parameter type

need to send the pointer to the C struct, not the python object

fix compilation with cython 0.15.1

Need to help cython to find out that a new CalibrationSetting is a CalibrationSetting, otherwise
it thinks that its properties are python objects.

Add `-*- coding: utf-8 -*-` comments where Éric Piel is in authors.

Ran update-copyright.py.

MANIFEST.in: add AUTHORS (generated by update-copyright.py).

setup: use format() for formatting strings.

setup: add explicit Python 2.7 and 3.2 classifiers.

cmd: add --plot option (for use with --callback).

cmd: add poll() calls to try and flush data off card.

In order to bring data off the card faster, we'll try and use the
subdevice.poll() command.  I may be doing this wrong, though, because
all of the poll() calls return zero.

pycomedi_demo_args: comment on what happens with lots of verbose args.

For example, if you call

  cmd.py -vvvvvvv

This will set pycomedi.LOG to DEBUG.

  WARN -> INFO
  INFO -> DEBUG
  no-op
  no-op
  etc.

The new comment makes this clearer, because it took me a minute to
understand the implementation ;).

cmd: flush stream in write_data().

calibration: fix Python-to-caldac cast in CalibrationSetting._caldacs_set.

Pointed out by Éric Piel using Cython 0.15.1:

  Error compiling Cython file:
  ------------------------------------------------------------
  ...
              raise MemoryError()
          self.setting.num_caldacs = length
          for i,x in enumerate(value):
              if i >= length:
                  raise ValueError((i, length))
              self.setting.caldacs[i] = x
                                        ^
  ------------------------------------------------------------

  pycomedi/calibration.pyx:505:39: Cannot convert Python object to
  'comedi_caldac_t'

calibration: set .num_arefs in CalibrationSetting._arefs_set.

calibration: add CalibrationSetting attribute-setting doctests.

calibration: shift settings[0] doctest spacing.

calibration: add Caldac.allocate() for stand-alone caldac instances.

README: warn about channel output during testing.

Merge calibaration branch into master.

This feature branch adds support for loading and applying calibration
files, as well as for loading soft calibration converters.

channel: standardize indentation in AnalogChannel._get_converter().

channel: add AnalogChannel.apply_calibration.

calibration: add Caldac, CalibrationSetting, and Calibration.

Add Python wrappers around comedi_calibration_t and its
sub-structures.  This allows you to load calibration files (soft and
hard) and manipulate their contents in Python.

test.sh: use Python-3-compatible print().

device: remove trailing whitespace from Éric's patch.

add support for soft calibration

Strip trailing whitespace.

Bump to version 0.5.

Add MANIFEST to .gitignore.

Ran update-copyright.py.

AUTHORS should not be version controlled (generated by update-copyright.py).

.update-copyright.conf should not be executable.

Oops, convert period from seconds to nanoseconds in cmd.py demo.

Add --callback option to cmd.py demo to use CallbackReader.

The --verbose argument to the demo scripts doesn't take arguments.

Fix conversion to physical in cmd.py demo ('float32' is not defined).

Add pycomedi.utility.CallbackReader for handling read data as it comes in.

Change my email address from drexel.edu to tremily.us.

Ran update-copyright.py.

Add doc/demo/aout.py example of repeated analog output.

This script contains the condensed wisdom of mailing list
discussions between Richard Höchenberger and myself.

Cc: Richard Höchenberger

Wrap long lines in doc/demo/info.py.

'channels' default should be a list in pycomedi_demo_args.py.

Wrap long help lines in pycomedi_demo_args.py.

Add `block_while_running` option to `_ReadWriteThread`.

This way users don't need to understand the following distinctions:

* written to driver vs. output from card.
* `SDF_BUSY` vs. `SDF_RUNNING`.

The `subdevice.cancel` call in `_ReadWriteThread.block` is because the
`RUNNING` flag is cleared after output completes, but the `BUSY` flag
is not.  This may be a bug in Comedi.  I've asked on the mailing list,
but haven't heard back yet.

Add positional arguments to format strings for Python 2.6 compatibility.

For 2.7 and later, the positional arguments can be omitted, but
Richard Höchenberger (and others?) wants to run pycomedi on 2.6.

Add trailing slash to Gentoo overlay link in README.

Rework demos so that test.sh covers their critical parts.

Add --mmap argument to cmd.py demo and fix some pycomedi_demo_args.py bugs.

Fix subdevice._device -> subdevice.device in _MMapReadWriteThread._fileno().

When I was writing the Cython implementation, I initially tried to
keep more things private, before realizing that that wasn't a good
idea.  This snippit missed the initial transition.

Consolidate demo argument parsing in pycomedi_demo_args.py to reduce duplication.

Add cmd.py demo.

Allow AnalogChannel.__init__ to take integers for `range`.

If you know the index of your desired range, you can now use that
index directly and skip the usual call to `find_range`.

Actually listen to the --subdevice option in the insn.py demo.

Add insn.py demo.

Don't set log levels for pycomedi.LOG handlers.

That's too much granularity for the default situation, where there is
only one handler and we can use the logger's level to control
verbosity.

Fix error condition `ret < 0` -> `ret < len(insnlist)` for Device.do_insnlist.

The previous implemenation would apparently succeed if there was an
error executing an instruction.  It would only raise an exception if a
failure occured before the first instruction could be executed.

Add 'external' unit for RF_EXTERNAL (see previous commit for reasoning).

Revert "Mask range.unit with 0xff when determining the unit."

This reverts commit d721a0c05450c793a5e0e562d286a689565cf81b.

From the National Instruments E Series User Manual [1], page 3-2:

  Reference Selection

  (NI 6020E, NI PXI-6040E, NI 6052E, NI 6062E, NI 6070E/6071E, and
  PCI-MIO-16E-4 Devices Only) You can connect each DAC to the device
  internal reference of 10 V or to the external reference signal
  connected to the external reference (AO EXT REF) pin on the I/O
  connector. This signal applied to EXT REF should be within
  ±11 V. You do not need to configure both channels for the same mode.

So RF_EXTERNAL is a valid unit (i.e. in units of the AO EXT REF
signal).  The next commit will add this unit.

[1]: http://digital.ni.com/manuals.nsf/websearch/06115536722DAA558625728E007E6BA4
  Edition Date: February 2007
  Part Number:    370503K-01
  p

Add info.py demo.

Mask range.unit with 0xff when determining the unit.

This avoids crashes like:

  Traceback (most recent call last):
    ...
    File "range.pyx", line 62, in pycomedi.range.Range.__str__
    File "range.pyx", line 70, in pycomedi.range.Range._unit_get
    File "constant.pyx", line 269, in pycomedi.constant._Enum.index_by_value
  KeyError: 256L

when RF_EXTERNAL is set.

Add attributes to PyComediError to make intelligent error handling easier.

Add .ranges() method to Channel class.

Add .channels() method to Subdevice class.

Allow keywords for Channel.get_range().

Add docstring to Channel.get_range.

Bump to verssion 0.4.

Add __reduce__() method to BitwiseOperator and _NamedInt.

This makes it possible to successfully pickle and deepcopy instances
of these types [1,2].  This gets the

  TRIG_SRC.now == copy.deepcopy(TRIG_SRC.now)

doctest working, which I needed to successfully dump h5config
ChoiceConfig objects that use _Enum choices [3].

For example, the newly fixed pypiezo.config.ChannelConfig [4] uses the
AREF enum values as possible choices for it's `analog-reference`
setting.  h5config makes deepcopies of mutable objects to avoid
confusion if the mutable is changed externally.  It then compares the
deepcopies with uncopied values.  Now that deepcopying works for
_NamedInts, the h5config behavior will work.

[1] http://docs.python.org/library/pickle.html#pickling-and-unpickling-extension-types
[2] http://docs.python.org/library/copy.html
[3] http://pypi.python.org/pypi/h5config/
[4] http://pypi.python.org/pypi/pypiezo/

Use utility.lsample instead of numpy.uint in calibration._convert().

Don't repeat yourself!  Also, numpy.uint is a uint64 on my amd64, and
that does not match with lsampl_t.

Yes, 2 < 3.  (fix constant comparison doctest).

Fix rich comparison doctest prompts and add comparisons to None.

The None comparison logic avoids:

  TypeError: long() argument must be a string or a number, not 'NoneType'

Oops, Cython uses __richcmp__() instead of __eq__(), etc.

http://docs.cython.org/src/userguide/special_methods.html#rich-comparisons

Add rich comparisons to BitwiseOperator (compare by .value).

Fix get_version_code parsing and split it off into a new Device.get_version method.