Awa LWM2M C API (0.2.5)  
Public Attributes | List of all members
AwaFactoryBootstrapInfo Struct Reference

Information required to bootstrap the client daemon from a factory configuration. More...

#include <static.h>

Public Attributes

struct {
   char   ServerURI [BOOTSTRAP_CONFIG_SERVER_URI_SIZE]
 Specifies the URI of the LWM2M Server for the client to register with. More...
 
   AwaSecurityMode   SecurityMode
 Specifies the LWM2M Security Mode. More...
 
   char   PublicKeyOrIdentity [BOOTSTRAP_CONFIG_PUBLIC_KEY_SIZE]
 Specifies the LWM2M Client's certificate (Certificate mode), public key (RPK mode), or PSK identity (PSK mode). More...
 
   char   ServerPublicKey [BOOTSTRAP_CONFIG_SERVER_KEY_SIZE]
 Specifies the LWM2M Server’s or LWM2M Bootstrap Server’s Certificate (Certificate mode), public key (RPK mode). More...
 
   char   SecretKey [BOOTSTRAP_CONFIG_SECRET_KEY_SIZE]
 Specifies the secret key or private key of the security mode. More...
 
SecurityInfo
 LWM2M Security Object information, required to securely bootstrap and connect to LWM2M servers. More...
 
struct {
   int   Lifetime
 Specify the lifetime of the registration in seconds. More...
 
   int   DefaultMinPeriod
 Specify the default value the LWM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. More...
 
   int   DefaultMaxPeriod
 Specify the default value the LWM2M Client should use for the Maximum Period of an Observation in the absence of this parameter being included in an Observation. More...
 
   int   DisableTimeout
 Specify the period to disable the Server. More...
 
   bool   Notification
 Specify Notification Storing When Disabled or Offline: if true, the LWM2M Client stores “Notify” operations to the LWM2M Server while the LWM2M Server account is disabled or the LWM2M Client is offline. More...
 
   char   Binding [BOOTSTRAP_CONFIG_BINDING_SIZE]
 Specifies the transport binding configured for the LWM2M Client. More...
 
ServerInfo
 LWM2M Server Object information, providing the data related to an LWM2M Server. More...
 

Detailed Description

Information required to bootstrap the client daemon from a factory configuration.

The format of this information is directly drawn from the LWM2M specification.

Member Data Documentation

char AwaFactoryBootstrapInfo::ServerURI[BOOTSTRAP_CONFIG_SERVER_URI_SIZE]

Specifies the URI of the LWM2M Server for the client to register with.

For example: coap://127.0.0.1:5683

AwaSecurityMode AwaFactoryBootstrapInfo::SecurityMode

Specifies the LWM2M Security Mode.

char AwaFactoryBootstrapInfo::PublicKeyOrIdentity[BOOTSTRAP_CONFIG_PUBLIC_KEY_SIZE]

Specifies the LWM2M Client's certificate (Certificate mode), public key (RPK mode), or PSK identity (PSK mode).

See the LWM2M specification for details of the required format for each mode.

char AwaFactoryBootstrapInfo::ServerPublicKey[BOOTSTRAP_CONFIG_SERVER_KEY_SIZE]

Specifies the LWM2M Server’s or LWM2M Bootstrap Server’s Certificate (Certificate mode), public key (RPK mode).

See the LWM2M specification for details of the required format for each mode.

char AwaFactoryBootstrapInfo::SecretKey[BOOTSTRAP_CONFIG_SECRET_KEY_SIZE]

Specifies the secret key or private key of the security mode.

See the LWM2M specification for details of the required format for each mode.

struct { ... } AwaFactoryBootstrapInfo::SecurityInfo

LWM2M Security Object information, required to securely bootstrap and connect to LWM2M servers.

See the LWM2M specification for the Security object.

int AwaFactoryBootstrapInfo::Lifetime

Specify the lifetime of the registration in seconds.

int AwaFactoryBootstrapInfo::DefaultMinPeriod

Specify the default value the LWM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation.

int AwaFactoryBootstrapInfo::DefaultMaxPeriod

Specify the default value the LWM2M Client should use for the Maximum Period of an Observation in the absence of this parameter being included in an Observation.

int AwaFactoryBootstrapInfo::DisableTimeout

Specify the period to disable the Server.

After this period, the LWM2M Client MUST perform registration process to the Server.

bool AwaFactoryBootstrapInfo::Notification

Specify Notification Storing When Disabled or Offline: if true, the LWM2M Client stores “Notify” operations to the LWM2M Server while the LWM2M Server account is disabled or the LWM2M Client is offline.

After the LWM2M Server account is enabled or the LWM2M Client is online, the LWM2M Client reports the stored “Notify” operations to the Server. If false, the LWM2M Client discards all the “Notify” operationsor temporally disables the Observe function while the LWM2M Server is disabled or the LWM2M Client is offline.

char AwaFactoryBootstrapInfo::Binding[BOOTSTRAP_CONFIG_BINDING_SIZE]

Specifies the transport binding configured for the LWM2M Client.

See the LWM2M specification for details of the required format.

struct { ... } AwaFactoryBootstrapInfo::ServerInfo

LWM2M Server Object information, providing the data related to an LWM2M Server.

See the LWM2M specification for the Server object.


The documentation for this struct was generated from the following file: