blueprint freertos

Cetak Biru FreeRTOS 1NCE

1NCE FreeRTOS BluePrint mendemonstrasikan penggunaan berbagai protokol IoT termasuk CoAP, LwM2M, dan UDP dengan konektivitas seluler. Repositori ini menampilkan contoh pengintegrasian SDK 1NCE untuk memanfaatkan alat OS 1NCE, seperti autentikasi perangkat dan fitur hemat energi, menggunakan (Perpustakaan Wakaama LWM2M).

Ringkasan

Repositori ini menyediakan contoh protokol berikut:

• UDP
• CoAP (dengan/tanpa DTLS)
• LwM2M dengan Bootstrap (dengan/tanpa DTLS)

Setiap demo menyertakan fitur Penghemat Energi opsional yang dapat diaktifkan untuk pengujian.

Panduan Memulai Cepat

Folder Binaries berisi binari yang dibuat sebelumnya untuk aplikasi demo UDP dan CoAP.

1. Konfigurasikan Fitur Penghemat Energi di 1NCE OS
   Menggunakan templat ini.

2. Hubungkan Papan P-L496G-CELL02
   Saat terhubung melalui USB, papan akan muncul sebagai drive penyimpanan di komputer Anda.

3. Flash Biner
   Cukup drag dan drop file biner yang diinginkan dari folder Binaries ke drive penyimpanan. Papan akan secara otomatis mem-flash biner.

   Catatan: Jika flashing gagal, lihat Flashing menggunakan STM32CubeProgrammer.

4. Lihat Log Demo
   Gunakan Serial Monitor di Visual Studio Code untuk melihat log demo.

Memulai (Pembangunan Lokal)

Prasyarat

• P-L496G-CELL02 LTE Seluler ke Paket Cloud dengan STM32L496AG MCU
• Kartu SIM 1NCE
• Kode VSC
• STM32 VS Code Extension v2.0.0 dengan prasyarat yang disebutkan.
• Pastikan CMake versi 3.22 atau lebih tinggi digunakan.

Peningkatan firmware STLink

Diperlukan peningkatan firmware STLink. Plugin STM32 VSCode menyertakan tombol untuk ini, tetapi jika tidak berfungsi, pemutakhiran dapat dimulai secara manual dengan menjalankan file .bat dari folder STM32 yang diinstal: ST/STM32CubeCLTxx/STLinUpgrade.bat

Pembaruan Firmware Modem (Opsional)

Harap pastikan modem BG96 Anda memiliki versi firmware terbaru. Anda dapat mengunduh paket pembaruan firmware dan instruksi dari (halaman X-Cube Cellular ST) (disarankan v6.0.0).

Untuk flashing modem, QFlash tool sekarang dapat diunduh dari situs resmi Quectel: (QFlash Download (V7.1))

Contoh Bangunan

Untuk mengonfigurasi demo yang ingin Anda gunakan, ubah file nce_demo_config.h yang terletak di Application/Config/ : (secara default CONFIG_COAP_DEMO_ENABLED )

 CONFIG_COAP_DEMO_ENABLED
CONFIG_UDP_DEMO_ENABLED
CONFIG_LwM2M_DEMO_ENABLED

Demo yang Tersedia

Demo UDP

1NCE FreeRTOS BluePrint memungkinkan pelanggan berkomunikasi dengan titik akhir 1NCE melalui UDP dan menggunakan semua fitur sebagai bagian dari OS 1NCE.

• Siapkan pelari Demo di file Application/Config/nce_demo_config.h

 #define CONFIG_UDP_DEMO_ENABLED

• Parameter berikut dapat dikonfigurasi:

 #define CONFIG_UDP_DATA_UPLOAD_FREQUENCY_SECONDS    60

Demo COAP tanpa DTLS

1NCE FreeRTOS BluePrint memungkinkan pelanggan berkomunikasi dengan titik akhir 1NCE melalui CoAP dan menggunakan semua fitur sebagai bagian dari OS 1NCE.

Permintaan COAP POST: Di Bagian ini, langkah-langkah berikut dijalankan:

• Daftar ke Jaringan.

• Lakukan Resolusi DNS.

• Buat soket dan sambungkan ke Server

• Buat POST CoAP yang Dapat Dikonfirmasi dengan opsi Kueri

• Buat Interaksi Klien dan analisis responsnya (ACK)

• Validasi responsnya.

• Siapkan pelari Demo di file Application/Config/nce_demo_config.h

 #define CONFIG_COAP_DEMO_ENABLED

• Parameter berikut dapat dikonfigurasi:

    #define CONFIG_COAP_URI_QUERY                        "t=test"
    #define CONFIG_COAP_DATA_UPLOAD_FREQUENCY_SECONDS    60
    #define CONFIG_NCE_ENERGY_SAVER 

CoAP dengan DTLS

Untuk Dukungan DTLS, Port default adalah 5684 dan secara otomatis mendefinisikan ENABLE_DTLS sebagai definisi tambahan

