summaryrefslogtreecommitdiff
path: root/2.3-1/help/en_US/AVRReadADC.xml
diff options
context:
space:
mode:
Diffstat (limited to '2.3-1/help/en_US/AVRReadADC.xml')
-rw-r--r--2.3-1/help/en_US/AVRReadADC.xml71
1 files changed, 71 insertions, 0 deletions
diff --git a/2.3-1/help/en_US/AVRReadADC.xml b/2.3-1/help/en_US/AVRReadADC.xml
new file mode 100644
index 00000000..abdcad9a
--- /dev/null
+++ b/2.3-1/help/en_US/AVRReadADC.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from AVRReadADC.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="AVRReadADC" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ns3="http://www.w3.org/1999/xhtml"
+ xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:scilab="http://www.scilab.org"
+ xmlns:db="http://docbook.org/ns/docbook">
+
+ <refnamediv>
+ <refname>AVRReadADC</refname>
+ <refpurpose>Function to get voltage on analog pin on AVR</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ u8AVRReadADCs(channel)
+
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>channel :</term>
+ <listitem><para> Select which channel is to be read. Values from 0-7 select one of the pins ADC0-ADC7. For other possible channel values refer datasheet</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function returns digital value for present on adc pins. 'channel'
+selects which of the ADC0-ADC7 is to be used for reading analog value.
+Apart from reading just ADC0-ADC7 other it can also read differential
+voltages between some pins. For channel values for those options, please
+refer datasheet.
+ </para>
+ <para>
+This is curretly dummy function. It provides no functionality but is required
+for providing support for generating C code for AVR.
+ </para>
+ <para>
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+adc_result = u8AVRReadADC(0) //Read ADC0
+ ]]></programlisting>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Siddhesh Wani</member>
+ <member>Ashish Kamble</member>
+ </simplelist>
+</refsection>
+</refentry>