Unduh wakaama - Unduh Kode Sumber wakaama

wakaama

kode sumber C#

snapshot

Unduh

Wakaama

Wakaama (sebelumnya Liblwm2m) adalah implementasi dari M2M Protokol Open Mobile Alliance (LWM2M).

Mailing Daftar Pengembang: https://dev.eclipse.org/mailman/listinfo/wakaama-dev

Peringatan keamanan

Satu-satunya rilis resmi Wakaama, versi 1.0, dipengaruhi oleh berbagai masalah keamanan (CVE-2019-9004, CVE-2021-41040).

Harap gunakan komit terbaru di cabang utama. Rilis 1.0 tidak didukung lagi.

Lisensi

Pekerjaan ini berlisensi ganda di bawah Eclipse Public License v2.0 dan Eclipse Distribution License v1.0.

SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause

Memeriksa kode

Menggunakan Wakaama sebagai Perpustakaan

 git clone https://github.com/eclipse-wakaama/wakaama.git

Bekerja di Wakaama

Saat mengerjakan Wakaama sendiri, atau berniat untuk menjalankan contoh aplikasi klien, submodul harus diperiksa:

 git clone --recurse-submodules https://github.com/eclipse-wakaama/wakaama.git

Menyusun

Wakaama adalah perpustakaan yang sangat dapat dikonfigurasi. Itu dibangun dengan cmake. Lihatlah contoh/server/cmakelists.txt untuk contoh bagaimana memasukkannya.

Pengaturan yang berbeda dapat dikonfigurasi dengan variabel cache cmake (misalnya cmake -DLOG_LEVEL=INFO ).

Mode

Wakaama mendukung banyak mode. Setidaknya satu mode perlu didefinisikan dengan variabel cache cmake.

WAKAAMA_MODE_SERVER untuk mengaktifkan antarmuka server LWM2M.
WAKAAMA_MODE_BOOTTRAP_SERVER untuk mengaktifkan antarmuka server LWM2M Bootstrap.
WAKAAMA_MODE_CLIENT untuk mengaktifkan antarmuka klien LWM2M.

Pengaturan Klien

Wakaama mendukung opsi terkait klien tambahan. Ini hanya tersedia jika mode klien diaktifkan.

WAKAAMA_CLIENT_INITIATIED_BOOTSTRAP untuk mengaktifkan dukungan bootstrap LWM2M pada klien LWM2M.
WAKAAMA_CLIENT_LWM2M_V_1_0: Batasi kode klien untuk menggunakan LWM2M versi 1.0

Harap dicatat: LWM2M Versi 1.0 hanya didukung oleh klien, sementara server kompatibel ke belakang.

Format data

Format data berikut dapat dikonfigurasi untuk Wakaama:

WAKAAMA_DATA_TLV untuk mengaktifkan dukungan muatan TLV (implisit kecuali untuk klien LWM2M 1.1)
WAKAAMA_DATA_JSON untuk mengaktifkan dukungan payload JSON (implisit saat mendefinisikan lwm2m_server_mode)
Wakaama_data_senml_json untuk mengaktifkan dukungan payload senml json (implisit untuk lwm2m 1.1 atau lebih besar saat mendefinisikan lwm2m_server_mode atau lwm2m_boottrap_server_mode)
Wakaama_data_senml_cbor untuk mengaktifkan dukungan payload senml cbor (implisit untuk lwm2m 1.1 atau lebih besar saat mendefinisikan lwm2m_server_mode atau lwm2m_boottrap_server_mode)
Wakaama_data_senml_cbor_float16_support untuk mengaktifkan dukungan pengkodean pengkodean floating 16-bit di CBOR.
Wakaama_data_old_content_format untuk mendukung nilai format konten yang sudah usang untuk TLV dan JSON.

Pengaturan Coap

WAKAAMA_COAP_RAW_BLOCK1_REQUESTS untuk perangkat klien memori rendah di mana tidak mungkin untuk menyimpan pos besar atau memasukkan permintaan dalam memori untuk diuraikan (biasanya penulisan firmware). Opsi ini memungkinkan setiap muatan blok 1 yang belum diproses untuk diteruskan ke aplikasi, biasanya untuk disimpan ke memori flash.
Wakaama_coap_default_block_size ukuran blok coap yang digunakan oleh coap layer saat melakukan transfer blok-bijaksana. Nilai yang mungkin: 16, 32, 64, 128, 256, 512 dan 1024. Default ke 1024.

Logging

Infrastruktur logging dapat dikonfigurasi dengan variabel cache cmake (misalnya cmake -DWAKAAMA_LOG_LEVEL=INFO ).

