You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

68 lines
3.3 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. ![TinyGSM logo](https://cdn.rawgit.com/vshymanskyy/TinyGSM/master/extras/logo.svg)
  2. A small Arduino library for GSM modules, that just works.
  3. <!---
  4. [![GitHub download](https://img.shields.io/github/downloads/vshymanskyy/TinyGSM/total.svg)](https://github.com/vshymanskyy/TinyGSM/releases/latest)
  5. [![GitHub stars](https://img.shields.io/github/stars/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/stargazers)
  6. --->
  7. [![GitHub version](https://img.shields.io/github/release/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/releases/latest)
  8. [![GitHub issues](https://img.shields.io/github/issues/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/issues)
  9. [![GitHub wiki](https://img.shields.io/badge/Wiki-available-brightgreen.svg)](https://github.com/vshymanskyy/TinyGSM/wiki)
  10. [![License](https://img.shields.io/badge/license-LGPL3-blue.svg)](https://github.com/vshymanskyy/TinyGSM/blob/master/LICENSE)
  11. Supported modules:
  12. **SIM800, SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868,
  13. SIM900, SIM900A, SIM900D, SIM908, SIM968**
  14. More modules (SIM5320, SIM5216, A6, A6C, A7, M590, MG2639) may be supported later. Contributions are welcome!
  15. If you like **TinyGSM** - give it a star, or fork it and contribute!
  16. [![GitHub stars](https://img.shields.io/github/stars/vshymanskyy/TinyGSM.svg?style=social&label=Star)](https://github.com/vshymanskyy/TinyGSM/stargazers)
  17. [![GitHub forks](https://img.shields.io/github/forks/vshymanskyy/TinyGSM.svg?style=social&label=Fork)](https://github.com/vshymanskyy/TinyGSM/network)
  18. ## Features
  19. #### Supports Arduino Client interface
  20. This library is very easy to integrate with lots of sketches, which used Ethernet or WiFi previously.
  21. Examples for **Blynk**, **MQTT**, **Web Client** and **File Download** are provided.
  22. #### Tiny
  23. WebClient example for Arduino Nano (with Software Serial) takes little resources:
  24. ```
  25. Sketch uses 11,916 bytes (38%) of program storage space. Maximum is 30,720 bytes.
  26. Global variables use 649 bytes (31%) of dynamic memory. Maximum is 2,048 bytes.
  27. ```
  28. Now, you have more space for your experiments.
  29. #### Uses internal modem buffer for receive
  30. TinyGSM pulls data gently from the modem, so it can operate on very little RAM.
  31. ## Getting started
  32. 1. Using your phone:
  33. - Disable PIN code on the SIM card
  34. - Check your ballance
  35. - Check that APN,User,Pass are correct and you have internet
  36. 2. Ensure the SIM card is correctly inserted into the module
  37. 3. Provide a good, [stable power supply](wiki/Powering-GSM-module) (up to 2A, 4.0-4.2V or 5V according to your module documentation)
  38. 4. Check if serial connection is working (Hardware Serial is recommended)
  39. Send an ```AT``` command using [this sketch](tools/AT_Debug/AT_Debug.ino)
  40. 5. Check if GSM antenna is attached
  41. ## Troubleshooting
  42. Sometimes (especially if you played with AT comands), your module configuration may become invalid.
  43. This may result in problems such as:
  44. * Can't connect to the GPRS network
  45. * Can't connect to the server
  46. * Sent/recieved data contains invalid bytes
  47. * etc.
  48. To return module to **Factory Defaults**, use this sketch:
  49. File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
  50. __________
  51. ### License
  52. This project is released under
  53. The GNU Lesser General Public License (LGPL-3.0)