ห้องสมุดนี้ให้การสนับสนุนการสื่อสาร Lorawan โดยใช้ไมโครคอนโทรลเลอร์ STM32WL55 (พร้อมวิทยุ Lora แบบฝัง) ภายใน Arduino พัฒนาสภาพแวดล้อม (พร้อมกับแกน STM32Duino ที่มีเวอร์ชัน 2.4.0 หรือใหม่กว่า)
ห้องสมุดนี้มี API ที่มีความคล้ายคลึงกันอย่างมากกับ API ที่นำเสนอโดย Arduino Mkrwan Library (รวมถึงวิธีการที่ไม่มีเอกสาร) ดังนั้นภาพร่างใด ๆ ที่เขียนสำหรับห้องสมุดทั้งสองควรทำงานอีกอย่างเช่นกัน (แต่หมายเหตุด้านล่างสำหรับคำเตือนบางอย่าง)
ภาพรวมและเอกสารอ้างอิงถูกฝังอยู่ในซอร์สโค้ดและสามารถดูออนไลน์ได้บน GitHub
ในการสร้างเอกสารด้วยตัวคุณเองเพียงเรียกใช้คำสั่ง doxygen (ไม่จำเป็นต้องมีตัวเลือก) ในรูทของที่เก็บนี้ สิ่งนี้จะสร้างเอกสาร HTML ในไดเรกทอรีย่อย api-docs
ที่เก็บนี้ถูกตั้งค่าเพื่อเรียกใช้การตรวจสอบบางอย่างในเวิร์กโฟลว์ GitHub โดยอัตโนมัติ คุณยังสามารถเรียกใช้งานได้ในพื้นที่ดังนี้
สำหรับการตรวจสอบคาถา codespell เพียงเรียกใช้คำสั่งโดยไม่มีตัวเลือกมันจะบอกคุณเกี่ยวกับข้อผิดพลาดในการสะกดคำใด ๆ ในรหัส
codespell
สำหรับ Astyle คุณต้องผ่านตัวเลือกเล็กน้อย สิ่งนี้จะแก้ไขข้อผิดพลาดสไตล์โดยอัตโนมัติดังนั้นสิ่งนี้อาจทำได้ดีที่สุดหลังจากจัดเตรียมการเปลี่ยนแปลงทั้งหมดดังนั้นคุณสามารถเห็นสิ่งที่เปลี่ยนแปลงได้อย่างง่ายดาย เพิ่ม --dry-run เพื่อดูว่าต้องมีการเปลี่ยนแปลงไฟล์ใด (ไม่แสดงการเปลี่ยนแปลงที่เกิดขึ้น)
astyle --project=.astylerc --recursive '*.c' '*.h' '*.ino'
(คุณยังสามารถตั้งค่า ARTISTIC_STYLE_PROJECT_OPTIONS=.astylerc ในสภาพแวดล้อมของคุณและละเว้น --project )
ห้องสมุดนี้ใช้ Loramac-node ที่พัฒนาโดย Semtech โดยมีการดัดแปลงอย่างกว้างขวางและการเพิ่มเติมที่ทำโดย STMicroelectronics
รหัสทั้งหมดที่รวมอยู่ในไลบรารีนี้ได้รับอนุญาตภายใต้ใบอนุญาต BSD ที่แก้ไขแล้วข้อความใบอนุญาตเต็มสามารถพบได้ในไฟล์ใบอนุญาตและในแต่ละไฟล์แหล่งที่มาเช่นกัน