WAKAAMA_LOG_LEVEL: Level log terendah yang akan diaktifkan. Tingkat yang lebih tinggi juga diaktifkan.
- Salah satu: DBG, info, peringatkan, err, fatal, log_disabled (default)
WAKAAMA_LOG_CUSTOM_HANDLER: Setel ini Tentukan untuk menyediakan fungsi penangan khusus untuk entri log. Lihat implementasi default untuk detailnya.
WAKAAMA_LOG_MAX_MSG_TXT_SIZE: MAX. ukuran pesan log yang diformat. Ini hanya pesan tanpa data tambahan seperti keparahan dan nama fungsi.

Mengangkut

WAKAAMA_TRANSPORT: Pilih implementasi lapisan transportasi. Salah satu:
- POSIX_UDP: Implementasi UDP sederhana menggunakan POSIX Socket API.
- TinyDtls: Gunakan DTL dengan perpustakaan 'TinyDTls'.
- Tidak ada: Tidak ada lapisan transport yang disediakan.

Jika NONE yang dipilih, pengguna Wakaama perlu menerapkan lapisan transportasi khusus. Periksa implementasi yang tersedia untuk informasi lebih lanjut.

Platform

WAKAAMA_PLATFORM: Pilih implementasi lapisan abstraksi platform, salah satunya:
- POSIX: Implementasi menggunakan API POSIX.
- Tidak ada: Tidak ada lapisan abstraksi platform yang disediakan.

Jika NONE yang dipilih, pengguna Wakaama perlu menerapkan lapisan abstraksi platform khusus. Periksa implementasi POSIX yang tersedia untuk informasi lebih lanjut.

Baris perintah

Wakaama menyediakan perpustakaan CLI sederhana. Itu dapat diaktifkan dengan:

WAKAAMA_CLI: Jika diaktifkan pustaka baris perintah ditambahkan ke Wakaama (default: dinonaktifkan)

Perkembangan

Ketergantungan dan alat

Wajib:
- Kompiler: GCC dan/atau dentang
Opsional (tetapi sangat disarankan):
- Generator Sistem Bangun: CMake 3.21+
- Sistem Kontrol Versi: GIT (dan akun GitHub)
- GIT Commit Message Linter: Gitlint
- Sistem Bangun: Ninja
- C Formating Kode C: Format Dentang, Versi 18
- Format file daftar CMAKE: CMAKE-FORMAT, Versi 0.6.13
- Pengujian Unit: Cunit

Pada Ubuntu 24.04, digunakan dalam CI, dependensi dapat dipasang seperti itu:

apt install build-essential clang-format clang-format-18 clang-tools-18 cmake cppcheck gcovr git libcunit1-dev ninja-build python3-pip
pip3 install -r tools/requirements-compliance.txt

Untuk MacOS, dependensi pengembangan dapat diinstal seperti itu:

brew install automake clang-format cmake cppcheck cunit gcc gitlint gnu-getopt make ninja

Pemformatan kode

C

Kode C baru harus diformat dengan format dentang.

Gaya ini didasarkan pada gaya LLVM, tetapi dengan 4 bukannya 2 ruang indentasi dan memungkinkan untuk 120 bukan 80 karakter per baris.

Untuk memeriksa apakah kode Anda cocok dengan gaya yang diharapkan, perintah berikut sangat membantu:

git clang-format-18 --diff : Tunjukkan apa yang perlu diubah agar sesuai dengan gaya kode yang diharapkan
git clang-format-18 : Terapkan semua perubahan yang diperlukan secara langsung
git clang-format-18 --commit main : Memperbaiki Gaya Kode untuk Semua Perubahan Sejak Utama

Jika kode yang ada diformat ulang, ini harus dilakukan dalam komit terpisah. ID komit-nya harus ditambahkan ke file .git-blame-ignore-revs dan berkomitmen dalam komit lain.

Cmake

Semua kode cmake harus diformat dengan format CMake.

Untuk memeriksa apakah kode Anda cocok dengan gaya yang diharapkan, perintah berikut sangat membantu:

tools/ci/run_ci.sh --run-cmake-format : Uji semua file CMake, cetak yang menyinggung
cmake-format --in-place <unformatted-file> : Terapkan semua perubahan yang diperlukan langsung ke

Menjalankan tes CI secara lokal

Untuk menghindari beban yang tidak dibutuhkan pada infrastruktur GitHub, harap pertimbangkan untuk menjalankan tools/ci/run_ci.sh --all sebelum mendorong.

Menjalankan tes integrasi secara lokal

 cd wakaama
tools/ci/run_ci.sh --run-build
pytest -v tests/integration

Contoh

Ada beberapa contoh aplikasi yang disediakan untuk menguji kemampuan server, klien dan bootstrap Wakaama. Resep -resep berikut menganggap Anda berada di platform seperti Unix dan Anda memiliki cmake dan membuat terpasang.

