小型GSM

一個用於 GSM 模組的小型 Arduino 庫，可以正常工作。

如果您喜歡TinyGSM - 給它一顆星，或者分叉它並做出貢獻！

您也可以加入我們的聊天：

• 支援的數據機
  • 支援的闆卡/模組
• 特徵
• 入門
  • 第一步
  • 編寫自己的程式碼
  • 如果您有任何問題
• 它是如何運作的？
• API參考
• 故障排除
  • 確保穩定的數據和電源連接
  • 波特率
  • 初始配置損壞
  • 連線失敗或未收到數據
  • 診斷草圖
  • Web 請求格式問題 - “但它適用於 PostMan”
  • 軟體序號問題
  • ESP32 註釋
    • 硬體序列
    • Http客戶端
  • SAMD21
  • Goouuu Tech IOT-GA6 與 AI-Thinker A6 混淆
  • SIM800 和 SSL
  • 使用哪個版本的 SIM7000 程式碼
• 執照

Arduino 用戶端介面支援

該庫很容易與許多使用乙太網路或 WiFi 的草圖整合。提供了PubSubClient (MQTT) 、 Blynk 、 HTTP Client和檔案下載範例。

TinyGSM 很小

Arduino Uno 的完整 WebClient 範例（透過軟體串列）只需要很少的資源：

 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 庫使用 15868 位元組 (49%) 的快閃記憶體和 1113 位元組 (54%) 的 RAM。 TinyGSM 也從數據機中輕輕地提取資料（只要可能），因此它可以在很少的 RAM 上運行。現在，您有更多的實驗空間。

支援的數據機

• 芯訊通SIM800系列（SIM800A、SIM800C、SIM800L、SIM800H、SIM808、SIM868）
• 芯訊通SIM900系列（SIM900A、SIM900D、SIM908、SIM968）
• SIMCom WCDMA/HSPA/HSPA+模組（SIM5360、SIM5320、SIM5300E、SIM5300E/A）
• SIMCom LTE模組（SIM7100E、SIM7500E、SIM7500A、SIM7600C、SIM7600E）
• 芯訊通SIM7000E/A/G CAT-M1/NB-IoT模組
• 芯訊通SIM7070/SIM7080/SIM7090 CAT-M1/NB-IoT模組
• SIMCom A7672X CAT-M1模組
• 人工智慧思考者A6、A6C、A7、A20
• ESP8266/ESP32（AT指令接口，類似GSM調變解調器）
• Digi XBee WiFi 和蜂窩網路（使用 XBee 指令模式）
• 有方M590
• u-blox 2G、3G、4G 和 LTE Cat1 蜂窩數據機（許多模組包括 LEON-G100、LISA-U2xx、SARA-G3xx、SARA-U2xx、TOBY-L2xx、LARA-R2xx、MPCI-L2xx）
• u-blox LTE-M/NB-IoT 數據機（SARA-R4xx、SARA-N4xx、SARA-R5xx，但不是 SARA-N2xx ）
• Sequans Monarch LTE Cat M1/NB1 (VZM20Q)
• 移遠BG96
• 移遠BG95
• 移遠M95
• 移遠MC60 （阿爾法）

支援的闆卡/模組

• EnviroDIY LTE 蜜蜂、WiFi 蜜蜂
• Arduino MKR GSM 1400
• Sodaq GPRSbee、uBee
• Microduino GSM
• Adafruit FONA 迷你蜂巢 GSM 分線器、800/808 擴充板、FONA 3G
• 工業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
• 哈伊馬角 WisLTE （阿爾法版）
• ...其他模組，基於支援的調製解調器。有些板子需要特殊配置。

觀看此存儲庫以獲取新更新！當然，歡迎貢獻；）

特徵

數據連接

• TCP（HTTP、MQTT、Blynk...）
  • 所有模組均支援 TCP 連接
  • 大多數模組支援多個同時連接：
    • A6/A7 - 8
    • ESP8266-5
    • 有方M590-2
    • 移遠通信BG96-12
    • 移遠通信BG95-12
    • 移遠M95-6
    • 移遠MC60/MC60E - 6
    • 塞昆斯君主 - 6
    • 卡 800/900 - 5
    • 卡 5360/5320/5300/7100 - 10
    • SIM7000 - 8 個可能不含 SSL，只有 2 個有 SSL
    • SIM 7070/7080/7090 - 12
    • 卡 7500/7600/7800 - 10
    • SIM A7672X - 10
    • u-blox 2G/3G - 7
    • u-blox SARA R4/N4 - 7
    • Digi XBee -僅支援 1 個連線！
• UDP協定
  • 尚未在任何模組上受支持，但可能有一天會支持
