diff options
Diffstat (limited to 'help/en_US/AVRUARTSetup.xml')
-rw-r--r-- | help/en_US/AVRUARTSetup.xml | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/help/en_US/AVRUARTSetup.xml b/help/en_US/AVRUARTSetup.xml new file mode 100644 index 0000000..043e265 --- /dev/null +++ b/help/en_US/AVRUARTSetup.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from AVRUARTSetup.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="AVRUARTSetup" 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>AVRUARTSetup</refname> + <refpurpose>Function to Setup Serial Communication i.e UART or USART in ATmega16.</refpurpose> + </refnamediv> + + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>mode :</term> + <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> + <varlistentry><term>baudrate :</term> + <listitem><para> Enter one of the following available baudrates (2400 , 4800 , 9600 , 14400 , 19200 , 28800 , 38400 , 57600 , 768000 , 115200 , 230400 , 250000 , 1000000)</para></listitem></varlistentry> + <varlistentry><term>stopbits :</term> + <listitem><para> integer, (0 for one stopbit) or (1 for two stopbits)</para></listitem></varlistentry> + <varlistentry><term>parity :</term> + <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This function Setup the UART or USART for Serial Communicaion between ATmega16 +and different micro controllers or between ATmega16 and Computer. + </para> + <para> +mode can take values: +<itemizedlist> +<listitem><para>0 for Asynchronous Normal mode</para></listitem> +<listitem><para>1 for Asynchronous Double Speed mode</para></listitem> +<listitem><para>2 for Synchronous mode</para></listitem> +</itemizedlist> + </para> + <para> +parity can take values: +<itemizedlist> +<listitem><para>0 for parity disabled</para></listitem> +<listitem><para>1 for even parity</para></listitem> +<listitem><para>2 for odd parity</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[ +AVRUARTSetup(0,9600,0,0); //This function will enable UART Communication for ATmega16 +with 9600 as baudrate,one stop bit and parity disabled + ]]></programlisting> +</refsection> + +<refsection> + <title>See also</title> + <simplelist type="inline"> + <member><link linkend="AVRUARTTransmit">AVRUARTTransmit</link></member> + <member><link linkend="AVRUARTReceive">AVRUARTReceive</link></member> + </simplelist> +</refsection> + +<refsection> + <title>Authors</title> + <simplelist type="vert"> + <member>Ashish Kamble</member> + </simplelist> +</refsection> +</refentry> |