Loading...
Searching...
No Matches

Configuration options for the LwM2M client implementation based on the Wakaama package. More...

Detailed Description

Configuration options for the LwM2M client implementation based on the Wakaama package.

Modules

 LwM2M Light Control object compile configurations
 

Files

file  lwm2m_client_config.h
 LwM2M client configurations.
 

Macros

#define CONFIG_LWM2M_STANDARD_PORT   "5683"
 CoAP default port of the LwM2M server.
 
#define CONFIG_LWM2M_DTLS_PORT   "5684"
 CoAPS default port of the LwM2M server.
 
#define CONFIG_LWM2M_BSSERVER_PORT   "5685"
 CoAP default port of the LwM2M bootstrap server.
 
#define CONFIG_LWM2M_LOCAL_PORT   "5683"
 Default port for the local LwM2M instance.
 
#define CONFIG_LWM2M_DEVICE_NAME   "testRIOTDevice"
 Device name used to register at the LwM2M server.
 
#define CONFIG_LWM2M_DEVICE_TTL   300
 Lifetime of the device object on the LwM2M server.
 
#define CONFIG_LWM2M_SERVER_URI   "coap://[fd00:dead:beef::1]"
 LwM2M server URI to register/bootstrap with.
 
#define CONFIG_LWM2M_SERVER_ID   10
 Numeric ID of CONFIG_LWM2M_SERVER_URI.
 
#define CONFIG_LWM2M_ALT_PATH   NULL
 Alternate path to place LwM2M resources.
 
#define CONFIG_LWM2M_BOOTSTRAP
 Define to 1 to specify that CONFIG_LWM2M_SERVER_URI is a bootstrap server.
 
#define CONFIG_LWM2M_DEVICE_MANUFACTURER   "A RIOT maker"
 Device object manufacturer string.
 
#define CONFIG_LWM2M_DEVICE_MODEL   RIOT_BOARD
 Device object model.
 
#define CONFIG_LWM2M_DEVICE_SERIAL   "undefined"
 Device object serial number.
 
#define CONFIG_LWM2M_DEVICE_FW_VERSION   RIOT_VERSION
 Device object firmware version.
 
#define CONFIG_LWM2M_DEVICE_TYPE   "RIOT device"
 Device object device type.
 
#define CONFIG_LWM2M_DEVICE_HW_VERSION   RIOT_BOARD
 Device object hardware version.
 
#define CONFIG_LWM2M_DEVICE_SW_VERSION   RIOT_VERSION
 Device object software version.
 
#define CONFIG_LWM2M_DEVICE_BINDINGS   "U"
 Device binding and queue mode.
 

Device bindings and queue modes

This options are meant to be set either via Kconfig or CFLAGS:

CFLAGS += -DCONFIG_LWM2M_DEVICE_BINDING_UQ
Note
Only one option should be selected. If more than one is defined the priority follows this order. By default CONFIG_LWM2M_DEVICE_BINDING_U is assumed.
#define CONFIG_LWM2M_DEVICE_BINDING_U
 UDP binding.
 
#define CONFIG_LWM2M_DEVICE_BINDING_UQ
 UDP binding with Queue mode.
 
#define CONFIG_LWM2M_DEVICE_BINDING_S
 SMS binding.
 
#define CONFIG_LWM2M_DEVICE_BINDING_SQ
 SMS binding with Queue mode.
 
#define CONFIG_LWM2M_DEVICE_BINDING_US
 UDP and SMS bindings.
 
#define CONFIG_LWM2M_DEVICE_BINDING_UQS
 UDP and SMS bindings with Queue mode.
 

Macro Definition Documentation

◆ CONFIG_LWM2M_ALT_PATH

#define CONFIG_LWM2M_ALT_PATH   NULL

Alternate path to place LwM2M resources.

Definition at line 96 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_BOOTSTRAP

#define CONFIG_LWM2M_BOOTSTRAP

Define to 1 to specify that CONFIG_LWM2M_SERVER_URI is a bootstrap server.