• SSL/TLS (HTTPS)
  • 支持：
    • SIM800、SIM7000、A7672X、u-Blox、XBee蜂窩、ESP8266、Sequans Monarch 和 Quectel BG95 和 BG96
    • 注意：僅部分設備型號或韌體版本具有此功能（SIM8xx R14.18、A7等）
  • 尚不支持：
    • SIM 5360/5320/7100、SIM 7500/7600/7800
  • 不可能在：
    • SIM900、A6/A7、有方M590、XBee WiFi
  • 與 TCP 一樣，大多數模組都支援同時連接
  • TCP 和 SSL 連線通常可以混合使用，以達到可能的連線總數

美國SD

• 發送 USSD 請求並解碼 7、8、16 位元回應
  • 支持：
    • 所有 SIMCom 調變解調器、移遠調變解調器、大多數 u-blox
  • 不可能在：
    • XBee、u-blox SARA R4/N4、ESP8266（顯然）

簡訊

• 只支援發送短信，不支援接收
  • 所有蜂窩模組均支援

語音通話

• 支持：
  • SIM800/SIM900、SIM7600、A6/A7、移遠調變解調器、u-blox
• 尚不支持：
  • SIM7000、SIM5360/5320/7100、SIM7500/7800、VZM20Q（君主）
• 不可能在：
  • XBee（任何類型）、u-blox SARA R4/R5/N4、Neoway M590、ESP8266（顯然）
• 功能：
  • 撥號、掛斷
  • 雙音多頻發送

地點

• 全球定位系統/全球導航衛星系統
  • SIM808、SIM7000、SIM7500/7600/7800、BG96、BG95、u-blox
  • 注意：u-blox 晶片沒有嵌入式 GPS - 此功能僅在輔助 GPS 透過 I2C 連接到主蜂巢晶片時才起作用
• GSM定位服務
  • SIM800、SIM7000、移遠通訊、u-blox

製作人員

• 主要作者/貢獻者：
  • 弗希曼斯基
  • SRG達米亞1
• SIM7000：
  • 捕獲未來
  • 史蒂芬尼
• 塞昆斯君主：
  • 促智設計
• 移遠M9C60
  • V1pr
• 移遠M95
  • 複製品有限公司
• UBLOX SARA-R5
  • 塞巴斯蒂安·伯格納
• 芯訊通A7672X
  • 喬瓦尼·德·羅索·翁魯
• 其他貢獻者：
  • https://github.com/vshymanskyy/TinyGSM/graphs/contributors

入門

第一步

1. 使用您的手機： - 停用 SIM 卡上的 PIN 碼 - 檢查您的餘額 - 檢查 APN、用戶、通行證是否正確以及您是否有互聯網
2. 確保SIM卡正確插入模組
3. 確保 GSM 天線已牢固連接
4. 確保為模組提供至少2A的穩定電源。
5. 檢查串行連接是否正常運作（建議使用硬體串行）使用此草圖發送AT命令
6. 嘗試 WebClient 範例

編寫自己的程式碼

您的程式碼的一般流程應該是：

• 定義您正在使用的模組（僅選擇一個）
  • 即#define TINY_GSM_MODEM_SIM800
• 包含 TinyGSM
  • #include
• 建立 TinyGSM 數據機實例
  • TinyGsm modem(SerialAT);
• 建立一個或多個 TinyGSM 用戶端實例
  • 對於單一連接，請使用
    • TinyGsmClient client(modem);或TinyGsmClientSecure client(modem); （在支援的模組上）
  • 對於多個連接（在支援的模組上），請使用：
    • TinyGsmClient clientX(modem, 0); , TinyGsmClient clientY(modem, 1);等或
    • TinyGsmClientSecure clientX(modem, 0); , TinyGsmClientSecure clientY(modem, 1); ， ETC
  • 使用多個連線時，安全性和不安全的客戶端通常可以混合使用。
  • 可能的連接總數因模組而異
• 開始串行通訊並根據需要設定所有引腳，為模組供電並使其發揮全部功能。
  • 這些範例嘗試猜測模組的波特率。在工作代碼中，您應該使用設定的波特率。
• 等待模組準備就緒（可能長達 6 秒，視模組而定）
• 初始化調變解調器
  • modem.init()或modem.restart()
  • 重新啟動通常比初始化花費更長的時間，但確保模組沒有延遲連接
• 如有必要，解鎖您的 SIM 卡：
  • modem.simUnlock(GSM_PIN)
• 如果使用WiFi ，請指定您的 SSID 資訊：
  • modem.networkConnect(wifiSSID, wifiPass)
  • 蜂窩模組上的網路註冊應該是自動的
• 等待網路註冊成功
  • modem.waitForNetwork(600000L)
