README.md

AIS 4G Board Library for Arduino

AIS 4G Board คือบอร์ดพัฒนาที่สามารถเชื่อมต่ออินเตอร์เน็ตผ่าน 4G มาพร้อมกับไมโครคอนโทรลเลอร์ ESP32-WROOM-32 และโมดูลสื่อสาร SIM7600E-H1C รองรับการเชื่อมต่ออุปกรณ์ภายนอกผ่าน GPIO ทั้ง ESP32 และ SIM7600 นอกจากนี้ยังรองรับการเชื่อมต่อแบบ I2C/RS485/SPI/I2S/UART

ไลบรารีสำหรับ AIS 4G Board ใช้กับโปรแกรม Arduino IDE รองรับการเชื่อมต่อ MQTT, HTTP, Azure IoT Hub, Azure IoT Central มาพร้อมคำสั่งอ่านพิกัดจาก GPS (บนโมดูล SIM7600), อ่านค่าอุณหภูมิ/ความชื้นจากเซ็นเซอร์บนบอร์ด, ติดต่อกับอุปกรณ์ภายนอกผ่าน RS485/ModbusRTU, บันทึกและเปิดไฟล์จาก MicroSD Card เป็นต้น

---

สารบัญ

• รู้จัก AIS 4G Board
• การเริ่มต้นใช้งาน
• การส่งข้อมูลขึ้น Azure IoT Central
  • เตรียมโค้ดโปรแกรม
  • สมัคร Azure และสร้างโปรเจค
  • สร้าง Device templates
  • สร้าง Device
  • แก้โค้ดโปรแกรม
  • ตรวจสอบผลการทำงาน
• การส่งข้อมูลขึ้น Magellan Platform
  • เตรียมโค้ดโปรแกรมเชื่อมต่อ Magellan platform
  • สมัคร AIS Playground และ Magellan Platform
  • ลงทะเบียน Device และสร้างโปรเจค
  • เพิ่ม Device เข้าโปรเจค และตั้งค่า Heartbeat
  • แก้ไขโค้ดโปรแกรมให้เชื่อมต่อ
  • ตรวจสอบผลการทำงานบน Magellan Platform
• คำสั่งที่มีให้ใช้งาน
  • GSM.h
  • GSMNetwok.h
  • GSMClient.h
  • GSMClientSecure.h
  • GSMUdp.h
  • GPS.h
  • Storage.h
  • SHT40.h
  • RS485.h
  • AzureIoTHub.h
  • AzureIoTCentral.h
  • MAGELLAN_SIM7600E_MQTT.h
• ศึกษาเพิ่มเติม
  • เอกสารการใช้งาน
  • ตัวอย่างโค้ดโปรแกรม
  • Dimension

รู้จัก AIS 4G Board

AIS 4G Board เป็นบอร์ดที่รวมไมโครคอนโทรลเลอร์ ESP32-WROOM-32 (โมดูล WiFi/Bluetooth) เข้ากับ SIM7600E-H1C (โมดูล 4G) รองรับการเชื่อมต่ออินเตอร์เน็ตเพื่อทำงานด้าน IoT ครบทุกรูปแบบการเชื่อมต่อ ทั้งผ่านเครือข่ายโทรศัพท์มือถือ 4G, WiFi และ Bluetooth รองรับการอ่านค่าตำแหน่งปัจจุบันจาก GPS มีเซ็นเซอร์วัดอุณหภูมิและความชื้นบนบอร์ด มีปุ่มโปรแกรมได้อิสระ 1 ปุ่ม มีหลอดแอลอีดีโปรแกรมได้อิสระ 1 ดวง มีช่องเสียบ MicroSD Card มีช่องต่ออุปกรณ์ภายนอกผ่าน RS485, I2C, SPI, UART, I2S

การเริ่มต้นใช้งาน

• เสียบสาย USB Type-C เข้ากับ AIS 4G Board ฝั่ง ESP32 ปลายอีกด้านเสียบเข้ากับคอมพิวเตอร์
• ดาวน์โหลดไดร์เวอร์ FT231X จาก VCP Drivers และติดตั้งตามขั้นตอน Installation Guides
• ดาวน์โหลดโปรแกรม Arduino IDE V1.xx.xx จาก Software | Arduino แล้วติดตั้งโปรแกรมตามขั้นตอน Install the Arduino Software (IDE) on Windows PCs
• เปิดโปรแกรม Arduino IDE ขึ้นมา แล้วติดตั้งแพ็กเกจบอร์ด ESP32 เพิ่ม โดยทำตามขั้นตอน Installing - Arduino-ESP32
• ติดตั้งไลบรารี่ AIS 4G Board ผ่าน Library Manager (อ่านเพิ่มเติม Installing Additional Arduino Libraries)
• เลือกบอร์ดเป็น ESP32 Dev Module แล้วเลือกพอร์ตเป็น COM port ที่ใช้
• เปิดโปรแกรมตัวอย่าง Read_IMEI เพื่อทดสอบอ่านหมายเลข IMEI ของโมดูล 4G (ทดสอบการอัพโหลดโปรแกรม-ทดสอบการทำงานของโมดูล 4G)
• อัพโหลดโปรแกรมลงบอร์ด แล้วเปิด Serial Monitor ขึ้นมา ปรับ baud rate เป็น 115200 จากนั้นให้กดปุ่ม RESET แล้วดูผลลัพธ์ที่ได้ จะต้องแสดงหมายเลข IMEI ออกมา

การส่งข้อมูลขึ้น Azure IoT Central

เตรียมโค้ดโปรแกรม

• ติดตั้งไลบรารี AIS IoT 4G ตามหัวข้อ การเริ่มต้นใช้งาน
• ใช้ตัวอย่าง IoT_Central_sample ในการทดสอบส่งข้อมูลอุณหภูมิและความชื้นจากเซ็นเซอร์บนบอร์ด ขึ้น Azure IoT Central

สมัคร Azure และสร้างโปรเจค

• สมัครสมาชิก https://portal.azure.com/ กดปุ่ม Start free แล้วสมัครสมาชิกพร้อมตั้งค่ารูปแบบการชำระเงินให้เรียบร้อย (ใช้งานครั้งแรกได้เครดิทฟรี $200 เป็นเวลา 7 วัน)
• เข้าไปที่ https://apps.azureiotcentral.com/myapps กดสร้าง Custom app ตั้งชื้อ พร้อมตั้งค่าการชำระเงินให้เรียบร้อย

สร้าง Device templates

• เข้าไปที่ Device templates กดปุ่ม New แล้วดูตรง Create a custom device template ให้กดเลือก IoT Device ตั้งชื่อ แล้วดำเนินขั้นตอนจนจบ
• เข้าไปที่ Device template ที่สร้างขึ้น สร้าง/ตั้งค่า Modal ดังนี้

Display name	Name	Capability type	Semantic type
temperature	temperature	Telemetry	Temperature
humidity	humidity	Telemetry	Relative humidity
light	light	Command

• ของ light (ที่เป็น Command) ให้กดเปิดรายละเอียดขึ้นมา แล้ว
  • กดเปิดใช้ Request
  • Display name กำหนดเป็น Level
  • Name กำหนดเป็น level
  • Schema กำหนดเป็น Integer
• แล้วกดปุ่ม Save ให้เรียบร้อย
• กดที่เมนู Views แล้วกดเลือก Generate default views
• ตั้งค่าหน้า Dashboard ย้ายตำแหน่งกราฟ-กล่องข้อความ เปลี่ยนชื่อได้ตามต้องการ แล้วกด Save
• กด Back กลับมาหน้าจัดการ Device template กดปุ่ม Publish เพื่อให้นำ template ไปใช้ตอนสร้าง Device ได้

สร้าง Device

• เข้าไปที่เมนู Devices กดปุ่ม New
• ตั้งชื่ออุปกรณ์ตรง Device name แล้วเลือก Device template เป็นชื่อ template ที่สร้างไว้ก่อนหน้านี้
• กดปุ่ม Create

แก้โค้ดโปรแกรม

• ใน Azure ที่หน้าอุปกรณ์ ให้กดปุ่ม Connect ด้านบนมุมซ้าย
• คัดลอก ID scope, Device ID, Primary key ไปใส่ในโค้ดโปรแกรมตัวอย่าง IoT_Central_sample
• อัพโหลดโปรแกรมลงบอร์ด

