Commit graph

1254 commits

Author SHA1 Message Date
Bernd Porr
ee16e47509 Just spotted that the documentation also talks about board_info.
I've updated it as well: explained the new command comedi_board_info.
2012-05-03 02:07:30 +01:00
Bernd Porr
2d0ed0442c Added a couple of sentences about async acquisition and the
two modes cards do it and then mentioned our new board_info.
2012-05-03 01:24:22 +01:00
Bernd Porr
47b3edd6e2 Changed some of the descriptions for the SDF flags which were
a bit misleading.
2012-05-03 01:03:16 +01:00
Bernd Porr
33f3a2eada Just what I said in the git log is now also actually in the man page
namely that the frequency option is only there for debugging.
2012-05-03 00:52:13 +01:00
Bernd Porr
c22d498dc0 Added comedi_board_info which has been inspired by the original
info in the demo directory. I've made it a bit more verbose
and also took into account that now the generic_timed command
takes more than one channel so that a user can experiment which
sampling rates are possible with different channel numbers.
I've also added an option to set the sampling rate for the generic_timed
command. That sould actually not be needed but I'm sure there
are drivers out there which do not correct the sampling rate
downwards automatically.
2012-05-03 00:39:04 +01:00
Bernd Porr
74a1207a29 Added info that '-n' is used to select the waveform. 2012-05-02 18:40:07 +01:00
Bernd Porr
58e0e21ea9 Merge branch 'master' of ssh://comedi.org/git/comedi/comedilib 2012-05-02 17:59:46 +01:00
Bernd Porr
90ea57b2e9 Created a PWM demo using the newly introduced defines to
manipulate PWM frequency.
2012-05-02 17:58:15 +01:00
Ian Abbott
708b802811 doc/comedilib.xml: Add myself (Ian Abbott) to list of authors. 2012-05-02 13:04:24 +01:00
Ian Abbott
ad6a93952f doc/tutorial.xml: Fix a broken link. 2012-05-02 13:01:41 +01:00
Ian Abbott
6892b40468 doc/other.xml: Use comedi_dio_bitfield2 instead of comedi_dio_bitfield.
Rework text to use comedi_dio_bitfield2 as comedi_dio_bitfield is marked
as deprecated elsewhere in the document.
2012-05-02 12:54:46 +01:00
Bernd Porr
aaa4514804 I've added a bit more "meat" to the asynchronous acquisition section
and added myself to the authors section.
2012-05-01 19:41:38 +01:00
Ian Abbott
14d401376f configure: Avoid PDF generation by default if don't have dblatex
Changed handling of --with-pdf-backend[=yes] to avoid picking the default
xmlto backend for PDF generation because it's broken.

The default xmlto backend for PDF generation can still be selected using
--with-pdf-backend=default if you really want to try it.
2012-05-01 18:03:57 +01:00
Ian Abbott
5392632a1c doc/funcref: Added missing comedi_data_read_n
There was a broken link to the comedi_data_read_n function from
elsewhere, so we'd better add a section for it.
2012-05-01 17:42:15 +01:00
Ian Abbott
7655653daf doc: Use ansi style funcsynopsis for html output.
Set XSL parameter "funcsynopsis.style" to "ansi" in the XSL stylesheet
used for HTML output (comedilib_html_config.xsl).
2012-05-01 17:14:27 +01:00
Ian Abbott
cc82998ec7 doc/mkref: Add some refmiscinfo for man pages
Make the man pages a bit neater.
2012-05-01 16:54:39 +01:00
Ian Abbott
1d351bfa04 doc/other.xml: Some DocBook markup changes. 2012-05-01 15:42:07 +01:00
Ian Abbott
5fdc15c302 doc: A few whitespace tweaks in program listings 2012-05-01 12:51:08 +01:00
Ian Abbott
c938e2bf60 doc/other.xml: Replaced simplelists
Replaced some simplelists with variablelists to fix some dblatex layout
problems.
2012-05-01 11:48:46 +01:00
Bernd Porr
df6a97ec6c I've updated the manual in the section configuration and
also updated the tutorial. I've simplified the tut2.c
by using comedi2phys instead of comedi2physical. The use of
polynomials as a 2nd comedi program is a bit too difficult
for a novice and might deter the user to dig deeper into
the coding. Also, I've added tut3.c which is a stripped
down version of cmd.c and of that again the relevant lines
for the handbook to save space.
2012-04-27 01:37:33 +01:00
Bernd Porr
12155822bc Removed old hotplug install which is no longer used at all and
just left udev as the only hotplug mechanism. I've also added
an option to disable the installation of the firmware. This
is useful for debian or ubuntu packages where the firmware
is now provided by a package accompanying the staging kernel.
All usbdux files are included in the kernel firmware packages.
Package maintainers should use the --disable-firmware option.
2012-04-26 23:24:50 +01:00
Ian Abbott
e7a3e54042 doc/other.xml: Make table of configuration instructions less ugly.
The PDF output of the table of configurations was awful.  Fiddled with
the column widths a bit and simplified the layout "Meanings of data[1],..."
column to allow it to wrap.
2012-04-25 18:34:54 +01:00
Ian Abbott
be4e3b4007 configure: Allow choice of backend for PDF generation.
Add --with-pdf-backend=[yes|no|dblatex|fop|default] option which
defaults to "yes".  This controls the option passed to 'xmlto' to
generate PDFs.