• 如果使用蜂窩網絡，請在網絡上成功註冊後建立 GPRS 或 EPS 數據連接
  • modem.gprsConnect(apn, gprsUser, gprsPass) （或簡稱modem.gprsConnect(apn) ）
  • 相同的命令用於 GPRS 或 EPS 連接
  • 如果使用Digi品牌的蜂巢 XBee，您必須在等待網路之前指定您的 GPRS/EPS 連線資訊。這僅適用於Digi 蜂窩 XBees ！對於所有其他蜂窩模組，請在網路註冊後使用 GPRS 連線功能。
• 連線 TCP 或 SSL 用戶端client.connect(server, port)
• 發送您的資料。

如果您有任何問題

1. 閱讀整個自述文件（您正在看它！），特別是下面的故障排除部分。
2. 有些板子需要特殊配置。
3. 嘗試執行診斷草圖
4. 在此處檢查突出顯示的主題
5. 如果您有疑問，請在我們的 Gitter 聊天中發布

它是如何運作的？

許多 GSM 數據機、WiFi 和無線電模組可以透過串列發送 AT 命令來控制。 TinyGSM 知道要傳送哪些指令，以及如何處理 AT 回應，並將其包裝到標準 Arduino 用戶端介面中。

該庫的所有通訊都處於「阻塞」狀態。根據功能的不同，您的程式碼可能會被阻塞很長時間以等待模組回應。除了明顯的（即waitForNetwork() ）之外，其他幾個函數可能會阻塞您的程式碼長達數分鐘。 gprsConnect()和client.connect()函數通常阻塞時間最長，尤其是在服務較差的地區。模組關閉和重啟也可能相當慢。

該庫不支援模組的任何類型的“硬體”或引腳級控制。如果您需要使用某種高/低/高引腳序列開啟或重置模組，則必須自行編寫這些函數。

API參考

對於 GPRS 資料流，此程式庫提供標準 Arduino 用戶端介面。如需其他功能，請參考此範例草圖

故障排除

確保穩定的數據和電源連接

大多數模組需要2A 電流才能正確連接到網路。這是「標準」USB 所能提供的容量的 4 倍！改善供電其實很多時候就解決穩定性問題了！

• 了解有關為模組供電的資訊。
• 使電線盡可能短
• 考慮焊接它們以獲得穩定的連接
• 請勿將電線放置在噪音訊號源（降壓轉換器、天線、振盪器等）附近
• 如果其他一切似乎都正常，但您無法連接到網絡，請檢查您的電源！

波特率