ตรวจสอบผลการทำงาน

• เปิด Serial Monitor ขึ้นมา ในหน้าต่าง Serial Monitor จะแจ้งสถานะการเชื่อมต่อกับ Azure IoT Central เป็นระยะ ๆ
• เมื่อเชื่อมต่อสำเร็จ ค่าอุณหภูมิและความชื้นจะส่งขึ้น Azure IoT Central ทุก ๆ 3 วินาที
• ใน Azure ที่หน้าอุปกรณ์ จะแสดงสถานะอุปกรณ์เป็น Connected ให้กดที่แถบ View เพื่อดูค่าในรูปแบบกราฟ
• กดดูข้อมูลแบบละเอียดได้ในแถบ Raw data
• สั่งเปิด-ปิด หลอด LED E15 บนบอร์ดได้โดยกดแถบ Command ตรง Level ให้ใส่ 1 หากต้องการให้ไฟติด และใส่ 0 หากต้องการให้ไฟดับ แล้วกดปุ่ม Run
• สังเกตว่าใน Serial Monitor จะแสดงผลข้อความแจ้งได้รับ Command ใหม่เข้ามา พร้อมหลอด LED E15 ติด-ดับ ตามคำสั่งที่ส่งเข้ามา

การส่งข้อมูลขึ้น Magellan Platform

เตรียมโค้ดโปรแกรมเชื่อมต่อ Magellan platform

• ติดตั้งไลบรารี AIS IoT 4G ตามหัวข้อ การเริ่มต้นใช้งาน
• ใช้ตัวอย่าง reportSensorJSON ในการทดสอบส่งข้อมูลอุณหภูมิและความชื้นจากเซ็นเซอร์บนบอร์ด ขึ้น Magellan Platform

สมัคร AIS Playground และ Magellan Platform

• เข้าไปที่ https://magellan.ais.co.th/ กด REGISTER เพื่อสมัครสมาชิก หากไม่มี Account ของ AIS Playground ให้กดเลือก Register กรอกข้อมูลแล้วกด ปุ่ม Done จากนั้นรอ Email ยืนยัน
• เมื่อได้รับ Email ยืนยันเรียบร้อยแล้ว สามารถ Login ใช้งาน Magellan Platform ได้ผ่าน Email ที่สมัครไว้

ลงทะเบียน Device และสร้างโปรเจค

• กดที่แถบ menu ซ้ายมือเลือก MY THINGS กดปุ่ม RESIGTER THING กรอก ICCID และ IMSI ตั้งชื่อ Thing กดปุ่ม SAVE
• กดที่แถบ menu ซ้ายมือเลือก ALL PROJECT กดเลือกที่ MY PROJECT กดปุ่ม CREATE NEW PROJECT แล้วตั้งชื่อ กดปุ่ม CREATE

เพิ่ม Device เข้าโปรเจค และตั้งค่า Heartbeat

• กดเลือกโปรเจคที่สร้าง กดเลือกที่แถบ THING และกดปุ่ม ADD THING แล้วเลือก Device ที่ลงทะเบียนไว้โดยกดปุ่ม ADD TO PROJECT
• กดเลือกที่กล่อง Thing กดปุ่ม EDIT THING ให้กดเลือก Heartbeat กำหนดเวลาที่ต้องการให้แสดงหาก Device ขาดการเชื่อมต่อในที่นี้ยกตัวอย่างเป็น 20 วินาที และกดปุ่ม SAVE

แก้ไขโค้ดโปรแกรม

• ไปที่โค้ดตัวอย่าง reportSensorJSON
• อัพโหลดโปรแกรมลงบอร์ด

ตรวจสอบผลการทำงานบน Magellan Platform

• เปิด Serial Monitor ขึ้นมา ในหน้าต่าง Serial Monitor จะแจ้งสถานะการเชื่อมต่อกับ Magellan Platform
• เมื่อเชื่อมต่อสำเร็จ ค่าอุณหภูมิและความชื้นจะส่งขึ้น Magellan Platfrom ทุก ๆ 10 วินาที
• ใน Magellan Platform ที่หน้าอุปกรณ์ จะแสดงสถานะอุปกรณ์เป็น Connected
• กดดูข้อมูลแบบละเอียดได้ในแถบ Data History
• สังเกตว่าใน Serial Monitor จะแสดงผลข้อความแจ้งค่าอุณหภูมิและความชื้นจากเซ็นเซอร์บนบอร์ดตามคำสั่งที่กำหนด

คำสั่งที่มีให้ใช้งาน

#include <GSM.h>

ใช้สั่งงานโมดูล SIM7600 บนบอร์ดเบื้องต้น มีคำสั่งดังนี้

• GSM.begin() สั่งให้โมดูล SIM7600 เริ่มทำงาน
• GSM.shutdown() สั่งให้โมดูล SIM7600 หยุดทำงาน
• GSM.lowPowerMode() สั่งให้โมดูล SIM7600 เข้าโหมดประหยัดพลังงาน (โหมดเครื่องบิน)
• GSM.noLowPowerMode() สั่งให้โมดูล SIM7600 ออกจากโหมดประหยัดพลังงาน
• GSM.getIMEI() อ่านหมายเลข IMEI ของโมดูล
• GSM.getIMSI() อ่านหมายเลข IMSI
• GSM.pinMode() กำหนดโหมด INPUT/OUTPUT ของขา S3 ถึง S77
• GSM.digitalWrite() กำหนดเขียนสถานะลอจิก HIGH / LOW ไปที่ขา S3 ถึง S77
• GSM.digitalRead() อ่านสถานะลอจิก HIGH / LOW จากขา S3 ถึง S77

#include <GSMNetwok.h>

คำสั่งเกี่ยวกับการเชื่อมต่อเครือข่าย 4G มีดังนี้

• Network.getCurrentCarrier() อ่านชื่อเครือข่ายที่เชื่อมต่ออยู่
• Network.getSignalStrength() อ่านความแรงของสัญญาณ 4G
• Network.getDeviceIP() อ่านหมายเลข IP ของอุปกรณ์
• Network.pingIP() ใช้ Ping ไปที่ Host ใด ๆ เพื่อทดสอบการเชื่อมต่ออินเตอร์เน็ต

#include <GSMClient.h>

(สืบทอดคลาส Client) ใช้เชื่อมต่อ TCP ผ่านเครือข่าย 4G มีคำสั่งดังนี้

• GSMClient client สร้าง Socket ของ TCP และสร้างออปเจค client
• client.connect() สั่งเชื่อมต่อไปที่ TCP Server
• client.connected() ตรวจสอบสถานะการเชื่อมต่อ TCP Server
• client.write() ส่งข้อมูลไปที่ TCP Server
• client.available() ตรวจสอบจำนวนข้อมูลที่ TCP Server ส่งมา
• client.read() อ่านข้อมูลที่ TCP Server ส่งมา
• client.stop() ตัดการเชื่อมต่อกับ TCP Server

#include <GSMClientSecure.h>

(สืบทอดคลาส Client) ใช้เชื่อมต่อ TCP ผ่าน TLS ผ่านเครือข่าย 4G มีคำสั่งเหมือนกับ GSMClient.h แต่มีคำสั่งเพิ่มขึ้นมาดังนี้

• client.setInsecure() ปิดการตรวจสอบใบรับรอง (CA) ของ TCP/TLS Server
• client.setCACert() ตั้งค่าใบรับรองของ TCP/TLS Server

#include <GSMUdp.h>

(สืบทอดคลาส Client) ใช้เชื่อมต่อ UDP ผ่านเครือข่าย 4G มีคำสั่งดังนี้

• GSMUdp udp จองใช้ Socket และสร้างออปเจค udp
• udp.begin() เริ่มต้นใช้งาน UDP และกำหนด Local Port
• udp.beginPacket() สร้าง Data Packet ใหม่ พร้อมสร้างบัฟเฟอร์ใช้เก็บข้อมูลเพื่อส่ง
• udp.write() เขียนข้อมูลที่ต้องการส่งลงบัฟเฟอร์
• udp.endPacket() ใช้บอกจบ Packet และส่งข้อมูล UDP ในบัฟเฟอร์ไปยัง Server
• udp.parsePacket() ตรวจสอบว่ามี Data Packet ใหม่เข้ามาหรือไม่
• udp.available() ตรวจสอบจำนวนข้อมูลที่ยังไม่ได้อ่าน
• udp.read() อ่านข้อมูลใน Data Packet
• udp.stop() ยกเลิกการใช้งาน UDP

