summaryrefslogtreecommitdiff
path: root/help/en_US/AVRADCSetup.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/AVRADCSetup.xml')
-rw-r--r--help/en_US/AVRADCSetup.xml83
1 files changed, 83 insertions, 0 deletions
diff --git a/help/en_US/AVRADCSetup.xml b/help/en_US/AVRADCSetup.xml
new file mode 100644
index 0000000..a0abf03
--- /dev/null
+++ b/help/en_US/AVRADCSetup.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from AVRADCSetup.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="AVRADCSetup" 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>AVRADCSetup</refname>
+ <refpurpose>Function to initialise ADC of AVR</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ AVRADCSetup(uint8 prescaler, uint8 adc_ref)
+
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>prescaler:</term>
+ <listitem><para> prescaler to be used for generating ADC clock (0-7)</para></listitem></varlistentry>
+ <varlistentry><term>adc_ref :</term>
+ <listitem><para> reference voltage to be used for ADC conversion</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function initialises ADc of AVR with given parameters. 'prescaler' is needed for deciding ADC clock. ADC clock should be between 50KHz and 200KHz and it given as (MCU clock/2^prescaler). Select appropriate prescaler depending on MCU clock. 'adc_ref' selects one of the available reference voltage sources available.
+ </para>
+ <para>
+The adc_ref can take the following values-
+<itemizedlist>
+<listitem><para>0 -> Voltage on VREF pin</para></listitem>
+<listitem><para>1 -> Voltage on AVCC pin</para></listitem>
+<listitem><para>2 -> Internal 2.56 reference voltage</para></listitem>
+</itemizedlist>
+ </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[
+AVRADCSetup(128,0)
+ ]]></programlisting>
+</refsection>
+
+<refsection>
+ <title>See also</title>
+ <simplelist type="inline">
+ <member><link linkend="AVRReadADC">AVRReadADC</link></member>
+ </simplelist>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Siddhesh Wani</member>
+ <member>Ashish Kamble</member>
+ </simplelist>
+</refsection>
+</refentry>