CoAP DTLS melakukan 3 tugas utama dari 1NCE IoT C SDK :

• Kirim Permintaan Authenticator Perangkat
• Dapatkan Responnya
• Memproses Respon dan memberikan identitas DTLS dan PSK ke kode aplikasi.

Demo LwM2M

Dukungan LWM2M disediakan menggunakan perpustakaan Eclipse Wakaama yang berkomunikasi dengan server Leshan LWM2M. Mode ini memungkinkan perangkat bertindak sebagai klien LwM2M, memfasilitasi komunikasi dengan server LwM2M untuk kasus penggunaan seperti manajemen perangkat, pembaruan firmware, dan pengumpulan data sensor. Secara default, klien mendaftar ke server 1NCE LwM2M, dan komunikasi yang aman dipastikan melalui dukungan DTLS opsional.

• Siapkan pelari Demo dalam file (Application/Config/nce_demo_config.h)

 #define CONFIG_LwM2M_DEMO_ENABLED 

Parameter Konfigurasi Kunci LwM2M

Parameter berikut sangat penting untuk mengaktifkan dan menyesuaikan mode klien LwM2M dalam cetak biru:

• Titik Akhir Server LwM2M: Perangkat berkomunikasi dengan server 1NCE LwM2M secara default.

 #define LWM2M_ENDPOINT "lwm2m.os.1nce.com"

• Mode Klien LwM2M: ini akan bertindak sebagai klien yang mendaftar dan berkomunikasi dengan server LwM2M. Mode klien bertanggung jawab untuk mengirimkan permintaan (misalnya data perangkat atau pembacaan sensor) ke server dan menangani perintah yang dikirim oleh server.

 #define LWM2M_CLIENT_MODE

• Mode Bootstrap: Memungkinkan perangkat mengambil konfigurasi, kunci keamanan, dan informasi server dari server bootstrap jika diperlukan. Fitur ini berguna ketika perangkat tidak memiliki konfigurasi yang diperlukan untuk mendaftar langsung ke server LwM2M.

 #define LWM2M_BOOTSTRAP

• Dukungan SenML JSON: Ini memungkinkan perangkat mengirim data sensor dalam format JSON SenML (Sensor Markup Language). SenML adalah cara standar untuk merepresentasikan pengukuran sensor dan kejadian perangkat dalam format JSON, sehingga lebih mudah untuk diinterpretasikan dan diproses di sisi server.

 #define LWM2M_SUPPORT_SENML_JSON

• Format Data JSON: Ini mengaktifkan pemformatan JSON untuk komunikasi data umum, memastikan kompatibilitas dengan server yang menggunakan JSON untuk mengirim dan menerima pesan.

 #define LWM2M_SUPPORT_JSON

• Format Little Endian: Mengonfigurasi perangkat untuk menggunakan urutan byte Little Endian. Hal ini umum terjadi pada banyak sistem tertanam dan mikrokontroler, di mana byte terkecil disimpan atau dikirim terlebih dahulu.

 #define LWM2M_LITTLE_ENDIAN

• Dukungan TLV (Type-Length-Value): Memungkinkan perangkat menggunakan pengkodean TLV (Type-Length-Value), yang merupakan format biner ringkas yang digunakan untuk mewakili objek dan nilai dalam komunikasi LwM2M. TLV sangat berguna untuk mentransfer data secara efisien antara perangkat yang dibatasi dan server.

 #define LWM2M_SUPPORT_TLV

• Ukuran Blok Default CoAP: Mengatur ukuran blok default menjadi 1024 byte untuk komunikasi CoAP. Saat mentransfer pesan berukuran besar, transfer berdasarkan blok digunakan, dan konfigurasi ini menentukan ukuran setiap blok.

 #define LWM2M_COAP_DEFAULT_BLOCK_SIZE 1024

• Pendaftaran Server Tunggal: Konfigurasi ini memastikan bahwa perangkat mendaftar hanya dengan satu server LwM2M. Dalam kebanyakan kasus, mendaftar dengan beberapa server tidak diperlukan, dan satu server saja sudah cukup untuk manajemen perangkat dan pertukaran data.

 #define LWM2M_SINGLE_SERVER_REGISTERATION

• Pengiriman Objek LwM2M: Ini mendefinisikan URI Objek LwM2M yang akan dikirim ke server. URI default "/3/0" sesuai dengan Objek Perangkat LwM2M, yang menyediakan informasi penting perangkat, seperti pabrikan, nomor model, dan versi firmware.

 #define LWM2M_OBJECT_SEND "/3/0"

• Silakan tambahkan ICCID di file konfigurasi. Jika DTLS diaktifkan, psk bootstrap juga harus ditentukan. PSK dapat diatur selama pengujian integrasi LwM2M melalui Device Integrator atau melalui 1NCE API.

    #define CONFIG_NCE_ICCID          ""
    #define CONFIG_LWM2M_BOOTSTRAP_PSK    ""

Fitur Penghemat Energi