#include <GPS.h>

ใช้อ่านค่าพิกัด เวลา ความเร็ว จาก GNSS (GPS) มีคำสั่งดังนี้

• GPS.begin() เริ่มต้นใช้งาน GNSS
• GPS.available() ตรวจสอบสถานะการจับสัญญาณ GNSS (จับสัญญาณได้แล้ว/ยังจับสัญญาณไม่ได้)
• GPS.latitude() อ่านค่าละติจูด
• GPS.longitude() อ่านค่าลองจิจูด
• GPS.speed() อ่านค่าความเร็ว
• GPS.course()
• GPS.altitude() อ่านค่าความสูง
• GPS.getTime() อ่านค่าเวลา Timestamp หน่วยวินาที (GMT+0)
• GPS.standby() ปิดใช้ GNSS
• GPS.wakeup() เปิดใช้งาน GNSS

#include <Storage.h>

ใช้อ่าน-เขียนไฟล์ใน SIM7600 และใน MicroSD Card

• Storage.fileWrite() ใช้เขียนไฟล์
• Storage.fileRead() ใช้อ่านไฟล์

remark: มี 2 ไดร์ให้สามารถอ่านเขียนไฟล์ได้ คือ C: เป็นพื้นที่เก็บข้อมูลภายใน SIM7600 และ D: เป็นพื้นที่ใน MicroSD Card

#include <SHT40.h>

ใช้อ่านค่าเซ็นเซอร์วัดอุณหภูมิและความชื้นบนบอร์ด AIS 4G Board

• SHT40.begin() เริ่มต้นใช้งานเซ็นเซอร์วัดอุณหภูมิและความชื้น
• SHT40.readTemperature() อ่านค่าอุณหภูมิในหน่วยองศาเซลเซียส
• SHT40.readHumidity() อ่านค่าความชื้นในหน่วย %RH

remark: ก่อนเรียกใช้คำสั่ง SHT40.begin() ต้องเรียกใช้ Wire.begin() ก่อนเสมอ

#include <RS485.h>

ใช้รับ-ส่งข้อมูลผ่านช่อง RS485 พร้อมคำสั่งอ่านค่าผ่านโปรโตคอล MODBUS RTU มีคำสั่งพื้นฐาน RS485.begin() RS485.write() RS485.available() RS485.read() เหมือน Serial ปกติ แต่มีคำสั่งเพิ่มขึ้นมาดังนี้

• RS485.beginTransmission() คำสั่งเริ่มต้นส่งข้อมูลผ่าน RS485 (จองใช้บัส RS485)
• RS485.endTransmission() คำสั่งจบการส่งข้อมูลผ่าน RS485 (คืนบัส RS485 ให้อุปกรณ์อื่นใช้บัสต่อ)
• RS485.receive() สั่งเข้าโหมดรับข้อมูล
• RS485.noReceive() สั่งออกจากโหมดรับข้อมูล (เข้าโหมดส่งข้อมูล)
• RS485.coilRead() ส่งคำสั่ง Coil Read (Function Code 1) อ่านค่าหน้าสัมผัสจากอุปกรณ์ MODBUS
• RS485.discreteInputRead() ส่งคำสั่ง Read Discrete Inputs (Function Code 2) อ่านค่าหน้าสัมผัสจากอุปกรณ์ MODBUS
• RS485.holdingRegisterRead() ส่งคำสั่ง Read Holding Registers (Function Code 3) อ่านค่าจาก Holding Register ในอุปกรณ์ MODBUS
• RS485.inputRegisterRead() ส่งคำสั่ง Read Input Registers (Function Code 4) อ่านค่าจาก Input Register ในอุปกรณ์ MODBUS
• RS485.coilWrite() ส่งคำสั่ง Coil Write (Function Code 5) สั่งให้รีเลย์/หน้าสัมผัส ของอุปกรณ์ MODBUS เปิด-ปิด

remark: ก่อนส่งข้อมูลด้วย RS485.write() RS485.print() RS485.println() ต้องเรียกใช้คำสั่ง RS485.beginTransmission() ก่อนเสมอ และเมื่อส่งข้อมูลครบแล้ว ต้องเรียกใช้คำสั่ง RS485.endTransmission() ด้วย

#include <AzureIoTHub.h>

ใช้เชื่อมต่อ รับ-ส่งข้อมูลกับ Azure IoT Hub

• AzureIoTHub iot; เริ่มต้นใช้งานไลบรารี Azure IoT Hub สร้างออปเจค iot
• iot.configs() ตั้งค่าการเชื่อมต่อ Azure IoT Hub
• iot.connect() สั่งให้เชื่อมต่อไปที่ Azure IoT Hub
• iot.isConnected() ตรวจสอบการเชื่อมต่อกับ Azure IoT Hub
• iot.setTelemetryValue() กำหนดค่าให้ Telemetry ที่ต้องการส่งขึ้น Azure IoT Hub
• iot.sendMessage() ส่ง Telemetry ขึ้น Azure IoT Hub
• iot.addCommandHandle() ใช้เพิ่มฟังก์ชั่นรับข้อมูลจาก Command ที่ส่งมาจาก Azure IoT Hub
• iot.loop()

remark: คำสั่ง iot.loop() จำเป็นต้องถูกเรียกใช้ให้บ่อยที่สุดเท่าที่เป็นไปได้ หากเรียกใช้งานไม่บ่อย จะไม่สามารถรับข้อมูล (Command) จาก Azure IoT Hub ได้ และจะถูกตัดการเชื่อมต่อจาก Azure IoT Hub เป็นระยะ ๆ

#include <AzureIoTCentral.h>

ใช้เชื่อมต่อ รับ-ส่งข้อมูลกับ Azure IoT Central มีคำสั่งเหมือนกับ AzureIoTHub.h ทุกประการ ยกเว้นตอนสร้างออปเจค ให้สร้างโดยใช้คำสั่ง AzureIoTCentral iot; แทน

#include <MAGELLAN_SIM7600E_MQTT.h>

ใช้เชื่อมต่อ รับ-ส่งข้อมูลกับ Magellan Platform ด้วยโปรโตคอล MQTT (Message Queuing Telemetry Transport)

• setting (Global Object Variables)

  • setting.ThingIdentifier ใช้เป็นตัวแปรสำหรับกำหนดค่า ThingIdentifier
  • setting.ThingSecret ใช้เป็นตัวแปรสำหรับกำหนดค่า ThingSecret
  • setting.endpoint ใช้เป็นตัวแปรสำหรับกำหนดค่า IP หรือ URL Path ปลายทางที่ต้องการให้อุปกรณ์เชื่อมต่อ
  • setting.clientBufferSize ใช้เป็นตัวแปรสำหรับกำหนดค่า clientBufferSize ของอุปกรณ์ โดยสามารถกำหนดขนาดตามที่ต้องการหรือใช้ค่าตัวแปร Default ที่กำหนดให้
  • setting.builtInSensor ใช้เป็นตัวแปรสำหรับกำหนดค่า เปิดใช้งาน Sensor builtin บนตัวบอร์ด AIS 4G board

• MAGELLAN_SIM7600E_MQTT magel; เริ่มต้นใช้งานไลบรารี Magellan Platform สร้างออปเจค magel

• Begin

  • magel.begin() เริ่มต้นใช้งาน AIS 4G Baoard และตั้งค่าการเชื่อมต่อ Magellan Platform
  • magel.centric.begin() เริ่มต้นใช้งาน AIS 4G Baoard และตั้งค่าการเชื่อมต่อ Magellan Platform โดยมีการตรวจสอบการลงทะเบียนของอุปกรณ์ผ่านตัวกลาง
  • magel.begin(setting) เริ่มต้นใช้งาน และตั้งค่าการเชื่อมต่อ Magellan Platform ตามที่กำหนดใน Setting (Global Object Variables)
  • magel.centric.begin(setting) เริ่มต้นใช้งาน AIS 4G Baoard และตั้งค่าการเชื่อมต่อ Magellan Platform โดยมีการตรวจสอบการลงทะเบียนของอุปกรณ์ผ่านตัวกลาง ตามที่กำหนดใน Setting (Global Object Variables)

