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.

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