If set to "yes" (the default) it looks for 'dblatex' and uses it as the
backend for 'xmlto' if found, otherwise 'xmlto' will use the default
backend.

If set to "no" (same as --without-pdf-backend), PDF generation is
disabled.

If set to "dblatex" it looks for 'dblatex' and uses it as the backend
for 'xmlto' if found, otherwise PDF generation is disabled.

If set to "fop" it looks for 'fop' and uses it as the backend
for 'xmlto' if found, otherwise PDF generation is disabled.

If set to "default", 'xmlto' will use the default backend.
2012-04-25 17:14:16 +01:00
Ian Abbott
08448172d8 doc/drivers.txt: Rebuilt from comedi
Rebuilt "doc/drivers.txt" using "make Documentation/comedi/drivers.txt"
in the Comedi package.  Note: this scans the driver sources included
with the comedi.org Comedi package, not the Linux "staging" Comedi
sources, so some newer, staging-only drivers are missing.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-23 18:12:41 +01:00
Ian Abbott
31b558634a doc/Makefile.am: Create directory for pdf output
dblatex is passed the option `-o $(srcdir)/pdf`, but if this directory
does not exist, the PDF file is created with the name 'pdf' in
$(srcdir).  Make the directory so that the -o option treats the
specified name as an output directory instead of an output filename.
2012-04-23 17:52:06 +01:00
Ian Abbott
be02f1a3d6 etc/hotplug/usbduxsigma: Remove Makefile and Makefile.in ...
... but keep Makefile.am of course!
2012-04-23 17:29:51 +01:00
Bernd Porr
ac43731c43 Updated usbdux firmware files. The udev hotplug mechanism
now takes binary files and no longer hex files. Also
added the firmware for usbduxsigma.
2012-04-23 14:03:12 +01:00
Bernd Porr
1d86853f1b Fixed an issue reported by Graeme Hattan that the udev
rules were installed in the etc directory and not the lib.
See also:
http://lintian.debian.org/tags/udev-rule-in-etc.html
./configure --with-udev-hotplug=/lib places now all
files in /lib. The scripts were wrongly prefixed with the
sysconf directory which is /etc but should be /lib.
The directory is now also taken from --with-udev-hotplug=/lib.
2012-04-23 13:15:03 +01:00
Bernd Porr
456421c4f6 Fixed a path issue with comedilib.pdf. Got correctly
saved into the pdf subfolder but install exprected
it in the doc folder.
2012-04-23 12:43:04 +01:00
Bernd Porr
c2d03227e0 Removed two scripts which are no longer used by hotplug.
In the early udev days the firmware had to be uploaded
by comedi_config. However now the driver requests the
firmware by itself and there is no need to have dedicated
scripts for every kernel module in udev.
2012-04-23 12:28:13 +01:00
Bernd Porr
9a76f63cd3 automake now checks for dblatex and the pdf version
of the comedi manual is now generated
2012-04-23 12:22:16 +01:00
Bernd Porr
0d8c6e9661 Comedilib.pdf can now be generated with
dblatex -t pdf ./comedilib.xml

There were two major issues in the comedilb.xml:
1) there were too many nested sections so that
   latex ran out of sub-sub-sub-sub-sections.
2) A section needs a title and can no longer
   exist without one. The first line
   of the textfiles contains now the title
   and will be inserted by mkref into the xml file.

todo: switch from xmlto to dblatex for the pdf generation
and re-enable it in the makefile.
2012-04-23 00:23:03 +01:00
Ian Abbott
428ad43ebc Generate ChangeLog from git log during 'make dist'
Generate the ChangeLog using git log in the dist-hook target of the main
Makefile.  The git command used is:

	git log --stat --name-only --date=iso