• Loop handle message MQTT

  • magel.loop() ใช้ทำให้คำสั่งต่าง ๆ สามารถทำงานได้อย่างต่อเนื่องในระหว่างการเชื่อมต่อกับ Magellan Platform จำเป็นต้องถูกเรียกใช้

• Information (Info)

  • magel.Info.getBoardInfo() ใช้อ่านหมายเลข Thing Identifier, Thing Secret ของโมดูลที่ Library ได้ทำการ Generate Thing Key ให้
  • magel.Info.getThingIdentifier() ใช้อ่านหมายเลข Thing Identifier
  • magel.Info.getThingSecret() ใช้อ่านหมายเลข Thing Secret
  • magel.Info.getThingToken() ใช้อ่าน Thing Token
  • magel.Info.getHostName() ใช้อ่าน Host Name บนอุปกรณ์ที่ทำการเชื่อมต่ออยู่

• Subscribes (lists of subscribe)

  • magel.subscribes.([](){ Function Register Subscribe Here }) ใช้ Subscribe Topic หรือ Subscribe Function ภายใน Function subscribes นี้เมื่อมีการ connect หรือ reconnect ตัว function นี้จะ triger function ที่บรรจุไว้ภายในให้อัตโนมัติให้อัตโนมัติเมื่ออุปกรณ์สามารถเชื่อมต่อ Magellan Platform ได้

วิธีใช้งาน Subscribes

   void loop()
   {
     magel.loop();
     magel.subscribes([](){ //* lambda function
       magel.subscribe.control();
       magel.subscribe.report.response();
       Serial.println("Subscribe list!!!");
       /* subscribe something or doing something at once after connect/reconnect */
     });
     /* do something */
   }

หรือ

   void listSubscribe(){
      magel.subscribe.control();
      magel.subscribe.report.response();
      Serial.println("Subscribe list!!!");
   }

   void loop()
   {
     magel.loop();
     magel.subscribes(listSubscribe);
     /* do something */
   }

• Interval timer
  • magel.interval(unsigned int second, []() { function here }) ใช้กำหนดช่วงเวลาให้ Function ที่ประกาศภายใน Interval ทำงานในแต่ละรอบโดยมีหน่วยเป็น Second

ℹ️ InformationFunction "Interval" เป็น Function optional เท่านั้น สามารถใช้ function timer ทดแทนได้

• Check Connection

  • magel.isConnected() ใช้ในการตรวจสอบสถานะการเชื่อมต่อกับ Magellan Platform โดย true = Connected และ false = Not Connected

• BuiltinSensor

  • magel.builtinSensor.readTemperature() ใช้อ่านค่าอุณหภูมิจากเซนเซอร์
  • magel.builtinSensor.readHumidity() ใช้อ่านค่าความชื้นจากเซนเซอร์

ℹ️ Informationหากต้องการปิดหรือเปิดใช้งาน Builtin Sensor สามารถตั้งได้ในส่วนนี้ setting.builtInSensor โดย default ถูกเปิดใช้งานไว้อยู่แล้ว

• GPS

  • magel.gps.avalible() ใช้ตรวจสอบสถานะการจับสัญญาณ GNSS (จับสัญญาณได้/ไม่สามารถจับสัญญาณได้)
  • magel.gps.readLattitude() ใช้อ่านค่าละติจูด
  • magel.gps.readLongitude() ใช้อ่านค่าลองจิจูด
  • magel.gps.readAltitude() ใช้อ่านค่าความสูง
  • magel.gps.readSpeed() ใช้อ่านค่าความเร็ว
  • magel.gps.readCourse() ใช้อ่านค่ามุมองศาของการเคลื่อนที่่
  • magel.gps.readLocation() ใช้อ่านค่าละติจูด และค่าลองจิจูด
  • magel.getUnixTime() ใช้อ่านค่าเวลา Unix (Timestamp) จาก GPS

• Report

  • magel.subscribe.report.response() ใช้ในการ Subscribe Response จากการส่งข้อมูลเซนเซอร์ในรูปแบบ JSON
  • magel.report.send(sensors) ใช้ส่งข้อมูลเซนเซอร์ในรูปแบบ JSON
  • magel.subscribe.report.response(PLAINTEXT) ใช้ในการ Subscribe Response ของการส่งข้อมูลเซนเซอร์ในรูปแบบ Plain Text
  • magel.report.send(String reportKey, String reportValue) ใช้ส่งค่าเซนเซอร์ในรูปแบบ Plain Text
  • magel.subscribe.reportWithTimestamp.response(); ใช้ในการ Subscribe Response การส่งข้อมูลเซนเซอร์ในรูปแบบ JSON พร้อมค่า Timestamp
  • magel.report.send(Int UNIXtimestamp, String sensors); ใช้ส่งข้อมูลเซนเซอร์ในรูปแบบ JSON พร้อมค่า Timestamp ในรูปแบบ UNIXTS (UnixTimestamp) ไปยัง Magellan Platform

• Report with message id

  • magel.subscribe.report.response() ใช้ในการ Subscribe Response จากการส่งข้อมูลเซนเซอร์ในรูปแบบ JSON
  • magel.report.send(String sensors, int msgId); ใช้ส่งข้อมูลเซนเซอร์ในรูปแบบ JSON ด้วย manual MessageId
  • magel.subscribe.report.response(PLAINTEXT) ใช้ในการ Subscribe Response ของการส่งข้อมูลเซนเซอร์ในรูปแบบ Plain Text
  • magel.report.send(String reportKey, String reportValue, int msgId) ใช้ส่งค่าเซนเซอร์ในรูปแบบ Plain Text ด้วย manual MessageId
  • 🆕magel.report.send(String sensors, RetransmitSetting &retransSetting) ใช้ส่งค่าเซนเซอร์ในรูปแบบ JSON ด้วย RetransmitSetting
  • 🆕magel.report.send(String reportKey, String reportValue, RetransmitSetting &retransSetting) ใช้ส่งค่าเซนเซอร์ในรูปแบบ Plain Text ด้วย RetransmitSetting

• 🆕ResultReport [Properties variable inside struct ResultReport]

  • statusReport boolean สำหรับ check publish MQTT Status
  • msgId MessageId default: -1 เมื่อไม่มี MsgId

• 🆕RetransmitSetting [Properties function inside struct RetransmitSetting]

  • .option(bool enabled, unsigned int repeat, unsigned int duration, int msgId)
  • .setEnabled(bool enabled)
  • .setMsgId(int msgId)
  • .setRepeat(unsigned int repeat)
  • .setDuration(unsigned int duration)
  • .generateMsgId()

⚠️ Warningหากมีการเปิดใช้งาน enabled retransmit ด้วย setEnabled จะมีการ report จนกว่าจะได้ Response, msgId โดยทุกๆ duration และ repeat ที่ตั้งค่าไว้ซึ่งจะใช้เวลาในการทำงาน เนื่องจากต้องรอการตอบกลับ ทั้งนี้ขึ้นอยู่กับคุณภาพของสัญญาณของ network connection ของอุปกรณ์แต่สามารถมั่นใจได้ว่า message ของที่ส่งไปถึงหรือไม่ หรือในกรณีผิดพลาดสามารถ track ได้จากจากStatus code

วิธีใช้งาน Report with message id ด้วย RetransmitSetting เพิ่มเติม

   void loop()
   {
     magel.loop();
     magel.subscribes([](){
       magel.subscribe.report.response(); //if using MessageId please subscribe response report to check status and MessageId is acepted from platform.
     });
     magel.interval(15, [](){
       RetransmitSetting settingReport; //decleare object variable for setting report
       ResultReport result; //decleare object variable for receive result report
       settingReport.setEnabled(true); //true: retransmit / false: report with MsgId only
       settingReport.setRepeat(5); //default: 2 attempt *retransmit max 2 time to cancel attempt
       settingReport.setDuration(7); //default: 5 sec. delay wait duration every retransmit
       settingReport.generateMsgId(); //optional: regenerateMsgId if manual using ".setMsgId(msgId)"
       result = magel.report.send("{\"hello\":\"magellan\"}", settingReport);
       Serial.print("[MsgId report]: ");
       Serial.println(result.msgId);
       Serial.print("[Status report]: ");
       Serial.println((result.statusReport)? "SUCCESS" : "FAIL");
     });
     /* do something */
   }

