Merge branch 'master' into sim7020_support

Author: imliubo

.github/ISSUE_TEMPLATE.md

@@ -25,7 +25,7 @@ with your board before submitting any issues.
 
 Modem: <!-- Brand, model, variant, firmware version, ie Quectel BG96 Revision: BG96MAR02A07M1G -->
 Main processor board: <!-- Uno, Zero, ESP32, Particle, etc -->
-TinyGSM version: <!-- always try to use the latest (0.11.7) -->
+TinyGSM version: <!-- always try to use the latest (0.12.0) -->
 Code: <!-- Example name or paste in your code -->
 
 ### Scenario, steps to reproduce

.github/workflows/build_examples_platformio.yaml

@@ -3,10 +3,67 @@ name: Build Examples with PlatformIO
 # Triggers the workflow on push or pull request events
 on: [push, pull_request]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build:
+  determine_library_source:
+    name: determine_library_source
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
+    outputs:
+      library_install_zip: ${{ steps.store_vars.outputs.library_install_zip }}
+      library_install_git: ${{ steps.store_vars.outputs.library_install_git }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables for pushes to any branch
+        if: github.event_name == 'push'
+        run: |
+          echo "Push to commit ${GITHUB_SHA}"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_SHA}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_SHA}" >> $GITHUB_ENV
+
+      - name: Set environment variable for PR's from any branch
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name == github.repository
+        run: |
+          echo "Pull Request from the ${GITHUB_HEAD_REF} branch"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_HEAD_REF}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_HEAD_REF}" >> $GITHUB_ENV
+
+      - name: Set environment variable for PR's from any fork
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name != github.repository
+        run: |
+          echo "Pull Request from the fork ${{ github.event.pull_request.head.repo.full_name }} at ${{ github.event.pull_request.head.ref }}"
+          echo "LIBRARY_INSTALL_ZIP=https://github.com/${{ github.event.pull_request.head.repo.full_name }}/archive/${{ github.event.pull_request.head.ref }}.zip" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${{ github.event.pull_request.head.repo.full_name }}.git#${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
+
+      - name: store enviroment variables as output
+        id: store_vars
+        run: |
+          echo "library_install_zip=${{ env.LIBRARY_INSTALL_ZIP }}" >> $GITHUB_OUTPUT
+          echo "library_install_git=${{ env.LIBRARY_INSTALL_GIT }}" >> $GITHUB_OUTPUT
+
+  print_library_source:
+    name: print_library_source
+    runs-on: ubuntu-latest
+    needs: determine_library_source
+    steps:
+      - name: Check the library installation source
+        run: |
+          echo "Link to zip for Arduino CLI testing install:"
+          echo "${{ needs.determine_library_source.outputs.library_install_zip }}"
+          echo
+          echo "Git reference for PlatformIO testing install"
+          echo "${{ needs.determine_library_source.outputs.library_install_git }}"
+
+  build_pio:
+    runs-on: ubuntu-latest
+    needs: [determine_library_source]
+    env:
+      LIBRARY_INSTALL_GIT: ${{ needs.determine_library_source.outputs.library_install_git }}
 
     strategy:
       matrix:
