📄 avrgsm__api_8c.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>AVR323 Interfacing GSM modems: AVRGSM_api.c File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.7 --><div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>AVRGSM_FILES/AVRGSM_api.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>Atmel Corporation<p><ul><li>File : AVR_api.c</li><li>Compiler : IAR EWAAVR 4.11a</li></ul><p><ul><li>Support mail : <a href="mailto:avr@atmel.com">avr@atmel.com</a></li></ul><p><ul><li>Supported devices : All devices with a UART/USART can be used. The example is written for ATmega128</li></ul><p><ul><li>AppNote : AVR323 - Interfacing GSM modems</li></ul><p><ul><li>Description : Example of how to use AT-Commands to control a GSM modem</li></ul><p><dl compact><dt><b>Revision</b></dt><dd>1.2 </dd></dl><dl compact><dt><b>Date</b></dt><dd>Wednesday, January 26, 2005 10:43:44 UTC </dd></dl><p>Definition in file <a class="el" href="AVRGSM__api_8c-source.html">AVRGSM_api.c</a>.<p><code>#include <inavr.h></code><br><code>#include "<a class="el" href="AVRGSM__com_8h-source.html">AVRGSM_com.h</a>"</code><br><code>#include "<a class="el" href="AVRGSM__zip_8h-source.html">AVRGSM_zip.h</a>"</code><br><code>#include "<a class="el" href="AVRGSM__header_8h-source.html">AVRGSM_header.h</a>"</code><br><code>#include "<a class="el" href="AVRGSM__tools_8h-source.html">AVRGSM_tools.h</a>"</code><br><code>#include "<a class="el" href="AVRGSM__api_8h-source.html">AVRGSM_api.h</a>"</code><br><p>Include dependency graph for AVRGSM_api.c:<p><center><img src="AVRGSM__api_8c__incl.png" border="0" usemap="#AVRGSM_api.c_map" alt="Include dependency graph"></center><map name="AVRGSM_api.c_map"><area href="AVRGSM__com_8h.html" shape="rect" coords="92,7,218,34" alt=""><area href="AVRGSM__zip_8h.html" shape="rect" coords="242,7,356,34" alt=""><area href="AVRGSM__header_8h.html" shape="rect" coords="380,7,519,34" alt=""><area href="AVRGSM__tools_8h.html" shape="rect" coords="543,7,671,34" alt=""><area href="AVRGSM__api_8h.html" shape="rect" coords="695,7,812,34" alt=""></map><p><a href="AVRGSM__api_8c-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a9">API_check_acknowledge</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Function prototype. <a href="#a9"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a11">API_deletemsg</a> (int <a class="el" href="STATE__functions_8c.html#a0">index</a>)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a message from a given index. <a href="#a11"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a10">API_modem_init</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Used to setup the connected GSM modem. <a href="#a10"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a13">API_readmsg</a> (int ind)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Read message from a given index. <a href="#a13"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a12">API_sendmsg</a> (unsigned char *msg)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Send message. <a href="#a12"></a><br><br></td></tr><tr><td colspan=2><br><h2>Variables</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a5">AT_CMGD</a> [] = "AT+CMGD="</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Delete message at index. <a href="#a5"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a6">AT_CMGR</a> [] = "AT+CMGR="</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Read from index. <a href="#a6"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a7">AT_CMGS</a> [] = "AT+CMGS="</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Send mmessage. <a href="#a7"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a3">AT_CNMI</a> [] = "AT+CNMI=1,1,,,1\r\n"</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Identification of new sms. <a href="#a3"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a4">AT_CPMS</a> [] = "AT+CPMS=\"ME\",\"ME\",\"ME\"\r\n"</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Preferred storage. <a href="#a4"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a2">ATE0</a> [] = "ATE0\r\n"</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Echo off. <a href="#a2"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char __flash </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a8">CRLF</a> [] = "\r\n"</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Carrige return Line feed. <a href="#a8"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>unsigned char </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a1">msgbuff</a> [161]</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Message buffer for coded and decoded messages. <a href="#a1"></a><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="AVRGSM__api_8c.html#a0">rx_ack</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Extern flag from AVRSMS_com.c. <a href="#a0"></a><br><br></td></tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="a9" doxytag="AVRGSM_api.c::API_check_acknowledge" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int API_check_acknowledge </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Function prototype. <p>This function is very important. It checks if an acknowledge has been received from the phone. A counting loop is also included to avoid waiting for a acknowledge that never arrives.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>void</em> </td><td></td></tr> </table></dl><dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>1</em> </td><td>Success, correct acknowledge </td></tr> <tr><td></td><td valign=top><em>0</em> </td><td>Error, returned "ERROR" or timed out</td></tr> </table></dl><p>Local variables <p>Definition at line <a class="el" href="AVRGSM__api_8c-source.html#l00278">278</a> of file <a class="el" href="AVRGSM__api_8c-source.html">AVRGSM_api.c</a>.<p>References <a class="el" href="AVRGSM__com_8c-source.html#l00114">COM_rx_off()</a>, <a class="el" href="AVRGSM__com_8c-source.html#l00085">COM_rx_reset()</a>, and <a class="el" href="AVRGSM__api_8c-source.html#l00039">rx_ack</a>.<p>Referenced by <a class="el" href="AVRGSM__api_8c-source.html#l00125">API_deletemsg()</a>, <a class="el" href="AVRGSM__api_8c-source.html#l00073">API_modem_init()</a>, <a class="el" href="AVRGSM__api_8c-source.html#l00232">API_readmsg()</a>, and <a class="el" href="AVRGSM__api_8c-source.html#l00160">API_sendmsg()</a>.<p><pre class="fragment"><div>00279 {00280 00282 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i, ii;00283 00284 <span class="keywordflow">for</span>( i = 0; ( <a class="code" href="AVRGSM__api_8c.html#a0">rx_ack</a> == 0 ) && ( i < 65535 ); i++ ) <span class="comment">//Wait loop</span>00285 {00286 <span class="keywordflow">for</span>( ii = 0; ii < 10; ii++ )00287 {00288 ;00289 }00290 }00291 00292 <span class="keywordflow">if</span>( <a class="code" href="AVRGSM__api_8c.html#a0">rx_ack</a> > 0 ) <span class="comment">//Everything worked out fine...rx turned off</span>00293 {00294 <a class="code" href="AVRGSM__api_8c.html#a0">rx_ack</a> = 0; <span class="comment">//Reset flag</span>00295 <span class="keywordflow">return</span> 1;00296 }00297 00298 <span class="keywordflow">else</span> <span class="comment">//A timeout could result from no acknowledge, wrong acknowledge or buffer overrun</span>00299 {00300 <a class="code" href="AVRGSM__com_8c.html#a15">COM_rx_off</a>( ); <span class="comment">//Receiver off</span>00301 <a class="code" href="AVRGSM__com_8c.html#a13">COM_rx_reset</a>( ); <span class="comment">//Reset buffer and interrupt routine</span>00302 <span class="keywordflow">return</span> 0; <span class="comment">//Timed out, or wrong acknowledge from phone</span>00303 }00304 }</div></pre><p>Here is the call graph for this function:<p><center><img src="AVRGSM__api_8c_a9_cgraph.png" border="0" usemap="#AVRGSM__api_8c_a9_cgraph_map" alt=""></center><map name="AVRGSM__api_8c_a9_cgraph_map"><area href="AVRGSM__com_8c.html#a15" shape="rect" coords="236,7,329,34" alt=""><area href="AVRGSM__com_8c.html#a13" shape="rect" coords="228,58,337,84" alt=""></map> </td> </tr></table><a class="anchor" name="a11" doxytag="AVRGSM_api.c::API_deletemsg" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int API_deletemsg </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>index</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Delete a message from a given index. <p>This function will use the "AT+CMGD" command to delete the message @ index<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>index</em> </td><td>index to delete from</td></tr> </table></dl><dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>1</em> </td><td>Success </td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -