summaryrefslogtreecommitdiff
path: root/2.3-1/help/en_US/AVRDigitalIn.xml
diff options
context:
space:
mode:
Diffstat (limited to '2.3-1/help/en_US/AVRDigitalIn.xml')
-rw-r--r--2.3-1/help/en_US/AVRDigitalIn.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/2.3-1/help/en_US/AVRDigitalIn.xml b/2.3-1/help/en_US/AVRDigitalIn.xml
new file mode 100644
index 00000000..ef87407c
--- /dev/null
+++ b/2.3-1/help/en_US/AVRDigitalIn.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from AVRDigitalIn.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="AVRDigitalIn" 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>AVRDigitalIn</refname>
+ <refpurpose>Function to get state (high\low) of a digital input pin on AVR</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ state=AVRDigitalIn(port,pin)
+
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>port :</term>
+ <listitem><para> port of microcontroller to be used</para></listitem></varlistentry>
+ <varlistentry><term>pin :</term>
+ <listitem><para> pin of port (mentioned above) to be used</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+Each AVR microcontroller has pins which can be configured as digital
+inputs. These are normally divided among some 'ports' (group of pins).
+User has to select one of these port and which pin of that port as
+digital input.
+ </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[
+pinA0 = AVRDigitalIn(1,0) //To read state on pin 0 of port A
+ ]]></programlisting>
+</refsection>
+
+<refsection>
+ <title>See also</title>
+ <simplelist type="inline">
+ <member><link linkend="AVRDigitalOut">AVRDigitalSetup</link></member>
+ </simplelist>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Siddhesh Wani</member>
+ <member>Ashish Kamble</member>
+ </simplelist>
+</refsection>
+</refentry>