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.

107 lines
5.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
7 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
7 years ago
8 years ago
8 years ago
7 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
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
  1. ![TinyGSM logo](https://cdn.rawgit.com/vshymanskyy/TinyGSM/d18e93dc51fe988a0b175aac647185457ef640b5/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 version](https://img.shields.io/github/release/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/releases/latest)
  6. [![Build status](https://img.shields.io/travis/vshymanskyy/TinyGSM.svg)](https://travis-ci.org/vshymanskyy/TinyGSM)
  7. [![GitHub issues](https://img.shields.io/github/issues/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/issues)
  8. [![GitHub wiki](https://img.shields.io/badge/Wiki-available-brightgreen.svg)](https://github.com/vshymanskyy/TinyGSM/wiki)
  9. [![GitHub stars](https://img.shields.io/github/stars/vshymanskyy/TinyGSM.svg)](https://github.com/vshymanskyy/TinyGSM/stargazers)
  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. You can also join our chat:
  15. [![Gitter](https://img.shields.io/gitter/room/vshymanskyy/TinyGSM.svg)](https://gitter.im/tinygsm)
  16. ### Arduino Client interface support
  17. This library is easy to integrate with lots of sketches, which use Ethernet or WiFi.
  18. Examples for **PubSubClient ([MQTT](http://mqtt.org/))**, **[Blynk](http://blynk.cc)**, **Web Client** and **File Download** are provided.
  19. ![examples](/extras/examples.png)
  20. ### TinyGSM is tiny
  21. The complete WebClient example for Arduino Uno (via Software Serial) takes little resources:
  22. ```
  23. Sketch uses 14094 bytes (43%) of program storage space. Maximum is 32256 bytes.
  24. Global variables use 625 bytes (30%) of dynamic memory, leaving 1423 bytes for local variables. Maximum is 2048 bytes.
  25. ```
  26. Arduino GSM library uses 15868 bytes (49%) of Flash and 1113 bytes (54%) of RAM in a similar scenario.
  27. TinyGSM also pulls data gently from the modem (whenever possible), so it can operate on very little RAM.
  28. **Now, you have more space for your experiments.**
  29. ### Supported modem models
  30. - [x] SIMCom SIM800 series (SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868)
  31. - [x] SIMCom SIM900 series (SIM900A, SIM900D, SIM908, SIM968)
  32. - [x] AI-Thinker A6, A6C, A7
  33. - [x] Neoway M590
  34. - [x] ESP8266 (AT commands interface, similar to GSM modems)
  35. ### Supported modules
  36. - [x] GPRSbee
  37. - [x] Microduino GSM
  38. - [x] Adafruit FONA (Mini Cellular GSM Breakout)
  39. - [x] Adafruit FONA 800/808 Shield
  40. - [x] ... other modules based on supported modems
  41. More modems may be supported later:
  42. - [ ] Hi-Link HLK-RM04
  43. - [ ] Quectel M10, M95, UG95
  44. - [ ] SIMCom SIM5320, SIM5216
  45. - [ ] Telit GL865
  46. - [ ] ZTE MG2639
  47. Watch this repo for new updates! And of course, contributions are welcome ;)
  48. ## Getting Started
  49. 1. Using your phone:
  50. - Disable PIN code on the SIM card
  51. - Check your ballance
  52. - Check that APN,User,Pass are correct and you have internet
  53. 2. Ensure the SIM card is correctly inserted into the module
  54. 3. Provide a good, [stable power supply](https://github.com/vshymanskyy/TinyGSM/wiki/Powering-GSM-module) (up to 2A and specific voltage according to your module documentation)
  55. 4. Check if serial connection is working (Hardware Serial is recommended)
  56. Send an ```AT``` command using [this sketch](tools/AT_Debug/AT_Debug.ino)
  57. 5. Check if GSM antenna is attached
  58. ## How does it work?
  59. Many GSM modems, WiFi and radio modules can be controlled by sending AT commands over Serial.
  60. TinyGSM knows which commands to send, and how to handle AT responses, and wraps that into standard Arduino Client interface.
  61. ## Troubleshooting
  62. ### SoftwareSerial problems
  63. When using ```SoftwareSerial``` (on Uno, Nano, etc), the speed **115200** may not work.
  64. Try selecting **57600**, **38400**, or even lower - the one that works best for you.
  65. Be sure to set correct TX/RX pins in the sketch. Please note that not every Arduino pin can serve as TX or RX pin.
  66. **Read more about SoftSerial options and configuration [here](https://www.pjrc.com/teensy/td_libs_AltSoftSerial.html) and [here](https://www.arduino.cc/en/Reference/SoftwareSerial).**
  67. ### Diagnostics sketch
  68. Use this sketch to diagnose your SIM card and GPRS connection:
  69. File -> Examples -> TynyGSM -> tools -> [Diagnostics](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/Diagnostics/Diagnostics.ino)
  70. ### Broken initial configuration
  71. Sometimes (especially if you played with AT comands), your module configuration may become invalid.
  72. This may result in problems such as:
  73. * Can't connect to the GPRS network
  74. * Can't connect to the server
  75. * Sent/recieved data contains invalid bytes
  76. * etc.
  77. To return module to **Factory Defaults**, use this sketch:
  78. File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
  79. __________
  80. ### License
  81. This project is released under
  82. The GNU Lesser General Public License (LGPL-3.0)