1 Star 0 Fork 1

子安/TinyGSM

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
LGPL-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 (VZM20Q)
  • 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
      • Note: only some device models or firmware revisions have this feature (SIM8xx R14.18, A7, etc.)
    • Not yet supported on:
      • Quectel modems, SIM7000, SIM5360/5320, SIM7100/7500/7600
    • Not possible on:
      • SIM900, A6/A7, Neoway M590, XBee WiFi

USSD

  • Sending USSD requests and decoding 7,8,16-bit responses
    • Supported on:
      • All SIMCom modems, Quectel modems, most u-blox
    • Not possible on:
      • XBee, u-blox SARA R4/N4, ESP8266 (obviously)

SMS

  • Only sending SMS is supported, not receiving
    • Supported on all cellular modules

Voice Calls

  • Supported on:
    • SIM800/SIM900, A6/A7, Quectel modems, u-blox
  • Not yet supported on:
    • SIM7000, SIM5360/5320/7100, SIM7500/7600/7800, VZM20Q (Monarch)
  • Not possible on:
    • XBee (any type), u-blox SARA R4/N4, Neoway M590, ESP8266 (obviously)
  • Functions:
    • Dial, hangup
    • Receiving calls
    • Incoming event (RING)
    • DTMF sending
    • DTMF decoding

Location

  • GPS/GNSS
    • SIM808, SIM7000, SIM7500/7600/7800, BG96, u-blox
    • NOTE: u-blox chips do NOT have embedded GPS - this function only works if a secondary GPS is connected to primary cellular chip over I2C
  • GSM location service
    • SIM800, SIM7000, Quectel, u-blox

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.2. Upgrade to 1.0.3, downgrade to version 1.0.1 or use the WebClient example.

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)

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

简介

A small Arduino library for GSM modules, that just works 展开 收起
README
LGPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/andrewgithub/TinyGSM.git
git@gitee.com:andrewgithub/TinyGSM.git
andrewgithub
TinyGSM
TinyGSM
master

搜索帮助