<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>5.4. Functions</title><link rel="stylesheet" type="text/css" href="comedilib.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Comedi"><link rel="up" href="comedireference.html" title="5. Comedi reference"><link rel="prev" href="datatypesstructures.html" title="5.3. Data types and structures"><link rel="next" href="func-ref-comedi-close.html" title="comedi_close"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.4. Functions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="datatypesstructures.html">Prev</a> </td><th width="60%" align="center">5.
<acronym class="acronym">Comedi</acronym> reference
</th><td width="20%" align="right"> <a accesskey="n" href="func-ref-comedi-close.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="functionreference"></a>5.4. Functions</h3></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="functionreference.html#idm2224">5.4.1. Core Functions</a></span></dt><dt><span class="section"><a href="functionreference.html#idm3568">5.4.2. Asynchronous commands</a></span></dt><dt><span class="section"><a href="functionreference.html#idm4383">5.4.3. Calibration</a></span></dt><dt><span class="section"><a href="functionreference.html#idm4760">5.4.4. Digital I/O</a></span></dt><dt><span class="section"><a href="functionreference.html#idm4994">5.4.5. Error reporting</a></span></dt><dt><span class="section"><a href="functionreference.html#idm5166">5.4.6. Extensions</a></span></dt><dt><span class="section"><a href="functionreference.html#idm6060">5.4.7. Deprecated functions</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm2224"></a>5.4.1. Core Functions</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-close.html">comedi_close</a></span><span class="refpurpose"> — close a Comedi device</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-data-read.html">comedi_data_read</a></span><span class="refpurpose"> — read single sample from channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-data-read-n.html">comedi_data_read_n</a></span><span class="refpurpose"> — read multiple samples from channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-data-read-delayed.html">comedi_data_read_delayed</a></span><span class="refpurpose"> — read single sample from channel after delaying for specified settling time</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-data-read-hint.html">comedi_data_read_hint</a></span><span class="refpurpose"> — tell driver which channel/range/aref you are going to read from next</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-data-write.html">comedi_data_write</a></span><span class="refpurpose"> — write single sample to channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-do-insn.html">comedi_do_insn</a></span><span class="refpurpose"> — perform instruction</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-do-insnlist.html">comedi_do_insnlist</a></span><span class="refpurpose"> — perform multiple instructions</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-fileno.html">comedi_fileno</a></span><span class="refpurpose"> — get file descriptor for open Comedilib device</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-find-range.html">comedi_find_range</a></span><span class="refpurpose"> — search for range</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-find-subdevice-by-type.html">comedi_find_subdevice_by_type</a></span><span class="refpurpose"> — search for subdevice type</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-from-phys.html">comedi_from_phys</a></span><span class="refpurpose"> — convert physical units to sample</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-from-physical.html">comedi_from_physical</a></span><span class="refpurpose"> — convert physical units to sample using calibration data</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-board-name.html">comedi_get_board_name</a></span><span class="refpurpose"> — Comedi device name</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-driver-name.html">comedi_get_driver_name</a></span><span class="refpurpose"> — Comedi driver name</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-maxdata.html">comedi_get_maxdata</a></span><span class="refpurpose"> — maximum sample of channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-n-channels.html">comedi_get_n_channels</a></span><span class="refpurpose"> — number of subdevice channels</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-n-ranges.html">comedi_get_n_ranges</a></span><span class="refpurpose"> — number of ranges of channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-n-subdevices.html">comedi_get_n_subdevices</a></span><span class="refpurpose"> — number of subdevices</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-range.html">comedi_get_range</a></span><span class="refpurpose"> — range information of channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-subdevice-flags.html">comedi_get_subdevice_flags</a></span><span class="refpurpose"> — properties of subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-subdevice-type.html">comedi_get_subdevice_type</a></span><span class="refpurpose"> — type of subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-version-code.html">comedi_get_version_code</a></span><span class="refpurpose"> — Comedi version code</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-internal-trigger.html">comedi_internal_trigger</a></span><span class="refpurpose"> — generate soft trigger</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-lock.html">comedi_lock</a></span><span class="refpurpose"> — subdevice reservation</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-maxdata-is-chan-specific.html">comedi_maxdata_is_chan_specific</a></span><span class="refpurpose"> — maximum sample depends on channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-open.html">comedi_open</a></span><span class="refpurpose"> — open a Comedi device</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-range-is-chan-specific.html">comedi_range_is_chan_specific</a></span><span class="refpurpose"> — range information depends on channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-global-oor-behavior.html">comedi_set_global_oor_behavior</a></span><span class="refpurpose"> — out-of-range behavior</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-to-phys.html">comedi_to_phys</a></span><span class="refpurpose"> — convert sample to physical units</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-to-physical.html">comedi_to_physical</a></span><span class="refpurpose"> — convert sample to physical units using polynomials</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-unlock.html">comedi_unlock</a></span><span class="refpurpose"> — subdevice reservation</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm3568"></a>5.4.2. Asynchronous commands</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-cancel.html">comedi_cancel</a></span><span class="refpurpose"> — stop streaming input/output in progress</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-command.html">comedi_command</a></span><span class="refpurpose"> — start streaming input/output</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-command-test.html">comedi_command_test</a></span><span class="refpurpose"> — test streaming input/output configuration</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-contents.html">comedi_get_buffer_contents</a></span><span class="refpurpose"> — streaming buffer status</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-read-offset.html">comedi_get_buffer_read_offset</a></span><span class="refpurpose"> — streaming buffer read offset</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-write-offset.html">comedi_get_buffer_write_offset</a></span><span class="refpurpose"> — streaming buffer write offset</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-read-count.html">comedi_get_buffer_read_count</a></span><span class="refpurpose"> — streaming buffer read count</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-write-count.html">comedi_get_buffer_write_count</a></span><span class="refpurpose"> — streaming buffer write count</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-size.html">comedi_get_buffer_size</a></span><span class="refpurpose"> — streaming buffer size of subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-cmd-generic-timed.html">comedi_get_cmd_generic_timed</a></span><span class="refpurpose"> — streaming input/output capabilities</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-cmd-src-mask.html">comedi_get_cmd_src_mask</a></span><span class="refpurpose"> — streaming input/output capabilities</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-max-buffer-size.html">comedi_get_max_buffer_size</a></span><span class="refpurpose"> — maximum streaming buffer size</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-read-subdevice.html">comedi_get_read_subdevice</a></span><span class="refpurpose"> — find streaming input subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-write-subdevice.html">comedi_get_write_subdevice</a></span><span class="refpurpose"> — find streaming output subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-mark-buffer-read.html">comedi_mark_buffer_read</a></span><span class="refpurpose"> — streaming buffer control</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-mark-buffer-written.html">comedi_mark_buffer_written</a></span><span class="refpurpose"> — streaming buffer control</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-poll.html">comedi_poll</a></span><span class="refpurpose"> — force updating of streaming buffer</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-buffer-size.html">comedi_set_buffer_size</a></span><span class="refpurpose"> — streaming buffer size of subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-max-buffer-size.html">comedi_set_max_buffer_size</a></span><span class="refpurpose"> — streaming maximum buffer size of subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-read-subdevice.html">comedi_set_read_subdevice</a></span><span class="refpurpose"> — set streaming input subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-write-subdevice.html">comedi_set_write_subdevice</a></span><span class="refpurpose"> — set streaming output subdevice</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm4383"></a>5.4.3. Calibration</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-apply-calibration.html">comedi_apply_calibration</a></span><span class="refpurpose"> — set hardware calibration from file</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-apply-parsed-calibration.html">comedi_apply_parsed_calibration</a></span><span class="refpurpose"> — set calibration from memory</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-cleanup-calibration.html">comedi_cleanup_calibration</a></span><span class="refpurpose"> — free calibration resources</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-default-calibration-path.html">comedi_get_default_calibration_path</a></span><span class="refpurpose"> — get default calibration file path</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-hardcal-converter.html">comedi_get_hardcal_converter</a></span><span class="refpurpose"> — get converter for hardware-calibrated subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-softcal-converter.html">comedi_get_softcal_converter</a></span><span class="refpurpose"> — get converter for software-calibrated subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-parse-calibration-file.html">comedi_parse_calibration_file</a></span><span class="refpurpose"> — load contents of calibration file</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm4760"></a>5.4.4. Digital I/O</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-bitfield2.html">comedi_dio_bitfield2</a></span><span class="refpurpose"> — read/write multiple digital channels</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-config.html">comedi_dio_config</a></span><span class="refpurpose"> — change input/output properties of channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-get-config.html">comedi_dio_get_config</a></span><span class="refpurpose"> — query input/output properties of channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-read.html">comedi_dio_read</a></span><span class="refpurpose"> — read single bit from digital channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-write.html">comedi_dio_write</a></span><span class="refpurpose"> — write single bit to digital channel</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm4994"></a>5.4.5. Error reporting</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-errno.html">comedi_errno</a></span><span class="refpurpose"> — number of last Comedilib error</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-loglevel.html">comedi_loglevel</a></span><span class="refpurpose"> — change Comedilib logging properties</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-perror.html">comedi_perror</a></span><span class="refpurpose"> — print a Comedilib error message</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-strerror.html">comedi_strerror</a></span><span class="refpurpose"> — return string describing Comedilib error code</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm5166"></a>5.4.6. Extensions</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-arm.html">comedi_arm</a></span><span class="refpurpose"> — arm a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-arm-channel.html">comedi_arm_channel</a></span><span class="refpurpose"> — arm a subdevice channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-digital-trigger-disable.html">comedi_digital_trigger_disable</a></span><span class="refpurpose"> — disable a digital trigger</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-digital-trigger-enable-edges.html">comedi_digital_trigger_enable_edges</a></span><span class="refpurpose"> — set digital trigger edge detection</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-digital-trigger-enable-levels.html">comedi_digital_trigger_enable_levels</a></span><span class="refpurpose"> — set digital trigger level detection</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-disarm.html">comedi_disarm</a></span><span class="refpurpose"> — disarm a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-disarm-channel.html">comedi_disarm_channel</a></span><span class="refpurpose"> — disarm a subdevice channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-clock-source.html">comedi_get_clock_source</a></span><span class="refpurpose"> — get master clock for a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-gate-source.html">comedi_get_gate_source</a></span><span class="refpurpose"> — get gate for a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-hardware-buffer-size.html">comedi_get_hardware_buffer_size</a></span><span class="refpurpose"> — get size of subdevice's hardware buffer</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-routing.html">comedi_get_routing</a></span><span class="refpurpose"> — get routing for an output</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-reset.html">comedi_reset</a></span><span class="refpurpose"> — reset a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-reset-channel.html">comedi_reset_channel</a></span><span class="refpurpose"> — reset a subdevice channel</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-clock-source.html">comedi_set_clock_source</a></span><span class="refpurpose"> — set master clock for a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-counter-mode.html">comedi_set_counter_mode</a></span><span class="refpurpose"> — change mode of a counter subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-filter.html">comedi_set_filter</a></span><span class="refpurpose"> — select a filter for a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-gate-source.html">comedi_set_gate_source</a></span><span class="refpurpose"> — select gate source for a subdevice</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-other-source.html">comedi_set_other_source</a></span><span class="refpurpose"> — select source signal for something other than a gate or clock</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-set-routing.html">comedi_set_routing</a></span><span class="refpurpose"> — select a routing for an output</span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idm6060"></a>5.4.7. Deprecated functions</h4></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="func-ref-comedi-dio-bitfield.html">comedi_dio_bitfield</a></span><span class="refpurpose"> — read/write multiple digital channels</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-buffer-offset.html">comedi_get_buffer_offset</a></span><span class="refpurpose"> — streaming buffer status (deprecated)</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-get-timer.html">comedi_get_timer</a></span><span class="refpurpose"> — timer information (deprecated)</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-sv-init.html">comedi_sv_init</a></span><span class="refpurpose"> — slowly-varying inputs</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-sv-measure.html">comedi_sv_measure</a></span><span class="refpurpose"> — slowly-varying inputs</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-sv-update.html">comedi_sv_update</a></span><span class="refpurpose"> — slowly-varying inputs</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-timed-1chan.html">comedi_timed_1chan</a></span><span class="refpurpose"> — streaming input (deprecated)</span></dt><dt><span class="refentrytitle"><a href="func-ref-comedi-trigger.html">comedi_trigger</a></span><span class="refpurpose"> — perform streaming input/output (deprecated)</span></dt></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="datatypesstructures.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="comedireference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="func-ref-comedi-close.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.3.
Data types and structures
</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> comedi_close</td></tr></table></div></body></html>
|