• Sensor
  • magel.sensor.add(sensorKey, sensorValue) ใช้เพิ่มข้อมูลเซนเซอร์ โดยเก็บไว้ที่ JSONBuffer ของ Sensor
  • magel.sensor.update(sensorKey, sensorValue) ใช้แก้ไขข้อมูลเซนเซอร์ตาม sensorKey และ sensorValue ที่กำหนด
  • magel.sensor.location.add(locationKey, latitude , longtitude) ใช้เพิ่มข้อมูลเซนเซอร์ประเภท Location ซึ่งต้องกำหนด locationKey,latitude และ longtitude
  • magel.sensor.location.update(locationKey, latitude , longtitude) ใช้แก้ไขข้อมูลเซนเซอร์ประเภท Location ตาม locationKey,latitude และ longtitude ที่กำหนด
  • magel.sensor.findKey(sensorKey) ใช้ค้นหา sensorKey ใน JSONBuffer ที่เคยเพิ่มเข้าไป ต้องทำการกำหนด sensorKey ที่ต้องการค้นหา
  • magel.sensor.remove(sensorKey) ใช้ลบข้อมูลของเซนเซอร์ออกจาก JSONBuffer ด้วย sensorKey
  • magel.sensor.toJSONString() ใช้แปลงรูปแบบข้อมูล JSON ไปเป็นรูปแบบ JSONString จากข้อมูลเซนเซอร์ที่เก็บไว้ใน JSONBuffer
  • magel.sensor.setJSONBufferSize(int) ใช้กำหนดขนาดของ JSONBuffer ที่ใช้ในการเก็บข้อมูลของ sensorKey และ sensorValue ซึ่งกำหนดค่าเริ่มต้นไว้ที่ 1,024 ไบต์ สามารถกำหนดได้สูงสุดที่ 8,192 ไบต์
  • magel.sensor.readJSONBufferSize() ใช้อ่านขนาดของ JSONBuffer
  • magel.sensor.report() ใช้ในการส่งข้อมูลเซนเซอร์ทั้งหมดที่อยู่ใน JSONBuffer ไปยัง Magellan Platform และลบค่าเซนเซอร์ทั้งหมดที่อยู่ภายใน JSONBuffer ให้หลังจากส่งข้อมูล
  • 🆕magel.report.report(RetransmitSetting &retransSetting) ใช้ส่งค่าเซนเซอร์ในรูปแบบ JSON ด้วย RetransmitSetting
  • magel.sensor.clear() ใช้ลบค่าเซนเซอร์ทั้งหมดที่อยู่ภายใน JSONBuffer

วิธีใช้งาน sensor.report with message id ด้วย RetransmitSetting เพิ่มเติม

   void loop()
   {
     magel.loop();
     magel.subscribes([](){
       magel.subscribe.report.response(); //if using MessageId please subscribe response report to check status and MessageId is acepted from platform.
     });
     magel.interval(15, [](){
       RetransmitSetting settingReport; //decleare object variable for setting report
       ResultReport result; //decleare object variable for receive result report
       settingReport.setEnabled(true); //true: retransmit / false: report with MsgId only
       settingReport.setRepeat(5); //default: 2 attempt *retransmit max 2 time to cancel attempt
       settingReport.setDuration(7); //default: 5 sec. delay wait duration every retransmit
       settingReport.generateMsgId(); //optional: regenerateMsgId if manual using ".setMsgId(msgId)"
       magel.sensor.add("hello","magellan");
       magel.sensor.add("numbers",1234);
       result = magel.sensor.report(settingReport);
       Serial.print("[MsgId report]: ");
       Serial.println(result.msgId);
       Serial.print("[Status report]: ");
       Serial.println((result.statusReport)? "SUCCESS" : "FAIL");
     });
     /* do something */
   }

วิธีการใช้งาน Callback getControl and Acknowledge control

  #include <MAGELLAN_SIM7600E_MQTT.h>
  MAGELLAN_SIM7600E_MQTT magel;
  void setup()
  {
    Serial.begin(115200);
    setting.endpoint = "magellan.ais.co.th"; //if not set *default: magellan.ais.co.th
    setting.clientBufferSize = defaultOTAbuffer; // if not set *default: 1024
    magel.begin(setting);
    //* callback getControl
    magel.getControlJSON([](String controls){ 
      Serial.print("# Control incoming JSON: ");
      Serial.println(controls);
      String control = magel.deserializeControl(controls);
      magel.control.ACK(control); //ACKNOWLEDGE control to magellan ⚠️ important to Acknowledge control value to platform
    });
  }

• หลังจาก decleare function callback getControl มาแล้วไม่ว่าจะ format 'JSON' หรือ 'Plaintext' ก็ตามหากทำการ triger control จาก widget บน platform เพื่อให้อุปกรณ์ได้รับค่า control แต่ตัวอุปกรณ์เกิด disconnect หรือปัญหาที่ไม่ได้รับ message value ทัน event นั้นๆ สามารถเรียกขอค่า control ที่ค้างหรือยังไม่ได้ Acknowledge ได้ดังนี้

ℹ️ Informationหากทำการ Request control แล้วไม่มีค่าค้างอยู่ค่าที่จะได้รับเข้ามาใน Callback getControl จะมีแค่ code 40400 หากมีค้างอยู่จะได้รับ code 20000 และ value control Status code

วิธีการ Request control value ที่ค้างอยู่ (ยังไม่ได้รับการ Acknowledge จากอุปกรณ์)

   void loop()
   {
     magel.loop();
     magel.subscribes([](){
       magel.subscribe.control();
       magel.control.request();  //* using here for request once after new connect or reconnect
     });
     
     magel.interval(20, [](){
       magel.control.request(); //*
     });
   }

• ClientConfig
  • magel.clientConfig.add(ClientConfigKey, ClientConfigValue) ใช้เพิ่มข้อมูล ClientConfig ลงใน JSONBuffer ของ ClientConfig
  • magel.clientConfig.update(ClientConfigKey, ClientConfigValue) ใช้แก้ไขค่า ClientConfig ที่มีการเพิ่มไว้แล้วภายใน JSONBuffer
  • magel.clientConfig.findKey(ClientConfigKey) ใช้ในการค้นหา ClientConfigKey ใน JSONBuffer ของ ClientConfig ซึ่งผู้ใช้งานจะต้องกำหนด ClientConfigKey ที่ต้องการค้นหา โดยจะได้รับผลลัพธ์ในรูปแบบ Boolean หากพบ ClientConfigKey จะได้รับผลลัพธ์เป็น true หากไม่จะได้รับผลลัพธ์เป็น false
  • magel.clientConfig.remove(ClientConfigKey) ใช้ในการลบข้อมูลของ ClientConfig ออกจาก JSONBuffer ของ ClientConfig ด้วย ClientConfigKey
  • magel.clientConfig.toJSONString() ใช้สร้าง JSON String จากข้อมูล ClientConfig ที่ได้ทำการเพิ่มเข้าไปใน JSONBuffer ของ ClientConfig ซึ่งมีขนาดให้ใช้งานจำนวน 512 ไบต์
  • magel.clientConfig.save() ใช้ส่งข้อมูล ClientConfig บันทึกไปยัง Magellan Platform จาก clientConfigKey และ clientConfigValue ที่ได้ทำการเพิ่มเข้าไปใน JSONBuffer
  • magel.clientConfig.save(clientConfigs) ใช้ส่งข้อมูล ClientConfig บันทึกไปยัง Magellan Platform จากข้อมูลในรูปแบบ JSON
  • magel.clientConfig.clear() ใช้ลบค่า ClientConfig ใน JSONBuffer ของ ClientConfig ทั้งหมด

วิธีการใช้งาน Client config

