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.

69 lines
3.4 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
  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. ## Features
  15. #### Supports Arduino Client interface
  16. This library is very easy to integrate with lots of sketches, which used Ethernet or WiFi previously.
  17. Examples for **Blynk**, **MQTT**, **Web Client** and **File Download** are provided.
  18. ![examples](/extras/examples.png)
  19. #### Tiny
  20. WebClient example for Arduino Nano (with Software Serial) takes little resources:
  21. ```
  22. Sketch uses 11,916 bytes (38%) of program storage space. Maximum is 30,720 bytes.
  23. Global variables use 649 bytes (31%) of dynamic memory. Maximum is 2,048 bytes.
  24. ```
  25. Now, you have more space for your experiments.
  26. #### Supported modules:
  27. SIM800, SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868,
  28. SIM900, SIM900A, SIM900D, SIM908, SIM968
  29. More modules (SIM5320, SIM5216, A6, A6C, A7, M590, MG2639) may be supported later. Contributions are welcome!
  30. #### Uses internal modem buffer for receive
  31. TinyGSM pulls data gently from the modem, so it can operate on very little RAM.
  32. ## Getting started
  33. 1. Using your phone:
  34. - Disable PIN code on the SIM card
  35. - Check your ballance
  36. - Check that APN,User,Pass are correct and you have internet
  37. 2. Ensure the SIM card is correctly inserted into the module
  38. 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)
  39. 4. Check if serial connection is working (Hardware Serial is recommended)
  40. Send an ```AT``` command using [this sketch](tools/AT_Debug/AT_Debug.ino)
  41. 5. Check if GSM antenna is attached
  42. ## Troubleshooting
  43. Sometimes (especially if you played with AT comands), your module configuration may become invalid.
  44. This may result in problems such as:
  45. * Can't connect to the GPRS network
  46. * Can't connect to the server
  47. * Sent/recieved data contains invalid bytes
  48. * etc.
  49. To return module to **Factory Defaults**, use this sketch:
  50. File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
  51. __________
  52. ### License
  53. This project is released under
  54. The GNU Lesser General Public License (LGPL-3.0)