首頁>編程相關>C#源碼
下載

Wakaama

Wakaama（以前是LIBLWM2M）是開放移動聯盟輕量級M2M協議（LWM2M）的實現。

開發人員郵寄列表：https：//dev.eclipse.org/mailman/listinfo/wakaama-dev

安全警告

Wakaama版本1.0的唯一正式發行版受各種安全問題的影響（CVE-2019-9004，CVE-2021-41040）。

請使用主要分支機構中的最新提交。版本1.0不再支持。

執照

這項工作由Eclipse公共許可證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上工作

在處理Wakaama本身或打算運行示例客戶端應用程序時，必須檢查子模型： 

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

編譯

Wakaama是一個高度可配置的庫。它是用cmake構建的。查看示例/服務器/cmakelists.txt，以獲取如何包含它的示例。

可以使用CMAKE CACHE變量（例如cmake -DLOG_LEVEL=INFO ）配置不同的設置。

模式

Wakaama支持多種模式。至少需要使用CMake CACHE變量來定義一種模式。

  • wakaama_mode_server啟用LWM2M服務器接口。
  • wakaama_mode_bootstrap_server啟用LWM2M Bootstrap服務器接口。
  • wakaama_mode_client啟用LWM2M客戶端接口。

客戶設置

Wakaama支持其他與客戶相關的選項。這些僅在啟用客戶端模式時才可用。

  • wakaama_client_initiated_bootstrap啟用LWM2M客戶端中的LWM2M Bootstrap支持。
  • 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_SERVER_MODE或LWM2M2M_BOOTSTRAP_SERVER_MODE時，lwm2m 1.1或更大
  • wakaama_data_senml_cbor啟用SENML CBOR有效載荷支持（定義LWM2M_SERVER_MODE或LWM2M2M_BOOTSTRAP_SERVER_MODE時，lwm2m 1.1或更大
  • wakaama_data_senml_cbor_float16_support啟用CBOR中的16位浮點編碼支持。
  • wakaama_data_old_content_format支持TLV和JSON的不推薦的內容格式值。

CoAp設置

  • wakaama_coap_raw_block1_requests用於低內存客戶端設備，在該設備中無法保留大型帖子或將請求放在存儲器中進行解析（通常是固件寫入）。此選項啟用每個未處理的塊1有效載荷將傳遞給應用程序，通常存儲到閃存中。
  • wakaama_coap_default_block_size coap塊大小在執行塊轉換時，由coap層使用。可能的值：16、32、64、128、256、512和1024。默認為1024。

記錄

可以使用CMAKE CACHE變量（例如cmake -DWAKAAMA_LOG_LEVEL=INFO ）配置日誌記錄基礎架構。

  • wakaama_log_level：啟用最低日誌級別。還啟用了更高的級別。
    • 之一：DBG，信息，警告，err，致命，log_disabled（默認）
  • wakaama_log_custom_handler：設置此定義以提供日誌條目的自定義處理程序功能。有關詳細信息，請參見默認實現。
  • wakaama_log_max_msg_txt_size：max。格式日誌消息的大小。這只是沒有其他數據（例如嚴重性和功能名稱）的消息。

運輸

  • wakaama_transport：選擇傳輸層的實現。之一：
    • POSIX_UDP：使用POSIX套接字API的簡單UDP實現。
    • TinyDTLS：將DTL與“ TinyDTLS”庫一起使用。
    • 無：沒有提供運輸層。

如果NONE選擇，則Wakaama的用戶需要實現自定義運輸層。檢查可用的實現以獲取更多信息。

平台

  • wakaama_platform：選擇平台抽象層的實現，其中之一是：
    • POSIX：使用POSIX API的實現。
    • 無：沒有提供平台抽象層。

如果NONE選擇，則Wakaama的用戶需要實現自定義平台抽象層。檢查可用的POSIX實現以獲取更多信息。

命令行

Wakaama提供了一個簡單的CLI庫。它可以啟用：

  • wakaama_cli：如果啟用了命令行庫將添加到wakaama（默認：禁用）

發展

依賴和工具

  • 強制的：
    • 編譯器：GCC和/或CLANG
  • 可選（但強烈建議）：
    • 構建系統發電機：CMAKE 3.21+
    • 版本控制系統：git（和一個github帳戶）
    • git提交消息林格：gitlint
    • 構建系統：忍者
    • C代碼格式：Clang-Format，版本18
    • CMAKE列表文件格式：CMAKE-FORMAT，版本0.6.13
    • 單位測試：CUNIT

在CI中使用的Ubuntu 24.04上，可以安裝依賴項：

  • 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

新的C代碼必須使用Clang-Format進行格式。

該樣式基於LLVM樣式，但具有4個而不是2個空間凹痕，並且允許每行80個字符，而不是80個字符。

要檢查您的代碼是否匹配預期樣式，以下命令很有幫助：

  • git clang-format-18 --diff ：顯示需要更改的內容以匹配預期的代碼樣式
  • git clang-format-18 ：直接應用所有必要的更改
  • git clang-format-18 --commit main ：為所有更改修復代碼樣式，因為

如果現有代碼重新格式化，則必須在單獨的提交中完成。必須將其提交ID添加到文件.git-blame-ignore-revs中，並在另一個提交中添加。

cmake

所有CMAKE代碼必須使用CMAKE-FORMAT進行格式。

要檢查您的代碼是否匹配預期樣式，以下命令很有幫助：

  • 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旁邊還有啟用DTL的示例，並啟用了RAW Block1傳輸。

LWM2MClient具有9個LWM2M對象：

  • 安全對象（ID：0）

  • 服務器對象（ID：1）

  • 訪問控制對象（ID：2）作為骨架

  • 設備對象（ID：3）包含LWM2M技術規範附錄E的示例LWM2M客戶端的硬編碼值。

  • 連接性監視對象（ID：4）作為骨架

  • 固件更新對象（ID：5）作為骨架。

  • 位置對象（ID：6）作為骨架。

  • 連接統計對象（ID：7）作為骨架。

  • 測試對象（ID：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，並試圖以127.0.0.0.1:5683註冊到LWM2M服務器。它具有基本的命令行接口。輸入“幫助”以獲取支持命令的列表。

選項是： 

 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二進制的其他值： 

  -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

啟動引導程序： ./lwm2mclient -b

更簡單的測試客戶端示例

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

LightClient比LWM2MClient更簡單，並且僅具有四個LWM2M對象：

  • 安全對象（ID：0）
  • 服務器對象（ID：1）
  • 設備對象（ID：3）包含LWM2M技術規範附錄E的示例LWM2M客戶端的硬編碼值。
  • 如上所述，來自LWM2MCLENT的測試對象（ID：31024）。

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

Bootstrap服務器示例

  • cmake -S examples/bootstrap_server -B build-bootstrap
  • cmake --build build-bootstrap
  • ./build-bootstrap/bootstrap_server [Options]

有關更多信息，請參閱示例/bootstrap_server/readme。

展開
附加信息
相關應用
爲您推薦
相關資訊 全部