Contoh server

cmake -S examples/server -B build-server
cmake --build build-server
./build-server/lwm2mserver [Options]

LWM2MServer mendengarkan port UDP 5683. Ini fitur antarmuka baris perintah dasar. Ketik 'bantuan' untuk daftar perintah yang didukung.

Pilihannya adalah:

 Usage: lwm2mserver [OPTION]
Launch a LwM2M server on localhost.

Options:
  -4		Use IPv4 connection. Default: IPv6 connection
  -l PORT	Set the local UDP port of the Server. Default: 5683
  -S BYTES	CoAP block size. Options: 16, 32, 64, 128, 256, 512, 1024. Default: 1024

Tes Contoh Klien

cmake -S examples/client/udp -B build-client-udp
cmake --build build-client-udp
./build-client-udp/lwm2mclient [Options]

Di sebelah LWM2MClient ada juga contoh dengan DTL yang diaktifkan dan dengan transfer block1 mentah diaktifkan.

LWM2MClient menampilkan sembilan objek LWM2M:

Objek Keamanan (ID: 0)
Objek Server (ID: 1)
Objek Kontrol Akses (ID: 2) sebagai kerangka
Objek Perangkat (ID: 3) Berisi nilai-nilai kode keras dari contoh klien LWM2M Lampiran E dari spesifikasi teknis LWM2M.
Objek Pemantauan Konektivitas (ID: 4) sebagai kerangka
Objek Pembaruan Firmware (ID: 5) sebagai kerangka.
Objek Lokasi (ID: 6) sebagai kerangka.
Objek Statistik Konektivitas (ID: 7) sebagai kerangka.

Objek Tes (ID: 31024) dengan deskripsi berikut:

                    Multiple
   Object |  ID   | Instances | Mandatory |
    Test  | 31024 |    Yes    |    No     |

    Resources:
                Supported    Multiple
    Name | ID | Operations | Instances | Mandatory |  Type   | Range |
    test |  1 |    R/W     |    No     |    Yes    | Integer | 0-255 |
    exec |  2 |     E      |    No     |    Yes    |         |       |
    dec  |  3 |    R/W     |    No     |    Yes    |  Float  |       |

LWM2MClient membuka port UDP 56830 dan mencoba mendaftar ke server LWM2M di 127.0.0.1:5683. Ini fitur antarmuka baris perintah dasar. Ketik 'bantuan' untuk daftar perintah yang didukung.

Pilihannya adalah:

 Usage: lwm2mclient [OPTION]
Launch a LwM2M client.
Options:
  -n NAME	Set the endpoint name of the Client. Default: testlwm2mclient
  -l PORT	Set the local UDP port of the Client. Default: 56830
  -h HOST	Set the hostname of the LwM2M Server to connect to. Default: localhost
  -p PORT	Set the port of the LwM2M Server to connect to. Default: 5683
  -4		Use IPv4 connection. Default: IPv6 connection
  -t TIME	Set the lifetime of the Client. Default: 300
  -b		Bootstrap requested.
  -c		Change battery level over time.
  -S BYTES	CoAP block size. Options: 16, 32, 64, 128, 256, 512, 1024. Default: 1024

Nilai tambahan untuk biner lwm2mclient_tinydtls:

  -i Set the device management or bootstrap server PSK identity. If not set use none secure mode
  -s Set the device management or bootstrap server Pre-Shared-Key. If not set use none secure mode

Untuk meluncurkan sesi bootstrap: ./lwm2mclient -b

Contoh klien tes yang lebih sederhana

cmake -S examples/lightclient -B build-lightclient
cmake --build build-lightclient
./build-lightclient/lightclient [Options]

Lightclient jauh lebih sederhana bahwa LWM2MClient dan hanya memiliki empat objek LWM2M:

Objek Keamanan (ID: 0)
Objek Server (ID: 1)
Objek Perangkat (ID: 3) Berisi nilai-nilai kode keras dari contoh klien LWM2M Lampiran E dari spesifikasi teknis LWM2M.
Objek uji (ID: 31024) dari LWM2MClient seperti dijelaskan di atas.

LightClient tidak menampilkan antarmuka baris perintah apa pun.

Pilihannya adalah:

 Usage: lwm2mclient [OPTION]
Launch a LwM2M client.
Options:
  -n NAME	Set the endpoint name of the Client. Default: testlightclient
  -l PORT	Set the local UDP port of the Client. Default: 56830
  -4		Use IPv4 connection. Default: IPv6 connection
  -S BYTES	CoAP block size. Options: 16, 32, 64, 128, 256, 512, 1024. Default: 1024