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.

76 lines
3.6 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
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/ffac7710ec93ec36648ec336b08a5856dcba6154/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. If you like **TinyGSM** - give it a star, or fork it and contribute!
  12. [![GitHub stars](https://img.shields.io/github/stars/vshymanskyy/TinyGSM.svg?style=social&label=Star)](https://github.com/vshymanskyy/TinyGSM/stargazers)
  13. [![GitHub forks](https://img.shields.io/github/forks/vshymanskyy/TinyGSM.svg?style=social&label=Fork)](https://github.com/vshymanskyy/TinyGSM/network)
  14. ### Arduino Client interface support
  15. This library is easy to integrate with lots of sketches, which use Ethernet or WiFi.
  16. Examples for **PubSubClient ([MQTT](http://mqtt.org/))**, **[Blynk](http://blynk.cc)**, **Web Client** and **File Download** are provided.
  17. ![examples](/extras/examples.png)
  18. ### TinyGSM is tiny
  19. WebClient example for Arduino Nano (with Software Serial) takes little resources:
  20. ```
  21. Sketch uses 11,916 bytes (38%) of program storage space. Maximum is 30,720 bytes.
  22. Global variables use 649 bytes (31%) of dynamic memory. Maximum is 2,048 bytes.
  23. ```
  24. Now, you have more space for your experiments.
  25. ### Supported modules
  26. - [x] SIMCom SIM800, SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868
  27. - [x] SIMCom SIM900, SIM900A, SIM900D, SIM908, SIM968
  28. More modules may be supported later:
  29. - [ ] SIMCom SIM5320, SIM5216
  30. - [ ] AI-Thinker A6, A6C, A7
  31. - [ ] Quectel M10, M95, UG95
  32. - [ ] Neoway M590
  33. - [ ] ZTE MG2639
  34. Watch this repo for new updates! And of course, contributions are welcome ;)
  35. ### Uses internal modem buffer for receive
  36. TinyGSM pulls data gently from the modem (whenever possible), so it can operate on very little RAM.
  37. ## Getting Started
  38. 1. Using your phone:
  39. - Disable PIN code on the SIM card
  40. - Check your ballance
  41. - Check that APN,User,Pass are correct and you have internet
  42. 2. Ensure the SIM card is correctly inserted into the module
  43. 3. Provide a good, [stable power supply](https://github.com/vshymanskyy/TinyGSM/wiki/Powering-GSM-module) (up to 2A, 4.0-4.2V or 5V according to your module documentation)
  44. 4. Check if serial connection is working (Hardware Serial is recommended)
  45. Send an ```AT``` command using [this sketch](tools/AT_Debug/AT_Debug.ino)
  46. 5. Check if GSM antenna is attached
  47. ## Troubleshooting
  48. Sometimes (especially if you played with AT comands), your module configuration may become invalid.
  49. This may result in problems such as:
  50. * Can't connect to the GPRS network
  51. * Can't connect to the server
  52. * Sent/recieved data contains invalid bytes
  53. * etc.
  54. To return module to **Factory Defaults**, use this sketch:
  55. File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
  56. __________
  57. ### License
  58. This project is released under
  59. The GNU Lesser General Public License (LGPL-3.0)