Merge pull request #12 from vshymanskyy/master

ReadMe updates

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--
+Thanks for using TinyGSM!
+
+Before opening an issue, please make sure you've read the README.
+We do not respond to general questions here, use gitter chat for that.
+Please provide the following information for all issues.
+The issues that do not contain the relevant information may be rejected.
+-->
+
+TinyGSM version: <!-- always try to use the latest -->
+Hardware: <!-- modem model, main board type, etc -->
+
+### Scenario, steps to reproduce
+<!-- What you are trying to achieve and you can't? -->
+
+### Expected result
+<!-- What are you expecting to happen as the consequence of above reproduction steps? -->
+
+### Actual result
+<!-- What actually happens after the reproduction steps? Include the error output or a link to a gist if possible. -->
+
+### AT command log
+<!-- The AT commands log you get using StreamDebugger or any other debugging method -->

.travis.yml

@@ -19,6 +19,7 @@ env:
 
     # Arduino test
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_SIM800'  --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev --board=mayfly"
+    - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_SIM900'  --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev --board=mayfly"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_A6'      --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev --board=mayfly"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_M590'    --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev --board=mayfly"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_ESP8266' --project-option='framework=arduino' --board=uno --board=leonardo --board=yun --board=megaatmega2560 --board=genuino101 --board=mkr1000USB --board=zero --board=teensy31 --board=bluepill_f103c8 --board=uno_pic32 --board=esp01 --board=nodemcuv2 --board=esp32dev --board=mayfly"
@@ -27,11 +28,14 @@ env:
 
     # Energia test
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_SIM800'  --project-option='framework=energia' --board=lplm4f120h5qr"
+    - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_SIM900'  --project-option='framework=energia' --board=lplm4f120h5qr"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_A6'      --project-option='framework=energia' --board=lplm4f120h5qr"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_M590'    --project-option='framework=energia' --board=lplm4f120h5qr"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_ESP8266' --project-option='framework=energia' --board=lplm4f120h5qr"
     - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_U201'    --project-option='framework=energia' --board=lplm4f120h5qr"
-    - PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_XBEE'    --project-option='framework=energia' --board=lplm4f120h5qr"
+
+    # Disabled due to a bug in Energia readBytes implementation
+    #- PLATFORMIO_CI_SRC=tools/test_build PLATFORMIO_CI_ARGS="--project-option='build_flags=-D TINY_GSM_MODEM_XBEE'    --project-option='framework=energia' --board=lplm4f120h5qr"
 
 install:
     # ChipKIT issue: install 32-bit support for GCC PIC32

README.md

@@ -107,13 +107,12 @@ 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 ballance
+    - 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. 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)
+  3. 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)
-  5. Check if GSM antenna is attached
+  4. Ensure that GSM antenna is firmly attached
 
 ## How does it work?
 
@@ -131,6 +130,14 @@ For additional functions, please refer to [this example sketch](examples/AllFunc
 
 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)
+  
+### Ensure stable data & power connection
+
+This actually solves stability problems in **many** cases:
+- 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)
+- 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
 
@@ -162,6 +169,10 @@ This may result in problems such as:
 To return module to **Factory Defaults**, use this sketch:  
   File -> Examples -> TynyGSM -> tools -> [FactoryReset](https://github.com/vshymanskyy/TinyGSM/blob/master/tools/FactoryReset/FactoryReset.ino)
 
+### 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... But no one confirmed that up to my knowledge.
+
 __________
 
 ### License

library.json

@@ -1,6 +1,6 @@
 {
   "name": "TinyGSM",
-  "version": "0.3.20",
+  "version": "0.3.30",
   "description": "A small Arduino library for GPRS modules, that just works. Includes examples for Blynk, MQTT, File Download, and Web Client. Supports GSM modules with AT command interface: SIM800, SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868, SIM900, SIM900A, SIM900D, SIM908, SIM968",
   "keywords": "GSM, AT commands, AT, SIM800, SIM900, A6, A7, M590, ESP8266, SIM800A, SIM800C, SIM800L, SIM800H, SIM808, SIM868, SIM900A, SIM900D, SIM908, SIM968",
   "authors":

library.properties

@@ -1,5 +1,5 @@
 name=TinyGSM
-version=0.3.20
+version=0.3.30
 author=Volodymyr Shymanskyy
 maintainer=Volodymyr Shymanskyy
 sentence=A small Arduino library for GPRS modules, that just works.

src/TinyGsmClientSIM800.h

@@ -740,9 +740,10 @@ public:
 protected:
 
   bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) {
+    int rsp;
 #if !defined(TINY_GSM_MODEM_SIM900)
     sendAT(GF("+CIPSSL="), ssl);
-    int rsp = waitResponse();
+    rsp = waitResponse();
     if (ssl && rsp != 1) {
       return false;
     }

tools/Diagnostics/Diagnostics.ino

@@ -47,8 +47,9 @@ StreamDebugger debugger(SerialAT, SerialMon);
 TinyGsm modem(debugger);
 TinyGsmClient client(modem);
 
-const char server[] = "cdn.rawgit.com";
+const char server[] = "vsh.pp.ua";
-const char resource[] = "/vshymanskyy/tinygsm/master/extras/logo.txt";
+const char resource[] = "/TinyGSM/logo.txt";
+const int  port = 80;
 
 void setup() {
   // Set console baud rate
@@ -108,7 +109,7 @@ void loop() {
 
   SerialMon.print("Connecting to ");
   SerialMon.print(server);
-  if (!client.connect(server, 80)) {
+  if (!client.connect(server, port)) {
     SerialMon.println(" fail");
     delay(10000);
     return;