تنزيل wakaama - تنزيل رمز المصدر wakaama

wakaama

كود مصدر C#

snapshot

تنزيل

واكاما

Wakaama (سابقًا LiBlWM2M) هو تطبيق لبروتوكول M2M الخفيف الوزن (LWM2M).

القائمة البريدية للمطورين: https://dev.eclipse.org/mailman/listinfo/wakaama-dev

تحذير أمني

يتأثر الإصدار الرسمي الوحيد لـ Wakaama ، الإصدار 1.0 ، بمختلف مشكلات الأمان (CVE-2019-9004 ، CVE-2021-41040).

يرجى استخدام أحدث الالتزام في الفرع الرئيسي. الإصدار 1.0 غير مدعوم بعد الآن.

رخصة

هذا العمل مرخص له مزدوج بموجب ترخيص Eclipse Public V2.0 وترخيص توزيع Eclipse v1.0.

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

التحقق من الرمز

باستخدام Wakaama كمكتبة

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

العمل على واكاما

عند العمل على Wakaama نفسها ، أو تعتزم تشغيل تطبيق العميل على سبيل المثال ، يجب التحقق من العروض الفرعية:

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

التجميع

Wakaama هي مكتبة قابلة للتكوين. وهي مبنية مع cmake. انظر إلى الأمثلة/الخادم/cmakelists.txt للحصول على مثال على كيفية تضمينه.

يمكن تكوين الإعدادات المختلفة مع متغيرات ذاكرة التخزين المؤقت CMAKE (مثل cmake -DLOG_LEVEL=INFO ).

وضع

يدعم Wakaama أوضاع متعددة. يجب تعريف وضع واحد على الأقل مع متغيرات ذاكرة التخزين المؤقت CMAKE.

wakaama_mode_server لتمكين واجهات خادم LWM2M.
wakaama_mode_bootstrap_server لتمكين واجهات خادم Bootstrap LWM2M.
wakaama_mode_client لتمكين واجهات عميل LWM2M.

إعدادات العميل

يدعم Wakaama خيارات إضافية تتعلق بالعميل. هذه متوفرة فقط إذا تم تمكين وضع العميل.

wakaama_client_initied_bootstrap لتمكين دعم bootstrap LWM2M في عميل LWM2M.
wakaama_client_lwm2m_v_1_0: تقييد رمز العميل لاستخدام الإصدار LWM2M 1.0

يرجى ملاحظة: يتم دعم LWM2M الإصدار 1.0 فقط من قبل العملاء ، في حين أن الخوادم متوافقة مع الوراء.

تنسيقات البيانات

تنسيقات البيانات التالية قابلة للتكوين لـ Wakaama:

wakaama_data_tlv لتمكين دعم حمولة TLV (ضمنيًا باستثناء عملاء LWM2M 1.1)
wakaama_data_json لتمكين دعم حمولة JSON (ضمنيًا عند تحديد LWM2M_Server_Mode)
wakaama_data_senml_json لتمكين دعم حمولة Senml JSON (ضمنيًا لـ LWM2M 1.1 أو أكثر عند تحديد LWM2M_Server_Mode أو LWM2M_BOOTSTRAP_SERVER_MODE)
wakaama_data_senml_cbor لتمكين دعم حمولة SENML CBOR (ضمنيًا لـ LWM2M 1.1 أو أكبر عند تحديد LWM2M_Server_Mode أو LWM2M_BOOTSTRAP_SERVER_MODE)
wakaama_data_senml_cbor_float16_support لتمكين دعم ترميز نقطة عائم 16 بت في CBOR.
wakaama_data_old_content_format لدعم قيم تنسيق المحتوى المنخفض لـ TLV و JSON.

إعدادات COAP

wakaama_coap_raw_block1_requests لأجهزة عميل الذاكرة المنخفضة حيث لا يمكن الحفاظ على منشور كبير أو تقديم طلب في الذاكرة ليتم تحليله (عادةً ما تكون كتابة البرامج الثابتة). يمكّن هذا الخيار كل حمولة Block 1 غير المجهزة لتمريرها إلى التطبيق ، وعادة ما يتم تخزينها في ذاكرة الفلاش.
wakaama_coap_default_block_size حجم كتلة coop المستخدمة بواسطة طبقة COAP عند إجراء عمليات نقل الكتلة. القيم الممكنة: 16 ، 32 ، 64 ، 128 ، 256 ، 512 و 1024. الافتراضيات إلى 1024.

قطع الأشجار

يمكن تكوين البنية التحتية للتسجيل باستخدام متغيرات ذاكرة التخزين المؤقت CMAKE (مثل cmake -DWAKAAMA_LOG_LEVEL=INFO ).

wakaama_log_level: أقل مستوى سجل يتم تمكينه. يتم تمكين المستويات العليا أيضا.
- واحد من: DBG ، معلومات ، تحذير ، err ، قاتلة ، log_disabled (افتراضي)
wakaama_log_custom_handler: قم بتعيين هذا لتحديد وظيفة معالج مخصصة لإدخالات السجل. انظر التنفيذ الافتراضي للحصول على التفاصيل.
wakaama_log_max_msg_txt_size: الحد الأقصى. حجم رسالة السجل المنسقة. هذه هي الرسالة فقط بدون بيانات إضافية مثل الشدة واسم الوظيفة.

ينقل

Wakaama_transport: حدد تنفيذ طبقة النقل. واحد من:
- POSIX_UDP: تطبيق UDP بسيط باستخدام API POSIX Socket.
- tinydtls: استخدم DTLs مع مكتبة 'tinydtls'.
- لا شيء: لا يتم توفير طبقة نقل.

إذا لم يتم اختيار NONE ، يحتاج مستخدم Wakaama إلى تنفيذ طبقة نقل مخصصة. تحقق من التطبيقات المتاحة لمزيد من المعلومات.