大多數模組支援某種「自動波特率」功能，其中模組將嘗試調整其波特率以匹配其接收的波特率。 TinyGSM 也實作了自己的自動波特率功能（ TinyGsmAutoBaud(SerialAT, GSM_AUTOBAUD_MIN, GSM_AUTOBAUD_MAX); ）。雖然在最初連接到模組並進行測試時非常有用，但它們不應該在任何類型的生產程式碼中使用。與模組建立通訊後，使用setBaud(#)函數設定波特率並堅持使用該速率。

初始配置損壞

有時（特別是如果您使用 AT 命令），您的模組配置可能會變得無效。這可能會導致以下問題：

• 無法連接GPRS網絡
• 無法連接到伺服器
• 發送/接收的資料包含無效位元組
• ETC。

若要將模組還原為出廠預設值，請使用下列草圖：檔案 -> 範例 -> TinyGSM -> 工具 -> FactoryReset

在某些情況下，您可能需要設定初始 APN 才能連接到蜂窩網路。如果您無法在網路上註冊，請嘗試使用gprsConnect(APN)函數設定初始 APN。註冊後您可能需要重新設定APN。 （大多數情況下，您應該在註冊後設定 APN。）

連線失敗或未收到數據

首次使用新 SIM 卡、新模組或在新位置/塔進行連接可能需要很長時間 - 長達 15 分鐘甚至更長，特別是在訊號品質不佳的情況下。如果這是您第一次轉機，您可能需要調整等待時間，並可能在等待時去吃午餐。

如果您能夠開啟 TCP 連接，但在接收資料之前關閉連接，請嘗試在您的請求中新增 keep-alive 標頭。當遠端伺服器關閉連線時，某些模組（即 SSL 模式下的 SIM7000）將立即丟棄任何未讀取的資料 - 有時甚至不會先發出資料到達的通知。使用 MQTT 時，為了保持連續連接，您可能需要減少保持活動間隔 (PINGREQ/PINGRESP)。

診斷草圖

使用此草圖協助診斷 SIM 卡和 GPRS 連線問題：檔案 -> 範例 -> TinyGSM -> 工具 -> 診斷

如果診斷失敗，請取消註解此行以從庫中輸出一些偵錯註解：

# define TINY_GSM_DEBUG SerialMon

在任何自訂程式碼中，必須在包含 TinyGSM 庫之前定義TINY_GSM_DEBUG 。

如果在庫偵錯中無法看到任何明顯錯誤，請使用 StreamDebugger 將整個 AT 命令序列複製到主串列埠。在診斷範例中，只需取消註解該行：

# define DUMP_AT_COMMANDS

在自訂程式碼中，您可以新增此片段：

# ifdef DUMP_AT_COMMANDS
  # include < StreamDebugger.h >
  StreamDebugger debugger (SerialAT, SerialMon);
  TinyGsm modem (debugger);
# else
  TinyGsm modem (SerialAT);
# endif

Web 請求格式問題 - “但它適用於 PostMan”

該庫開啟到伺服器的 TCP（或 SSL）連線。在 OSI 模型中，這是第 4 層（對於 SSL 來說是第 5 層）。 HTTP (GET/POST)、MQTT 以及您可能想要在第 7 層使用的大多數其他功能。像 PostMan 這樣的工具也顯示第 7 層，而不是像 TinyGSM 那樣顯示第 4/5 層。如果您成功連接到伺服器，但收到「錯誤請求」的回應（或無回應），則問題可能在於您的格式。以下是手動編寫第 7 層（特別是 HTTP 請求）的一些技巧：

• 查看“WebClient”範例
• 確保包含所有必需的標頭。
  • 如果您正在使用 PostMan 進行測試，請確保取消隱藏並查看「自動產生」標頭；您可能會對它們的數量感到驚訝。
• 使用client.print("...")或client.write(buf, #) ，甚至client.write(String("...")) ，而不是client.write("...")來幫助防止文字一次發送一個字元（打字機風格）
• 將每個標題或行的全部內容包含在單一字串或列印語句中
  • 使用

  client.print(String( " GET " ) + resource + " HTTP/1.1 rn " );

  而不是

  client.print( " GET " );
  client.print(resource);
  client.println( " HTTP/1.1 " )

• 確保最後一個標頭和任何 POST 請求的內容之間有一個完全空白的行。
  • 在最後一個標頭中加入兩行client.print("....rnrn")或放入額外的client.println()
  • 這是一個 HTTP 需求，而且很容易被忽略。

軟體序號問題

當使用SoftwareSerial （在 Uno、Nano 等上）時，速度115200可能無法運作。嘗試選擇57600 、 38400甚至更低 - 最適合您的。在某些情況下， 9600不穩定，但使用38400會有所幫助，等等。請注意，並非每個 Arduino 引腳都可以用作 TX 或 RX 引腳。在此處和此處閱讀有關 SoftSerial 選項和配置的更多資訊。

ESP32 註釋

硬體序列

使用 ESP32 HardwareSerial時，您可能需要為.begin()呼叫指定其他參數。請參考這個評論。

Http客戶端

您將無法使用 ESP32 core 1.0.2 編譯 HttpClient 或 HttpsClient 範例。升級到 1.0.3、降級到版本 1.0.1 或使用 WebClient 範例。

SAMD21

當使用基於 SAMD21 的板時，您可能需要使用 sercom uart 連接埠而不是Serial1 。請參考這個評論。

Goouuu Tech IOT-GA6 與 AI-Thinker A6 混淆

事實證明， Goouuu Tech IOT-GA6與AI-Thinker A6並不相同。不幸的是，IOT-GA6 尚不支援開箱即用。有一些提示表明 IOT-GA6 韌體可能會更新以匹配 A6...請參閱此主題。

SIM800 和 SSL

SIM800 的某些版本（但不是全部）支援 SSL。是否支援 SSL 取決於韌體版本和各個模組。即使韌體明顯相同，用戶在 SIM800 上使用 SSL 也取得了不同程度的成功。如果您需要 SSL，但它似乎不適用於您的 SIM800，請嘗試不同的模組或嘗試使用輔助 SSL 庫。

使用哪個版本的 SIM7000 程式碼

SIM7000 代碼有兩種版本，一種使用TINY_GSM_MODEM_SIM7000 ，另一種使用TINY_GSM_MODEM_SIM7000SSL 。 TINY_GSM_MODEM_SIM7000版本不支援SSL ，但最多支援8個同時連線。 TINY_GSM_MODEM_SIM7000SSL版本支援 SSL和不安全連接，最多可同時連接 2 個。那為什麼會有兩個版本呢？ 「SSL」版本使用SIM7000的「應用程式」指令，而另一個版本則使用「TCP-IP工具包」。根據您所在的地區/固件，其中之一可能不適合您。兩者都嘗試一下，然後使用更穩定的一個。如果您不需要 SSL，我建議從TINY_GSM_MODEM_SIM7000開始。

---

執照

該專案根據 GNU Lesser General Public License (LGPL-3.0) 發布