ℹ️ Information Client config จุดประสงค์หรือการใช้งาน feature นี้ถูกสร้างมาเพื่อให้ตัวอุปกรณ์อัพเดทค่า "การตั้งค่าของอุปกรณ์" คล้ายกับ report แต่ไปแสดงข้อมูลใน thing information ด้านล่างแทน activity realtime เพื่อให้ผู้ใช้ง่ายทราบว่า ณ ตอนนี้อุปกรณ์มีการตั้งค่าอย่างไรโดยไม่ไปปะปนกับการส่งค่า sensor ผ่านการ report

  #include <MAGELLAN_SIM7600E_MQTT.h>
  MAGELLAN_SIM7600E_MQTT magel;
  void setup()
  {
    Serial.begin(115200);
    setting.endpoint = "magellan.ais.co.th"; //if not set *default: magellan.ais.co.th
    magel.begin(setting);
    magel.clientConfig.add("location", "15.0000, 58.0000"); //* update location once after connect platform
    magel.clientConfig.add("battery", 100); //* update battery level once after connect platform
    magel.clientConfig.add("interval", 15000); //* update interval value level once after connect platform
    magel.clientConfig.send(); //* send all added clientConfig to platform
  }

• ServerConfig
  • magel.subscribe.serverConfig() ใช้ในการ Subscribe รับข้อมูลการตั้งค่าของอุปกรณ์ (serverConfig) ในรูปแบบ JSON
  • magel.serverConfig.request() ใช้ในการร้องขอข้อมูลการตั้งค่าของอุปกรณ์รูปแบบ JSON
  • magel.subscribe.serverConfig(PLAINTEXT) ใช้ในการ Subscribe รับข้อมูลการตั้งค่าของอุปกรณ์ในรูปแบบ Plain Text
  • magel.serverConfig.request(String serverConfigKey) ใช้ในการร้องขอข้อมูลการตั้งค่าของอุปกรณ์ด้วย serverConfigKey ในรูปแบบ Plain Text
• Heartbeat
  • magel.subscribe.heartbeat.response() ใช้ในการ Subscribe Response เมื่อมีการส่ง Heartbeat ไปยัง Magellan Platform ในรูปแบบ JSON
  • magel.subscribe.heartbeat.response(PLAINTEXT) ใช้ในการ Subscribe getServerTime รับค่า Timestamp เมื่ออุปกรณ์มีการร้องขอเวลาไปยัง Magellan Platfrom ในรูปแบบ JSON
  • magel.heartbeat(unsign int second) ใช้ในการส่งสถานะของอุปกรณ์ไปยัง Magellan Platform ด้วยความถีเป็นวินาทีที่สม่ำเสมอ
• GetServerTime
  • magel.getServerTime() ใช้ในการร้องขอเวลา Timestamp (Unix) จาก Magellan Platform
  • magel.subscribe.getServerTime() ใช้ในการ Subscribe getServerTime รับค่า Timestamp เมื่ออุปกรณ์มีการร้องขอเวลาไปยัง Magellan Platfrom ในรูปแบบ JSON
  • magel.subscribe.getServerTime(PLAINTEXT) ใช้ในการ Subscribe getServerTime รับค่า Timestamp เมื่ออุปกรณ์มีการร้องขอเวลาไปยัง Magellan Platfrom ในรูปแบบ Plant Text

วิธีการใช้งาน GetServerTime

  #include <MAGELLAN_SIM7600E_MQTT.h>
  MAGELLAN_SIM7600E_MQTT magel;
  unsigned long unixTimeMG;
  void setup()
  {
    Serial.begin(115200);
    setting.endpoint = "magellan.ais.co.th"; //if not set *default: magellan.ais.co.th
    magel.begin(setting);
    magel.getResponse(UNIXTIME, [](EVENTS events) 
    { //* for get unixTime from magellan
      unixTimeMG = events.Payload.toInt();
      Serial.print("[unixTimeMG from magellan]: ");
      Serial.println(unixTimeMG);

      String timeString = magel.utils.toDateTimeString(unixTimeMG, 7);
      Serial.printf("\nMagellan: %s\n", timeString.c_str());
    });
  }
   void loop()
   {
     magel.loop();
     magel.subscribes([](){
       magel.subscribe.getServerTime(PLAINTEXT); 
       magel.getServerTime(); // request time from magellan server once after new connect or reconnect
     });
     
     magel.interval(20, [](){
       magel.getServerTime(); // request time from magellan server //*
     });
   }

ℹ️ Information หากอุปกรณ์ต้องการค่าเวลาไปใช้ไม่ว่าจะเป็นการ sync RTC Module หรืออื่นๆ สามารถ request ขอค่าเวลาจาก platform ได้โดยค่าเวลาจะเป็น UnixTimestamp format เช่น 1688011509

• Callback

  • magel.getControl(callback void(String key, String value)) ใช้รับค่า Control เมื่อเกิด Control events จาก Widget บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลเป็น Key และ Value จากการ Control ในรูปแบบ Plain Text
  • magel.getControl(String focusKey, callback void(String payload)) ใช้รับค่า Control เมื่อเกิด Control events จาก Widget บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูล Value จากการ Control เฉพาะ focusKey ที่ผู้ใช้ได้กำหนดไว้เท่านั้น ในรูปแบบ Plain Text
  • magel.getControlJSON(callback void(String payload)) ใช้รับค่า Control เมื่อเกิด Control events จาก Widget บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลในรูปแบบ JSON String
  • magel.getControlJSON(callback void(JsonObject docJson)) ใช้รับค่า Control เมื่อเกิด Control events จาก Widget บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลในรูปแบบ JSON Object
  • magel.getServerConfig(callback void(String key, String value)) ใช้รับค่า Config เมื่อเกิด events จากเปลี่ยนแปลง Online Config บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลเป็น Key และ Value ในรูปแบบ Plain Text
  • magel.getServerConfig(String focusKey, callback void(String payload)) ใช้รับค่า Config เมื่อเกิด events จากเปลี่ยนแปลง Online Config บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูล Value เฉพาะ focusKey ที่ผู้ใช้ได้กำหนดไว้เท่านั้น ในรูปแบบ Plain Text
  • magel.getServerConfigJSON(callback void(String payload)) ใช้รับค่า Config เมื่อเกิด events จากเปลี่ยนแปลง Online Config บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลในรูปแบบ JSONString
  • magel.getServerConfigJSON(callback void(JsonObject docJson)) ใช้รับค่า Config เมื่อเกิด events จากเปลี่ยนแปลง Online Config บนหน้าเว็บ Magellan Platform ซึ่งจะได้รับข้อมูลในรูปแบบ JSONObject
  • magel.getResponse(enum eventResponse, [] (EVENTS event){}) ใช้รับข้อมูลของ Response เมื่อเกิด events ต่าง ๆ โดยผู้ใช้งานสามารถกำหนด enum eventResponse จาก event ที่ต้องการจะแสดงค่าลงไปใน function callback getResponse ได้ดังนี้

• [ Suggest for use in callback getResponse ]

  eventResponse	enum
  UNIXTIME	6
  RESP_REPORT_JSON	8
  RESP_REPORT_PLAINTEXT	9
  RESP_REPORT_TIMESTAMP	10
  RESP_REPORT_JSON	11
  RESP_REPORT_PLAINTEXT	12

• [ Inside data type struct EVENTS ]

  Available function	Results
  event.Key	Type Plaintext
  event.Payload	Type JSON or Plaintext
  event.RESP	String message response “SUCCESS” or “FAIL”
  event.CODE	success code such as 20000 or 40400 etc

• [ ตารางแสดงค่าตัวแปร Default Setting clientBufferSize ]

  ตัวแปร	Default value	การเรียกใช้ตัวแปร
  defaultbuffer	1,024 bytes	setting.clientBufferSize = defaultbuffer
  defaultOTAbuffer	8,192 bytes	setting.clientBufferSize = defaultOTAbuffer