منصة

wakaama_platform: حدد تنفيذ طبقة تجريد النظام ، واحدة من:
- POSIX: تطبيق باستخدام POSIX API.
- لا شيء: لا يتم توفير طبقة تجريد النظام الأساسي.

إذا لم يتم اختيار NONE ، يحتاج مستخدم Wakaama إلى تنفيذ طبقة تجريد منصة مخصصة. تحقق من تطبيق Posix المتاح لمزيد من المعلومات.

سطر الأوامر

يوفر Wakaama مكتبة CLI بسيطة. يمكن تمكينه مع:

Wakaama_cli: إذا تم تمكين مكتبة سطر الأوامر إلى Wakaama (افتراضي: معطل)

تطوير

التبعيات والأدوات

إلزامي:
- المترجم: GCC و/أو Clang
اختياري (ولكن موصى به بشدة):
- مولد نظام البناء: Cmake 3.21+
- نظام التحكم في الإصدار: GIT (وحساب GitHub)
- GIT ارتكاب رسالة linter: gitlint
- نظام البناء: النينجا
- تنسيق رمز C: Clang-Format ، الإصدار 18
- ملفات قائمة cmake تنسيق: cmake-format ، الإصدار 0.6.13
- اختبار الوحدة: CUNIT

على Ubuntu 24.04 ، المستخدمة في CI ، يمكن تثبيت التبعيات على هذا النحو:

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

بالنسبة إلى MacOS ، يمكن تثبيت تبعيات التطوير على هذا النحو:

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

تنسيق الكود

ج

يجب أن يتم تنسيق رمز C الجديد مع clang-format.

يعتمد النمط على نمط LLVM ، ولكن مع 4 بدلاً من المسافة المسافة المسافة والسماح بـ 120 بدلاً من 80 حرفًا لكل سطر.

للتحقق مما إذا كان الرمز الخاص بك يتطابق مع النمط المتوقع ، فإن الأوامر التالية مفيدة:

git clang-format-18 --diff : أظهر ما يجب تغييره لمطابقة نمط الكود المتوقع
git clang-format-18 : تطبيق جميع التغييرات المطلوبة مباشرة
git clang-format-18 --commit main : إصلاح نمط رمز لجميع التغييرات منذ ذلك الحين

إذا تم إعادة تنسيق الكود الحالي ، فيجب القيام بذلك في التزام منفصل. يجب إضافة معرف الالتزام الخاص به إلى الملف .git-blame-ignore-revs والالتزام في التزام آخر.

cmake

يجب تنسيق جميع رمز CMAKE مع تنسيق cmake.

للتحقق مما إذا كان الرمز الخاص بك يتطابق مع النمط المتوقع ، فإن الأوامر التالية مفيدة:

tools/ci/run_ci.sh --run-cmake-format : اختبر جميع ملفات cmake ، وطباعة مخالفة مخالفة
cmake-format --in-place <unformatted-file>

تشغيل اختبارات CI محليًا

لتجنب الحمل غير الضروري على البنية التحتية لـ GitHub ، يرجى النظر في تشغيل tools/ci/run_ci.sh --all قبل الدفع.

تشغيل اختبارات التكامل محليًا

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

أمثلة

هناك بعض التطبيقات المقدمة لاختبار إمكانيات الخادم والعميل والتمهيد في Wakaama. تفترض الوصفات التالية أنك على نظام UNIX مثل الأساس ولديك cmake وتثبيت.

مثال الخادم

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

يستمع LWM2MServer على منفذ UDP 5683. ويتميز بواجهة سطر الأوامر الأساسية. اكتب "مساعدة" للحصول على قائمة بالأوامر المدعومة.

الخيارات هي:

 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

اختبار مثال العميل

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

بجانب LWM2Mclient ، هناك أيضًا أمثلة مع تمكين DTLs ومع تمكين نقل block1 الخام.

يتميز LWM2Mclient بتسعة كائنات LWM2M:

كائن أمان (معرف: 0)
كائن الخادم (معرف: 1)
كائن التحكم في الوصول (المعرف: 2) كهيكل عظمي
كائن الجهاز (المعرف: 3) يحتوي على قيم مرمزة من مثال العميل LWM2M من الملحق E للمواصفات الفنية LWM2M.
كائن مراقبة الاتصال (المعرف: 4) كهيكل عظمي
كائن تحديث البرامج الثابتة (المعرف: 5) كهيكل عظمي.
كائن الموقع (معرف: 6) كهيكل عظمي.
كائن إحصائيات الاتصال (المعرف: 7) كهيكل عظمي.

اختبار كائن (معرف: 31024) مع الوصف التالي:

                    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 منفذ UDP 56830 ويحاول التسجيل في خادم LWM2M على 127.0.0.1:5683. يتميز بواجهة سطر الأوامر الأساسية. اكتب "مساعدة" للحصول على قائمة بالأوامر المدعومة.

الخيارات هي:

 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

قيم إضافية لـ LWM2MCLIENT_TINYDTLS BINARY:

  -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

لإطلاق جلسة bootstrap: ./lwm2mclient -b

مثال عميل اختبار أبسط

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

يكون Lightclient أبسط بكثير من أن LWM2Mclient ويتميز فقط بأربعة كائنات LWM2M:

كائن أمان (معرف: 0)
كائن الخادم (معرف: 1)
كائن الجهاز (المعرف: 3) يحتوي على قيم مرمزة من مثال العميل LWM2M من الملحق E للمواصفات الفنية LWM2M.
كائن الاختبار (المعرف: 31024) من LWM2Mclient كما هو موضح أعلاه.

لا يعرض LightClient أي واجهة سطر الأوامر.

الخيارات هي:

 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