+Deprecated functions
Function: comedi_dio_bitfield -- read/write multiple digital channels
Retval: int
Param: comedi_t * device
Param: unsigned int * bits
Status: deprecated
Description:
- This function is deprecated. Use comedi_dio_bitfield2() instead.
-
-Function: comedi_from_phys -- convert physical units to sample
-Retval: lsampl_t
-Param: double data
-Param: comedi_range * range
-Param: lsampl_t maxdata
-Status: deprecated
-Description:
- Converts data given in physical units (data) into sample values
- (lsampl_t, between 0 and maxdata). The parameter rng
- represents the conversion information to use, and the parameter
- maxdata represents the maximum possible data value for the
- channel that the data will be written to.
-
- Conversion is not affected by out-of-range behavior. Out-of-range
- data parameters are silently truncated to the range 0 to maxdata.
+ This function is deprecated. Use <function><link
+ linkend="func-ref-comedi-dio-bitfield2">comedi_dio_bitfield2</link></function>
+ instead. It is equivalent to using <function>comedi_dio_bitfield2</function>
+ with <parameter class="function">base_channel</parameter> set to
+ <literal>0</literal>.
Function: comedi_get_timer -- timer information (deprecated)
Retval: int
Param: double * actual_frequency
Status: deprecated
Description:
- The function comedi_get_timer converts the frequency frequency
- to a number suitable to send to the driver in a comedi_trig
+ The function <function>comedi_get_timer</function> converts the frequency
+ <parameter class="function">frequency</parameter>
+ to a number suitable to send to the driver in a <type>comedi_trig</type>
structure. This function remains for compatibility with very
old versions of Comedi, that converted sampling rates to timer
- values in the libary. This conversion is now done in the kernel,
- and every device has the timer type nanosec_timer, indicating
+ values in the library. This conversion is now done in the kernel,
+ and every device has the timer type <constant>nanosec_timer</constant>, indicating
that timer values are simply a time specified in nanoseconds.
Function: comedi_sv_init -- slowly-varying inputs
Param: unsigned int channel
Status: deprecated
Description:
- The function comedi_sv_init() initializes the slow varying Comedi
- structure sv to use the device device, the analog input subdevice
- subdevice, and the channel channel. The slow varying Comedi
- structure is used by comedi_sv_measure() to accurately measure
+ The function <function>comedi_sv_init</function> initializes the slow varying Comedi
+ structure pointed to by <parameter class="function">sv</parameter> to use the
+ device <parameter class="function">device</parameter>, the analog input subdevice
+ <parameter class="function">subdevice</parameter>, and the channel
+ <parameter class="function">channel</parameter>. The slow varying Comedi
+ structure is used by
+ <function><link linkend="func-ref-comedi-sv-measure">comedi_sv_measure</link></function>
+ to accurately measure
an analog input by averaging over many samples. The default
- number of samples is 100. This function returns 0 on success,
- -1 on error.
+ number of samples is 100.
+Returns:
+ This function returns <literal>0</literal> on success,
+ <literal>-1</literal> on error.
Function: comedi_sv_measure -- slowly-varying inputs
Retval: int
Param: double * data
Status: deprecated
Description:
- The function comedi_sv_measure() uses the slowly varying Comedi
- structure sv to measure a slowly varying signal. If successful,
+ The function <function>comedi_sv_measure</function> uses the slowly varying Comedi
+ structure pointed to by <parameter class="function">sv</parameter>
+ to measure a slowly varying signal. If successful,
the result (in physical units) is stored in the location pointed
- to by data, and the number of samples is returned. On error, -1
+ to by <parameter class="function">data</parameter>, and the number of samples
+ is returned. On error, <literal>-1</literal>
is returned.
Function: comedi_sv_update -- slowly-varying inputs
Param: comedi_sv_t * sv
Status: deprecated
Description:
- The function comedi_sv_update() updates internal parameters of
- the slowly varying Comedi structure sv.
+ The function <function>comedi_sv_update</function> updates internal parameters of
+ the slowly varying Comedi structure pointed to by
+ <parameter class="function">sv</parameter>.
Function: comedi_timed_1chan -- streaming input (deprecated)
Retval: int
Description:
Not documented.
-Function: comedi_to_phys -- convert sample to physical units
-Retval: double
-Param: lsampl_t data
-Param: comedi_range * range
-Param: lsampl_t maxdata
-Status: deprecated
-Description:
- Converts data given in sample values (lsampl_t, between 0 and
- maxdata) into physical units (double). The parameter range
- represents the conversion information to use, and the parameter
- maxdata represents the maximum possible data value for the
- channel that the data was read.
-
- Conversion of endpoint sample values, that is, sample values
- equal to 0 or maxdata, is affected by the Comedilib out-of-range
- behavior. If the out-of-range behavior is set to COMEDI_OOR_NAN,
- endpoint values are converted to NAN. If the out-of-range
- behavior is set to COMEDI_OOR_NUMBER, the endpoint values are
- converted similarly to other values.
-
- If there is an error, NAN is returned.
-
Function: comedi_trigger -- perform streaming input/output (deprecated)
Retval: int
Param: comedi_t * device
Param: comedi_trig * trig
Status: deprecated
Description:
- The function comedi_trigger() instructs Comedi to
- perform the command specified by the trigger structure trig.
+ The function <function>comedi_trigger</function> instructs Comedi to
+ perform the command specified by the trigger structure pointed to by
+ <parameter class="function">trig</parameter>.
The return value depends on
- the particular trig being issued. If there is an
- error, -1 is returned.
+ the particular trigger being issued. If there is an
+ error, <literal>-1</literal> is returned.
projects / comedilib.git / blobdiff