• OTA

  • magel.OTA.utility(). Properties Here; เป็นคำสั่งที่ให้ผู้ใช้งานสามารถอ่านค่าการ OTA เพื่อนำมาใช้เป็นเงื่อนไขหรือเปรียบเทียบ

  [ ตารางแสดงข้อมูล Properties ของ Utility ]

  Properties	Data Type	Default value	Description
  isReadyOTA	boolean	false	สถานะข้อมูลการ OTA ของอุปกรณ์ โดย - true = มีข้อมูลให้ทำการ OTA - false = ไม่มีข้อมูลให้ทำการ OTA
  firmwareIsUpToDate	int	false	สถานะของ Firmware บนอุปกรณ์ เมื่อเทียบกับข้อมูลการ OTA ของอุปกรณ์ที่ได้รับมาล่าสุด ได้แก่ 1) UNKNOWN / (-1) = ไม่ทราบสถานะ 2) OUT_OF_DATE / (0) = ไม่เป็นปัจจุบัน 3) UP_TO_DATE / (1) = ปัจจุบัน
  inProcessOTA	boolean	false	สถานะของการดำเนินการ OTA โดย - true = กำลังดำเนินการ OTA - false = ไม่ได้กำลังดำเนินการ OTA
  firmwareTotalSize	unsigned int	false	ขนาดของ Firmware มีหน่วยเป็น Byte
  firmwareName	String	UNKNOWN	ชื่อของ Firmware
  firmwareVersion	String	UNKNOWN	Version ของ Firmware
  checksum	String	UNKNOWN	ค่า checksum ใช้รับรองความถูกต้องของ Firmware
  checksumAlgorithm	String	UNKNOWN	ประเภท Algorithm ของ Checksum

⚠️ Warning หากมีการ ใช้งาน OTA ควรจะหยุดการทำงานอื่นๆของอุปกรณ์ในส่วนทำงานของโปรแกรม void loop() มีไม่ให้เกิดการขัดขวางการทำงานในการ download และ buffer firmware data บนตัวอุปกรณ์ โดยสามารถ เช็คและหยุดการทำงานในส่วนอื่นๆที่ไม่จำเป็นเพื่อให้อุปกรณ์สามารถ OTA ได้อย่างมีประสิทธิภาพดังนี้

   void loop()
   {
     magel.loop();
     magel.subscribes([](){
       magel.subscribe.control();
     });
     
    if(!magel.OTA.utility().inProcessOTA){
      /* 
      do something if device not in OTA process such as read and send data
      */
    }
   }

• magel.OTA.autoUpdate(boolean) ใช้สำหรับเรียกใช้งานการทำ OTA โดยอัตโนมัติ โดยผู้ใช้งานสามารถกำหนดได้ โดย true คือการกำหนดให้ทำ OTA โดยอัตโนมัติ และ false คือการกำหนดให้ทำ OTA ตามที่ผู้ใช้งานกำหนด
• magel.OTA.executeUpdate() ใช้สำหรับเรียกใช้งานการทำ OTA แบบ Manual
• magel.OTA.getAutoUpdate() ใช้สำหรับอ่านสถานะการตั้งค่าในการทำ OTA
• magel.OTA.checkUpdate() ใช้สำหรับตรวจสอบข้อมูลการ OTA จาก Magellan Platform กับ Firmware ปัจจุบันของอุปกรณ์
• magel.OTA.magel.OTA.readDeviceInfo() ใช้สำหรับอ่านข้อมูล Firmware ปัจจุบันของอุปกรณ์

ศึกษาเพิ่มเติม

ข้อมูลเพิ่มเติมที่จะช่วยให้เริ่มต้นใช้งาน AIS IoT 4G board ได้ง่ายขึ้น

เอกสารการใช้งาน

ไลบรารีนี้พัฒนาขึ้นโดยยึดมาตรฐานชื่อคำสั่งที่ Arduino กำหนดไว้ ให้ใช้เอกสารบนเว็บ Arduino ในการอ้างอิงได้เลย

• Arduino - GSM
• Arduino - Arduino MKR GPS
• Arduino - ArduinoRS485

ตัวอย่างโค้ดโปรแกรม

โค้ดโปรแกรมตัวอย่างอยู่ในโฟลเดอร์ examples แยกตามหมวดหมู่ ดังนี้

• GPS
  • Location - อ่านพิกัดจาก GNSS แสดงผลบน Serial Monitor
  • UnixTime - อ่านค่าเวลา่ Unix (Timestamp) แสดงผลบน Serial Monitor
  • LocalTime - อ่านค่าเวลาประเทศไทย แสดงผลบน Serial Monitor
• Storage
  • File_Read_Write - อ่าน-เขียนไฟล์บน SIM7600
• GSM
  • Read_IMEI - อ่านหมายเลข IMEI แสดงผลบน Serial Monitor
  • Read_IMSI - อ่านหมายเลข IMSI แสดงผลบน Serial Monitor
  • Read_ICCID - อ่านหมายเลข ICCID ของ eSIM แสดงผลบน Serial Monitor
  • LowPowerMode - ตัวอย่างการสั่งให้ SIM7600 เข้าโหมดประหยัดพลังงาน
  • digitalWrite_Sx_pin สั่งให้สถานะลอจิกขา S3 เป็น HIGH/LOW ทุก ๆ 500 วินาที (โปรแกรมไฟกระพริบ)
  • digitalRead_Sx_pin อ่านสถานะลอจิกขา S77 แสดงผลบน Serial Monitor
• Network
  • Ping - Ping เว็บ www.ais.co.th
  • Read_Device_IP - อ่านหมายเลข IP แสดงผลบน Serial Monitor
  • Read_Operator_Name - อ่านชื่อเครือข่ายที่เชื่อมต่ออยู่
  • Read_Signal_Strength - อ่านความแรงสัญญาณ 4G
• TCP
  • GSMClient - ตัวอย่างการรับ-ส่งข้อมูลผ่าน TCP
  • GSMClientSecure - ตัวอย่างการรับ-ส่งข้อมูลผ่าน TCP/TLS
• UDP
  • GSMUdpNtpClient - อ่านค่าเวลาจากอินเตอร์เน็ตด้วยโปรโตคอล NTP
• MQTT - ตัวอย่างในโฟลเดอร์นี้ดัดแปลงมาจาก PubSubClient ศึกษารายละเอียดเพิ่มเติมได้ในลิ้งต้นฉบับ
  • mqtt_basic - ตัวอย่างการเชื่อมต่อ MQTT อย่างง่าย ส่งข้อมูลเข้า Topic outTopic และ Subscribe Topic inTopic
  • mqtt_auth - ตัวอย่างการเชื่อมต่อ MQTT แบบต้องใช้ Username และ Password
  • mqtt_publish_in_callback - ตัวอย่างการส่งข้อมูลเข้า Topic outTopic ในฟังก์ชั่น Callback
• Sensor
  • SHT40_Read - อ่านอุณหภูมิและความชื้นจากเซ็นเซอร์บนบอร์ด แสดงผลบน Serial Monitor
• OTA
  • OTA_via_HTTP_over_4G - อัพเดทเฟิร์มแวร์ผ่าน HTTP ด้วยเครือข่าย 4G (โค้ดโปรแกรมส่วนใหญ่ดัดแปลงมาจากตัวอย่าง AWS_S3_OTA_Update)
• RS485
  • RS485_Slave_Echo - ตัวอย่างการรับข้อมูลจาก RS485 Master แล้วตอบข้อมูลได้ที่รับมากลับไป
  • SDM120CT_Read - ตัวอย่างการอ่านค่าแรงดันไฟฟ้า กระแสไฟฟ้า พลังงานไฟฟ้า จาก Power Meter รุ่น SDM120CT ด้วย RS485 ผ่านโปรโตคอล MODBUS RTU
  • XY_MD02_Read - ตัวอย่างการอ่านค่าอุณหภูมิและความชื้นจากเซ็นเซอร์รุ่น XY-MD02 ด้วย RS485 ผ่านโปรโตคอล MODBUS RTU
  • PZEM_016_Read - ตัวอย่างการอ่านค่าแรงดันไฟฟ้า กระแสไฟฟ้า พลังงานไฟฟ้า จาก Power Meter รุ่น PZEM-016
  • PZEM_016_to_IoT_Central - ตัวอย่างการอ่านค่าแรงดันไฟฟ้า กระแสไฟฟ้า พลังงานไฟฟ้า จาก Power Meter รุ่น PZEM-016 ส่งค่าขึ้น Azure IoT Central
