8.3 Specific DM SDT modules management
8.3.1 Resource [dmDeviceInfo ]
8.3.1.1 Introduction
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 |
Note
S: - 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] .
8.3.1.2 Create
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.
8.3.1.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.1.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.1.5 Delete
This operation is not allowed, as [dmDeviceInfo] is a mandatory child of [flexNode].
8.3.1.6 Notify
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.
8.3.2 Resource [dmAgent ]
8.3.2.1 Introduction
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.
8.3.2.2 Create
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 TS-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.
8.3.2.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.2.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.2.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.2.6 Notify
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.
8.3.2.7 Resource [reboot]
8.3.2.7.1 Introduction
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.
8.3.2.7.2 Create
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.
8.3.2.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.2.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.2.7.5 Delete
This operation is not allowed, as [reboot] is a mandatory child of [dmAgent].
8.3.2.7.6 Notify
Processing at Managing IPE:
- Trigger a reboot of the corresponding Proximal IoT device, according to the rebootType argument.
- Update the parent state attribute according to the known status of the Proximal IoT device.
8.3.2.8 Resource [deployPackage]
8.3.2.8.1 Introduction
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.
8.3.2.8.2 Create
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.
8.3.2.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.2.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.2.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.2.8.6 Notify
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.
8.3.3 Resource [dmDataModelIO]
8.3.3.1 Introduction
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.
8.3.3.2 Create
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.
8.3.3.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.3.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.3.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.3.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.3.7 Resource [readIO]
8.3.3.7.1 Introduction
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.
8.3.3.7.2 Create
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.
8.3.3.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.3.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.3.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.3.7.6 Notify
Processing at Managing IPE:
- Trigger a read of the parameter(s) referenced by the address argument on the corresponding Proximal IoT device.
- Create a result (short name resut ) attribute of the [dmDataModelIO] resource and fill it with the values returned by the device.
8.3.3.8 Resource [writeIO]
8.3.3.8.1 Introduction
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.
8.3.3.8.2 Create
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.
8.3.3.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.3.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.3.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.3.8.6 Notify
Processing at Managing IPE:
- Trigger a write of the parameter(s) referenced by the address argument, with values in the payload argument, on the Proximal IoT device.
- Create a result (short name resut) attribute of the [dmDataModelIO] resource and fill it with the values returned by the device.
8.3.4 Resource [dmFirmware]
8.3.4.1 Introduction
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.
8.3.4.2 Create
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.
8.3.4.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.4.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.4.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.4.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.4.7 Resource [updateFirmware ]
8.3.4.7.1 Introduction
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.
8.3.4.7.2 Create
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.
8.3.4.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.4.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.4.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.4.7.6 Notify
Processing at Managing IPE:
- Trigger an update of a new firmware, referenced by the url and version argument, on the Proximal IoT device.
- Create a result (short name resut) attribute of the [updateFirmware] resource and fill it with the message returned by the device.
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.
8.3.4.8 Resource [toggle ]
8.3.4.8.1 Introduction
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.
8.3.4.8.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.4.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.4.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.4.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.4.8.6 Notify
Processing at Managing IPE:
- Trigger a toggle between the current firmware and a backup one, on the Proximal IoT device.
- Create a result (short name resut) attribute of the [toggle] resource and fill it with the message returned by the device.
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.
8.3.5 Resource [dmSoftware ]
8.3.5.1 Introduction
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.
8.3.5.2 Create
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.
8.3.5.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.5.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.5.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.5.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.5.7 Resource [activate ]
8.3.5.7.1 Introduction
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.
8.3.5.7.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.5.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.5.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.5.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.5.7.6 Notify
Processing at Managing IPE:
- Trigger an activation of the software on the Proximal IoT device.
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.
8.3.5.8 Resource [deactivate ]
8.3.5.8.1 Introduction
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.
8.3.5.8.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.5.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.5.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.5.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.5.8.6 Notify
Processing at Managing IPE:
- Trigger a deactivation of the software on the Proximal IoT device.
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.
8.3.6 Resource [dmPackage ]
8.3.6.1 Introduction
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.
8.3.6.2 Create
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 TS-0023 [3] 5.8.9, the Creator IPE shall create <flexContainer> [install], [uninstall], [update] specializations as children of the [dmPackage] resource (see clauses 8.3.6.7, 8.3.6.8 and 8.3.6.9).
8.3.6.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.6.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.6.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.6.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.6.7 Resource [install]
8.3.6.7.1 Introduction
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.
8.3.6.7.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.6.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.6.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.6.7.5 Delete
This operation is not allowed, as [install] is a mandatory child of [dmPackage].
8.3.6.7.6 Notify
Processing at Managing IPE:
- Trigger an installation of the package on the Proximal IoT device.
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.
8.3.6.8 Resource [uninstall]
8.3.6.8.1 Introduction
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.
8.3.6.8.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.6.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.6.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.6.8.5 Delete
This operation is not allowed, as [uninstall] is a mandatory child of [dmPackage].
8.3.6.7.6 Notify
Processing at Managing IPE:
- Trigger a deinstallation of the package on the Proximal IoT device.
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.
8.3.6.9 Resource [update]
8.3.6.9.1 Introduction
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.
8.3.6.9.2 Create
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.
8.3.6.9.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.6.9.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.6.9.5 Delete
This operation is not allowed, as [update] is a mandatory child of [dmPackage].
8.3.6.9.6 Notify
Processing at Managing IPE:
- Trigger an update of the package on the Proximal IoT device.
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.
8.3.7 Resource [dmEventLog ]
8.3.7.1 Introduction
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).
8.3.7.2 Create
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.
8.3.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.7.6 Notify
Processing at Managing IPE:
- When the enabled attribute is set to TRUE (resp. FALSE), trigger a start (resp. a stop) of the logging behaviour on the Proximal IoT device.
- Modify the enabled attribute if the triggered action succeeds.
- Modify the status attribute accordingly.
8.3.7.7 Resource [retrieveLog]
8.3.7.7.1 Introduction
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.
8.3.7.7.2 Create
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.
8.3.7.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.7.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.7.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.7.7.6 Notify
Processing at Managing IPE:
- Trigger a retrieval of the logs of the Proximal IoT device.
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.
8.3.8 Resource [dmCapability ]
8.3.8.1 Introduction
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.
8.3.8.2 Create
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.
8.3.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.8.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.8.7 Resource [enable]
8.3.8.7.1 Introduction
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.
8.3.8.7.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.8.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.8.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.8.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.8.7.6 Notify
Processing at Managing IPE:
- Trigger the enabling of the capability on the Proximal IoT device.
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.
8.3.8.8 Resource [disable]
8.3.8.8.1 Introduction
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.
8.3.8.8.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.8.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.8.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.8.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.8.8.6 Notify
Processing at Managing IPE:
- Trigger the disabling of the capability on the Proximal IoT device.
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.
8.3.9 Resource [dmStorage]
8.3.9.1 Introduction
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.
8.3.9.2 Create
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.
8.3.9.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.9.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.9.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.9.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.9.7 Resource [format]
8.3.9.7.1 Introduction
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.
8.3.9.7.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.9.7.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.9.7.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.9.7.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.9.7.6 Notify
Processing at Managing IPE:
- Trigger the formatting of the storage on the Proximal IoT device.
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.
8.3.9.8 Resource [unmount]
8.3.9.8.1 Introduction
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.
8.3.9.8.2 Create
No change from the generic procedures in clause 8.2.1.
8.3.9.8.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.9.8.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.9.8.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.9.8.6 Notify
Processing at Managing IPE:
- Trigger the unmount of the storage on the Proximal IoT device.
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.
8.3.10 Resource [battery]
8.3.10.1 Introduction
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.
8.3.10.2 Create
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.
8.3.10.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.10.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.10.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.10.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.11 Resource [dmAreaNwkInfo]
8.3.11.1 Introduction
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).
8.3.11.2 Create
No change from the generic procedures in clause 8.2.1.
Originator: the Creator IPE shall create the 'propAreaNwkType' property of the [dmAreaNwkInfo] subdevice.
8.3.11.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.11.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.11.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.11.6 Notify
No change from the generic procedure in clause 8.2.5.
8.3.12 Resource [dmAreaNwkDeviceInfo]
8.3.12.1 Introduction
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.
8.3.12.2 Create
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.
8.3.12.3 Retrieve
No change from the generic procedures in clause 8.2.2.
8.3.12.4 Update
No change from the generic procedures in clause 8.2.3.
8.3.12.5 Delete
No change from the generic procedure in clause 8.2.4.
8.3.12.6 Notify
No change from the generic procedure in clause 8.2.5.