summaryrefslogtreecommitdiff
path: root/2.3-1/help/en_US/AVRGetTimerValue.xml
diff options
context:
space:
mode:
authorSiddhesh Wani2017-06-30 14:10:45 +0530
committerGitHub2017-06-30 14:10:45 +0530
commitec7b617027e145730e028727bd74afb323f495af (patch)
tree798ae26a88891509424f8ade489b87cbf2af2093 /2.3-1/help/en_US/AVRGetTimerValue.xml
parentf805bc9553b3d88d7c9e7dbf59486c5da490231e (diff)
parent4c6f1a8cced5610ab5075ea61c507c1dbc25f520 (diff)
downloadScilab2C-ec7b617027e145730e028727bd74afb323f495af.tar.gz
Scilab2C-ec7b617027e145730e028727bd74afb323f495af.tar.bz2
Scilab2C-ec7b617027e145730e028727bd74afb323f495af.zip
Merge pull request #12 from jschandi/master
Help files and modified Raspberry Pi code conversion
Diffstat (limited to '2.3-1/help/en_US/AVRGetTimerValue.xml')
-rw-r--r--2.3-1/help/en_US/AVRGetTimerValue.xml73
1 files changed, 73 insertions, 0 deletions
diff --git a/2.3-1/help/en_US/AVRGetTimerValue.xml b/2.3-1/help/en_US/AVRGetTimerValue.xml
new file mode 100644
index 00000000..f639c60d
--- /dev/null
+++ b/2.3-1/help/en_US/AVRGetTimerValue.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from AVRGetTimerValue.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="AVRGetTimerValue" 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>AVRGetTimerValue</refname>
+ <refpurpose>Function to get timer count</refpurpose>
+ </refnamediv>
+
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>timer :</term>
+ <listitem><para> timer whose current count is to be returned</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function returns the count value of a desired timer.By knowing the count value certain interrupt action can be taken.
+ </para>
+ <para>
+Timer can take the following values
+<itemizedlist>
+<listitem><para>0 -> for timer0</para></listitem>
+<listitem><para>1 -> for timer1</para></listitem>
+<listitem><para>2 -> for timer2</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[
+AVRGetTimerValue(0); //returns present count of the TCNT0 counter
+ ]]></programlisting>
+</refsection>
+
+<refsection>
+ <title>See also</title>
+ <simplelist type="inline">
+ <member><link linkend="AVRTimerSetup">AVRTimerSetup</link></member>
+ </simplelist>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Ashish Kamble</member>
+ </simplelist>
+</refsection>
+</refentry>