70 lines
3.0 KiB
Markdown
70 lines
3.0 KiB
Markdown
```
|
|
_______ _____ __ _ __ __ ______ _______ _______
|
|
| | | \ | \_/ | ____ |______ | | |
|
|
| __|__ | \_| | |_____| ______| | | |
|
|
|
|
```
|
|
|
|
A small Arduino library for GPRS modules, that just works.
|
|
<!---
|
|
[](https://github.com/vshymanskyy/TinyGSM/releases/latest)
|
|
[](https://github.com/vshymanskyy/TinyGSM/stargazers)
|
|
--->
|
|
[](https://github.com/vshymanskyy/TinyGSM/releases/latest)
|
|
[](https://github.com/vshymanskyy/TinyGSM/issues)
|
|
[](https://github.com/vshymanskyy/TinyGSM/blob/master/LICENSE)
|
|
|
|
Currently only SIM800/SIM900 are tested, more modules may be supported later.
|
|
|
|
If you like TinyGSM - give it a star, or fork it and contribute!
|
|
[](https://github.com/vshymanskyy/TinyGSM/stargazers)
|
|
[](https://github.com/vshymanskyy/TinyGSM/network)
|
|
|
|
## Features
|
|
|
|
#### Supports Arduino Client interface
|
|
This library is very easy to integrate with lots of sketches, which used Ethernet or WiFi previously.
|
|
Examples for **Blynk**, **MQTT**, **Web Client** and **File Download** are provided.
|
|
|
|
#### Tiny
|
|
WebClient example for Arduino Nano (with Software Serial) takes little resources:
|
|
```
|
|
Sketch uses 11,916 bytes (38%) of program storage space. Maximum is 30,720 bytes.
|
|
Global variables use 649 bytes (31%) of dynamic memory. Maximum is 2,048 bytes.
|
|
```
|
|
Now, you have more space for your experiments.
|
|
|
|
#### Uses internal modem buffer for receive
|
|
TinyGSM pulls data gently from the modem, so it can operate on very little RAM.
|
|
|
|
## Getting started
|
|
|
|
1. Using your phone:
|
|
- Disable PIN code on the SIM card
|
|
- Check your ballance
|
|
- Check that APN,User,Pass are correct and you have internet
|
|
2. Ensure the SIM card is correctly inserted into the module
|
|
3. Provide a good, stable power supply (up to 2A, 4.0-4.2V or 5V according to your module documentation)
|
|
4. Provide good, stable serial connection
|
|
(Hardware Serial is recommended)
|
|
5. Check if GSM antenna is attached
|
|
|
|
## Troubleshooting
|
|
|
|
Sometimes (especially if you played with AT comands), your module configuration may become invalid.
|
|
This may result in problems such as:
|
|
|
|
* Can't connect to the GPRS network
|
|
* Can't connect to the server
|
|
* Sent/recieved data contains invalid bytes
|
|
* etc.
|
|
|
|
To return module to **Factory Defaults**, use this sketch:
|
|
File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
|
|
|
|
__________
|
|
|
|
### License
|
|
This project is released under
|
|
The GNU Lesser General Public License (LGPL-3.0)
|