Fitur Penghemat Energi tersedia untuk demo UDP dan CoAP. Hal ini memungkinkan pengguna untuk mengoptimalkan konsumsi daya perangkat saat berkomunikasi dengan titik akhir 1NCE.

Konfigurasi

Untuk mengaktifkan fitur Penghemat Energi, tambahkan tanda berikut di nce_demo_config.h :

 #define CONFIG_NCE_ENERGY_SAVER

Catatan: Untuk menggunakan fitur Penghemat Energi untuk demo UDP dan CoAP, pastikan template terjemahan yang benar diterapkan di OS 1NCE. dan protokol yang tepat dipilih serta template yang digunakan.

Pengontrol Perangkat

Pengontrol Perangkat adalah API yang memungkinkan Anda berinteraksi dengan perangkat yang terintegrasi ke dalam API 1NCE. Anda dapat menggunakan API ini untuk mengirim permintaan ke perangkat, dan perangkat akan meresponsnya. Untuk lebih jelasnya Anda dapat mengunjungi DevHub kami

Mengirim Permintaan

Untuk mengirim permintaan ke perangkat tertentu, Anda dapat merujuk ke dokumentasi kami di 1NCE DevHub

Konfigurasi FreeRTOS

Untuk menangani permintaan masuk dari 1NCE API, diperlukan konfigurasi parameter tertentu Application/Config/nce_demo_config.h

 /* C2D Parameters */
/* This port is used for both UDP and CoAP communication. */
#define NCE_RECV_PORT 3000
#define NCE_RECEIVE_BUFFER_SIZE_BYTES 200

• NCE_RECV_PORT : Ini adalah nomor port tempat perangkat Anda akan mendengarkan permintaan masuk. Itu harus cocok dengan parameter port yang digunakan dalam permintaan.
• NCE_RECEIVE_BUFFER_SIZE_BYTES : Ini adalah ukuran buffer yang akan digunakan untuk menerima data masuk dari 1NCE API.

Catatan: C2D (Cloud to Device) didukung untuk ketiga protokol: UDP, CoAP, dan LwM2M. Klien LwM2M terintegrasi erat dengan permintaan C2D, dan untuk UDP dan CoAP juga membuka port latar belakang untuk komunikasi C2D.

Pemecahan masalah

Firmware Modem dan Konfigurasi Pita

Jika perangkat hanya terhubung ke jaringan 2G atau tidak dapat terhubung di beberapa wilayah, Anda mungkin perlu menyesuaikan pengaturan RAT (Radio Access Technology) dan pita di Application/Config/nce_demo_config.h :

 #define CELLULAR_CONFIG_DEFAULT_RAT 8  // Example for CAT M1
#define CELLULAR_CONFIG_DEFAULT_RAT_2 0 // Example for GSM
#define CELLULAR_CONFIG_DEFAULT_RAT_3 9 // Example for NBIOT
#define CUSTOM_BAND_BG96 "AT+QCFG="band",F,80004,80008"  // Example for Germany CATM1

// Values 
/**
*  The GSM RATs network      0
*  The CAT M1 RATs network   8
*  The NBIOT RATs network    9
**/

Untuk detail selengkapnya tentang pengaturan pita, rujuk Manual Perintah AT BG96.

Flashing menggunakan STM32CubeProgrammer

• Unduh dan instal STM32CubeProgrammer.
• Hubungkan papan dan tekan "Hubungkan" untuk mengaktifkan ST-Link.
• Pilih tab "Menghapus & Pemrograman" di sebelah kiri.
• Tambahkan file biner dan tekan "Mulai Pemrograman".

Mengonfigurasi Tingkat Log

Verbositas log dapat diatur dengan mendefinisikan makro LIBRARY_LOG_LEVEL di file Core/Inc/iot_config.h . Pengaturan ini mengontrol tingkat detail logging untuk tujuan debugging dan pemecahan masalah.

Level log yang tersedia untuk LIBRARY_LOG_LEVEL adalah:

IOT_LOG_NONE : Menonaktifkan semua pencatatan. IOT_LOG_ERROR : Hanya mengaktifkan pesan kesalahan. IOT_LOG_WARN : Mengaktifkan peringatan dan kesalahan. IOT_LOG_INFO : Mengaktifkan pesan informasi, peringatan, dan kesalahan. IOT_LOG_DEBUG : Mengaktifkan informasi debug terperinci, peringatan, kesalahan, dan pesan informasi.

Contoh Konfigurasi di iot_config.h :

 #define LIBRARY_LOG_LEVEL IOT_LOG_DEBUG

Konfigurasi ini mengeluarkan semua informasi debug, yang berguna selama pengembangan atau pemecahan masalah.

Meminta Bantuan

Komunikasi paling efektif dengan tim kami adalah melalui GitHub. Cukup buat terbitan baru dan pilih dari berbagai templat yang mencakup laporan bug, permintaan fitur, masalah dokumentasi, atau Pertanyaan Umum.