To define just add it to your CFLAGS in your application's Makefile:

CFLAGS += -DCONFIG_LWM2M_BOOTSTRAP=1

Definition at line 109 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_BSSERVER_PORT

#define CONFIG_LWM2M_BSSERVER_PORT   "5685"

CoAP default port of the LwM2M bootstrap server.

Definition at line 51 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_S

#define CONFIG_LWM2M_DEVICE_BINDING_S

SMS binding.

Definition at line 172 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_SQ

#define CONFIG_LWM2M_DEVICE_BINDING_SQ

SMS binding with Queue mode.

Definition at line 177 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_U

#define CONFIG_LWM2M_DEVICE_BINDING_U

UDP binding.

Definition at line 162 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_UQ

#define CONFIG_LWM2M_DEVICE_BINDING_UQ

UDP binding with Queue mode.

Definition at line 167 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_UQS

#define CONFIG_LWM2M_DEVICE_BINDING_UQS

UDP and SMS bindings with Queue mode.

Definition at line 187 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDING_US

#define CONFIG_LWM2M_DEVICE_BINDING_US

UDP and SMS bindings.

Definition at line 182 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_BINDINGS

#define CONFIG_LWM2M_DEVICE_BINDINGS   "U"

Device binding and queue mode.

Note
Select using CONFIG_LWM2M_DEVICE_BINDING_*

Definition at line 222 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_FW_VERSION

#define CONFIG_LWM2M_DEVICE_FW_VERSION   RIOT_VERSION

Device object firmware version.

Note
Defaults to the running RIOT version

Definition at line 141 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_HW_VERSION

#define CONFIG_LWM2M_DEVICE_HW_VERSION   RIOT_BOARD

Device object hardware version.

Note
Defaults to the board name

Definition at line 204 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_MANUFACTURER

#define CONFIG_LWM2M_DEVICE_MANUFACTURER   "A RIOT maker"

Device object manufacturer string.

Definition at line 116 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_MODEL

#define CONFIG_LWM2M_DEVICE_MODEL   RIOT_BOARD

Device object model.

Note
Defaults to the board name

Definition at line 125 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_NAME

#define CONFIG_LWM2M_DEVICE_NAME   "testRIOTDevice"

Device name used to register at the LwM2M server.

Definition at line 65 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_SERIAL

#define CONFIG_LWM2M_DEVICE_SERIAL   "undefined"

Device object serial number.

Definition at line 132 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_SW_VERSION

#define CONFIG_LWM2M_DEVICE_SW_VERSION   RIOT_VERSION

Device object software version.

Note
Defaults to the running RIOT version

Definition at line 213 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_TTL

#define CONFIG_LWM2M_DEVICE_TTL   300

Lifetime of the device object on the LwM2M server.

Definition at line 72 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DEVICE_TYPE

#define CONFIG_LWM2M_DEVICE_TYPE   "RIOT device"

Device object device type.

Definition at line 195 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_DTLS_PORT

#define CONFIG_LWM2M_DTLS_PORT   "5684"

CoAPS default port of the LwM2M server.

Definition at line 44 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_LOCAL_PORT

#define CONFIG_LWM2M_LOCAL_PORT   "5683"

Default port for the local LwM2M instance.

Definition at line 58 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_SERVER_ID

#define CONFIG_LWM2M_SERVER_ID   10

Numeric ID of CONFIG_LWM2M_SERVER_URI.

Definition at line 89 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_SERVER_URI

#define CONFIG_LWM2M_SERVER_URI   "coap://[fd00:dead:beef::1]"

LwM2M server URI to register/bootstrap with.

Note
The host part of the URI MUST be a valid IPv6 address. Host names can not be resolved at this time.

Definition at line 82 of file lwm2m_client_config.h.

◆ CONFIG_LWM2M_STANDARD_PORT

#define CONFIG_LWM2M_STANDARD_PORT   "5683"

CoAP default port of the LwM2M server.

Definition at line 37 of file lwm2m_client_config.h.