6.3 Mapping of resources
6.2.0 Introduction
This clause describes how to map the <mgmtObj> Resources specified in the annex D of [1] to the relevant Objects specified in OMA LwM2M [5].
6.3.1 General Mapping Assumptions
OMA LwM2M [5] implements the functionalities of the device management and M2M service enablement as Objects. An Object is a collection of resources which are related to a specific management functionality. For example the Firmware Update Object contains all the resources used for firmware update purpose. Before to be capable of fulfilling its role, an Object shall be first instantiated into an Object Instance.
Since <mgmtObj> Resources are for providing specific management functionalities, the attributes of a given <mgmtObj> Resource shall be mapped to the resources of one or several LwM2M Object Instances within the context of the Resource's objectIDs as defined in clause 6.2.2.
The objectPath is a local context which has to be combined with a given <mgmtObj> Resource's attribute for realizing the final mapping to the targeted OMA LwM2M [5] resource.
In case the objectPath is multiple (several Object Instances are referenced in that Resource), a specified couple composed of one element of the objectIDs list and one element of the objectPath list will be associated to a given Resource attribute for realizing the final mapping to the targeted OMA LwM2M [5] resource.
In OMA LwM2M, the Objects Instances are located under the default rootpath (i.e. "/") when this rootpath is not explicitly specified. However, devices might be hosting other resources, that is why the LwM2M has the capability to assign the LwM2M rootpath to an alternative path. In oneM2M this alternate path will be part of a Resource objectPath attribute (e.g. "/lwm2mPath /3/0").
6.3.2 Resource [firmware]
The resource [firmware] is for firmware management in the service layer.
The context of this Resource is the following:
Table 6.3.2-1 Context of resource [firmware]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:5 Firmware Update Object |
| objectPath | /5/0 |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Firmware Update Object Instance as follows.
Table 6.3.2-2 Attributes of resource [firmware]
| Attribute Name of [firmware] | Mapping to resources in LwM2M Device Object Instance |
|---|---|
| version | 7 PkgVersion |
| name | 6 Pkgname |
| URL | 1 PackageURI |
| update | 2 Update |
| updateStatus | 5 UpdateResult |
6.3.3 Resource [software]
The resource [software] is for software management in the service layer.
The context of this Resource is the following.
Table 6.3.3-1 Context of resource [software]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:9 |
| objectPath | /9/{i} |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Software Management Object (urn:oma:lwm2m:oma:9 [18])
Table 6.3.3-2 Attributes of resource [software]
| Attribute Name of [software] | Mapping to resources in LwM2M Software management Device Object Instance |
|---|---|
| version | 1 Version of the software package |
| name | 0 Name of the software package |
| URL | 3 Package URI |
| install | 4 Install |
| uninstall | 6 Uninstall |
| installStatus | 9 Update Result |
| activate | 10 Activate |
| deactivate | 11 Deactivate |
| activeStatus | 12 ActivationState |
6.3.4 Resource [memory]
The Resource [memory] provides memory related information. For OMA LwM2M, this Resource shall be mapped to the unique Instance of LwM2M Device Object (LwM2M ObjectID: 3).
The context of this Resource is as follows.
Table 6.3.4-1 Context of resource [memory]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:3 |
| objectPath | /3/0 (instance 0 of Object 3) |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Device Object Instance as follows:
Table 6.3.4-1 Attributes of resource [memory]
| Attribute Name of [memory] | Mapping to resources in LwM2M Device Object Instance |
|---|---|
| memAvailable | 10 estimated current available amount of memory in KB |
| memTotal | 21 total amount of storage space in KB in the LwM2M Device |
6.3.5 Resource [areaNwkInfo]
The resource [areaNwkInfo] is for managing the area network.
Note
There is currently no defined LwM2M object yet. This mapping is not available in the present document.
6.3.6 Resource [areaNwkDeviceInfo]
The resource [areaNwkDeviceInfo] is for managing the device of the area network as well as acquiring information about devices in the area network.
Note
There is currently no defined LwM2M object yet. This mapping is not available in this current specification .
6.3.7 Resource [battery]
The Resource [battery] provides battery related information. For OMA LwM2M, this Resource shall be mapped to the unique Instance of LwM2M Device Object (LwM2M ObjectID: 3).
The context of this Resource is as follows.
Table 6.3.7-1 Context of resource [battery]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:3 |
| objectPath | /3/0 |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Device Object Instance as follows.
Table 6.3.7-2 Attributes of resource [battery]
| Attribute Name of [battery] | Mapping to resources in LwM2M Device Object Instance |
|---|---|
| batteryLevel | 9 current battery level as percentage |
| batteryStatus |
20 contains the internal battery status |
6.3.8 Resource [deviceInfo]
The Resource [deviceInfo] provides device related information. For OMA LwM2M, this Resource shall be mapped to the unique Instance of LwM2M Device Object (LwM2M ObjectID: 3).
The context of this Resource is the following.
Table 6.3.8-1 Context of resource [deviceInfo]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:3 |
| objectPath | /3/0 |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Device Object Instance as follows.
Table 6.3.8-2 Attributes of resource [deviceInfo]
| Attribute Name of [deviceInfo] | Mapping to resources in LwM2M Device Object Instance |
|---|---|
| deviceLabel | 2 Serial Number |
| manufacturer | 0 Manufacturer name |
| model | 1 Model Number |
| deviceType | 17 The class of the device |
| fwVersion | 3 Firmware Version |
| swVersion | 19 Software Version of the device |
| hwVersion | 18 Hardware version of the device |
6.3.9 Resource [deviceCapability]
The Resource [deviceCapability] is to manage the device capabilities such USB, camera, etc. The Resource [deviceCapability] is mapped to the LwM2M Device Capability Management Object (urn:oma:lwm2m:oma:15 [19])
The context of this Resource is the following.
Table 6.3.9-1 Context of resource [deviceCapability]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:15 |
| objectPath | /15/{i} |
The attributes of this Resource shall be mapped to specific resources of the LwM2M Device Capability Management Object as follows.
Table 6.3.9-2 Attributes of resource [deviceCapability]
| Attribute Name of [deviceCapability] | Mapping to resources in LwM2M Device Object Instance |
|---|---|
| capabilityName | 2 Property |
| attached | 3 Attached |
| capabilityActionStatus | Has to be assigned by Management Adapter |
| enable | 5 opEnable |
| disable | 6 op Disable |
6.3.10 Resource [reboot]
The Resource [reboot] is used for rebooting the device. For OMA LwM2M, this Resource shall be mapped to the unique Instance of LwM2M Device Object (LwM2M ObjectID: 3).
The context of this Resource is as follows.
Table 6.3.10-1 Context of resource [reboot]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:3 |
| objectPath | /3/0 |
The attributes of this Resource shall be mapped to LwM2M Device Object Instance as follows.
Table 6.3.10-2 Attributes of resource [reboot]
| Attribute Name of [reboot] | Mapping to resources in LwM2M Object Instance |
|---|---|
| reboot | 4 reboot the LwM2M Device to restore the Device from unexpected firmware failure. |
| factoryReset | 5 Perform Factory Reset : the LwM2M device return to the same configuration as at the initial deployment. |
6.3.11 Resource [eventLog]
The Resource [eventLog] is to record the event log for the device. For OMA LwM2M, this Resource shall be mapped to one instance of LwM2M Event Log Object (LwM2M Object: {20}).
The context of this Resource is as follows.
Table 6.3.11-1 Context of resource [eventLog]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:oma:{20} |
| objectPath | /{20}/{i} |
The attributes of this Resource shall be mapped to LwM2M Device Object Instance as follows.
Table 6.3.11-2 Attributes of resource [eventLog]
| Attribute Name of [eventLog] | Mapping to resources in LwM2M Object Instance |
|---|---|
| logTypeId | 4010 LogClass: 1 (system) if the logTypeId of oneM2M [eventLog] resource is "System"; 2 (security) if the logTypeId of oneM2M [eventLog] resource is "Security"; 3 or 6 (event of charging) if the logTypeId of oneM2M [eventLog] resource is "Event". The charging event shall be mapped to 6; generic events shall be mapped to 3; 4 (trace) if the logTypeId of oneM2M [eventLog] resource is "Trace"; 5 (panic) if the logTypeId of oneM2M [eventLog] resource is "Panic". |
| logData | 4014 LogData The log data is mapped transparently without any transformation. The data format is considered as unspecified opaque (sequence of bytes) in LwM2M. The LwM2M 'LogDataFormat' resource (4015) is not used for the mapping. |
| logStatus |
4013 LogStatus: oneM2M logStatus attribute is translated as follows to LwM2M LogStatus Resource 0 : when logging activity is started (oneM2M logStatus : 1) 1 : when logging activity is stopped without error (oneM2M logStatus : 2) 3 : when logData attribute must be ignored (oneM2M logStatus :4) 5 : when logging activity is stopped with error (oneM2M logStatus :5) 128 (0x80) : when the status of the logging activity is unknown (oneM2M logStatus :3) |
| logStart | 4011 LogStart: When oneM2M logStart attribute is set to "True", CSE shall execute the LogStart command without argument (default) |
| logStop | 4012 LogStop: When oneM2M logStop attribute is set to "True", CSE shall execute the LogStop command without argument (default) |
6.3.12 Resource [cmdhPolicy]
6.3.12.0 Introduction
The Resource Type [cmdhPolicy] represents a set of rules associated with a specific CSE that govern the behaviour of that CSE regarding rejecting, buffering and sending request or response messages via the Mcc reference point. See clause D.12 of TS-0001 [1] for a detailed high-level description of the overall structure of the [cmdhPolicy] resource.
The mapping of CMDH Policy Resources on LwM2M Device Management technology is addressed through the definitions of 10 specific LwM2M Objects:
- CmdhPolicy Object
- ActiveCmdhPolicy Object
- CmdhDefaults Object
- CmdhDefEcValue Object
- CmdhEcDefParamsValues Object
- CmdhLimits Object
- CmdhNetworkAccessRules Object
- CmdhNwAccessRule Object
- CmdhBuffer Object
- CmdhBackOffParametersSet Object
These LwM2M Objects are specified in section 6.6.1 of this present document and are registered in OMNA as LwM2M objects.
The Resource Type [cmdhPolicy] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M cmdhPolicy Object.
The context of this Resource is as follows
Table 6.3.12.0-1: Context of resource [cmdhPolicy]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2048 |
| objectPath | /2048/{i} |
The attributes of an instance of [cmdhPolicy] shall be mapped to LwM2M resources of a given cmdhPolicy Object instance as follows :
Table 6.3.12.0-2: Attributes of resource [cmdhPolicy]
| Attribute Name of [cmdhPolicy] | Mapping to resources in LwM2M Object Instance |
|---|---|
| name | 0 : Name |
| cmdhDefaults | 1 : DefaultRule |
| cmdLimits | 2 : LimitRules |
| cmdhNwAccRules | 3 : NetworkAccessECRules |
| cmdhBuffer | 4 : BufferRules |
6.3.12.1 Resource [activeCmdhPolicy]
The Resource [activeCmdhPolicy] provides a link to the currently active set of CMDH policies, see clause D.12.1 of TS-0001 [1].
The Resource [activeCmdhPolicy] includes an attribute cmdhPolicy which is mapped on the ActiveLink resource of the LwM2M ActiveCmdhPolicy Object instance pointing to the active instance of the LwM2M CmdhPolicy Object.
The context of this Resource is as follows
Table 6.3.12.1-1: Context of resource [activeCmdhPolicy]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2049 |
| objectPath | /2049/0 |
The attribute of [activeCmdhPolicy] shall be mapped to the resource of the LwM2M ActiveCmdhPolicy Object Instance as follows:
Table 6.3.12.1-2: Attributes of resource [activeCmdhPolicy]
| Attribute Name of [activeCmdhPolicy] | Mapping to resources in LwM2M Object Instance |
|---|---|
| cmdhPolicy | 0 : ActiveLink At most one <cmdhPolicy> instance shall be enabled at a time. Hence, there can only be a single instance of the activeCmdhPolicy whose cmdhPolicy attribute points to the active CMDH policy. |
6.3.12.2 Resource [cmdhDefaults]
The Resource [cmdhDefaults] defines default CMDH policy values, see clause D.12.2 of TS-0001 [1].
The Resource [cmdhDefaults] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M cmdhDefaults Object.
The context of this Resource is as follows
Table 6.3.12.2-1: Context of resource [cmdhDefaults]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2050 |
| objectPath | /2050/{i} |
The attributes of an instance of [cmdhDefaults] shall be mapped to the resources of a LwM2M CmdDefaults Object instance as follows:
Table 6.3.12.2-2: Attributes of resource [cmdhDefaults]
| Attribute Name of [cmdhDefaults] | Mapping to resources in LwM2M Object Instance |
|---|---|
| cmdhDefEcValue | 0 : DefaultEcRules |
| cmdhEcDefParamValues | 1 : DefaultEcParamRules |
6.3.12.3 Resource [cmdhDefEcValue]
The Resource [cmdhDefEcValue] represents a default value for the ec (event category) parameter of an incoming request, see clause D.12.3 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.3-1: Context of resource [cmdhDefEcValue]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2051 |
| objectPath | /2051/{i} |
The Resource [cmdhDefEcValue] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M CmdhDefEcValue Object.
The attributes of an Instance of this Resource shall be mapped to the resources of a LwM2M CmdhDefEcValue Object instance as follows:
Table 6.3.12.3-2: Attributes of resource [cmdhDefEcValue]
| Attribute Name of [cmdhDefEcValue] | Mapping to resources in LwM2M Object Instance |
|---|---|
| order | 0 : Order |
| defEcValue | 1 : DefEcValue |
| requestOrigin | 2 : RequestOrigin |
| requestContext | 3 : RequestContext |
| requestContextNotification | 4 : RequestContextNotification |
| requestCharacteristics | 5 : RequestCharacteristics |
6.3.12.4 Resource [cmdhEcDefParamValues]
The Resource [cmdhEcDefParamValues] represents a specific set of default values for the CMDH related parameters rqet (request expiration timestamp), rset (result expiration timestamp), oet (operational execution time), rp (response persistence) and da (delivery aggregation) that are applicable for a given ec (event category) if these parameters are not specified in the request, see clause D.12.4 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.4-1: Context of resource [cmdhEcDefParamValues]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2051 |
| objectPath | /2052/{i} |
The Resource [cmdhEcDefParamValues] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M CmdhEcDefParamValues Object.
The attributes of an instance of [cmdhEcDefParamValues] shall be mapped to the resources of a LwM2M CmdhEcDefParamValues Object instance as follows:
Table 6.3.12.4-2: Attributes of resource [cmdhEcDefParamValues]
| Attribute Name of [cmdhEcDefParamValues] |
Mapping to resources in LwM2M Object Instance |
|---|---|
| applicableEventCategory | 0 : ApplicableEventCategory |
| defaultRequestExpTime | 1 : DefaultRequestExpTime |
| defaultResultExpTime | 2 : DefaultResultExpTime |
| defaultOpExecTime | 3 : DefaultOpExecTime |
| default RespPersistence | 4 : DefaultRespPersistence |
| defaultDelAggregation | 5 : DefaultDelAggregation |
6.3.12.5 Resource [cmdhLimits]
The Resource [cmdhLimits] represents limits for CMDH related parameter values, see clause D.12.5 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.5-1: Context of resource [cmdhLimits]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2053 |
| objectPath | /2053/{i} |
The Resource [cmdhLimits] is a multi-instance Resource where each instance of the Resource shall map to an instance of the CmdhLimits Object.
The attributes of an instance of [cmdhLimits] shall be mapped to the resources of an instance of the LwM2M CmdhLimits Object as follows:
Table 6.3.12.5-2: Attributes of resource [cmdhLimits]
| Attribute Name of [cmdhLimits] | Mapping to resources in LwM2M CmdhLimits Object Instance |
|---|---|
| order | 0 : Order |
| requestOrigin | 1 : RequestOrigin |
| requestContext | 2 : RequestContext |
| requestContextNotification | 3 : RequestContextNotification |
| requestCharacteristics | 4 : RequestCharacteristics |
| limitsEventCategory | 5 : LimitsEventCategory |
| limitsRequestExpTime | 6 : LimitsRequestExpTime |
| limitsOpExecTime | 7 : LimitsOpExecTime |
| limitsRespPersistence | 8 : LimitsRespPersistence |
| limitsDelAggregation | 9 : LimitsDelAggregation |
6.3.12.6 Resource [cmdhNetworkAccessRules]
The Resource [cmdhNetworkAccessRules] defines the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE, see clause D.12.6 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.6-1: Context of resource [cmdhNetworkAccessRules]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2054 |
| objectPath | /2054/{i} |
The Resource [cmdhNetworkAccessRules] is a multi-instance Resource where each instance of the Resource shall map to an instance of one instance of the LwM2M CmdhNetworkAccessRules Object.
The attributes of an instance of [cmdhNetworkAccessRules] shall be mapped to the resources of a LwM2M CmdhNetworkAccessRules Object Instance as follows:
Table 6.3.12.6-2: Attributes of resource [cmdhNetworkAccessRules]
| Attribute Name of [cmdhNetworkAccessRules] | Mapping to resources in LwM2M Object Instance |
|---|---|
| applicableEventCategories | 0 : ApplicableEventCategories |
| cmdhNwAccessRule | 1 : NetworkAccessRule |
6.3.12.7 Resource [cmdhNwAccessRule]
The Resource [cmdhNwAccessRule] defines limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH-related requests, see clause D.12.7 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.7-1: Context of resource [cmdhNwAccessRule]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2055 |
| objectPath | /2055/{i} |
The Resource [cmdhNwAccessRule] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M CmdhNwAccessRule Object.
The attributes of an instance of [cmdhNwAccessRule] shall be mapped to the resources of a LwM2M cmdhNwAccessRule Object Instance as follows:
Table 6.3.12.7-2: Attributes of resource [cmdhNwAccessRule]
| Attribute Name of [cmdhNwAccessRule] | Mapping to resources in LwM2M Object Instance |
|---|---|
| targetNetwork | 0 : TargetNetwork |
| minReqVolume | 1 : MinReqVolume |
| spreadingWaitTime | 2 : SpreadingWaitTime |
| backOffParameters | 3 : BackOffParameters |
| otherConditions | 4 : OtherConditions |
| allowedSchedule | 5 : AllowedSchedule |
6.3.12.8 Resource [cmdhBuffer]
The Resource [cmdhBuffer] represents limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE, see clause D.12.8 of TS-0001 [1].
The context of this Resource is as follows:
Table 6.3.12.8-1: Context of resource [cmdhBuffer]
| Context | Mapping |
|---|---|
| objectIDs | urn:oma:lwm2m:ext:2056 |
| objectPath | /2056/{i} |
The Resource [cmdhBuffer] is a multi-instance Resource where each instance of the Resource shall map to an instance of the LwM2M CmdhBuffer Object.
The attributes of an instance of [cmdhBuffer] shall be mapped to the resources of an LwM2M cmdhBuffer Object Instance as follows:
Table 6.3.12.8-2: Attributes of resource [cmdhBuffer]
| Attribute Name of [cmdhBuffer] | Mapping to resources in LwM2M Object Instance |
|---|---|
| applicableEventCategory | 0 : ApplicableEventCategory |
| maxBufferSize | 1 : MaxBufferSize |
| storagePriority | 2 : StoragePriority |