-
Notifications
You must be signed in to change notification settings - Fork 29
/
arduinoRead.xml
81 lines (73 loc) · 2.79 KB
/
arduinoRead.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<refentry id="arduinoRead">
<indexterm
id="IndexArduinoRead"><primary>arduinoRead</primary></indexterm>
<refentryinfo><title>Serial I/O</title></refentryinfo>
<refmeta>
<refentrytitle>arduinoRead</refentrytitle>
</refmeta>
<refnamediv>
<refname>arduinoRead</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>arduinoRead</command> iPort, iStream[, iSmooth]</synopsis>
</refsect1>
<refsect1>
<title>Performance</title>
<para>
<emphasis>iPort</emphasis> -- port number obtained from a
<emphasis>arduinoStart</emphasis> opcode.
</para>
<para>
<emphasis>iStream</emphasis> -- Number of the data stream in
range 0 to 30.
</para>
<para>
<emphasis>iSmooth</emphasis> -- halftime of a portamento filter
to smooth the stream of data. Defaults to 0 meaning no filtering.
</para>
<para>
<emphasis>kval</emphasis> -- data to read in range [0, 1023].
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Here is an example of the arduinoRead opcode. It uses the file <ulink url="examples/arduinoRead.csd"><citetitle>arduinoRead.csd</citetitle></ulink>.
<example>
<title>Example of the arduinoRead 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/arduinoRead.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</example>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<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>
<para>
<link linkend="arduinoStart"><citetitle></citetitle>arduinoStart</link>,
<link linkend="arduinoStop"><citetitle></citetitle>arduinoStop</link>,
</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>