arduinoReadF.xml

<refentry id="arduinoReadF">
<indexterm
    id="IndexArduinoReadF"><primary>arduinoReadF</primary></indexterm>

  <refentryinfo><title>Serial I/O</title></refentryinfo>
  <refmeta>
    <refentrytitle>arduinoReadF</refentrytitle>
  </refmeta>

   <refnamediv>
    <refname>arduinoReadF</refname>
    <refpurpose>
      Read data from an arduino port using the Csound-Arduino protocol.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>Plugin opcode in serial.</para>
    <para>
      Read integer data from an arduino port with CsoundArduino protocol.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
      <synopsis>kval <command>arduinoReadF</command> iPort, iStream1,
      iStream2, iStream3</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>iPort</emphasis> -- port number obtained from a
      <emphasis>arduinoStart</emphasis> opcode.
    </para>
    <para>
      <emphasis>iStream1, iStream2, iStream3</emphasis> -- Numbers of
      the three data streams in the range 0 to 30.  Each stream
      carries 10 bits of the 30 bits floating point result. The division
      is created in the Arduino sketch encapsulated in the put_float function.
    </para>
    <para>
      <emphasis>kval</emphasis> -- floating point value read.
    </para>
    <note>The value transmitted is two bits shorter in the mantissa
    than produced on the Arduino so there is a little error introduced.</note>
 </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the arduinoReadF opcode. It uses the file <ulink url="examples/arduinoReadF.csd"><citetitle>arduinoReadF.csd</citetitle></ulink>.
      <example>
        <title>Example of the arduinoReadF opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/arduinoReadF.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="arduinoStart"><citetitle></citetitle>arduinoStart</link>,
      <link linkend="arduinoStop"><citetitle></citetitle>arduinoStop</link>,
      <link linkend="arduinoRead"><citetitle></citetitle>arduinoRead</link>,
    </para>
    <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>Author: Richard Boulanger</member>
        <member>2020</member>
      </simplelist>
    </para>
    <para>New in version 6.15</para>
  </refsect1>
</refentry>