summaryrefslogtreecommitdiff
path: root/2.3-1/help/en_US/AVRUARTSetup.xml
blob: 043e2652cc9744324b306b1d890527ffa0165c76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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>