JSD/TinyGSM_Senseright
3
0
Fork 0
Code Issues Pull Requests 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

81
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)
@@ -29,38 +29,38 @@ The complete WebClient example for Arduino Uno (via Software Serial) takes littl
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.
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.**
## 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.)
✔ - implemented  ◌ - planned  x - not available on this modem
¹ - only some device models or firmware revisions have this feature (SIM8xx R14.18, A7, etc.)
## Supported modems
@@ -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
@@ -100,9 +101,9 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
[![Donate BountySource](https://img.shields.io/badge/Donate-BountySource-149E5E.svg)](https://salt.bountysource.com/checkout/amount?team=tinygsm-dev)
[![Donate Bitcoin](https://img.shields.io/badge/Donate-Bitcoin-orange.svg)](http://tny.im/aen)
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!
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
@@ -113,10 +114,10 @@ If you have found TinyGSM to be useful in your work, research or company, please
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
- 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)
4. Check if serial connection is working (Hardware Serial is recommended)
Send an ```AT``` command using [this sketch](tools/AT_Debug/AT_Debug.ino)
If you have any issues:
@@ -129,20 +130,20 @@ If you have any issues:
## How does it work?
Many GSM modems, WiFi and radio modules can be controlled by sending AT commands over Serial.
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](https://www.arduino.cc/en/Reference/ClientConstructor) interface.
For GPRS data streams, this library provides the standard [Arduino Client](https://www.arduino.cc/en/Reference/ClientConstructor) interface.
For additional functions, please refer to [this example sketch](examples/AllFunctions/AllFunctions.ino)
## Troubleshooting
### 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)
Use this sketch to diagnose your SIM card and GPRS connection:
File -> Examples -> TinyGSM -> tools -> [Diagnostics](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/Diagnostics/Diagnostics.ino)
### Ensure stable data & power connection
@@ -155,10 +156,10 @@ So this actually solves stability problems in **many** cases:
### 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.
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](https://www.pjrc.com/teensy/td_libs_AltSoftSerial.html) and [here](https://www.arduino.cc/en/Reference/SoftwareSerial).**
### ESP32 HardwareSerial
@@ -173,15 +174,15 @@ 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:
To return module to **Factory Defaults**, use this sketch:
File -> Examples -> TinyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
### Goouuu Tech IOT-GA6 vs AI-Thinker A6 confusion

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.