-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
194 lines (192 loc) · 11.1 KB
/
index.html
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SIM900: SIM900 Library Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SIM900
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
searchBox.OnSearchSelectShow()"
searchBox.OnSearchSelectHide()"
searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">SIM900 Library Overview </div></div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><ul><li class="level2"><a href="#autotoc_md0">Features</a></li>
<li class="level2"><a href="#autotoc_md1">Getting Started</a><ul><li class="level3"><a href="#autotoc_md2">Installation</a></li>
<li class="level3"><a href="#autotoc_md3">Hardware Setup</a></li>
</ul>
</li>
<li class="level2"><a href="#autotoc_md4">Usage</a></li>
<li class="level2"><a href="#autotoc_md5">Examples</a></li>
<li class="level2"><a href="#autotoc_md6">Contribution and Feedback</a></li>
<li class="level2"><a href="#autotoc_md7">Credits</a></li>
<li class="level2"><a href="#autotoc_md8">TODO</a></li>
<li class="level2"><a href="#autotoc_md9">License</a></li>
</ul>
</ul>
</div>
<div class="textblock"><p ><img src="https://github.com/nthnn/SIM900/actions/workflows/arduino_ci.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/SIM900/actions/workflows/arduino_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-1.1.0-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/SIM900/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-LGPL3.0-yellow.svg" alt="License: LGPL3.0" style="pointer-events: none;" class="inline"/></a></p>
<p >The SIM900 Arduino Shield Library is a versatile and powerful Arduino library for interfacing with the SIM900 GSM/GPRS module. This library provides a wide range of functionalities for working with the SIM900 module, including sending and receiving calls, sending and receiving SMS, updating and extracting real-time clock data, sending HTTP requests, and retrieving various information about the SIM900 module's status and the network it is connected to.</p>
<table align="center">
<tr>
<td align="center">SIM900 Arduino Shield </td><td align="center">SIM900 Vector </td></tr>
<tr>
<td><img src="sim900-shield.png" alt="" height="350" class="inline"/> </td><td><img src="sim900-vector.png" alt="" height="350" class="inline"/> </td></tr>
</table>
<blockquote class="doxtable">
<p >‍<b>Note:</b> The <code><a class="el" href="classSIM900.html#afbebb9f4a6fcb1dcd769b387e96ae540" title="Send an HTTP request to a remote server.">SIM900::request(SIM900HTTPRequest)</a></code> function is still underdevelopment. </p>
</blockquote>
<h2><a class="anchor" id="autotoc_md0"></a>
Features</h2>
<ul>
<li><b>Call Handling</b>: Make and receive calls with ease.</li>
<li><b>SMS Communication</b>: Send and receive SMS messages effortlessly.</li>
<li><b>Real-Time Clock</b>: Update and extract real-time clock data from the module.</li>
<li><b>HTTP Requests</b>: Send HTTP requests and retrieve responses.</li>
<li><b>Information Retrieval</b>: Gather data about network operator, module status, SIM card information, and more.</li>
<li><b>Phonebook Management</b>: Store and retrieve phonebook accounts.</li>
<li><b>Extensive Documentation</b>: Well-documented code and usage examples.</li>
</ul>
<h2><a class="anchor" id="autotoc_md1"></a>
Getting Started</h2>
<h3><a class="anchor" id="autotoc_md2"></a>
Installation</h3>
<p >To use this library, follow these steps:</p>
<ol type="1">
<li>Download the library from the GitHub <a href="https://github.com/nthnn/SIM900">repository</a>.</li>
<li>Open your Arduino IDE.</li>
<li>Click on <code>Sketch</code> -> <code>Include Library</code> -> <code>Add .ZIP Library...</code></li>
<li>Select the downloaded library ZIP file.</li>
</ol>
<p >Alternatively, you can click on the <code>Library Manager</code> then type "SIM900" to install this library for your projects.</p>
<h3><a class="anchor" id="autotoc_md3"></a>
Hardware Setup</h3>
<p >Make sure you have the following components:</p>
<ul>
<li>Arduino board compatible with the SIM900 Shield.</li>
<li>SIM900 Shield with a SIM card inserted.</li>
<li>3V CR1220 coin battery for RTC (optional).</li>
</ul>
<p >Connect the SIM900 Shield to your Arduino board, ensuring it's properly powered and connected. Refer to your hardware documentation for detailed instructions on connecting the module.</p>
<h2><a class="anchor" id="autotoc_md4"></a>
Usage</h2>
<p >To use the SIM900 module in your Arduino sketch:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <SoftwareSerial.h></span></div>
<div class="line"><span class="preprocessor">#include <sim900.h></span></div>
<div class="line"> </div>
<div class="line">SoftwareSerial shieldSerial(7, 8); <span class="comment">//RX and TX</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup() {</div>
<div class="line"> Serial.begin(9600); <span class="comment">// Initialize serial communication</span></div>
<div class="line"> <a class="code hl_class" href="classSIM900.html">SIM900</a> sim900(&shieldSerial); <span class="comment">// Initialize the SIM900 shield</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Your code goes here...</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> loop() { }</div>
<div class="ttc" id="aclassSIM900_html"><div class="ttname"><a href="classSIM900.html">SIM900</a></div><div class="ttdoc">A class for interfacing with the SIM900 GSM/GPRS module using Arduino and SoftwareSerial.</div><div class="ttdef"><b>Definition:</b> <a href="sim900_8h_source.html#l00041">sim900.h:41</a></div></div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md5"></a>
Examples</h2>
<p >The repository includes a variety of example sketches that demonstrate the library's features. You can find them in the <a href="https://github.com/nthnn/SIM900/tree/main/examples">examples</a> folder.</p>
<h2><a class="anchor" id="autotoc_md6"></a>
Contribution and Feedback</h2>
<p >Contributions and feedback are all welcome to enhance this library. If you encounter any issues, have suggestions for improvements, or would like to contribute code, please do so.</p>
<h2><a class="anchor" id="autotoc_md7"></a>
Credits</h2>
<ul>
<li>The SIM900 vector image above was from a <a href="https://fritzing.org">Fritzing</a> part, found at <a href="https://forum.fritzing.org/t/sim900-part-request/17688">https://forum.fritzing.org/t/sim900-part-request/17688</a>.</li>
</ul>
<h2><a class="anchor" id="autotoc_md8"></a>
TODO</h2>
<ol type="1">
<li>Receiving, listing, dumping, deleting, and setting the preferred message storage.</li>
<li>Functional HTTP requesting.</li>
</ol>
<h2><a class="anchor" id="autotoc_md9"></a>
License</h2>
<p >Copyright 2023 - Nathanne Isip</p>
<p >Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p >The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p >THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="footer">Copyright 2023 - <a href="https://github.com/nthnn" target="_blank">Nathanne Isip</a></li>
</ul>
</div>