wakaama下载wakaama源代码下载

wakaama

C#源码

snapshot

下载

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。

展开

附加信息

版本 snapshot
类型 C#源码
更新时间 2025-03-18
大小 455.34KB
来自于 Github