KevinMidboe/TinyGSM
1
0
Fork 0
mirror of https://github.com/KevinMidboe/TinyGSM.git synced 2025-10-29 18:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Sara Damiano
2019-03-08 16:38:29 -05:00
parent 033beb068e
commit 11cafff889
2 changed files with 41 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -18,7 +18,7 @@ You can also join our chat:
[![Gitter](https://img.shields.io/gitter/room/vshymanskyy/TinyGSM.svg)](https://gitter.im/tinygsm)
### Arduino Client interface support
This library is easy to integrate with lots of sketches, which use Ethernet or WiFi.
This library is easy to integrate with lots of sketches which use Ethernet or WiFi.
**PubSubClient ([MQTT](http://mqtt.org/))**, **[Blynk](http://blynk.cc)**, **HTTP Client** and **File Download** examples are provided.
![examples](/extras/examples.png)
@@ -35,29 +35,29 @@ TinyGSM also pulls data gently from the modem (whenever possible), so it can ope
## Features
Feature \ Modem | SIM8xx | u-Blox | A6/A7/A20 | M590 | ESP8266 | XBee | BG96 | M95 | MC60 |
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
Feature \ Modem | SIM8xx | u-Blox | A6/A7/A20 | M590 | ESP8266 | XBee | BG96 | M95 | MC60 | SIM7000 |
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | |
**Data connections**
TCP (HTTP, MQTT, Blynk, ...) | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
UDP | ◌ | ◌ | | | | ◌ | ◌ | | |
SSL/TLS (HTTPS) | ✔¹ | ✔ | x | x | ✔ | ✔ | ◌ | | |
TCP (HTTP, MQTT, Blynk, ...) | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |
UDP | ◌ | ◌ | | | | ◌ | ◌ | | | ◌ |
SSL/TLS (HTTPS) | ✔¹ | ✔ | x | x | ✔ | ✔ | ◌ | | | ◌ |
**USSD**
Sending USSD requests | ✔ | | ✔ | ✔ | x | | | | |
Decoding 7,8,16-bit response | ✔ | | ✔ | ✔ | x | | | | |
Sending USSD requests | ✔ | | ✔ | ✔ | x | | | | | ✔ |
Decoding 7,8,16-bit response | ✔ | | ✔ | ✔ | x | | | | | ✔ |
**SMS**
Sending | ✔ | ✔ | ✔ | ✔ | x | ✔ | ✔ | ✔ | ✔ |
Sending Unicode | ✔ | | ◌ | x | x | | ✔ | ✔ | ✔ |
Reading | | | | | x | | | | |
Incoming message event | | | | ? | x | | | | |
Sending | ✔ | ✔ | ✔ | ✔ | x | ✔ | ✔ | ✔ | ✔ | ✔ |
Sending Unicode | ✔ | | ◌ | x | x | | ✔ | ✔ | ✔ | ✔ |
Reading | | | | | x | | | | | |
Incoming message event | | | | ? | x | | | | | |
**Calls**
Dial, hangup | ✔ | | ✔ | x | x | x | | | |
Receiving calls | ✔ | | ✔ | x | x | x | | | |
Incoming event (RING) | ◌ | | ◌ | x | x | x | | | |
DTMF sending | ✔ | | ✔ | x | x | x | | | |
DTMF decoding | ◌ | | x | x | x | x | | | |
Dial, hangup | ✔ | | ✔ | x | x | x | | | | |
Receiving calls | ✔ | | ✔ | x | x | x | | | | |
Incoming event (RING) | ◌ | | ◌ | x | x | x | | | | |
DTMF sending | ✔ | | ✔ | x | x | x | | | | |
DTMF decoding | ◌ | | x | x | x | x | | | | |
**Location**
GSM location service | ✔ | ✔ | x | x | x | x | | x | ✔ |
GPS/GNSS | ✔¹ | x | ◌¹ | x | x | x | | x | |
GSM location service | ✔ | ✔ | x | x | x | x | | x | ✔ | ✔ |
GPS/GNSS | ✔¹ | x | ◌¹ | x | x | x | | x | | ✔ |
✔ - implemented  ◌ - planned  x - not available on this modem
¹ - only some device models or firmware revisions have this feature (SIM8xx R14.18, A7, etc.)
@@ -70,10 +70,11 @@ GPS/GNSS | ✔¹ | x | ◌¹ | x | x
- ESP8266 (AT commands interface, similar to GSM modems)
- Digi XBee WiFi and Cellular (using XBee command mode)
- Neoway M590
- u-blox Cellular Modems (LEON-G100, LISA-U2xx, SARA-G3xx, SARA-U2xx, TOBY-L2xx, LARA-R2xx, MPCI-L2xx)
- u-blox Cellular Modems (many modules including LEON-G100, LISA-U2xx, SARA-G3xx, SARA-U2xx, TOBY-L2xx, LARA-R2xx, MPCI-L2xx, SARA-R4xx, SARA-N4xx, _but NOT SARA-N2xx_)
- Quectel BG96 ***(alpha)***
- Quectel M95 ***(alpha)***
- Quectel MC60 ***(alpha)***
- SIMCom SIM7000 series ***(alpha)***
### Supported boards/modules
- Arduino MKR GSM 1400
@@ -88,7 +89,7 @@ GPS/GNSS | ✔¹ | x | ◌¹ | x | x
More modems may be supported later:
- [ ] Sequans Monarch LTE Cat M1/NB1
- [ ] Quectel M10, UG95
- [ ] SIMCom SIM5320, SIM5360, SIM5216, SIM7xxx
- [ ] SIMCom SIM5320, SIM5360, SIM5216
- [ ] Telit GL865
- [ ] ZTE MG2639
- [ ] Hi-Link HLK-RM04
@@ -102,7 +103,7 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
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 expences
- Covering cellular network expenses
- Buying new hardware and modems for integration
- Bounty Budget (to reward other developers for their contributions)
- Implementing new features
@@ -142,7 +143,7 @@ For additional functions, please refer to [this example sketch](examples/AllFunc
### Diagnostics sketch
Use this sketch to diagnose your SIM card and GPRS connection:
File -> Examples -> TynyGSM -> tools -> [Diagnostics](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/Diagnostics/Diagnostics.ino)
File -> Examples -> TinyGSM -> tools -> [Diagnostics](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/Diagnostics/Diagnostics.ino)
### Ensure stable data & power connection
@@ -173,12 +174,12 @@ Please [refer to this comment](https://github.com/vshymanskyy/TinyGSM/issues/102
### Broken initial configuration
Sometimes (especially if you played with AT comands), your module configuration may become invalid.
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/recieved data contains invalid bytes
* Sent/received data contains invalid bytes
* etc.
To return module to **Factory Defaults**, use this sketch:

BIN
extras/AT Command Manuals/u-blox SARA-R4 SARA-N4 AT Commands r12 (UBX-17003787).pdf Normal file
View File

Binary file not shown.