The format of the resulting ChangeLog is different to the old one that
was produced with cvs2cl.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 14:18:53 +01:00
Ian Abbott
a61c28c696 doc/reference.xml: Added section for comedi_polynomial_t.
The tutorial.xml contained links to a missing section for the
comedi_polynomial_t type, so I added one.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 13:28:15 +01:00
Ian Abbott
4f21a64daa doc/Makefile: Remove *.css files on uninstallation.
Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 12:26:34 +01:00
Ian Abbott
67a83184ad Makefile.am: Remove 'debian' from EXTRA_DIST.
The 'debian' target doesn't exist and there is no rule to make it, so
remove it from EXTRA_DIST.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 12:10:01 +01:00
Ian Abbott
38a3932fd9 Makefile.am: Don't bother removing CVS directories in dist-hook.
Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 11:57:23 +01:00
Ian Abbott
404cee44a9 todo: Added note about Ruby bindings disabled by default.
Signed-off-by: Ian Abbott <abbotti.mev.co.uk>
2012-04-20 10:42:25 +01:00
Ian Abbott
12fad7551d configure.ac: Use AS_HELP_STRING()
Use AS_HELP_STRING() to make the HELP-STRING arguments for the
AC_ARG_ENABLE() and AC_ARG_WITH() macro calls.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 10:34:27 +01:00
Ian Abbott
82456b6f98 configure: Disable Ruby bindings by default.
The SWIG Ruby bindings do not build cleanly from scratch.  They need an
existing installation of comedilib.  So disable them in the default
configuration.  They can be enabled with the --enable-ruby-bindings
configure option.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-20 10:11:57 +01:00
Ian Abbott
ee2986755a include/comedi.h: synced with comedi
Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
2012-04-16 14:53:28 +01:00
W. Trevor King
679c0fb5f7 driverwriting.xml: COMEDI_CB_EOA is also used to report end-of-output. 2012-04-16 08:58:20 -04:00
W. Trevor King
1fd268ccdb driverwriting.xml: COMEDI_CB_OVERFLOW is also used to report underflows. 2012-04-16 07:52:48 -04:00
W. Trevor King
5af8a8cf28 Add myself to the comedi.i copyright, since I just tweaked it.
I also added 2010 for:

  commit 3fe8e6baac
  Author: Ian Abbott <abbotti@mev.co.uk>
  Date:   Mon Dec 20 14:50:21 2010 +0000

    Add sampl_t and lsampl_t array_class()es to comedi.i.
    ...
    Patch from W. Trevor King.
2012-03-13 09:38:47 -04:00
W. Trevor King
db4fd99309 Suggest people use PYTHONPATH rather than adjusting sys.path internally.
The old method only worked out of the box if you were running Python
2.1 on a 586.  I imagine that is too small a slice of current users to
be worth hard coding ;).
2012-03-13 09:30:45 -04:00
W. Trevor King
55b6a03a50 Add myself to the old Python demo copyrights, since I just tweaked each demo. 2012-03-13 09:24:07 -04:00
W. Trevor King
b415c91aac Oops, fix copyright month on demo/python/insn.py. 2012-03-13 09:22:03 -04:00
W. Trevor King
3d79204427 Cast the period to an integer in demo/python/mmap.py's command setup.
This avoids:

   Traceback (most recent call last):
     ...
     File ".../mmap.py", line 96, in prepare_cmd
       C.scan_begin_arg = 1e9/freq
     ...
   TypeError: in method 'comedi_cmd_struct_scan_begin_arg_set',
      argument 2 of type 'unsigned int'
2012-03-13 09:17:08 -04:00
W. Trevor King
8add63faa3 Adjust sys.path before importing mmap in demo/python/mmap.py.
With the previous implementation, `mmap` was importing the demo
script, not the standard `mmap` library module.  From the docs [1]:

  The directory containing the script being run is placed at the
  beginning of the search path, ahead of the standard library
  path. This means that scripts in that directory will be loaded
  instead of modules of the same name in the library directory.

I'm not sure when this changed in Python, since the demo script
presumably worked with an earlier version.

[1]: http://docs.python.org/tutorial/modules.html#the-module-search-path
2012-03-13 09:12:41 -04:00
W. Trevor King
7a277ab0cb Cast the period to an integer in demo/python/cmd.py's command setup.
This avoids:

  TypeError: in method 'comedi_get_cmd_generic_timed',
    argument 5 of type 'unsigned int'
2012-03-13 08:58:19 -04:00