oneM2M TS-0033Release Notes diff from v5.0.1 to v5.0.1oneM2M TS-0033Release Notes diff from v5.0.1 to v5.0.1This clause specifies the procedures for managing device capabilities, using SDT DM
The
NOTE: throughout this clause, the expressions "Creator IPE" and "Managing IPE" refer to the IPEs that respectively creates and manages the NoDN. The Creator and Managing IPEs of the NoDN can be identical. If a DM resource has no associated IPE, no DM operation could be performed on the corresponding NoDN. Creation and deletion rules could be applied to prevent the situation where a DM resource has no associated IPE, but are deployment specific and out of scope of this document. The association of a DM resource with a Managing IPE is out of scope of this document.
This procedure shall be used for creating a [flexNode] resource.
Table 8.1.1‑1: [flexNode] CREATE
[flexNode] CREATE
|
|
|---|---|
Information in Request message
|
All parameters defined in TS-0001 [2] table 8.1.2‑3 apply with the specific details for: From : Identifier of the IPE that initiates the Request To : The address of the Content: The representation of the [flexNode] resource described in clause 5.8.2 in TS-0023 [3]. |
Processing at Originator before sending Request
|
According to clause 0001 [2] 10.1.2. The Originator should be a Creator IPE that manages the corresponding entity in the Proximal IoT System. |
Processing at Receiver
|
According to clause 0001 [2] 10.1.2
|
Information in Response message
|
All parameters defined in TS-0001 [2] table 8.1.3‑1 apply with the specific details for: Content : Address of the created [flexNode] resource, according to clause 0001 [2] 10.1.2 |
Processing at Originator after receiving Response
|
According to clause 0001 [2] 10.1.2. The originator shall create at least the [dmDeviceInfo], mandatory child of the [flexNode] (see clause 8.3.1). |
Exceptions
|
According to clause 0001 [2] 10.1.2
|
As specified in clause 5.8.2 of TS-0023 [3], the 'flexNode' has at least as mandatory child a 'dmDeviceInfo' ModuleClass The IPE, after creating the [flexNode] resource, shall therefore create a [dmDeviceInfo]
It also shall create the <flexContainer > specializations that correspond to the DM SDT modules that represent the device management capabilities of the Proximal IoT devices it manages.
For the generic operations on these DM SDT
This procedure shall be used for retrieving the attributes of a [flexNode] resource.
Table 8.1.2‑1: [flexNode] RETRIEVE
[_flexNode]_ RETRIEVE
|
|
|---|---|
Information in Request message
|
All parameters defined in TS-0001 [2] table 8.1.2‑3 apply with the specific details for: Content : Void |
Processing at Originator before sending Request
|
According to clause 0001 [2] 10.1.3
|
Processing at Receiver
|
According to clause 0001 [2] 10.1.3
|
Information in Response message
|
All parameters defined in TS-0001 [2] table 8.1.3‑1 apply with the specific details for: Content: Attributes of the [flexNode] resource as defined in clause 0023 [3] 5.8.2. |
Processing at Originator after receiving Response
|
According to clause 0001 [2] 10.1.3
|
Exceptions
|
According to clause 0001 [2] 10.1.3
|
This procedure shall be used for updating the attributes and the actual data of a [flexNode] resource and its child resources.
Table 8.1.3‑1: [flexNode] UPDATE
[flexNode] UPDATE
|
|
|---|---|
Information in Request message
|
All parameters defined in TS-0001 [2] table 8.1.2‑3 apply with the specific details for: Content : attributes of the [flexNode] resource as defined in clause 0023 [3] 5.8.2 which need be updated, with the exception of the Read Only (RO) attributes that cannot be modified |
Processing at Originator before sending Request
|
According to clause 0001 [2] 10.1.4
|
Processing at Receiver
|
According to clause 0001 [2] 10.1.4 with the following: The Receiver shall check whether the provided attributes of the [flexNode] resource represent a valid request for updating [flexNode] resource |
Information in Response message
|
According to clause 0001 [2] 10.1.4
|
Processing at Originator after receiving Response
|
According to clause 0001 [2] 10.1.4
|
Exceptions
|
According to clause 0001 [2] 10.1.4
|
This procedure shall be used for deleting an existing [flexNode] resource.
NOTE: The deletion of the [flexNode] resource is on discretion of the Creator IPE.
Table 8.1.4‑1: [flexNode] DELETE
[flexNode] DELETE
|
|
|---|---|
Information in Request message
|
All parameters defined in TS-0001 [2] table 8.1.2‑3 apply
|
Processing at Originator before sending Request
|
According to clause 0001 [2] 10.1.5 The Originator should be a Creator IPE that manages the corresponding entity in the Proximal IoT System. |
Processing at Receiver
|
According to clause 0001 [2] 10.1.5
|
Information in Response message
|
According to clause 0001 [2] 10.1.5
|
Processing at Originator after receiving Response
|
According to clause 0001 [2] 10.1.5
|
Exceptions
|
According to clause 0001 [2] 10.1.5
|
NOTE: This clause defines generic guidelines for handling all DM SDT modules; clause 8.3. will add detailed information for each specific module.
Besides the generic create procedure defined in oneM2M TS-0001 [2]clause 10.1.2, the procedure in table 8.2.1‑1 shall be used.
Table 8.2.1‑1: DM SDT
Information in Request message
|
From: Identifier of the IPE that initiates the Request To: The address of the [flexNode] where the Content: The representation of the |
Processing at Originator before sending Request
|
The Originator should be a Creator IPE that manages the corresponding entity in the Proximal IoT Technology. The Originator first collects the Proximal IoT Technology specific data model object (the management tree structure or also the value of the tree nodes if needed) of the Proximal IoT device and transforms the object into the DM SDT |
Processing at Receiver
|
According to clause 10.1.2
|
Information in Response message
|
According to clause 10.1.2
|
Processing at Originator after receiving Response
|
The originator shall create at least the mandatory children, if any, of the created |
Exceptions
|
The creation of the DM SDT The created DM SDT |
NOTE:
- the Creator IPE shall create at least the custom attributes that correspond to mandatory datapoints of SDT moduleClasses;
- it should create as many as possible custom attributes that correspond to optional datapoints of SDT moduleClasses;
- it should not create optional attributes that have no associated equivalent in the Proximal IoT Technology specific data model.
Update requests to this created <flexContainer> shall be retargeted to the Managing IPE. For this, the IPE can create a <subscription> resource, child of the <flexContainer> resource, with the attributes given in Table 8.2.1.1‑1.
Table 8.2.1.1‑1: <subscription> resource
Attributes of |
Description / Value
|
|---|---|
notificationURI
|
IPE URI
|
notificationContentType
|
all attributes
|
notificationEEventType
|
G. Update to attributes of the subscribed-to resource with blocking UPDATE |
This procedure shall be used to retrieve information from an existing DM SDT
Table 8.2.2‑1: DM SDT
Information in Request message
|
From: Identifier of the AE or the CSE that initiates the Request To: The address of the DM SDT |
Processing at Originator before sending Request
|
None
|
Processing at Receiver
|
According to clause 10.1.3, |
Information in Response message
|
Error code if the new technology specific data model object cannot be retrieved
|
Processing at Originator after receiving Response
|
None
|
Exceptions
|
Corresponding technology specific object data cannot be retrieved from the managed entity (e.g. technology specific object not found)
|
NOTE: the Managing IPE is responsible for providing updated data to DM SDT
resources of the entities it manages (see clause 6.2.2).
This procedure shall be used to update information of an existing DM SDT
Table 8.2.3‑1:
DM SDT |
|
|---|---|
Information in Request message
|
From: Identifier of the AE or the CSE that initiates the Request To: The address of the DM SDT Content: The representation of the |
Processing at Originator before sending Request
|
None
|
Processing at Receiver
|
Send a blocking UPDATE notification to the Managing IPE. Wait for the notification response. If the notification is successful, modify the current |
Processing at Managing IPE
|
The Managing IPE is responsible for invoking the appropriate non-oneM2M Proximal IoT function(s). See NOTIFY procedures on each DM flexContainer specialization in clauses 8.3.*
|
Information in Response message
|
The resource (or attributes defined in the originating request, depending on the result content) as it has been modified.
|
Processing at Originator after receiving Response
|
None
|
Exceptions
|
Error code if a timeout happens before the notification completes, otherwise returns the retargeted response. Error code if the request is trying to modify a read-only attribute (see note). Error code if the Managing IPE returned an error. |
NOTE:
- The creation and update of the
's custom attributes that correspond to datapoints specified as R (read only) in clauses5.8.x of TS-0023 [3] are allowed only to the Creator and Managing IPE.- The
's custom attributes that correspond to datapoints specified as RW are updatable by external AEs. This is ensured by the Managing IPE when it is notified about the UPDATE request.
This procedure shall be used to delete an existing DM SDT <flexContainer> resource. Besides the generic delete procedure defined in oneM2M TS-0001 [2]clause 10.1.5, the procedure in table 8.2.4‑1 shall be used.
Table 8.2.4‑1: DM SDT <flexContainer> DELETE
DM SDT |
|
|---|---|
Information in Request message
|
From: Identifier of the AE, or the CSE that initiates the Request To: The address of the |
Processing at Originator before sending Request
|
The Originator should be a Creator or Managing IPE that manages the corresponding entity in the Proximal IoT Technology.
|
Processing at Receiver
|
According to clause 10.1.5
|
Information in Response message
|
Error code OPERATION_NOT_ALLOWED if the |
Processing at Originator after receiving Response
|
None
|
Exceptions
|
Corresponding technology specific data model object cannot be deleted from managed entity (e.g. not reachable, technology specific data model object not found)
|
Following the <subscription> resource defined in clause 8.2.1.1, the Managing IPE shall be notified when the <flexContainer>, representing a DM SDT module, will be updated by an external entity. The IPE is responsible for invoking the appropriate non-oneM2M Proximal IoT function(s) when any change in the <flexContainer> resource, as specified in the received notification, is meant to trigger the execution of that non-oneM2M Proximal IoT function. For specific behaviour, depending on the type of
If the triggered IoT function is not successful (timeout or returned error), the Managing IPE shall respond to the notification with an error, otherwise it will respond with success.
If the UPDATE request contains custom attributes that correspond to read-only datapoints, the Managing IPE shall raise an error.
If the UPDATE request contains custom attributes that correspond to optional read-write datapoints that are not present in the resource, the Managing IPE may raise an error (there can be exceptions to this rule, for instance the description attribute of the [dmDeviceInfo]).
The detailed description of the [dmDeviceInfo] resource can be found in clause 5.8.4 of the oneM2M TS-0023 [3].
Table 8.3.1.1‑1: Data Type Definition of [dmDeviceInfo]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmDeviceInfo, dmDeviceInfoAnnc |
MAD-mod-dmDeviceInfo-vx_y_z.xsd
|
NOTES:
- The creation and deletion of the [dmDeviceInfo] resource is on discretion of the Creator IPE.
- As specified in clause 5.8.2 of TS-0023 [3], the 'flexNode' has at least as mandatory child a 'dmDeviceInfo' ModuleClass. The IPE, after creating the [flexNode] resource, shall therefore create a [dmDeviceInfo] <flexContainer> specialization under the [flexNode] .
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create as many as possible datapoints of the 'dmDeviceInfo' ModuleClass.
In particular, some datapoints should be filled, for instance serialNumber, manufacturer and model when this information is available.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
This operation is not allowed, as [dmDeviceInfo] is a mandatory child of [flexNode].
No change from the generic procedure in clause 8.2.5.
The only modifiable attributes are manufacturerDetailsLink, supportURL, presentationURL, friendlyName and description.
Depending on the underlying Proximal IoT technology, the Managing may forward the request to the managed node using the appropriate IoT function.
The detailed description of the [dmAgent] resource can be found in clause 5.8.3 of the oneM2M TS-0023 [3].
Table 8.3.2.1‑1: Data Type Definition of [dmAgent]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmAgent, dmAgentAnnc |
MAD-mod-dmAgent-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmAgent] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology can provide at least a rebooting function on the corresponding Proximal IoT devices and read their status.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create as many as possible datapoints of the dmAgent ModuleClass, at least the mandatory 'state' datapoint (attribute 'state '), but it should not create optional attributes that have no associated equivalent in the Proximal IoT Technology specific data model.
As the 'reboot' SDT action is mandatory in clause 0023[3] 5.8.3, the Creator IPE shall create a <flexContainer > [reboot ] specialization (see clause 8.3.2.7) as child of the [dmAgent ] resource.
If the Proximal IoT Technology allows deploying new packages on the Proximal IoT device, the Creator IPE will create a <flexContainer > [deployPackage ] specialization as child of the [dmAgent ] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The only modifiable attribute is systemTime .
Depending on the underlying Proximal IoT technology, the Managing IPE may forward the request to the managed node using the appropriate IoT function.
The detailed description of the [reboot] resource can be found in clause 5.8.3 of the oneM2M TS-0023 [3].
Table 8.3.2.7.1‑1: Data Type Definition of [reboot]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
reboot, rebootAnnc |
MAD-act-reboot-vx_y_z.xsd
|
NOTE: the creation and deletion of the [reboot] resource is on discretion of the Creator IPE. It is created as child of a [dmAgent] resource.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the argument 'rebootType' of the reboot SDT action as an attribute rebTe of the [reboot] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
This operation is not allowed, as [reboot] is a mandatory child of [dmAgent].
Processing at Managing IPE:
The detailed description of the [deployPackage] resource can be found in clause 5.8.3 of the oneM2M TS-0023 [3].
Table 8.3.2.8.1‑1: Data Type Definition of [deployPackage]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
deployPackage, deployPackageAnnc |
MAD-act-deployPackage-vx_y_z.xsd
|
NOTE: the creation and deletion of the [deployPackage] resource is on discretion of the Creator IPE. It is created as child of a [dmAgent] resource.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the argument 'name', 'version' and 'url' of the deployPackage SDT action as attributes name, versn and url of the [deployPackage] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
The IPE shall create a [dmPackage] <flexContainer> resource as child of the grand-parent [flexNode] resource. It will create a result (short name resut) attribute of the [deployPackage] resource and fill it with the resourceID of the created [dmPackage] resource.
NOTE: the IPE shall not, at this stage, attempt to deploy the package on the Proximal IoT device: this is done by manipulating the created [dmPackage] resource.
The detailed description of the [dmDataModelIO] resource can be found in clause 5.8.5 of the oneM2M TS-0023 [3].
Table 8.3.3.1‑1: Data Type Definition of [dmDataModelIO]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmDataModelIO, dmDataModelIOAnnc |
MAD-mod-dmDataModelIO-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmDataModelIO] resource is on discretion of the Creator IPE. It shall be created if the Proximal IoT Technology allows reading and/or writing parameters of the underlying data model.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the 'dataModelType' datapoint of the dmDataModelIO ModuleClass, as a daMTe attribute.
If the Proximal IoT Technology allows reading data model parameters, the Creator IPE will create a <flexContainer> [readIO] specialization as child of the [dmDataModelIO] resource.
If the Proximal IoT Technology allows writing data model parameters, the Creator IPE will create a <flexContainer> [writeIO] specialization as child of the [dmDataModelIO] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [readIO] resource can be found in clause 5.8.5 of the oneM2M TS-0023 [3].
Table 8.3.3.7.1‑1: Data Type Definition of [readIO]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
readIO, readIOAnnc |
MAD-act-readIO-vx_y_z.xsd
|
NOTE: the creation and deletion of the [readIO] resource is on discretion of the Creator IPE. It is created as child of a [dmDataModelIO] resource.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the argument 'address' of the readIO SDT action as an attribute addrs of the [readIO] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
The detailed description of the [writeIO] resource can be found in clause 5.8.5 of the oneM2M TS-0023 [3].
Table 8.3.3.8.1‑1: Data Type Definition of [writeIO]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
writeIO, writeIOAnnc |
MAD-act-writeIO-vx_y_z.xsd
|
NOTE: the creation and deletion of the [writeIO] resource is on discretion of the Creator IPE. It is created as child of a [dmDataModelIO] resource.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the arguments 'address' and 'payload' of the writeIO SDT action as attribute addrs and payld of the [writeIO] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
The detailed description of the [dmFirmware] resource can be found in clause 5.8.6 of the oneM2M TS-0023 [3].
Table 8.3.4.1‑1: Data Type Definition of [dmFirmware]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmFirmware, dmFirmwareAnnc |
MAD-mod-dmFirmware-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmFirmware] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows handling the firmware of the Proximal IoT devices.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create as many as possible datapoints of the dmFirmware ModuleClass, at least the mandatory ones.
If the Proximal IoT Technology allows updating the firmware of a Proximal IoT device, the Creator IPE will create a <flexContainer> [updateFirmware] specialization as child of the [dmFirmware] resource.
If the Proximal IoT Technology allows Proximal IoT devices to toggle between the installed firmware and a backup firmware, the Creator IPE will create a <flexContainer> [toggle] specialization as child of the [dmFirmware] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [updateFirmware] resource can be found in clause 5.8.6 of the oneM2M TS-0023 [3].
Table 8.3.4.7.1‑1: Data Type Definition of [updateFirmware]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
updateFirmware, updateFirmware Annc |
MAD-act-updateFirmware-vx_y_z.xsd
|
NOTE: the creation and deletion of the [updateFirmware] resource is on discretion of the Creator IPE. It is created as child of a [dmFirmware] resource.
No change from the generic procedures in clause 8.2.1.
Originator : the Creator IPE shall create the arguments 'url' and 'version' of the updateFirmware SDT action as attribute url and versn of the [updateFirmware] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the installation (download of the firmware, installation, etc.) are left to the Managing IPE, but the IPE shall fill the primaryState attribute of the parent [dmFirmware] resource accordingly.
The detailed description of the [toggle] resource can be found in clause 5.8.6 of the oneM2M TS-0023 [3].
Table 8.3.4.8.1‑1: Data Type Definition of [toggle]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
toggle, toggleAnnc |
MAD-act-toggle-vx_y_z.xsd
|
NOTE: the creation and deletion of the [toggle] resource is on discretion of the Creator IPE. It is created as child of a [dmFirmware] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the toggle (download of the firmware, installation, etc.) are left to the Managing IPE, but the IPE shall fill the primaryState attribute of the parent [dmFirmware] resource accordingly.
The detailed description of the [dmSoftware] resource can be found in clause 5.8.7 of the oneM2M TS-0023 [3].
Table 8.3.5.1‑1: Data Type Definition of [dmSoftware]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmSoftware, dmSoftwareAnnc |
MAD-mod-dmSoftware-vx_y_z.xsd
|
NOTE 1: the creation and deletion of the [dmSoftware] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows installing various software images on the Proximal IoT devices. The IPE shall create one [dmSoftware] resource per software image.
NOTE 2: a [dmSoftware] resource can be created either at the initialization if it represents a software module that is pre-installed on the device, or after installation of one or more [dmPackage] module(s) (see clause 8.3.6) that have been dynamically created (for instance a software image with associated configuration files and libraries). See TS-0023 [3]clause 5.8.7.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the dmSoftware ModuleClass, at least the mandatory ones.
If the Proximal IoT Technology allows activating/deactivating the software of a Proximal IoT device, the Creator IPE will create <flexContainer> [activate] and or [deactivate] specialization as child of the [dmSoftware] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [activate] resource can be found in clause 5.8.7 of the oneM2M TS-0023 [3].
Table 8.3.5.7.1‑1: Data Type Definition of [activate]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
activate, activateAnnc |
MAD-act-activate-vx_y_z.xsd
|
NOTE: the creation and deletion of the [activate] resource is on discretion of the Creator IPE. It is created as child of a [dmSoftware] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the activation are left to the Managing IPE, but the IPE shall fill the state attribute of the parent [dmSoftware] resource accordingly.
The detailed description of the [deactivate] resource can be found in clause 5.8.7 of the oneM2M TS-0023 [3].
Table 8.3.5.8.1‑1: Data Type Definition of [deactivate]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
deactivate, deactivateAnnc |
MAD-act-deactivate-vx_y_z.xsd
|
NOTE: the creation and deletion of the [deactivate] resource is on discretion of the Creator IPE. It is created as child of a [dmSoftware] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the deactivation are left to the Managing IPE, but the IPE shall fill the state attribute of the parent [dmSoftware] resource accordingly.
The detailed description of the [dmPackage] resource can be found in clause 5.8.9 of the oneM2M TS-0023 [3].
Table 8.3.6.1‑1: Data Type Definition of [dmPackage]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmPackage, dmPackageAnnc |
MAD-mod-dmPackage-vx_y_z.xsd
|
NOTE 1: the creation and deletion of the [dmPackage] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows installing various packages (libraries, configuration files, softwarevimages, etc) on the Proximal IoT devices. The Creator IPE shall create one [dmPackage] resource per package.
NOTE 2: a [dmPackage] resource can be created either at the initialization if it represents a package that is pre-installed on the device, or by a deployment from the [dmAgent] module (see clause 8.3.2). See TS-0023 [3]clause 5.8.9.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the dmPackage ModuleClass, at least the mandatory ones.
As the 'install', 'uninstall' and 'update' SDT actions are mandatory in clause 0023[3] 5.8.9, the Creator IPE shall create <flexContainer> [install], [uninstall], [update] specializations as children of the [dmPackage] resource (see clauses8.3.6.7, 8.3.6.8 and 8.3.6.9).
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [install] resource can be found in clause 5.8.9 of the oneM2M TS-0023 [3].
Table 8.3.6.7.1‑1: Data Type Definition of [install]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
install, installAnnc |
MAD-act-install-vx_y_z.xsd
|
NOTE: the creation and deletion of the [install] resource is on discretion of the Creator IPE. It is created as child of a [dmPackage] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
This operation is not allowed, as [install] is a mandatory child of [dmPackage].
Processing at Managing IPE:
NOTE: the steps of the installation (download, install, etc.) are left to the Managing IPE, but the IPE shall fill the state attribute of the parent [dmPackage] resource accordingly.
The detailed description of the [uninstall] resource can be found in clause 5.8.9 of the oneM2M TS-0023 [3].
Table 8.3.6.8.1‑1: Data Type Definition of [uninstall]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
uninstall, uninstallAnnc |
MAD-act-uninstall-vx_y_z.xsd
|
NOTE: the creation and deletion of the [uninstall] resource is on discretion of the Creator IPE. It is created as child of a [dmPackage] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
This operation is not allowed, as [uninstall] is a mandatory child of [dmPackage].
Processing at Managing IPE:
NOTE: the steps of the deinstallation are left to the Managing IPE, but the IPE shall fill the state attribute of the parent [dmPackage] resource accordingly.
The detailed description of the [update] resource can be found in clause 5.8.9 of the oneM2M TS-0023 [3].
Table 8.3.6.9.1‑1: Data Type Definition of [update]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
update, updateAnnc |
MAD-act-update-vx_y_z.xsd
|
NOTE: the creation and deletion of the [update] resource is on discretion of the Creator IPE. It is created as child of a [dmPackage] resource.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create the arguments 'url' and 'version' of the update SDT action as attribute url and versn of the [update] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
This operation is not allowed, as [update] is a mandatory child of [dmPackage].
Processing at Managing IPE:
NOTE: the steps of the update (download, install, etc.) are left to the Managing IPE, but the IPE shall fill the state attribute of the parent [dmPackage] resource accordingly.
The detailed description of the [dmEventLog] resource can be found in clause 5.8.8 of the oneM2M TS-0023 [3].
Table 8.3.7.1‑1: Data Type Definition of [dmEventLog]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmEventLog, dmEventLogAnnc |
MAD-mod-dmEventLog-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmEventLog] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows monitoring the logs on the Proximal IoT devices. The IPE shall create one [dmEventLog] resource per type of log (see enumeration logTypeId).
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the dmEventLog ModuleClass, at least the mandatory ones.
If the Proximal IoT Technology allows retrieving the logs of a Proximal IoT device, the Creator IPE will create a <flexContainer> [retrieveLog] specialization as child of the [dmEventLog] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
The detailed description of the [retrieveLog] resource can be found in clause 5.8.9 of the oneM2M TS-0023 [3].
Table 8.3.7.7.1‑1: Data Type Definition of [activate]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
retrieveLog, retrieveLogAnnc |
MAD-act-retrieveLog-vx_y_z.xsd
|
NOTE: the creation and deletion of the [retrieveLog] resource is on discretion of the Creator IPE. It is created as child of a [dmEventLog] resource.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create the arguments 'start' and 'end' of the update SDT action as attribute start and end of the [retrieveLog] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the retrieval are left to the Managing IPE, but the IPE shall fill the status attribute of the parent [dmEventLog] resource accordingly.
When retrieval is completed, the Managing IPE shall fill the data attribute of the parent [dmEventLog] with the retrieved log value.
The detailed description of the [dmCapability] resource can be found in clause 5.8.12 of the oneM2M TS-0023 [3].
Table 8.3.8.1‑1: Data Type Definition of [dmCapability]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmCapability, dmCapabilityAnnc |
MAD-mod-dmCapability-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmCapability ] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows enabling/disabling various capabilities on the Proximal IoT devices. The Creator IPE shall create one [dmCapability ] resource per capability.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the dmCapability ModuleClass, at least the mandatory ones.
If the Proximal IoT Technology allows enabling/disabling the capabilities of a Proximal IoT device, the Creator IPE will create <flexContainer> [enable] and or [disable] specialization as child of the [dmCapability] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [enable] resource can be found in clause 5.8.7 of the oneM2M TS-0023 [3].
Table 8.3.8.7.1‑1: Data Type Definition of [enable]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
enable, enableAnnc |
MAD-act-enable-vx_y_z.xsd
|
NOTE: the creation and deletion of the [enable] resource is on discretion of the Creator IPE. It is created as child of a [dmCapability] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the enabling are left to the Managing IPE, but the IPE shall fill the currentState attribute of the parent [dmCapability] resource accordingly.
The detailed description of the [disable] resource can be found in clause 5.8.7 of the oneM2M TS-0023 [3].
Table 8.3.8.8.1‑1: Data Type Definition of [disable]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
disable, disableAnnc |
MAD-act-disable-vx_y_z.xsd
|
NOTE: the creation and deletion of the [disable] resource is on discretion of the Creator IPE. It is created as child of a [dmCapability] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the disabling are left to the Managing IPE, but the IPE shall fill the currentState attribute of the parent [dmCapability] resource accordingly.
The detailed description of the [dmStorage] resource can be found in clause 5.8.13 of the oneM2M TS-0023 [3].
Table 8.3.9.1‑1: Data Type Definition of [dmStorage]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmStorage, dmStorageAnnc |
MAD-mod-dmStorage-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmStorage] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows handling various types of storage on the Proximal IoT devices. The IPE shall create one [dmStorage] resource per existing storage.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the dmStorage ModuleClass, at least the mandatory ones.
If the Proximal IoT Technology allows formatting/unmounting the storage(s) of a Proximal IoT device, the Creator IPE will create <flexContainer> [format] and or [unmount] specialization as child of the [dmStorage] resource.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [format] resource can be found in clause 5.8.13 of the oneM2M TS-0023 [3].
Table 8.3.9.7.1‑1: Data Type Definition of [format]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
format, formatAnnc |
MAD-act-format-vx_y_z.xsd
|
NOTE: the creation and deletion of the [format] resource is on discretion of the Creator IPE. It is created as child of a [dmStorage] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the formating are left to the Managing IPE, but the IPE shall fill the attributes of the parent [dmStorage] resource accordingly.
The detailed description of the [unmount] resource can be found in clause 5.8.13 of the oneM2M TS-0023 [3].
Table 8.3.9.8.1‑1: Data Type Definition of [unmount]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
unmount, unmountAnnc |
MAD-act-unmount-vx_y_z.xsd
|
NOTE: the creation and deletion of the [unmount] resource is on discretion of the Creator IPE. It is created as child of a [dmStorage] resource.
No change from the generic procedures in clause 8.2.1.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
Processing at Managing IPE:
NOTE: the steps of the unmounting are left to the Managing IPE, but the IPE shall fill the attributes of the parent [dmStorage] resource accordingly.
The detailed description of the [battery] resource can be found in clause 5.3.1.10 of the oneM2M TS-0023 [3].
Table 8.3.10.1‑1: Data Type Definition of [battery]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
battery, batteryAnnc |
COD-mod-battery-vx_y_z.xsd
|
NOTE: the creation and deletion of the [battery] resource is on discretion of the Creator IPE. It shall be created if the underlying Proximal IoT Technology allows monitoring the power supply on the Proximal IoT devices. The IPE shall create one [battery] resource per existing battery.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the [battery] ModuleClass.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [dmAreaNwkInfo] resource can be found in clause 5.8.10 of the oneM2M TS-0023 [3].
Table 8.3.11.1‑1: Data Type Definition of [dmAreaNwkInfo]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmAreaNwkInfo, dmAreaNwkInfoAnnc |
MAD-dmAreaNwkInfo-vx_y_z.xsd
|
NOTE: The creation and deletion of the [dmAreaNwkInfo] resource is on discretion of the Creator IPE. It gives information on the M2M Area Network managed by the IPE. This resource corresponds to a SubDevice, in SDT vocabulary, i.e. a child of a SDT Device that has no datapoints, just properties, and can have SDT ModuleClasses as children, in this case [dmAreaNwkDeviceInfo] flexContainers (see clause 8.3.11.7).
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create the 'propAreaNwkType' property of the [dmAreaNwkInfo] subdevice.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.
The detailed description of the [dmAreaNwkDeviceInfo] resource can be found in clause 5.8.11 of the oneM2M TS-0023 [3].
Table 8.3.12.1‑1: Data Type Definition of [dmAreaNwkDeviceInfo]
Data Type ID
|
File Name
|
Note
|
|---|---|---|
dmAreaNwkDeviceInfo, dmAreaNwkDeviceInfoAnnc |
MAD-mod-dmAreaNwkDeviceInfo-vx_y_z.xsd
|
NOTE: the creation and deletion of the [dmAreaNwkDeviceInfo] resource is on discretion of the Creator IPE. It shall be created if the IPE manages a M2M Area Network. The IPE shall create one [dmAreaNwkDeviceInfo] resource per device in the M2M Area Network. This resource is created as child of a [dmAreaNwkInfo] resource.
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create as many as possible datapoints of the [dmAreaNwkDeviceInfo ] ModuleClass, at least the mandatory 'devId' and 'devType' attributes.
No change from the generic procedures in clause 8.2.2.
No change from the generic procedures in clause 8.2.3.
No change from the generic procedure in clause 8.2.4.
No change from the generic procedure in clause 8.2.5.