• HTTP ตัวอย่างการรับ-ส่งข้อมูลผ่าน HTTP จำเป็นต้องติดตั้งไลบรารี ArduinoHttpClient เพิ่มเติม
  • HTTP_SimpleGet - ตัวอย่างการรับ-ส่งข้อมูลผ่าน HTTP ด้วย Method GET
  • HTTPS_SimpleGet - ตัวอย่างการรับ-ส่งข้อมูลผ่าน HTTPS ด้วย Method POST
  • HTTPS_SimplePost - ตัวอย่างการรับ-ส่งข้อมูลผ่าน HTTPS ด้วย Method POST
• Azure IoT
  • 4G
    • IoT_Hub_sample - ตัวอย่างการอ่านค่าอุณหภูมิและความชื้นส่งค่าขึ้น Azure IoT Hub ผ่าน 4G (SIM7600)
    • IoT_Central_sample - ตัวอย่างการอ่านค่าอุณหภูมิและความชื้นส่งค่าขึ้น Azure IoT Central ผ่าน 4G (SIM7600)
  • WiFi
    • IoT_Hub_sample - ตัวอย่างการอ่านค่าอุณหภูมิและความชื้นส่งค่าขึ้น Azure IoT Hub ผ่าน WiFi (ESP32)
    • IoT_Central_sample - ตัวอย่างการอ่านค่าอุณหภูมิและความชื้นส่งค่าขึ้น Azure IoT Central ผ่าน WiFi (ESP32)
• Magellan Platform
  • getServerConfig
    • getServerConfigJSON - ตัวอย่างการแสดงค่าที่อุปกรณ์ไปเรียกค่าที่เราทำการ Config ไว้บน Magellan Platform ในรูปแบบ JSON ผ่าน 4G (SIM7600)
    • getServerConfigPlaintext - ตัวอย่างการแสดงค่าที่อุปกรณ์ไปเรียกค่าที่เราทำการ Config ไว้บน Magellan Platform ในรูปแบบ Plain Text ผ่าน 4G (SIM7600)
  • getControl
    • getControlJSON - ตัวอย่างการแสดงค่าที่ตัวอุปกรณ์ทำการ Control บน Dashboard ของ Magellan Platform ในรูปแบบ JSON ผ่าน 4G (SIM7600)
    • getControlPlaintext - ตัวอย่างการแสดงค่าที่ตัวอุปกรณ์ทำการ Control บน Dashboard ของ Magellan Platform ในรูปแบบ Plain Text ผ่าน 4G (SIM7600)
  • getControlLED
    • getControlJSON_LED - ตัวอย่างการแสดงค่าที่ตัวอุปกรณ์ทำการ Control LED บน Dashboard ของ Magellan Platform ในรูปแบบ JSON ผ่าน 4G (SIM7600)
    • getControlPlaintext_LED - ตัวอย่างแสดงค่าที่ตัวอุปกรณ์ทำการ Control LED บน Dashboard ของ Magellan Platform ในรูปแบบ Plain Text ผ่าน 4G (SIM7600)
  • heartbeat
    • heartbeat - ตัวอย่างการส่งสัญญาณไปยัง Server รูปแบบ Heartbeat เพื่อบอกให้ Magellan Platform ทราบว่าอุปกรณ์ดังกล่าว มีการเชื่อมต่ออยู่ผ่าน 4G (SIM7600)
  • reportData
    • reportDataJSON - ตัวอย่างการส่งค่าตัวเลขแบบสุ่มขึ้นไปยัง Magellan Platform ในรูปแบบ JSON ผ่าน 4G (SIM7600)
    • reportDataPlaintext - ตัวอย่างการส่งค่าตัวเลขแบบสุ่มขึ้นไปยัง Magellan Platform ในรูปแบบ Plain Text ผ่าน 4G (SIM7600)
  • reportMultiDataType
    • reportMultiDataType - ตัวอย่างการส่งข้อมูลในรูปแบบหลายประเภท ได้แก่ เลขจำนวนเต็มบวก, เลขจำนวนเต็มลบ, ทศนิยม, ข้อความ, พิกัด GPS และ Boolean Magellan Platform ผ่าน 4G (SIM7600)
  • reportSensor
    • reportSensorJSON - ตัวอย่างการส่งข้อมูลจากเซนเซอร์บนอุปกรณ์ไปบน Magellan Platform ในรูปแบบ JSON ผ่าน 4G (SIM7600)
    • reportSensorPlaintext - ตัวอย่างการส่งข้อมูลจากเซนเซอร์บนอุปกรณ์ไปบน Magellan Platform ในรูปแบบ Plain Text ผ่าน 4G (SIM7600)
  • reportData with messageId
    • reportMsgId - ตัวอย่างการส่งค่าตัวขึ้นไปยัง Magellan Platform ด้วย MessageId
    • reportMsgIdReportSetting - ตัวอย่างการส่งค่าตัวขึ้นไปยัง Magellan Platform ด้วย MessageId ผ่านการใช้ ReportSetting
    • reportRetransmit - ตัวอย่างการส่งค่าตัวขึ้นไปยัง Magellan Platform ด้วยการเปิดใช้งาน
  • reportUserButton
    • reportUserButton - ตัวอย่างการใช้งานปุ่มกด (User Button) บนอุปกรณ์ โดยจะมีการทำงานร่วมกับ Magellan Platform ในส่วนของ Dashboard ผ่าน 4G (SIM7600)
  • reportWithTimestamp
    • reportWithTimestamp - ตัวอย่างการส่งข้อมูลจากเซนเซอร์พร้อม Timestamp บนอุปกรณไปบน Magellan Platform ผ่าน 4G (SIM7600)
  • saveClientConfig
    • saveClientConfig - ตัวอย่างการส่งข้อมูลจากเซนเซอร์พร้อม Timestamp บนอุปกรณไปบน Magellan Platform ผ่าน 4G (SIM7600)
  • getServerTime
    • getServerTime - ตัวอย่างการขอเวลา Timestamp จาก Server ของ Magellan Platform ผ่าน 4G (SIM7600)
  • gpsTime_Location
    • gpsTime_Location - ตัวอย่างการขอเวลา Timestamp จาก Location ใน GPS มาใช้งาน ผ่าน 4G (SIM7600)
  • RS485_PZEM_016_reportDataTo_Magellan
    • RS485_PZEM_016_reportDataTo_Magellan - ตัวอย่างการอ่านเซนเซอร์ RS485 แล้วส่งค่าขึ้นไปบน Magellan Platform ผ่าน 4G (SIM7600)
  • WiFi
    • ConnectWithESP32wifi - ตัวอย่างการส่งค่าขึ้น Magellan Platform ผ่าน WiFi (ESP32)
  • OTA
    • autoUpdate - ตัวอย่างการกำหนดให้อุปกรณ์ทำการอัพเดท Firmware อัตโนมัติ
    • manualUpdate - ตัวอย่างการกำหนดให้อุปกรณ์ทำการอัพเดท Firmware ตามที่ผู้ใช้งานกำหนดเอง
    • utilityInformation - ตัวอย่างการอ่านค่าข้อมูลการ OTA

⚠️ Warning ข้อควรระวังในการใช้งาน OTA ด้วยบอร์ด ESP8266 จำเป็นจะต้องทดสอบ Binary file (.bin) ของ firmware ก่อนใช้งาน OTA จริงเสมอเนื่องจากหาก Build Binary file (.bin) จากคนละบอร์ดเช่นใช้ binary file ของ ESP32 มาใช้ OTA เข้ายังบอร์ด ESP8266 อาจจะทำให้ firmware ดั่งเดิมที่ใช้งานได้เสียหายและไม่สามารถทำงานต่อได้จำเป็นต้องแก้ไขด้วยการ erase flash หรือ upload firmware ใหม่ผ่านสายเชื่อมโดยตรงแทน *แต่ในบน ESP32 ตัว standard library ได้มีการ validate board ใน Binary file ที่จะ OTA มาแล้วในระดับหนึ่ง แต่ทั้งนี้ก็ควรจะทดสอบก่อนใช้งาน OTA จริงเสมอเผื่อให้แน่ใจว่า firmware ใหม่ที่ OTA เข้าไปมีความเสถียรภาพพร้อมใช้งาน

ไลบรารีแนะนำให้ใช้งานร่วมกัน

• ArduinoHttpClient - ไลบรารีเชื่อมต่อ HTTP/HTTPS

Dimension