/TinyGSM

A small Arduino library for GSM modules, that just works

Primary LanguageC++GNU Lesser General Public License v3.0LGPL-3.0

TinyGSM logo

A small Arduino library for GSM modules, that just works.

GitHub version Build status GitHub issues GitHub wiki GitHub stars License

If you like TinyGSM - give it a star, or fork it and contribute! GitHub stars GitHub forks

You can also join our chat: Gitter

Arduino Client interface support

This library is easy to integrate with lots of sketches which use Ethernet or WiFi. PubSubClient (MQTT), Blynk, HTTP Client and File Download examples are provided.

examples

TinyGSM is tiny

The complete WebClient example for Arduino Uno (via Software Serial) takes little resources:

Sketch uses 15022 bytes (46%) of program storage space. Maximum is 32256 bytes.
Global variables use 574 bytes (28%) of dynamic memory, leaving 1474 bytes for local variables. Maximum is 2048 bytes.

Arduino GSM library uses 15868 bytes (49%) of Flash and 1113 bytes (54%) of RAM in a similar scenario. TinyGSM also pulls data gently from the modem (whenever possible), so it can operate on very little RAM. Now, you have more space for your experiments.

Supported modems

  • SIMCom SIM800 series (SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868)
  • SIMCom SIM900 series (SIM900A, SIM900D, SIM908, SIM968)
  • SIMCom WCDMA/HSPA/HSPA+ Modules (SIM5360, SIM5320, SIM5300E, SIM5300EA)
  • SIMCom LTE Modules (SIM7100E, SIM7500E, SIM7500A, SIM7600C, SIM7600E)
  • SIMCom SIM7000E CAT-M1/NB-IoT Module
  • AI-Thinker A6, A6C, A7, A20
  • ESP8266 (AT commands interface, similar to GSM modems)
  • Digi XBee WiFi and Cellular (using XBee command mode)
  • Neoway M590
  • u-blox 2G, 3G, 4G, and LTE Cat1 Cellular Modems (many modules including LEON-G100, LISA-U2xx, SARA-G3xx, SARA-U2xx, TOBY-L2xx, LARA-R2xx, MPCI-L2xx)
  • u-blox LTE-M Modems (SARA-R4xx, SARA-N4xx, but NOT SARA-N2xx)
  • Sequans Monarch LTE Cat M1/NB1
  • Quectel BG96
  • Quectel M95
  • Quectel MC60 (alpha)

Supported boards/modules

  • Arduino MKR GSM 1400
  • GPRSbee
  • Microduino GSM
  • Adafruit FONA (Mini Cellular GSM Breakout)
  • Adafruit FONA 800/808 Shield
  • Industruino GSM
  • RAK WisLTE (alpha)
  • ... other modules, based on supported modems. Some boards require special configuration.

More modems may be supported later:

  • Quectel M10, UG95
  • SIMCom SIM7020
  • Telit GL865
  • ZTE MG2639
  • Hi-Link HLK-RM04

Watch this repo for new updates! And of course, contributions are welcome ;)

Features

Data connections

  • TCP (HTTP, MQTT, Blynk, ...)
    • ALL modules support TCP connections
  • UDP
    • Not yet supported on any module, though it may be some day
  • SSL/TLS (HTTPS)
    • Supported on¹:
      • SIM800, u-Blox, XBee cellular, ESP8266, and Sequans Monarch ¹ - only some device models or firmware revisions have this feature (SIM8xx R14.18, A7, etc.)
    • Not yet supported on:
      • Quectel modems, SIM7000, SIM5360/5320/7100/7500/7600
    • Not possible on:
      • SIM900, A6/A7, M560, XBee WiFi

USSD

  • Sending USSD requests and decoding 7,8,16-bit responses
    • Supported on:
      • SIM800/SIM900, SIM7000
    • Not yet supported on:
      • Quectel modems, SIM5360/5320/7100/7500/7600, XBee

