Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 02e7bc50735df2e365110343fbf39739 > files > 52

comedilib-devel-0.8.1-7.fc14.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>comedi_data_read</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="    Comedi
  "
HREF="index.html"><LINK
REL="UP"
TITLE="    Comedi Function Reference
  "
HREF="x4629.html#FUNCTIONREFERENCE"><LINK
REL="PREVIOUS"
TITLE="comedi_from_physical"
HREF="r5697.html"><LINK
REL="NEXT"
TITLE="comedi_data_read_delayed"
HREF="r5758.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Comedi: The <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Control and Measurement Device Interface</I
></SPAN
>
handbook
  </TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="r5697.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="r5758.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="FUNC-REF-COMEDI-DATA-READ"
></A
>comedi_data_read</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5729"
></A
><H2
>Name</H2
>comedi_data_read&nbsp;--&nbsp;read single sample from channel</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5732"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5733"
></A
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &lt;comedilib.h&gt;</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int comedi_data_read</CODE
>(comedi_t * device, unsigned int subdevice, unsigned int channel, unsigned int range, unsigned int aref, lsampl_t * data);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5750"
></A
><H2
>      Description
    </H2
><P
>Reads a single sample on the channel specified by the Comedi
device device, the subdevice subdevice, and the channel channel.
For the A/D conversion (if appropriate),
the device is configured to use range specification
range and (if appropriate) analog reference type
aref. Analog reference types that are not supported
by the device are silently ignored.</P
><P
>The function comedi_data_read() reads one data value from
the specified channel and places the data value in the
location pointed to by data.</P
><P
>WARNING: comedi_data_read() does not do any pausing to
allow multiplexed analog inputs to settle before
performing an analog to digital conversion.  If you are
switching between different channels and need to allow
your analog input to settle for an accurate reading,
use comedi_data_read_delayed(), or set the
input channel at an earlier time with
comedi_data_read_hint().</P
><P
>On sucess, comedi_data_read() returns 1 (the number of samples
read).  If there is an error, -1 is returned.</P
><P
>Data values returned by this function are unsigned integers
less than or equal to the maximum sample value of the channel,
which can be determined using the function comedi_get_maxdata().
Conversion of data values to physical units can be performed
by the function comedi_to_phys().</P
><P
>    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="r5697.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="r5758.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>comedi_from_physical</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="x4629.html#FUNCTIONREFERENCE"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>comedi_data_read_delayed</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>