@@ -23,6 +80,7 @@ jobs:
           [
             TINY_GSM_MODEM_A6,
             TINY_GSM_MODEM_BG96,
+            TINY_GSM_MODEM_A7672X,
             TINY_GSM_MODEM_ESP8266,
             TINY_GSM_MODEM_M95,
             TINY_GSM_MODEM_M590,
@@ -36,12 +94,13 @@ jobs:
             TINY_GSM_MODEM_SIM7070,
             TINY_GSM_MODEM_UBLOX,
             TINY_GSM_MODEM_SARAR4,
+            TINY_GSM_MODEM_SARAR5,
             TINY_GSM_MODEM_XBEE,
             TINY_GSM_MODEM_SEQUANS_MONARCH,
           ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set variables
         run: |
@@ -54,7 +113,7 @@ jobs:
           fi
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 
@@ -64,8 +123,8 @@ jobs:
           python -m pip install --upgrade pip
           pip install --upgrade platformio
 
-      - name: Restore or Cache Platforms and Libraries
-        uses: actions/cache@v3.3.1
+      - name: Restore or Cache PlatformIO Platforms and Libraries
+        uses: actions/cache@v4
         id: cache_pio
         with:
           path: ~/.platformio
@@ -75,7 +134,7 @@ jobs:
           key: ${{ hashFiles('./examples/example_dependencies.json') }}
 
       # Install cores and library dependencies for the Arduino CLI, iff no cache
-      - name: Install the Arduino libraries
+      - name: Install the Arduino libraries for PlatformIO
         if: steps.cache_pio.outputs.cache-hit != 'true'
         run: pio lib --global install 89 415 1202 1286
 
@@ -84,8 +143,8 @@ jobs:
           PLATFORMIO_CI_SRC: ${{ matrix.example }}
           TINYGSM_MODEM_TO_USE: ${{ matrix.modem }}
         run: |
-          echo "${{ env.LIBRARY_INSTALL_SOURCE }}"
-          pio lib --global install ${{ env.LIBRARY_INSTALL_SOURCE }}
+          echo "${{ env.LIBRARY_INSTALL_GIT }}"
+          pio pkg install -g --library ${{ env.LIBRARY_INSTALL_GIT }}
           sed -i 's/\/\/ #define TINY_GSM_MODEM_SIM800/#define TINY_GSM_MODEM_SIM800/g' ${{ matrix.example }}/*
           platformio ci --project-option='build_flags=-D ${{ env.TINYGSM_MODEM_TO_USE }}' --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
           pio lib --global uninstall TinyGSM

.gitignore

@@ -47,3 +47,6 @@ extras/At Command Manuals - Unsupported/*
 filters/*
 platformio_extra_envs.ini
 *.tar.gz
+pioScripts/generate_compile_commands.py
+compile_commands.json
+src/TinyGsmATDefines.h

ChangeLog.md

@@ -0,0 +1,60 @@
+# ChangeLog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and its stricter, better defined, brother [Common Changelog](https://common-changelog.org/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+***
+
+
+## [Unreleased]
+****
+### Changed
+
+### Added
+
+### Removed
+
+### Fixed
+
+***
+
+
+## [v0.12.0]
+
+### Changed
+- Moved bulk of waitResponse function to modem template and gave modems handleURCs fxn
+- Moved option in waitResponse for verbose outputs.
+- setBaud now returns a bool
+- Replace new line consts with defines and renamed to AT_NL
+- Renamed all RegStatus enums to be unique
+- Replaced `NULL` with `nullptr` and replaced c-style casts.
+- Moved setCertificates function and the certificate name matrix to the SSL template.
+- Changed inputs for (unimplemented) SSL certificate functions.
+- All modems will now return the pre-defined manufacturer and model in the name if the function to get the internal name fails.
+- Cleaned up code for getting modem names.
+- Made battery return types signed.
+
+### Added
+- Added support for SSL for the Quentcel BG95 and BG96 from [Aurelien BOUIN](https://github.com/aurelihein) and [George O'Connor](https://github.com/georgeman93)
+- Added support for UBLOX SARA-R5 from [Sebastian Bergner](https://github.com/sebastianbergner)
+- Added support for SIMCOM A7672X from [Giovanni de Rosso Unruh](https://github.com/giovannirosso)
+- Added SIM5320 GPS location from [Bengarman](https://github.com/Bengarman)
+- Added functions `getModemSerialNumber`, `getModemModel`, and `getModemRevision`.
+- Added deep debugging option
+- Added documentation to the FIFO class
+
+### Removed
+- Removed non-functional factory reset from SIM70xx series
+
+### Fixed
+- Removed extra wait on SIM7000 from [Mikael Fredriksson](https://github.com/Gelemikke)
+- Fix status returns on ESP8266/ESP32 AT commands
+- Fix length of HEX for Sequans Monarch
+- Fix SIM7600 password then user when cid is set from [github0013](https://github.com/github0013)
+- Fix cardinal points in location by gps for SIM7600 from [Juxn3](https://github.com/Juxn3)
+- Fix NTP server sync for SIM70xx models from [Gonzalo Brusco](https://github.com/gonzabrusco)
+- Fixed SIM70xx inheritance
+
+***

README.md

@@ -17,7 +17,7 @@ If you like **TinyGSM** - give it a star, or fork it and contribute!
 [![GitHub forks](https://img.shields.io/github/forks/vshymanskyy/TinyGSM.svg?style=social&label=Fork)](https://github.com/vshymanskyy/TinyGSM/network)
 
 You can also join our chat:
-[![Gitter](https://img.shields.io/gitter/room/vshymanskyy/TinyGSM.svg)](https://gitter.im/tinygsm)
+[![Gitter](https://img.shields.io/gitter/room/vshymanskyy/TinyGSM.svg)](https://app.gitter.im/#/room/#tinygsm_Lobby:gitter.im)
 
 - [Supported modems](#supported-modems)
   - [Supported boards/modules](#supported-boardsmodules)
@@ -29,7 +29,7 @@ You can also join our chat:
 - [How does it work?](#how-does-it-work)
 - [API Reference](#api-reference)
 - [Troubleshooting](#troubleshooting)
-  - [Ensure stable data & power connection](#ensure-stable-data--power-connection)
+  - [Ensure stable data \& power connection](#ensure-stable-data--power-connection)
   - [Baud rates](#baud-rates)
   - [Broken initial configuration](#broken-initial-configuration)
   - [Failed connection or no data received](#failed-connection-or-no-data-received)
@@ -70,34 +70,33 @@ TinyGSM also pulls data gently from the modem (whenever possible), so it can ope
 - SIMCom LTE Modules (SIM7100E, SIM7500E, SIM7500A, SIM7600C, SIM7600E)
 - SIMCom SIM7000E/A/G CAT-M1/NB-IoT Module
 - SIMCom SIM7020C/G NB-IoT Module
-- SIMCom SIM7028  CAT-M1/NB-IoT Module
-- SIMCom SIM7070/SIM7080/SIM7090 CAT-M1/NB-IoT Module
+- SIMCom SIM7028/SIM7070/SIM7080/SIM7090 CAT-M1/NB-IoT Module
+- SIMCom A7672X CAT-M1 Module
 - AI-Thinker A6, A6C, A7, A20
 - ESP8266/ESP32 (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/NB-IoT Modems (SARA-R4xx, SARA-N4xx, _but NOT SARA-N2xx_)
+- u-blox LTE-M/NB-IoT Modems (SARA-R4xx, SARA-N4xx, SARA-R5xx, _but NOT SARA-N2xx_)
 - Sequans Monarch LTE Cat M1/NB1 (VZM20Q)
 - Quectel BG96
+- Quectel BG95
 - Quectel M95
 - Quectel MC60 ***(alpha)***
 
 ### Supported boards/modules
+- EnviroDIY LTE Bee, WiFi Bee
 - Arduino MKR GSM 1400
-- GPRSbee
+- Sodaq GPRSbee, uBee
 - Microduino GSM
-- Adafruit FONA (Mini Cellular GSM Breakout)
-- Adafruit FONA 800/808 Shield
+- Adafruit FONA Mini Cellular GSM Breakout, 800/808 Shield, FONA 3G
 - Industruino GSM
+- Dragino NB-IoT Bee
+- Digi XBee S6B, XBee LTE Cat 1, XBee3 LTE Cat 1, XBee3 CatM
+- Nimbelink Skywire/Airgain NL-SW-LTE-QBG96, NL-SW-LTE-QBG95
 - RAK WisLTE ***(alpha)***
 - ... other modules, based on supported modems. Some boards require [**special configuration**](https://github.com/vshymanskyy/TinyGSM/wiki/Board-configuration).
 
-More modems may be supported later:
-- [ ] Quectel M10, UG95
-- [ ] Telit GL865
-- [ ] ZTE MG2639
-- [ ] Hi-Link HLK-RM04
 
 Watch this repo for new updates! And of course, contributions are welcome ;)
 
@@ -111,6 +110,7 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
         - ESP8266 - 5
         - Neoway M590 - 2
         - Quectel BG96 - 12
+        - Quectel BG95 - 12
         - Quectel M95 - 6
         - Quectel MC60/MC60E - 6
         - Sequans Monarch - 6
@@ -119,17 +119,18 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
         - SIM7000 - 8 possible without SSL, only 2 with
         - SIM 7070/7080/7090 - 12
         - SIM 7500/7600/7800 - 10
+        - SIM A7672X - 10
         - u-blox 2G/3G - 7
         - u-blox SARA R4/N4 - 7
         - Digi XBee - _only 1 connection supported!_
 - UDP
     - Not yet supported on any module, though it may be some day
 - SSL/TLS (HTTPS)
     - Supported on:
-        - SIM800, SIM7000, u-Blox, XBee _cellular_, ESP8266, and Sequans Monarch
+        - SIM800, SIM7000, A7672X, u-Blox, XBee _cellular_, ESP8266, Sequans Monarch and Quectel BG95 and BG96
         - Note:  **only some device models or firmware revisions have this feature** (SIM8xx R14.18, A7, etc.)
     - Not yet supported on:
-        - Quectel modems, SIM 5360/5320/7100, SIM 7500/7600/7800
+        - SIM 5360/5320/7100, SIM 7500/7600/7800
     - Not possible on:
         - SIM900, A6/A7, Neoway M590, XBee _WiFi_
     - Like TCP, most modules support simultaneous connections
@@ -152,14 +153,14 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
 - Not yet supported on:
     - SIM7000, SIM5360/5320/7100, SIM7500/7800, VZM20Q (Monarch)
 - Not possible on:
-    -  XBee (any type), u-blox SARA R4/N4, Neoway M590, ESP8266 (obviously)
+    -  XBee (any type), u-blox SARA R4/R5/N4, Neoway M590, ESP8266 (obviously)
 - Functions:
     - Dial, hangup
     - DTMF sending
 
 **Location**
 - GPS/GNSS
-    - SIM808, SIM7000, SIM7500/7600/7800, BG96, u-blox
+    - SIM808, SIM7000, SIM7500/7600/7800, BG96, BG95, u-blox
     - NOTE:  u-blox chips do _NOT_ have embedded GPS - this functionality only works if a secondary GPS is connected to primary cellular chip over I2C
 - GSM location service
     - SIM800, SIM7000, Quectel, u-blox
@@ -177,6 +178,10 @@ Watch this repo for new updates! And of course, contributions are welcome ;)
     - [V1pr](https://github.com/V1pr)
 - Quectel M95
     - [replicadeltd](https://github.com/replicadeltd)
+- UBLOX SARA-R5
+  - [Sebastian Bergner](https://github.com/sebastianbergner)
+- SIMCOM A7672X
+  - [Giovanni de Rosso Unruh](https://github.com/giovannirosso)
 - Other Contributors:
     - https://github.com/vshymanskyy/TinyGSM/graphs/contributors