SMS

  • Only sending SMS is supported, not receiving
    • Supported on:
      • SIM800/SIM900, SIM7000, XBee
    • Not yet supported on:
      • Quectel modems, SIM5360/5320/7100/7500/7600

Voice Calls

  • Only Supported on SIM800 and A6/A7/A20
    • Dial, hangup
    • Receiving calls
    • Incoming event (RING)
    • DTMF sending
    • DTMF decoding

Location

  • GPS/GNSS
    • SIM808 and SIM7000 only
  • GSM location service
    • SIM800, SIM and SIM7000 only

Credits

Donation

Donate BountySource Donate Bitcoin

If you have found TinyGSM to be useful in your work, research or company, please consider making a donation to the project commensurate with your resources. Any amount helps! All donations will be used strictly to fund the development of TinyGSM:

  • Covering cellular network expenses
  • Buying new hardware and modems for integration
  • Bounty Budget (to reward other developers for their contributions)
  • Implementing new features
  • Quality Assurance

Getting Started

  1. Using your phone: - Disable PIN code on the SIM card - Check your balance - Check that APN, User, Pass are correct and you have internet
  2. Ensure the SIM card is correctly inserted into the module
  3. Ensure that GSM antenna is firmly attached
  4. Check if serial connection is working (Hardware Serial is recommended) Send an AT command using this sketch

If you have any issues:

  1. Read the whole README (you're looking at it!)
  2. Some boards require special configuration.
  3. Try running the Diagnostics sketch
  4. Check for highlighted topics here
  5. If you have a question, please post it in our Gitter chat

How does it work?

Many GSM modems, WiFi and radio modules can be controlled by sending AT commands over Serial. TinyGSM knows which commands to send, and how to handle AT responses, and wraps that into standard Arduino Client interface.

API Reference

For GPRS data streams, this library provides the standard Arduino Client interface. For additional functions, please refer to this example sketch

Troubleshooting

Diagnostics sketch

Use this sketch to diagnose your SIM card and GPRS connection: File -> Examples -> TinyGSM -> tools -> Diagnostics

Ensure stable data & power connection

Most modules require up to 2A and specific voltage - according to the module documentation. So this actually solves stability problems in many cases:

  • Provide a good stable power supply. Read about powering your module.
  • Keep your wires as short as possible
  • Consider soldering them for a stable connection
  • Do not put your wires next to noisy signal sources (buck converters, antennas, oscillators etc.)

SoftwareSerial problems

When using SoftwareSerial (on Uno, Nano, etc), the speed 115200 may not work. Try selecting 57600, 38400, or even lower - the one that works best for you. In some cases 9600 is unstable, but using 38400 helps, etc. 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. Read more about SoftSerial options and configuration here and here.

ESP32 Notes

HardwareSerial

When using ESP32 HardwareSerial, you may need to specify additional parameters to the .begin() call. Please refer to this comment.

HttpClient

You will not be able to compile the HttpClient or HttpsClient examples with ESP32 core >1.0.1. Downgrade to version 1.0.1 or use the WebClient example. Please comment on the issue on the ESP32 core, not in this library: espressif/arduino-esp32#2755

SAMD21

When using SAMD21-based boards, you may need to use a sercom uart port instead of Serial1. Please refer to this comment.

Broken initial configuration

Sometimes (especially if you played with AT commands), your module configuration may become invalid. This may result in problems such as:

  • Can't connect to the GPRS network
  • Can't connect to the server
  • Sent/received data contains invalid bytes
  • etc.

To return module to Factory Defaults, use this sketch: File -> Examples -> TinyGSM -> tools -> FactoryReset

Goouuu Tech IOT-GA6 vs AI-Thinker A6 confusion

It turns out that Goouuu Tech IOT-GA6 is not the same as AI-Thinker A6. Unfortunately IOT-GA6 is not supported out of the box yet. There are some hints that IOT-GA6 firmware may be updated to match A6... See this topic.

License

This project is released under The GNU Lesser General Public License (LGPL-3.0)