diff --git a/LICENSE b/LICENSE
index 05bae5b61e70d4b745f34f61d88d56d7c31baf42..acfd8e73177c1ec051bafd77a3f3ad4231b40fa7 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2019, oneM2M Partners Type 1
+Copyright 2020, oneM2M Partners Type 1
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
diff --git a/README.md b/README.md
index b1ea592c54f2fc0cd3e3770a9eec10283946b771..f30f7853b103f1020969802818af7304770b6ac7 100644
--- a/README.md
+++ b/README.md
@@ -12,12 +12,12 @@ Any contributions made to the Smart Device Template format must comply with the
-The Smart Device Template (SDT) is a template which is used to model the capabilities, actions and events of connected devices. The intent of the SDT is to be able to model any type of connected device using a well accepted and standardised format. The main application of SDT is to enable a uniformly structured Application Programmer's Interface (API) to applications that need to interact with connected devices. Usually, these applications would communicate to devices using an abstraction layer as an intermediary logic. The abstraction layer "hides" the technology-specific, native language format of devices of different technology type from the applications.
+The Smart Device Template (SDT) is a template method which is used to model the capabilities, actions and events of connected devices. The intent of the SDT is to be able to model any type of connected device using a well accepted and standardised format. The main application of SDT is to enable a uniformly structured Application Programmer's Interface (API) for applications that need to interact with connected devices. Usually, these applications would communicate to devices using an abstraction or service layer, or cloud platform as an intermediary logic. This layer usually "hides" the technology-specific, native language format of devices of different technology type from the applications.
[Read the full Introduction.](SDT/schema4.0/docs/Introduction.md)
## Quick Links
-- [UML Diagram of the SDT 4.0](SDT/schema4.0/docs/UML%20Diagram.md) ([Umlet source](SDT/schema4.0/docs/SDT_UML.uxf)) : This UML diagram describes the various components of the SDT and their relations.
+- [UML Diagrams of the SDT 4.0](SDT/schema4.0/docs/UML%20Diagram.md) ([Umlet source](SDT/schema4.0/docs/SDT_UML.uxf)) : These UML diagram describes the various components of the SDT and their relations.
- ['domain.xsd' Version 4.0](SDT/schema4.0/src/domain.xsd) : This is the XSD schema file that defines the SDT XML Schema.
diff --git a/SDT/schema4.0/docs/Changelog.md b/SDT/schema4.0/docs/Changelog.md
index 1ebec20041c53ff11b43dec07abca099b98d0cfe..ebe811527dfa7af9e3d08bec9cc538ec5f5409e8 100644
--- a/SDT/schema4.0/docs/Changelog.md
+++ b/SDT/schema4.0/docs/Changelog.md
@@ -13,6 +13,7 @@
- Added ``optional`` attribute to ``<Arg>``.
- Added ``default`` attribute to ``<Arg>``.
- Added ``default`` attribute to ``<DataPoint``.
+- Added `minOccurs`` and ``maxOccurs`` to SubDevice and ModuleClass
- Unified all component identifiers, names etc to XSD type ``name``.
- Introduced JSON serialization guidelines.
- Changed case of ``<Imports>`` element.
diff --git a/SDT/schema4.0/docs/Examples.md b/SDT/schema4.0/docs/Examples.md
index 182255574361e8247f3eda30b3b8df62df25b992..3cc928002b21b9469754a48a5a3d344408368394 100644
--- a/SDT/schema4.0/docs/Examples.md
+++ b/SDT/schema4.0/docs/Examples.md
@@ -7,29 +7,30 @@
1. [ModuleClasses Definition](#echonetExampleMC)
2. [DeviceClass Definition](#echonetExampleDC)
3. [The full SDT](#echonetExampleFull)
+3. [More examples](#moreExamples)
<a name="simpleExample"></a>
## A simple SDT example
-The following example shows a very simple device that represents a light that can be switched on and off. It contains just a single ModuleClass "Switch", which contains a single boolean data point "status" to control the on/off status of the device.
+The following example shows a very simple device that represents a light that can be switched on and off. It contains just a single [ModuleClass](SDT_Components.md#ModuleClass) "Switch", which contains a single boolean [data point](SDT_Components.md#DataPoint) "status" to control the on/off status of the device.
-It is a stand-alone definition without using previously defined ModuleClasses. A more sophisticated use is presented in the next example.
+It is a stand-alone definition without using previously defined [ModuleClasses](SDT_Components.md#ModuleClass). A more sophisticated use is presented in the next example.
The structure and the according SDT looks like this:
|SimpleExample.xml | |
|:--------------|-|
|Namespace information | SimpleExample |
-|DeviceClasses |<ul><li>Light</li><ul><li>Switch<ul><li>status</li></ul></li></ul></ul>|
+|DeviceClasses |<ul><li>Light ([DeviceClass](SDT_Components.md#DeviceClass))</li><ul><li>Switch ([ModuleClass](SDT_Components.md#ModuleClass))<ul><li>status ([DataPoint](SDT_Components.md#DataPoint)</li></ul></li></ul></ul>|
-The following code section shows the fully integrated template. The source code can be found in [SimpleExample.xml](../test/SimpleExample.xml) in the "test" directory.
+The following code section shows the fully integrated template. The source code can be found in [SimpleExample.xml](../test/SimpleExample.xml) in the [test](../test) directory.
```xml
<?xml version="1.0" encoding="iso-8859-1"?>
<Domain xmlns="http://www.onem2m.org/xml/sdt/4.0" id="SimpleExample" >
<DeviceClasses>
- <DeviceClass id="Light">
+ <DeviceClass name="Light">
<Doc>This is a very simple device representing a light.</Doc>
<ModuleClasses>
<ModuleClass name="Switch">
@@ -51,7 +52,7 @@ The following code section shows the fully integrated template. The source code
<a name="echonetExample"></a>
## A more sophisticated example
-In the ideal case, a large organization or SDO would define a widely-applicable set of [ModuleClasses](SDT_Components.md#ModuleClass), each of which could be used as needed to compose the description of a complex device. In order to show the approach, this section will create a few example ModuleClasses based on - or inspired by - features in the Echonet Lite protocol. Please note that the examples shown in this document are very "cut down" and by no means represent a true representation of Echonet Lite[^echonet].
+In the ideal case, a large organization or SDO would define a widely-applicable set of [ModuleClasses](SDT_Components.md#ModuleClass), each of which could be used as needed to compose the description of a complex device. In order to show the approach, this section will create a few example [ModuleClasses](SDT_Components.md#ModuleClass) based on - or inspired by - features in the Echonet Lite protocol. Please note that the examples shown in this document are very "cut down" and by no means represent a true representation of Echonet Lite[^echonet].
[^echonet]: The Echonet Consortium has standardized their specifications within IEC/ISO (IEC62394, ISO/IEC24767-1, ISO/IEC24767-2, IEC62480, ISO/IEC14543-4-1, ISO/IEC14543-4-2, IEC62457) and they provide a comprehensive collection of various types of home appliances relevant to SmartGrid applications as ECHONET Device objects (see [https://echonet.jp/spec_object_rf_en/](https://echonet.jp/spec_object_rf_en/) ).
@@ -59,17 +60,17 @@ The source code can be found in [EchonetLiteExamples.xml](../test/EchonetLiteExa
<a name="echonetExampleMC"></a>
### ModuleClasses
-For the example in this section, to show re-use of ModuleClass definitions, two complex devices are chosen which have some common features and hence could be expected to both use some of the same ModuleClasses: an air conditioner and a washing machine.
+For the example in this section, to show re-use of [ModuleClass](SDT_Components.md#ModuleClass) definitions, two complex devices are chosen which have some common features and hence could be expected to both use some of the same [ModuleClasses](SDT_Components.md#ModuleClass): an air conditioner and a washing machine.
|Functionality | Air Conditioner | Washing Machine |
|:------------|:----------------|:----------------|
|operationStatus |operates on/off |operates on/off |
|measuredCumulativePowerConsumption |the cumulative power consumption |the cumulative power consumption |
|installationLocation |this sets/reads a string text describing the location (room) of the air-conditioner |this sets/reads a string text describing the location (room) of the washing machine |
-|setTimer |(not applicable. there is no preset start for an air-conditioner) |This sets/reads use the on/off timer |
+|setTimer |not applicable (there is no preset start for an air-conditioner) |This sets/reads use the on/off timer |
|temperatureSensorDataPoints | this reads the measured temperature | this reads the measured temperature |
-Based on the simplified example above, the two appliances will need the ModuleClasses below:
+Based on the simplified example above, the two appliances will need the [ModuleClasses](SDT_Components.md#ModuleClass) below:
- *air-conditioner*: operationStatus, measuredCumulativePowerConsumption, installationLocation;
- *washing-machine*: operationStatus, measuredCumulativePowerConsumption, setTimer, temperatureSensorDataPoints.
@@ -131,9 +132,9 @@ Based on the simplified example above, the two appliances will need the ModuleCl
<a name="echonetExampleDC"></a>
### DeviceClass
-To define a device one would now reference those ModuleClass definitions in a new DeviceClass. For the sake of simplicity only the "SimpleWashingMachine" is implemented here.
+To define a device one would now reference those [ModuleClass](SDT_Components.md#ModuleClass) definitions in a new [DeviceClass](SDT_Components.md#DeviceClass). For the sake of simplicity only the "SimpleWashingMachine" is implemented here.
-In addition to the previously defined ModuleClasses this "SimpleWashingMachine" DeviceClass extends the existing ModuleClass "operationStatus" with an event. It also adds a new ModuleClass "washingMachineDataPoints" with model-specific DataPoints.
+In addition to the previously defined [ModuleClasses](SDT_Components.md#ModuleClass) this "SimpleWashingMachine" [DeviceClass](SDT_Components.md#DeviceClass) extends the existing [ModuleClass](SDT_Components.md#ModuleClass) "operationStatus" with an event. It also adds a new [ModuleClass](SDT_Components.md#ModuleClass) "washingMachineDataPoints" with model-specific [DataPoints](SDT_Components.md#DataPoint).
At the beginning of the definition some device Properties are defined.
@@ -249,8 +250,8 @@ The structure and the according SDT now looks like this:
|EchonetLiteExamples.xml | |
|:--------------|-|
|Namespace information | example.based.on.echonetLite |
-|ModuleClasses |<ul><li>operationStatus<ul><li>operationStatus</li></ul></li><li>measuredCumulativePowerConsumption<ul><li>measuredInstantaneousPowerConsumption</li></ul></li><li>installationLocation<ul><li>installationLocation</li></ul></li><li>temperatureSensorDataPoints<ul><li>measuredTemperatureValue</li></ul></li></ul>|
-|DeviceClasses |<ul><li>SimpleWaschingMachine</li><ul><li>installationLocation --> installationLocation</li><li>measuredCumulativePowerConsumption --> measuredCumulativePowerConsumption</li><li>temperatureSensorDataPoints --> temperatureSensorDataPoints</li><li>operationStatus --> washingMachineOperationStatus</li><li>washingMachineDataPoints</li><ul><li>door_CoverOpen_CloseStatus</li><li>washingMachineSetting</li><li>currentStageOfWashingCycle</li><li>timeRemainingToCompleteWashingCycle</li><li>onTimerReservationSetting</li><li>onTimerSetting</li><li>relativeTimeBasedOnTimerSetting</li></ul></ul></ul>|
+|[ModuleClasses](SDT_Components.md#ModuleClass) |<ul><li>operationStatus<ul><li>operationStatus</li></ul></li><li>measuredCumulativePowerConsumption<ul><li>measuredInstantaneousPowerConsumption</li></ul></li><li>installationLocation<ul><li>installationLocation</li></ul></li><li>temperatureSensorDataPoints<ul><li>measuredTemperatureValue</li></ul></li></ul>|
+|[DeviceClasses](SDT_Components.md#DeviceClass) |<ul><li>SimpleWaschingMachine</li><ul><li>installationLocation --> installationLocation</li><li>measuredCumulativePowerConsumption --> measuredCumulativePowerConsumption</li><li>temperatureSensorDataPoints --> temperatureSensorDataPoints</li><li>operationStatus --> washingMachineOperationStatus</li><li>washingMachineDataPoints</li><ul><li>door_CoverOpen_CloseStatus</li><li>washingMachineSetting</li><li>currentStageOfWashingCycle</li><li>timeRemainingToCompleteWashingCycle</li><li>onTimerReservationSetting</li><li>onTimerSetting</li><li>relativeTimeBasedOnTimerSetting</li></ul></ul></ul>|
The following code section shows the fully integrated template.
@@ -433,6 +434,8 @@ The following code section shows the fully integrated template.
</DeviceClass>
</DeviceClasses>
</Domain>
-
```
+<a name="moreExample"></a>
+## More Examples
+More examples that also show specific features of the SDT are available in the [test](../test) directory.
diff --git a/SDT/schema4.0/docs/FAQ.md b/SDT/schema4.0/docs/FAQ.md
index fa9430d1b1fd9e3c335597a4d688868352990ab9..03595764949852b6362e0a9604acc67482412c93 100644
--- a/SDT/schema4.0/docs/FAQ.md
+++ b/SDT/schema4.0/docs/FAQ.md
@@ -47,6 +47,8 @@ Please follow the instructions for the [SDT Build System](SDT/schema4.0/docs/SDT
In short:
+- Clone the SDT repository from [https://git.onem2m.org/MAS/SDT.git](https://git.onem2m.org/MAS/SDT.git)
+- Install Apache ant
- In a terminal, go to the directoy *SDT/schema4.0*
- Run the command:
```sh
diff --git a/SDT/schema4.0/docs/Introduction.md b/SDT/schema4.0/docs/Introduction.md
index 11795083d3abf72218187af724ee739b62f336d5..57d011ee930f603715df951519f58b41a919748f 100644
--- a/SDT/schema4.0/docs/Introduction.md
+++ b/SDT/schema4.0/docs/Introduction.md
@@ -13,12 +13,13 @@ The Smart Device Template (SDT) is an initiative from [oneM2M](http://www.onem2m
Originally initiated by the [Home Gateway Initiative (HGI)](http://www.homegatewayinitiative.org), oneM2M is now the owner and maintainer of the SDT.
-At the time of writing, every software developed for Internet-of-Things gateways, for example gateways for home automation, needs to be capable of using various different protocols (ZigBee, ZWave, KNX, OPC UA, EchonetLite, DECT ULE, etc) to interact with a range of devices designed for the IoT environment. This adds extreme overheads in integrating, checking and updating code. The purpose of SDT is to describe devices and device services in a way which is independent of the LAN technology and protocols, in a format which is convenient and reliable for integration in modern code (Java, C/C++, Go, Python, ...).
+At the time of writing, every software developed for Internet-of-Things gateways and applications, for example gateways for home or building automation, needs to be capable of using various different protocols (ZigBee, ZWave, KNX, OPC UA, EchonetLite, DECT ULE, etc) to interact with a range of devices designed for the IoT environment. This adds extreme overheads in integrating, testing and updating code. The purpose of the SDT is to describe devices and device services in a way which is independent of the LAN technology and protocols, in a format which is convenient and reliable for integration in modern code (C/C++, Go, Java, Javascript, Python, ...).
+### Goals
The key goals of the SDT are:
1. keep it simple, especially for manufacturers to contribute device information;
-2. modularity for functions and device types;
+2. enable and support modularity for functions and device types;
3. make it easy for developers to create unified APIs;
4. be independent of underlying LAN technologies and protocols;
5. enable extendibility of the system in place without service interruption;
@@ -26,28 +27,30 @@ The key goals of the SDT are:
In general a description of device (or complex appliance) behaviour can be made in many ways, with various kinds of constraints:
-1. no constraints (e.g. using OWL 2.0 or even more "flexibly" RDF)
+1. no constraints (e.g. using OWL 2.0 or RDF)
2. moderate constraints (e.g. using XML and a related extensible XSD template)
3. strict constraints (typical for a device certified to interoperate with a specific LAN protocol)
oneM2M chose to use the approach "moderate constraints" (XSD based) because for software development it offers ease of use and a good compromise. In particular, if there are few or no constraints on control parameters then few automatic checks can be made to detect if the software parameters are appropriate for each device integrated. XML and XSD languages were chosen because they are familiar to many developers, can be parsed and validated with common software tools, and can still be created and interpreted by humans if necessary. SDT intended use is for modeling, not as a presentation layer protocol, therefore the size of individual templates is not important.
+### Guidelines for Structured Information Models
+
oneM2M believes that Device information models based on XML and extensible XSD need some guidelines. If every possible feature of every existing LAN technology and appliance were allowed to be described in any formally correct way, then the results would be a modern Babel, no better than today's system of widely different and wildly competing automation protocols.
Therefore oneM2M proposes to recommend a certain structure (or template) for the information model(s), but to allow extensions. Naturally, the more industry consensus is achieved for a single recommended template, the greater the utility for software developers (and in the end users and customers).
-The SDT approach is to define re-usable basic functions (or services), labelled "ModuleClass" in the figure below, which can represent the typical functions found in many IoT systems, such as "on/off", "dim a lamp", "receive events from sensor", "read data from sensor", etc. Each ModuleClass is composed of a (preferable small) number of actions, datapoint read/write operations, or asynchronous events. For example, an "on/off" ModuleClass would consist perhaps of just one Action, but a "ReadKeypad" Action might have a number of possible events, each with some data value and (usually) a sequence-ID or timestamp start/stop to indicate when and how long each key was pressed.
+The SDT approach is to define re-usable basic functions (or services), labelled "[ModuleClass](SDT_Components.md#ModuleClass)" in the figure below, which can represent the typical functions found in many IoT systems, such as "on/off", "dim a lamp", "receive events from sensor", "read data from sensor", etc. Each ModuleClass is composed of a (preferable small) number of actions, datapoint read/write operations, or asynchronous events. For example, an "on/off" ModuleClass would consist perhaps of just one [Action](SDT_Components.md#Action), but a "ReadKeypad" Action might have a number of possible events, each with some data value and (usually) a sequence-ID or timestamp start/stop to indicate when and how long each key was pressed.
**SmartHome Device Template for a generic device (UML, basic entities)**
The SDT represents the device models introduced in the above figure by using an XSD schema to allow formal checking of compliance for XML device descriptions of specific appliances. The modularity goal in the schema is achieved with re-usable XML fragments (for example the "ModuleClass" in the figure).
-Complex devices or appliances can then be described by an appropriate set or collection of the agreed ModuleClasses, as indicated in the figure, which also shows an optional "Property" fragment to allow noting of static information such as device manufacturer name, device firmware version, etc.
+Complex [Devices](SDT_Components.md#Devices), appliances or even [Products](SDT_Components.md#Products) can then be described by an appropriate set or collection of the agreed [ModuleClasses](SDT_Components.md#ModuleClass), as indicated in the figure, which also shows an optional "[Property](SDT_Components.md#Property)" fragment to allow noting of static information such as device manufacturer name, device firmware version, etc.
oneM2M has discussed with many SDOs to validate these concepts. SDT is designed to take into account the list of "services" compiled by the [SAREF project](https://sites.google.com/site/smartappliancesproject/home).
-The SDT supports the use of a set of templates for generic devices or appliances (e.g. for a *dimmable lamp*, a basic *washing machine*, etc), which would be specific instances of the "DeviceClass", which form the basis of APIs used by application developers. These templates can also be referenced by manufacturers creating XML documents to describe their specific Products. For example, the SDT enables specification of a generic washing machine template, with *on/off*, *set-wash-temperature*, *pause* and a few other commands, which could be referenced and extended by a manufacturer as the schema for an XML description of a specific washing machine product. The SDT allows for vendor-specific additional commands (ModuleClasses) to suit specific product types.
+The SDT supports the use of a set of templates for generic devices or appliances (e.g. for a *dimmable lamp*, a basic *washing machine*, etc), which would be specific instances of the "[DeviceClass](SDT_Components.md#DeviceClass)", which form the basis of APIs used by application developers. These templates can also be referenced by manufacturers creating XML documents to describe their specific Products. For example, the SDT enables specification of a generic washing machine template, with *on/off*, *set-wash-temperature*, *pause* and a few other commands, which could be referenced and extended by a manufacturer as the schema for an XML description of a specific washing machine product. The SDT allows for vendor-specific additional commands (ModuleClasses) to suit specific product types.
The interoperability benefits can potentially partially be obtained even without a fully complete interoperability of the SDT. For example, the most common functions can be modeled with SDT, and more particular functions can be modeled with technology-specific, proprietary, or seldom-used aspects.
@@ -60,20 +63,22 @@ This section provides an overview about high-level SDT 4.0 definitions and eleme
| Term | Definition |
|------|------------|
-|Domain | Unique name, or "wrapper" which acts like a namespace, set by the organization, company, or project creating the template, allowing reference to a package of definitions for the contained ModuleClasses and device definitions. Can be referenced when extending Products, ModuleClasses, and data types. It has two possible uses: to select the scope of a technology domain, or to set the scope of a use case domain (like Home, SmartGrid, etc) |
-|ProductClass | A concrete device model with deterministic device Properties and ModuleClasses, without optionality. It is deemed as a specialized implementation of a DeviceClass that can be manufactured. |
-|DeviceClass | A physical, addressable, identifiable appliance, sensor, or actuator. |
-|Sub-Device | A device (usually one of several) which may be embedded in or attached to a (full) device. It is not designed to be operated as a standalone device. |
-| ModuleClass | Specification of a single service with one or more service methods, the involved abstracted data model and related events. The expectation is that each separate service which may be used in many kinds of devices (like *PowerON/OFF*, *Open/Close*, ...) will be described by a ModuleClass which can be re-used in many *DeviceClass* or *ProductClass* definitions. |
+|[Domain](SDT_Components.md#Domain) | Unique name, or "wrapper" which acts like a namespace, set by the organization, company, or project creating the template, allowing reference to a package of definitions for the contained ModuleClasses and device definitions. Can be referenced when extending Products, ModuleClasses, and data types. It has two possible uses: to select the scope of a technology domain, or to set the scope of a use case domain (like Home, SmartGrid, etc) |
+|[ProductClass](SDT_Components.md#ProductClass) | A concrete device model with deterministic device Properties and ModuleClasses, without optionality. It is deemed as a specialized implementation of a DeviceClass that can be manufactured. |
+|[DeviceClass](SDT_Components.md#DeviceClass) | A physical, addressable, identifiable appliance, sensor, or actuator. |
+|[Sub-Device](SDT_Components.md#SubDevice) | A device (usually one of several) which may be embedded in or attached to a (full) device. It is not designed to be operated as a standalone device. |
+| [ModuleClass](SDT_Components.md#ModuleClass) | Specification of a single service with one or more service methods, the involved abstracted data model and related events. The expectation is that each separate service which may be used in many kinds of devices (like *PowerON/OFF*, *Open/Close*, ...) will be described by a ModuleClass which can be re-used in many *DeviceClass* or *ProductClass* definitions. |
+
+A major decision, facilitating validation of code and signaling, was to describe services (functionality) of devices in terms of [ModuleClasses](SDT_Components.md#ModuleClass) made up of combinations of three kinds of elements:
-A major decision, facilitating validation of code and signaling, was to describe services (functionality) of devices in terms of ModuleClasses made up of combinations of three kinds of elements:
+1. [DataPoints](SDT_Components.md#DataPoint) which are aspects of a functionality that can be read and/or written,
+2. [Actions](SDT_Components.md#Action) which consist of more complex sequences of operations;
+3. [Events](SDT_Components.md#Event) which can be signaled ("published") by devices asynchronously.
-1. DataPoints which are aspects of a functionality that can be read and/or written,
-2. Actions which consist of more complex sequences of operations;
-3. Events which can be signaled ("published") by devices asynchronously.
+Any of these elements is optional.
-The ModuleClass structure is a major part of the SDT which is illustrated in detail in the following figure:
+This [ModuleClass](SDT_Components.md#ModuleClass) structure is a major part of the SDT which is illustrated in detail in the following figure:
**UML description of device functionality in terms of DataPoints, Actions, and Events**
@@ -81,7 +86,7 @@ The ModuleClass structure is a major part of the SDT which is illustrated in det
<a name="Work"/></a>
## How should SDT work?
-The basic concept is that a manufacturer, organisation or global SDO would define its preferred Smart Device Template, in XML, specified by and based on an XSD. Using that XSD, manufacturers or indeed hobbyists could "describe" existing or new devices by means of XML files, specifying the capabilities and the parameters needed to control the devices.
+The basic concept is that a manufacturer, organisation, service provider or global SDO would define its preferred Smart Device Template, in XML, specified by and based on an XSD. Using that XSD, manufacturers or indeed hobbyists could "describe" existing or new devices by means of XML files, specifying the capabilities and the parameters needed to control the devices.
Assuming that the XML files conform to the specified XSD and to some guidelines described in this document, software developers could readily create APIs able to "parse" the XML-descriptions of devices and (assuming the underlying LAN technology of the device is supported by the software/hardware environment in the gateway) operate the equipment.
@@ -94,7 +99,7 @@ For the convenience of users and developers, it would also be possible to collec
The SDT defines the structure of all compliant XML descriptions. Each XML description of a specific device is definable at the time of manufacture of the device and can therefore only contain "static" information: (a) manufacturer data in the form of documentation elements and properties, and (b) device capability information detailing the firmware operations and types/meanings of input/output variables.
-NOT directly part of this work is a related but separate aspect of every gateway software development: a "device abstraction layer" which can translate between (a) software APIs written based on a particular SDT and (b) the "commands" expected by several different LAN protocols and their hardware controllers.
+NOT directly part of this work is a related but separate aspect of every (gateway) software development: a "device abstraction layer" (or "service layer") which can translate between (a) software APIs written based on a particular SDT and (b) the "commands" expected by several different LAN protocols and their hardware controllers.
Programmers developing a "device abstraction layer" for software in a gateway need to create run-time representations of all the recognized devices, their operations and their actual states. This internal "information model" needs to be updated in real time as the devices and the users interact. Programmers may be tempted to use the SDT structure to organize their real-time information model, adding additional information elements for the current state of each device, for some kind of "history" of commands sent/acknowledged, the user etc.
diff --git a/SDT/schema4.0/docs/Links.md b/SDT/schema4.0/docs/Links.md
index 15f0c688c73fd570fddda5343f1e48583cffe4b9..2a5f8e9664c0b4aae0a50904b64dc59f1d8d3d47 100644
--- a/SDT/schema4.0/docs/Links.md
+++ b/SDT/schema4.0/docs/Links.md
@@ -3,9 +3,6 @@
## Smart Device Template
- **SDT Repository** : [https://git.onem2m.org/MAS/SDT](https://git.onem2m.org/MAS/SDT)
-
-## Further Information
-
- **TR-0039 Introduction to IPE and SDT** : [http://www.onem2m.org/tr-0039/ipe-and-sdt](http://www.onem2m.org/tr-0039/ipe-and-sdt)
- **The oneM2M Smart Device Template (SDT)** (BrightTALK) : [https://www.brighttalk.com/webcast/11949/340004/the-onem2m-smart-device-template-sdt](https://www.brighttalk.com/webcast/11949/340004/the-onem2m-smart-device-template-sdt)
diff --git a/SDT/schema4.0/docs/SDT Build System.md b/SDT/schema4.0/docs/SDT Build System.md
index a5d19a9788108047fe931e6b5907d60fbfd2c3dd..05dcdf069cbe204fe908cde649d171ace068352b 100644
--- a/SDT/schema4.0/docs/SDT Build System.md
+++ b/SDT/schema4.0/docs/SDT Build System.md
@@ -1,5 +1,5 @@
# SDT Build System
-This document describes the SDT build system and how to build the SDT and validate new templates and contributions.
+This document describes the SDT build system and how to build the SDT schema and validate new templates and contributions.
The files referenced in this document point to version **4.0** of the SDT.
@@ -16,7 +16,8 @@ The files referenced in this document point to version **4.0** of the SDT.
- [SDT/schema4.0/](../..) : Base directory
- [SDT/schema4.0/src/](../src/) : Source files of the SDT.
- [domain.rng](../src/domain.rng) : RELAX NG file with the SDT schema definition. This is the source file that is converted to the actual schema definition *domain.xsd* during the build. See also [http://en.wikipedia.org/wiki/RELAX_NG](http://en.wikipedia.org/wiki/RELAX_NG).
- **Only edit this file when you want to make changes to the SDT!** See also [Editing the Schema](#Editing) below.
+ **Only edit this file when you want to make changes to the SDT! Changes to XSD file will be overwritten the next time you run the *ant* command.**
+ See also [Editing the Schema](#Editing) below.
- [domain.xsd](../src/domain.xsd) : The actual SDT schema definition that is generated from *domain.rng*.
- [xml.xsd](../src/xml.xsd) : General schema definitions for the SDT
- [SDT/schema4.0/test/](../test/) : This directory contains XML files with SDT definitions that should be validated whether they conform to the SDT schema.
@@ -65,7 +66,7 @@ The output after a successful validation should look similar this:
>BUILD SUCCESSFUL
>Total time: 1 second
-Otherwise you most likely receive a stack trace or some other error messages. Search the output for the line *BUILD FAILED*. Above this line you will find some helpful hints for the filename and line number on which the error occurred (here: file *mseeb.xml* on line 66) and a reason:
+Otherwise you most likely receive a stack trace and some other error messages. Search the output for the line *BUILD FAILED*. Above this line you will find some helpful hints for the filename and line number on which the error occurred (here: file *mseeb.xml* on line 66) and a reason:
>[schemavalidate] /Users/someone/Sources/git/SmartDeviceTemplate/SDT/schema/test/mseeb.xml:66:18: cvc-elt.1: Cannot find the declaration of element 'Domain'.
>BUILD FAILED
diff --git a/SDT/schema4.0/docs/SDT_Components.md b/SDT/schema4.0/docs/SDT_Components.md
index b04b3f5a599dbb4b97adecf6e3e89981f96e63de..5162873528e54afe87b2c2f6cbfaf8b0894ecf3e 100644
--- a/SDT/schema4.0/docs/SDT_Components.md
+++ b/SDT/schema4.0/docs/SDT_Components.md
@@ -3,41 +3,40 @@
## Table of Contents
1. [Basic Components](#BasicComponents)
- 1. [Domain](#Domain)
- 2. [ModuleClass](#ModuleClass)
- 1. [DataPoint](#DataPoint)
- 2. [Action](#Action)
- 1. [Arg](#Arg)
- 3. [Event](#Event)
- 4. [DeviceClass](#DeviceClass)
- 1. [SubDevice](#SubDevice)
- 5. [ProductClass](#ProductClass)
- 6. [Property](#Property)
+ 1. [Domain](#Domain)
+ 2. [ModuleClass](#ModuleClass)
+ 1. [DataPoint](#DataPoint)
+ 2. [Action](#Action)
+ 1. [Arg](#Arg)
+ 3. [Event](#Event)
+ 3. [DeviceClass](#DeviceClass)
+ 1. [SubDevice](#SubDevice)
+ 4. [ProductClass](#ProductClass)
+ 5. [Property](#Property)
2. [Data Types](#DataTypes)
- 1. [DataType](#DataType)
- 1. [Constraint](#Constraint)
- 2. [TypeChoice](#TypeChoice)
- 2. [SimpleType](#SimpleType)
- 3. [StructType](#StructType)
- 4. [ArrayType](#ArrayType)
- 5. [EnumType](#EnumType)
- 1. [ExtendExclude](#ExtendExclude)
+ 1. [DataType](#DataType)
+ 1. [Constraint](#Constraint)
+ 2. [TypeChoice](#TypeChoice)
+ 2. [SimpleType](#SimpleType)
+ 3. [StructType](#StructType)
+ 4. [ArrayType](#ArrayType)
+ 5. [EnumType](#EnumType)
+ 1. [ExtendExclude](#ExtendExclude)
3. [Extending (Inheriting)](#Extending)
- 1. [Extend](#Extend)
- 1. [Include](#ExtendInclude)
- 2. [Exclude](#ExtendExclude)
- 3. [ExtendType](#ExtendType)
-4. [Documentation (Doc)](#Documentation)
+ 1. [Extend](#Extend)
+ 1. [Include](#ExtendInclude)
+ 2. [Exclude](#ExtendExclude)
+ 3. [ExtendType](#ExtendType)
+4. [Documentation (Doc)](#Documentation)
---
## SDT Overview
-The following UML diagram presents an overview of the structure (elements) of every SDT which is conformant with these guidelines. As implied in the above descriptions, there can be many different choices of SDT details, each one optimized for a particular market segment and the types of devices used in that market segment. Obviously an unnecessary proliferation is counter-productive, but as long as each SDT conforms to the structure shown below then it will be possible with little or modest effort for software to be adapted accordingly.
+The following UML diagrams presents an overview of the structure (elements) of every SDT which is conformant with these guidelines. As implied in the above descriptions, there can be many different choices of SDT details, each one optimized for a particular market segment and the types of devices used in that market segment. Obviously an unnecessary proliferation is counter-productive, but as long as each SDT conforms to the structure shown below then it will be possible with little or modest effort for software to be adapted accordingly.
The key to the diagram elements of the UML diagrams and the snippets in the following sections follow this figure:
-
The syntax used in the diagrams to model an XML Schema Definition (XSD) as an UML diagram follows the following approaches:
@@ -57,7 +56,7 @@ The syntax used in the diagrams to model an XML Schema Definition (XSD) as an UM
-The *Domain* element allows labeling of different SDT templates for different technologies and/or industry segments ("verticals"): for example eHealth and Building Management might prefer quite different detailed structures/templates. This also helps keep information in human-friendly and manageable blocks. It is assumed that there will be multiple "SDT Templates" and some of them may be completely proprietary.
+The *Domain* element allows labeling of different SDT templates for different technologies and/or industry segments ("verticals"): for example eHealth and Building Management might prefer quite different detailed structures/templates. This also helps keep information in human-friendly and manageable blocks. It is assumed that there will be multiple "SDT Templates", and some of them may be completely proprietary.
It can also be used to collect all specified [ModuleClasses](#ModuleClasses), [DeviceClasses](#DeviceClasss), [DataTypes](#DataTypes) and [ProductClasses](#ProductClasses) in one referencable logical group.
@@ -77,19 +76,20 @@ Note, that when using **Imports** one must include the following namespace in th
#### Example
```xml
<Domain xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns="http://homegatewayinitiative.org/xml/dal/3.0"
- id="org.homegatewayinitiative">
- <Doc>Some documentation</Doc>
- <Imports>
- <!-- Import other SDTs via XInclude's include mechanism -->
- <xi:include href="anotherSDT.xml" parse="xml" />
- </Imports>
- <ModuleClasses>
- <!-- List of Domain global ModuleClasses goes here -->
- </ModuleClasses>
- <DeviceClasses>
- <!-- List of Devices goes here -->
- </DeviceClasses>
+ xmlns="http://www.onem2m.org/xml/sdt/4.0">
+ id="org.onem2m.home.device">
+
+ <Doc>Some documentation</Doc>
+ <Imports>
+ <!-- Import other SDTs via XInclude's include mechanism -->
+ <xi:include href="anotherSDT.xml" parse="xml" />
+ </Imports>
+ <ModuleClasses>
+ <!-- List of Domain global ModuleClasses goes here -->
+ </ModuleClasses>
+ <DeviceClasses>
+ <!-- List of Devices goes here -->
+ </DeviceClasses>
</Domain>
```
@@ -101,13 +101,15 @@ Element of [Domain](#Domain) and [Product](#Product).
-*ModuleClass* elements are basically constraints or templates for how to model functionality of real things/appliances/devices within the [Domain](#Domain). A *ModuleClass* can extend another *ModuleClass* with additional functionalities.
+*ModuleClass* elements are basically constraints or templates for how to model functionality of real things/appliances/devices within the [Domain](#Domain). *ModuleClasses* are the central element of the SDT to wrap functionalities.
+
+A *ModuleClass* can extend another *ModuleClass* with additional functionalities.
Every [DeviceClass](#DeviceClass) can be described by a collection of *ModuleClasses* (functionality).
The set of *ModuleClasses* is defined at the [Domain](#Domain) level or in the context of a [DeviceClass](#DeviceClass).
-In principle there could be an infinite number of *ModuleClasses*, for every kind of functionality found in automation protocol ... However that would not simplify the job of software developers at all. Therefore, oneM2M recommends that a finite and convenient number of prototypical *ModuleClasses* are re-used as much as possible (within a Domain at least). oneM2M TS-0023 specification defines a rich set of such standardized *ModuleClasses* (as well as *DeviceClass* models).
+In principle there could be an infinite number of *ModuleClasses*, for every kind of functionality found in automation protocol ... However that would not simplify the job of system architects and software developers at all. Therefore, oneM2M recommends that a finite and convenient number of prototypical *ModuleClasses* are re-used as much as possible (within a domain at least). oneM2M TS-0023 specification defines a rich set of such standardized *ModuleClasses* (as well as [DeviceClass](#DeviceClass) and [SubDevice](#SubDevice) models).
Typical *ModuleClasses* might be equivalent to "power ON/OFF", "Open/Close", "PanUP/DOWN", "Temperature", etc. Those examples make it apparent that various read/write usage of parameters, invoking of actions and waiting for events might be needed in the different *ModuleClasses*, and a guideline for those structures is explained below.
@@ -116,6 +118,11 @@ Typical *ModuleClasses* might be equivalent to "power ON/OFF", "Open/Close", "Pa
- **name** : Name of the *ModuleClass*. The name must be unique in the scope of the [Domain](#Domain). Required.
- **optional**: Boolean that indicates whether a *ModuleClass* is optional or mandatory. Optional, the default is *false*.
- **semanticURI** : An attribute that contains a URI to a semantic description of the element. Optional.
+- **minOccurs** : An optional string attribute that indicates the minimum cardinality of a *ModuleClass*, for example, in a [DeviceClass](#DeviceClass) definition. Optional. The default is "1".
+Note, if only the *minOccurs* attribute is specified, it can't be greater than 1, because the default value for *maxOccurs* is 1.
+- **maxOccurs** : An optional string attribute that indicates the maximum cardinality of a *ModuleClass*, for example, in a [DeviceClass](#DeviceClass) definition. Optional. The default is "1".
+Note, if only the *maxOccurs* attribute is specified, it can't be smaller than 1, because the default value for *minOccurs* is 1.
+Also note, that if both *minOccurs* and *maxOccurs* are specified, then *maxOccurs* always must have an equal or higher cardinality than *minOccurs*.
#### Elements
@@ -129,16 +136,16 @@ Typical *ModuleClasses* might be equivalent to "power ON/OFF", "Open/Close", "Pa
#### Example
```xml
<ModuleClass name="BooleanState">
- <Doc>Some documentation</Doc>
- <Actions>
- <!-- List of Actions goes here-->
- </Actions>
- <Events>
- <!-- List of Events goes here-->
- </Events>
- <Data>
- <!-- List of DataPoints goes here-->
- </Data>
+ <Doc>Some documentation</Doc>
+ <Actions>
+ <!-- List of Actions goes here-->
+ </Actions>
+ <Events>
+ <!-- List of Events goes here-->
+ </Events>
+ <Data>
+ <!-- List of DataPoints goes here-->
+ </Data>
</ModuleClass>
```
@@ -175,7 +182,7 @@ string = (* character string excluding the character "/" *) ;
- **readable** : Boolean value that indicates whether this *DataPoint* is readable by an application. Optional. Default: true.
- **eventable** : Boolean value that indicates whether an internal or external change of this *DataPoint* raises an event. Optional. Default: false.
- **default** : A default value for the *DataPoint*.
-- - **semanticURI** : An attribute that contains a URI to a semantic description of the element. Optional.
+- **semanticURI** : An attribute that contains a URI to a semantic description of the element. Optional.
#### Elements
- **[Doc](#Documentation)** : Documentation for the *DataPoint*. Optional.
@@ -184,12 +191,12 @@ string = (* character string excluding the character "/" *) ;
#### Example
```xml
<Data>
- <DataPoint name="attributeName" writable="false">
- <Doc>Some documentation for the DataPoint</Doc>
- <DataType>
- <SimpleType type="string" />
- </DataType
- </DataPoint>
+ <DataPoint name="attributeName" writable="false">
+ <Doc>Some documentation for the DataPoint</Doc>
+ <DataType>
+ <SimpleType type="string" />
+ </DataType
+ </DataPoint>
</Data>
```
@@ -202,7 +209,7 @@ Element of [ModuleClass](#ModuleClass).
-*Action* elements are an efficient way of describing arbitrary sequences of operations/methods; these are very common in automation. Typical example include "FactoryReset", and "AutoCalibrate". *Actions* preserve transaction integrity by putting together all the parameters ([Args](#Arg), see next section) with the method which checks and executes them, in one step.
+*Action* elements are an efficient way of describing arbitrary sequences of operations/methods; these are very common in automation. Typical example include "FactoryReset", and "AutoCalibrate". *Actions* preserve transaction integrity by putting together all the parameters (see [Args](#Arg)) with the method which checks and executes them, in one step.
Note, that systems which rely on RESTful operations need to carry out such complex setup-parameters-then-do-action by first using (several) [DataPoint](#DataPoint) operations to "load" the parameters to the device and then do a [DataPoint](#DataPoint) operation to manipulate the "start operation NOW" action.
@@ -221,18 +228,18 @@ Note, that systems which rely on RESTful operations need to carry out such compl
The following are two examples for actions implementing a getter and a setter for boolean values.
```xml
<Action name="get" type="boolean">
- <Doc>Obtain the current associated state. Example of a getter.</Doc>
+ <Doc>Obtain the current associated state. Example of a getter.</Doc>
</Action>
<Action name="setTarget">
- <Doc>Set the associated state to the specified value. Example of a setter.</Doc>
- <Args>
- <Arg name="value">
- <Doc>The desired value of the associated state.</Doc>
- <DataType>
- <SimpleType type="boolean" />
- </DataType>
- </Arg>
+ <Doc>Set the associated state to the specified value. Example of a setter.</Doc>
+ <Args>
+ <Arg name="value">
+ <Doc>The desired value of the associated state.</Doc>
+ <DataType>
+ <SimpleType type="boolean" />
+ </DataType>
+ </Arg>
</Args>
</Action>
```
@@ -260,7 +267,7 @@ The *Arg* has the following attributes and elements:
- **[DataType](#DataType)** : The return type of the *argument*. It must comply to the *DataType* definition. Required.
#### Example
-See [example above](#ActionExample).
+See [the Action example above](#ActionExample).
---
@@ -284,14 +291,14 @@ Element of [ModuleClass](#ModuleClass).
#### Example
```xml
<Event name="stateChanged">
- <Doc>Some documentation for the Event</Doc>
- <Data>
- <DataPoint name="state">
- <DataType>
- <SimpleType type="boolean" />
- </DataType>
- </DataPoint>
- </Data>
+ <Doc>Some documentation for the Event</Doc>
+ <Data>
+ <DataPoint name="state">
+ <DataType>
+ <SimpleType type="boolean" />
+ </DataType>
+ </DataPoint>
+ </Data>
</Event>
```
---
@@ -304,9 +311,9 @@ Element of [Domain](#Domain) and [Product](#Product).
The *DeviceClass* was initially thought of as the representation of "the basic things we are trying to model" and can still be considered so. However, after discussion with various SDOs, it was decided to add also "[sub-devices](#SubDevice)". That is, there is one level of hierarchy to allow modeling of e.g. a set of independent energy monitoring plugs in a single addressable power-extension-block.
-Note, that all the different devices which one needs to model within a Domain are composed of one or more [ModuleClasses](#ModuleClass).
+Note, that all the different devices which one needs to model within a domain are composed of one or more [ModuleClasses](#ModuleClass).
-For each physical device on the network at least one *DeviceClass* **must** be defined. If the physical device is a simple device, i.e. it does not contain embedded devices, e.g. a light switch, it does not include further [SubDevices](#SubDevices). On the other hand, if the physical is a compound device, i.e. it does contain embedded devices that can be addressed separately, the *DeviceClass* **should** contain [SubDevices](SubDevices) for each of the identifiable embedded devices.
+For each physical device type on the network at least one *DeviceClass* **must** be defined. If the physical device is a simple device, i.e. it does not contain embedded devices, e.g. a light switch, it does not include further [SubDevices](#SubDevices). On the other hand, if the physical is a compound device, i.e. it does contain embedded devices that can be addressed separately, the *DeviceClass* **should** contain [SubDevices](SubDevices) for each of the identifiable embedded devices.
An example for a compound device is a connected power-strip where each of the sockets can be switched on and off individually. The power-strip itself can provide functions such as "all sockets off" and "overall power consumption".
@@ -326,16 +333,16 @@ An example for a compound device is a connected power-strip where each of the s
#### Example
```xml
<Device id="aDevice">
- <Doc>Some documentation</Doc>
- <Properties>
- <!-- The list of Properties for the Device goes here-->
- </Properties>
- <ModuleClasses>
- <!-- List of ModuleClasses local to the Device goes here-->
- </ModuleClasses>
- <SubDevices>
- <!-- List of Sub-Devices of the Device goes here-->
- </SubDevices>
+ <Doc>Some documentation</Doc>
+ <Properties>
+ <!-- The list of Properties for the Device goes here-->
+ </Properties>
+ <ModuleClasses>
+ <!-- List of ModuleClasses local to the Device goes here-->
+ </ModuleClasses>
+ <SubDevices>
+ <!-- List of Sub-Devices of the Device goes here-->
+ </SubDevices>
</Device>
```
@@ -347,13 +354,18 @@ Element of [DeviceClass](#DeviceClass) and [Product](#Product).
*SubDevices* are optional components of a [DeviceClass](#DeviceClass). They represent physical sub-devices and services inside another device (the *DeviceClass*).
-*SubDevices* may define their own [ModuleClasses](#ModuleClass) or extend *ModuleClasses* of it's or another [Domain](#Domain).
+*SubDevices* may define their own [ModuleClasses](#ModuleClass) or extend *ModuleClasses* of its or another [Domain](#Domain).
#### Attributes
- **id** : The identifier for that *SubDevice*. The identifier must be unique at least in the scope of the domain, but the final scope is also influenced by implementing technologies. Required.
- **semanticURI** : An attribute that contains a URI to a semantic description of the element. Optional.
+- **minOccurs** : An optional string attribute that indicates the minimum cardinality of a *SubDevice*, for example, in a [DeviceClass](#DeviceClass) definition. Optional. The default is "1".
+Note, if only the *minOccurs* attribute is specified, it can't be greater than 1, because the default value for *maxOccurs* is 1.
+- **maxOccurs** : An optional string attribute that indicates the maximum cardinality of a *SubDevice*, for example, in a [DeviceClass](#DeviceClass) definition. Optional. The default is "1".
+Note, if only the *maxOccurs* attribute is specified, it can't be smaller than 1, because the default value for *minOccurs* is 1.
+Also note, that if both *minOccurs* and *maxOccurs* are specified, then *maxOccurs* always must have an equal or higher cardinality than *minOccurs*.
#### Elements
- **[Doc](#Documentation)** : Documentation for the *SubDevice*. Optional.
@@ -363,13 +375,13 @@ Element of [DeviceClass](#DeviceClass) and [Product](#Product).
#### Example
```xml
<SubDevice id="aSubDevice">
- <Doc>Some documentation</Doc>
- <Properties>
- <!-- The list of Properties for the Device goes here-->
- </Properties>
- <ModuleClasses>
- <!-- List of ModuleClasses local to the Device goes here-->
- </ModuleClasses>
+ <Doc>Some documentation</Doc>
+ <Properties>
+ <!-- The list of Properties for the Device goes here-->
+ </Properties>
+ <ModuleClasses>
+ <!-- List of ModuleClasses local to the Device goes here-->
+ </ModuleClasses>
</SubDevice>
```
@@ -380,13 +392,13 @@ Element of [Domain](#Domain).
-In real life of device manufacturing, there is the important concept of a *ProductClass* for a certain [DeviceClass](#DeviceClass). For example, oneM2M may specify a generic [DeviceClass](#DeviceClass) called *deviceSmartBracelt* with many fancy features (ie. a [ModuleClasses](#ModuleClass). Based on the same [DeviceClass](#DeviceClass), company A may design a *ProductClass* called "X-Fit" with only the [ModuleClass](#ModuleClass) of "stepCounter" and the instantiated [Property](#Property) value of "Manufacturer = Company A", while company B may design a *ProductClass* called "Y-Wristband" with the [ModuleClasseses](#ModuleClass) of "stepCounter" and "heartRateMonitor" and the instantiated [Property](#Property) value of "Manufacturer = Company B". Those two *ProductClasses* are different but follow the same [DeviceClass](#DeviceClass).
+In real life of device manufacturing, there is the important concept of a *ProductClass* for a certain [DeviceClass](#DeviceClass). For example, oneM2M may specify a generic [DeviceClass](#DeviceClass) called *deviceSmartBracelt* with many features, using [ModuleClasses](#ModuleClass) to model the functionalities. Based on the same [DeviceClass](#DeviceClass), company A may design a *ProductClass* called "X-Fit" with only the [ModuleClass](#ModuleClass) of "stepCounter" and the instantiated [Property](#Property) value of "Manufacturer = Company A", while company B may design a *ProductClass* called "Y-Wristband" with the [ModuleClasseses](#ModuleClass) of "stepCounter" and "heartRateMonitor" and the instantiated [Property](#Property) value of "Manufacturer = Company B". Those two *ProductClasses* are different but follow the same [DeviceClass](#DeviceClass).
-On the other hand, a *ProductClass* is **NOT** yet a real device instance of that [DeviceClass](#DeviceClass). It may not have an instantiated [Properties](#Property) like device-id, date-of-manufacturing, and the firmware/software-version, etc. It can be ordered by the customers, but not necessarily instantiated or manufactured.
+On the other hand, a *ProductClass* is **NOT** yet a real device instance of that [DeviceClass](#DeviceClass). It may not have an instantiated [Properties](#Property) like *device-ID*, *date-of-manufacturing*, and the firmware/software-version, etc. It can be ordered by the customers, but not necessarily instantiated or manufactured.
-In short, a *ProductClass* is a concrete device model with deterministic Device Properties and ModuleClasses (no optionality). It's deemed as an specialized implementation of a [DeviceClass](#DeviceClass) but not yet an device instance. Examples are the shopping items in an online digital store that can be ordered (but not necessarily manufactured) by a customer.
+In short, a *ProductClass* is a concrete device model with deterministic [device Properties](#Property) and [ModuleClasses](#ModuleClass) without any optionality. It's deemed as an specialized implementation of a [DeviceClass](#DeviceClass) but not yet an device instance. Examples are the shopping items in an online digital store that can be ordered (but not necessarily manufactured) by a customer.
-A *ProductClass* can be defined by implementing the functionalities of an existing [DeviceClass](#DeviceClass) (while removing unimplemented optional *Properties* and [ModuleClasses](#ModuleClass)), extending from an existing [DeviceClass](#DeviceClass) (adding new [Properties](#Property) and [ModuleClasses](#ModuleClass)), or from scratch (without basing on any [DeviceClass](#DeviceClass)).
+A *ProductClass* can be defined by implementing the functionalities of an existing [DeviceClass](#DeviceClass) while removing unimplemented optional [ Properties](#Property) and [ModuleClasses](#ModuleClass)), by extending from an existing [DeviceClass](#DeviceClass) and adding new [Properties](#Property) and [ModuleClasses](#ModuleClass), or from scratch not re-using on any [DeviceClass](#DeviceClass).
#### Attributes
- **id** : The identifier for that *ProductClass*. The identifier must be unique at least in the scope of the domain, but the final scope is also influenced by the manufacturer or implementation domain. Required.
@@ -407,29 +419,29 @@ All elements of [DeviceClass](#DeviceClass) can be reused in *ProductClass*, but
#### Example
```xml
<ProductClass id="TestProductClass">
- <Doc>This is a new product</Doc>
- <Properties>
- <Property name="name" value="product-abc">
- <SimpleType type="string"></SimpleType>
- </Property>
- <Property name="vendor" value="xyz"/>
- <SimpleType type="string"></SimpleType>
- </Property>
- <Property name="SerialNumber"/>
- <SimpleType type="string"></SimpleType>
- </Property>
- </Properties>
- <ModuleClasses>
- <ModuleClass name="aModuleClass">
- <Extend domain="adomain" entity="aModuleClass" />
- </ModuleClass>
- <ModuleClass name="newModuleClass">
- <!-- List of Actions, Events and DataPoints goes here-->
- </ModuleClass>
- </ModuleClasses>
- <ExtendDevice>
- <Extend domain="adomain" entity="aDeviceClass" />
- </ExtendDevice>
+ <Doc>This is a new product</Doc>
+ <Properties>
+ <Property name="name" value="product-abc">
+ <SimpleType type="string"></SimpleType>
+ </Property>
+ <Property name="vendor" value="xyz"/>
+ <SimpleType type="string"></SimpleType>
+ </Property>
+ <Property name="SerialNumber"/>
+ <SimpleType type="string"></SimpleType>
+ </Property>
+ </Properties>
+ <ModuleClasses>
+ <ModuleClass name="aModuleClass">
+ <Extend domain="adomain" entity="aModuleClass" />
+ </ModuleClass>
+ <ModuleClass name="newModuleClass">
+ <!-- List of Actions, Events and DataPoints goes here-->
+ </ModuleClass>
+ </ModuleClasses>
+ <ExtendDevice>
+ <Extend domain="adomain" entity="aDeviceClass" />
+ </ExtendDevice>
</ProductClass>
```
@@ -460,7 +472,7 @@ Since the *Properties* are highly varied, depending on industry segment, no atte
#### Example
```xml
<Property name="ManufacturedDate" value="2015.10.30 10:06">
- <SimpleType type="datetime" />
+ <SimpleType type="datetime" />
</Property>
```
@@ -496,10 +508,10 @@ The *DataType* element is a "container" for the various aspects of a type.
#### Elements
- **[Doc](#Documentation)** : Documentation for the *DataType* Element. Optional.
- **TypeChoice** : This element is actual an element from the following list of data types:
- - **[SimpleType](#SimpleType)**
- - **[Struct](#StructType)**
- - **[Array](#ArrayType)**
- - **[EnumType](#EnumType)**
+ - **[SimpleType](#SimpleType)**
+ - **[Struct](#StructType)**
+ - **[Array](#ArrayType)**
+ - **[EnumType](#EnumType)**
- **[Constraint](#Constraint)** : A list of *Constraint* elements. Optional.
---
@@ -564,8 +576,8 @@ If not stated otherwise datatypes should comply to the equivalent datatypes defi
### Example
```xml
<DataPoint name="simpleDataPoint">
- <DataType>
- <SimpleType type="string" />
+ <DataType>
+ <SimpleType type="string" />
</DataType>
</DataPoint>
```
@@ -585,15 +597,15 @@ The *StructType* element can be used to represent an ordered list of diverse Dat
### Example
```xml
<DataPoint name="structDataPoint">
- <DataType name="structured">
- <Struct>
- <DataType name="aString">
- <SimpleType type="string" />
- </DataType>
- <DataType name="anInteger">
- <SimpleType type="integer" />
- </DataType>
- </Struct>
+ <DataType name="structured">
+ <Struct>
+ <DataType name="aString">
+ <SimpleType type="string" />
+ </DataType>
+ <DataType name="anInteger">
+ <SimpleType type="integer" />
+ </DataType>
+ </Struct>
</DataType>
</DataPoint>
```
@@ -615,12 +627,12 @@ The *ArrayType* element is provided for defining lists of data; the definition i
### Example
```xml
<DataPoint name="arrayDataPoint">
- <DataType name="arrayOfInteger">
- <Array>
- <DataType>
- <SimpleType type="integer" />
- </DataType>
- </Array>
+ <DataType name="arrayOfInteger">
+ <Array>
+ <DataType>
+ <SimpleType type="integer" />
+ </DataType>
+ </Array>
</DataType>
</DataPoint>
```
@@ -641,12 +653,12 @@ The *EnumType* element is provided for defining an enumeration data type; it def
#### Example
```xml
<DataPoint name="enumDataPoint">
- <DataType name="enumOfInteger">
- <Enum>
- <EnumValue name="red" value="1" type="integer" />
- <EnumValue name="green" value="2" />
- <EnumValue name="blue" value="3" />
- </Enum>
+ <DataType name="enumOfInteger">
+ <Enum>
+ <EnumValue name="red" value="1" type="integer" />
+ <EnumValue name="green" value="2" />
+ <EnumValue name="blue" value="3" />
+ </Enum>
</DataType>
</DataPoint>
```
@@ -692,22 +704,22 @@ The following example defines two [ModuleClasses](#ModuleClass), where the secon
```xml
<ModuleClasses>
- <ModuleClass name="aModuleClass">
- <Data>
- <DataPoint name="dataPoint1">
- <!-- type definition -->
- </DataPoint>
- <DataPoint name="dataPoint2">
- <!-- type definition -->
- </DataPoint>
- </Data>
- </ModuleClass>
- <ModuleClass name="anotherModuleClass">
- <Extend domain="aDomain" entity="aModuleClass">
- <Exclude name="dataPoint2" type="datapoint" />
- </Extend>
- <!-- more local definitions, such as Actions, DataPoints etc -->
- </ModuleClass>
+ <ModuleClass name="aModuleClass">
+ <Data>
+ <DataPoint name="dataPoint1">
+ <!-- type definition -->
+ </DataPoint>
+ <DataPoint name="dataPoint2">
+ <!-- type definition -->
+ </DataPoint>
+ </Data>
+ </ModuleClass>
+ <ModuleClass name="anotherModuleClass">
+ <Extend domain="aDomain" entity="aModuleClass">
+ <Exclude name="dataPoint2" type="datapoint" />
+ </Extend>
+ <!-- more local definitions, such as Actions, DataPoints etc -->
+ </ModuleClass>
</ModuleClasses>
```
@@ -729,8 +741,8 @@ Please note, that it is only possible to either [Include](#ExtendInclude) or [Ex
#### Elements
- **ExtendChoice** : This element is actual a list of elements from the following list of extend choices. Please note, that it is only possible to either **Include** or **Exclude** elements.
- - **[Include](#ExtendInclude)**
- - **[Exclude](#ExtendExclude)**
+ - **[Include](#ExtendInclude)**
+ - **[Exclude](#ExtendExclude)**
#### Example
See [example in *Extending (Inheriting)*](#ExtendExample).
diff --git a/SDT/schema4.0/docs/SDT_JSON.md b/SDT/schema4.0/docs/SDT_JSON.md
index ade2d189ca75694089d6f18b266e37bc81d700e5..4a1af69846c0f80f077233e548c2a0baa46a5f15 100644
--- a/SDT/schema4.0/docs/SDT_JSON.md
+++ b/SDT/schema4.0/docs/SDT_JSON.md
@@ -20,7 +20,7 @@
<a name="introduction"/></a>
## Introduction
-When SDT was introduced, XML was the favorite encoding format for schemas. Since then, JSON became more popular in the developers' communities, especially in the context of RESTful implementation.
+When the Smart Device Template was introduced, XML was the favorite encoding format for schemas. Since then, JSON became more popular in developers' communities, especially in the context of RESTful implementations.
JSON is more concise and human-readable comparing to XML, but has less capability of formal schema definition and validation (such as the XML Schema as defined in [domain.xsd](../src/domain.xsd)).
@@ -30,7 +30,7 @@ There are some open tools such as [JSON Schema](http://json-schema.org/) that mi
In this release, we chose to define the JSON serialization by the documentation below, while borrowing some valuable aspects from JSON Schema (e.g. data types and validation keywords). Full endorsement of [JSON Schema](http://json-schema.org/) may be considered in the future.
-The general JSON structure follows the general SDT structure presented in [SDT_UML.md](SDT_UML.md) and described in [SDT_Components.md](SDT_Components.md).
+The general JSON structure follows the general SDT structure presented in [SDT_UML.uxf](SDT_UML.uxf) and described in [SDT_Components.md](SDT_Components.md).
<a name="mappings"/></a>
## SDT mapping to JSON
@@ -38,36 +38,38 @@ The general JSON structure follows the general SDT structure presented in [SDT_U
<a name="elements"/></a>
### Elements mapping
-| SDT XML Elements | JSON Key Words | Remark |
-|------------------|----------------|--------|
-|Action | Action | |
-|Actions | Actions | This element is an array of *Action* structures. |
-|Arg | Arg | |
-|Args | Args | This element is an array of *Arg* structures. |
-|Constraint | Constraint | |
-|Constraints | Constraints | This element is an array of *Constraint* structures. |
-|Data | Data | This element is an array of *DataPoint* structures. |
-|DataPoint | DataPoint | |
-|DataType | DataType | |
-|DataTypes | DataTypes | This element is an array of *DataType* structures. |
-|DeviceClass | DeviceClass | |
-|DeviceClasses | DeviceClasses | This element is an array of *DeviceClass* structures. |
-|Doc |Doc | |
-|Domain | Domain | |
-|Event | Event | |
-|Events | Events | This element is an array of *Event* structures. |
-|Exclude | Exclude | |
-|Extend | Extend | |
-|Imports |Imports| This element is an array of *Include* structures. |
-|Include | Include | |
-|ModuleClass | ModuleClass | |
-|ModuleClasses | ModuleClasses | This element is an array of *ModuleClass* structures. |
-|ProductClass | ProductClass | |
-|ProductClasses | ProductClasses | This element is an array of *ProductClasses* structures. |
-|Properties | Properties | This element is an array of *Property* structures. |
-|Property | Property | |
-|SubDevice | SubDevice | |
-|SubDevices | SubDevices | This element is an array of *SubDevice* structures. |
+| SDT XML Elements | JSON Key Words | Remark |
+|:-----------------------------------------------|:---------------|:----------------------------------------------------------|
+| [Action](SDT_Components.md#Action) | Action | |
+| Actions | Actions | This element is an array of *Action* structures. |
+| [Arg](SDT_Components.md#Arg) | Arg | |
+| Args | Args | This element is an array of *Arg* structures. |
+| Constraint | Constraint | |
+| Constraints | Constraints | This element is an array of *Constraint* structures. |
+| Data | Data | This element is an array of *DataPoint* structures. |
+| [DataPoint](SDT_Components.md#DataPoint) | DataPoint | |
+| [DataType](SDT_Components.md#DataType) | DataType | |
+| [DataTypes](SDT_Components.md#DataTypes) | DataTypes | This element is an array of *DataType* structures. |
+| [DeviceClass](SDT_Components.md#DeviceClass) | DeviceClass | |
+| DeviceClasses | DeviceClasses | This element is an array of *DeviceClass* structures. |
+| [Doc](SDT_Components.md#Documentation) | Doc | |
+| [Domain](SDT_Components.md#Domain) | Domain | |
+| [Event](SDT_Components.md#Event) | Event | |
+| Events | Events | This element is an array of *Event* structures. |
+| Exclude | Exclude | |
+| Excludes | Excludes | This element is an array of *Exclude* structures. |
+| [Extend](SDT_Components.md#Extending) | Extend | |
+| Imports | Imports | This is an array of URLs or file URLs to files to import. |
+| Include | Include | |
+| Includes | Includes | This element is an array of *Include* structures. |
+| [ModuleClass](SDT_Components.md#ModuleClass) | ModuleClass | |
+| ModuleClasses | ModuleClasses | This element is an array of *ModuleClass* structures. |
+| [ProductClass](SDT_Components.md#ProductClass) | ProductClass | |
+| ProductClasses | ProductClasses | This element is an array of *ProductClasses* structures. |
+| Properties | Properties | This element is an array of *Property* structures. |
+| [Property](SDT_Components.md#Property) | Property | |
+| [SubDevice](SDT_Components.md#SubDevice) | SubDevice | |
+| SubDevices | SubDevices | This element is an array of *SubDevice* structures. |
#### Example
@@ -134,31 +136,34 @@ The following example defines a simple *Light* device.
<a name="attributes"/></a>
### Attributes mapping
-There are common attributes (e.g. *@id, @name, @optional*) used in several SDT components (e.g. in *DeviceClass, ModuleClass*) as well as attributes used only in certain components (e.g. *@entity* in *Extend*). The mapping of those attributes to JSON follows the rules as below.
+There are common attributes (e.g. *@id, @name, @optional*) used in several SDT components (e.g. in *DeviceClass, ModuleClass*) as well as attributes used only in certain components (e.g. *@entity* in *Extend*). XML attributes are represented as normal fields in JSON. The mapping of those attributes to JSON follows the rules as below.
| SDT XML Attributes | JSON Key Word |
-|----------------|-------------|
-|@default | default |
-|@domain |domain |
-|@entity |entity |
-|@eventable | eventable|
-|@href | href |
-|@id |id |
-|@name |name |
-|@optional | optional|
-|@parse | parse |
-|@readable | readable|
-|@semanticURI | semanticURI |
-|@value |value |
-|@writable | writable|
-|@type | type |
-|@unitOfMeasure | unitOfMeasure |
+|:-------------------|:--------------|
+| @default | default |
+| @domain | domain |
+| @entity | entity |
+| @eventable | eventable |
+| @href | href |
+| @id | id |
+| @maxOccurs | maxOccurs |
+| @minOccurs | minOccurs |
+| @name | name |
+| @optional | optional |
+| @parse | parse |
+| @readable | readable |
+| @semanticURI | semanticURI |
+| @type | type |
+| @unitOfMeasure | unitOfMeasure |
+| @value | value |
+| @writable | writable |
<a name="imports"/></a>
### Import mapping
-The imports are mapped to an array of *Include* structures. Each *Include* structure contains a *href* and a *parse* element.
+The imports are mapped to an array of *Include* structures. Each *Include* structure contains a *href* and a *parse* element.
+A parser must make sure to import and regard the definitions in the referenced files.
#### Example
@@ -178,19 +183,20 @@ The imports are mapped to an array of *Include* structures. Each *Include* struc
{ "Include" : { "href" : "anotherSDT.xml", "parse" : "json" } }
]
```
+
<a name="ExtendType"/></a>
### ExtendType mapping
-In the *Include* and *Exclude* elements one may specify the type of the element to be included or excluded. The following table shows the mapping of *ExtendType*.
+In the *Include* and *Exclude* elements one may specify the type of the element to be included or excluded. The following table shows the mapping of [ExtendType](SDT_Components.md#ExtendType).
| SDT ExtendType | JSON Key Word |
-|----------------|---------------|
-|action | action |
-|datapoint | datapoint |
-|event | event |
-|moduleclass | moduleclass |
-|property | property |
-|device | device |
-|subdevice |subdevice |
+|:---------------|:--------------|
+| action | action |
+| datapoint | datapoint |
+| event | event |
+| moduleclass | moduleclass |
+| property | property |
+| device | device |
+| subdevice | subdevice |
<a name="dataTypes"/></a>
@@ -203,21 +209,21 @@ The mapping of the different kind of data types to JSON happens directly to JSON
<a name="SimpleType"/></a>
### SimpleType
-Note for *SimpelType*: For simplicity, if there is no other attribute present then the type value of *SimpleType* can be directly put as the value of parent *DataType* key, e.g. ```"DataType":"string"```
-
-| SDT Data Types | Note |
-|----------------|-----------|
-| boolean | boolean (JSON Schema) |
-| string | string (JSON Schema) |
-| byte | An integer datatype with the range of [0 - 255] |
-| integer | integer (JSON Schema) |
-| float | number (JSON Schema) |
-| date | date (JSON Schema) |
-| time | time (JSON Schema) |
-| datetime | date-time (JSON Schema) |
-| blob | A *base64Binary* encoded string according to [RFC 2045](https://www.w3.org/TR/xmlschema-2/#RFC2045) |
-| uri | A string following the URI format (JSON Schema) |
-| void | null (JSON Schema) |
+Note for [SimpelType](SDT_Components.md#SimpelType): For simplicity, if there is no other attribute present then the type value of [SimpelType](SDT_Components.md#SimpelType) can be directly put as the value of parent [DataType](SDT_Components.md#DataType) key, e.g. ```"DataType":"string"```
+
+| SDT Data Types | Note |
+|:---------------|:----------------------------------------------------------------------------------------------------|
+| boolean | boolean (JSON Schema) |
+| string | string (JSON Schema) |
+| byte | An integer datatype with the range of [0 - 255] |
+| integer | integer (JSON Schema) |
+| float | number (JSON Schema) |
+| date | date (JSON Schema) |
+| time | time (JSON Schema) |
+| datetime | date-time (JSON Schema) |
+| blob | A *base64Binary* encoded string according to [RFC 2045](https://www.w3.org/TR/xmlschema-2/#RFC2045) |
+| uri | A string following the URI format (JSON Schema) |
+| void | null (JSON Schema) |
#### Examples
@@ -260,7 +266,7 @@ A simple data type with additional attributes:
<a name="ArrayType"/></a>
### ArrayType
-An *ArrayType* definition is mapped to an *Array* JSON structure. The content of the structure is only one element that defines the type of the array. This could be any *SimpleType*, *ArrayType*, *StructType*, or *EnumType*.
+An [ArrayType](SDT_Components.md#ArrayType) definition is mapped to an *Array* JSON structure. The content of the structure is only one element that defines the type of the array. This could be any [SimpleType](#SimpleType), [ArrayType](#ArrayType), [StructType](#StructType), or [EnumType](#EnumType).
#### Example
@@ -289,7 +295,7 @@ A simple data type with additional attributes:
<a name="StructType"/></a>
### StructType
-A *StructType* definition is mapped to a *Struct* JSON array. The content of the array are the individual data types for the structure. These could be any *SimpleType*, *ArrayType*, *StructType*, or *EnumType*.
+A [StructType](SDT_Components.md#StructType) definition is mapped to a *Struct* JSON array. The content of the array are the individual data types for the structure. These could be any [SimpleType](#SimpleType), [ArrayType](#ArrayType), [StructType](#StructType), or [EnumType](#EnumType).
A *StructType* definition must contain a *name* attribute.
@@ -371,13 +377,13 @@ A more complex structured data type (a structure that contains an indentifier va
<a name="EnumType"/></a>
### EnumType
-A *EnumType* definition is mapped to an *Enum* JSON structure. The content of the structure are the individual enum values of the enum.
+A [EnumType](SDT_Components.md#EnumType) definition is mapped to an *Enum* JSON structure. The content of the structure are the individual enum values of the enum.
A *EnumType* definition must contain a *name* attribute.
#### Example
-An *Enum* that defines three *EnumValues*. The first definition explicitly specifies the type of the *EnumValue*.
+An *Enum* that defines three [EnumValues](SDT_Components.md#EnumValues). The first definition explicitly specifies the type of the [EnumValues](SDT_Components.md#EnumValues).
**XML**:
@@ -404,12 +410,11 @@ An *Enum* that defines three *EnumValues*. The first definition explicitly speci
<a name="extendingDatatypes"/></a>
### Extending Data Types
-Extending *DataTypes* are mapped the same way as extending, for example, *ModuleClasses*. However, since the *DataType* is open, the generic form *DataType* must be used for JSON serialization. It maps to a structure that contains a single *Extend* structure. This structure contains the two attributes *domain* and *entity*.
+Extending [DataTypes](SDT_Components.md#DataTypes) are mapped the same way as extending, for example, [ModuleClasses](SDT_Components.md#ModuleClass). However, since the [DataType](SDT_Components.md#DataTypes) is open, the generic form [DataType](SDT_Components.md#DataTypes) must be used for JSON serialization. It maps to a structure that contains a single [Extend](SDT_Components.md#Extending) structure. This structure contains the two attributes *domain* and *entity*.
#### Example
-
-An *Enum* that defines three *EnumValues*. The first definition explicitly specifies the type of the *EnumValue*.
+An [Enum](SDT_Components.md#EnumType) that defines three *EnumValues*. The first definition explicitly specifies the type of the *EnumValue*.
**XML**:
diff --git a/SDT/schema4.0/docs/SDT_UML.uxf b/SDT/schema4.0/docs/SDT_UML.uxf
index cc0b7e3a989eff7d6d92da1ba152e3df890fca36..0ce26ab38c55b45579c9341b384e4edc524e5e7e 100644
--- a/SDT/schema4.0/docs/SDT_UML.uxf
+++ b/SDT/schema4.0/docs/SDT_UML.uxf
@@ -5,8 +5,8 @@
<element>
<id>UMLNote</id>
<coordinates>
- <x>1152</x>
- <y>1424</y>
+ <x>1136</x>
+ <y>1400</y>
<w>232</w>
<h>208</h>
</coordinates>
@@ -36,8 +36,8 @@ group=1</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1256</x>
- <y>1504</y>
+ <x>1240</x>
+ <y>1480</y>
<w>88</w>
<h>32</h>
</coordinates>
@@ -51,8 +51,8 @@ group=1</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1256</x>
- <y>1536</y>
+ <x>1240</x>
+ <y>1512</y>
<w>88</w>
<h>24</h>
</coordinates>
@@ -64,8 +64,8 @@ group=1</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>1264</x>
- <y>1056</y>
+ <x>1248</x>
+ <y>1032</y>
<w>120</w>
<h>176</h>
</coordinates>
@@ -88,8 +88,8 @@ void</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>768</x>
- <y>1120</y>
+ <x>752</x>
+ <y>1096</y>
<w>112</w>
<h>64</h>
</coordinates>
@@ -101,8 +101,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>768</x>
- <y>1056</y>
+ <x>752</x>
+ <y>1032</y>
<w>112</w>
<h>64</h>
</coordinates>
@@ -114,8 +114,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>384</x>
- <y>1056</y>
+ <x>368</x>
+ <y>1032</y>
<w>152</w>
<h>120</h>
</coordinates>
@@ -134,8 +134,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>528</x>
- <y>1016</y>
+ <x>512</x>
+ <y>992</y>
<w>544</w>
<h>96</h>
</coordinates>
@@ -147,8 +147,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>528</x>
- <y>1016</y>
+ <x>512</x>
+ <y>992</y>
<w>544</w>
<h>144</h>
</coordinates>
@@ -160,8 +160,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>864</x>
- <y>1152</y>
+ <x>848</x>
+ <y>1128</y>
<w>152</w>
<h>40</h>
</coordinates>
@@ -174,8 +174,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1008</x>
- <y>1176</y>
+ <x>992</x>
+ <y>1152</y>
<w>272</w>
<h>32</h>
</coordinates>
@@ -187,8 +187,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>864</x>
- <y>1248</y>
+ <x>848</x>
+ <y>1224</y>
<w>152</w>
<h>88</h>
</coordinates>
@@ -205,8 +205,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>528</x>
- <y>1136</y>
+ <x>512</x>
+ <y>1112</y>
<w>352</w>
<h>144</h>
</coordinates>
@@ -218,8 +218,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1008</x>
- <y>1224</y>
+ <x>992</x>
+ <y>1200</y>
<w>336</w>
<h>112</h>
</coordinates>
@@ -231,8 +231,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>864</x>
- <y>1056</y>
+ <x>848</x>
+ <y>1032</y>
<w>152</w>
<h>40</h>
</coordinates>
@@ -245,8 +245,8 @@ fg=blue</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>864</x>
- <y>1104</y>
+ <x>848</x>
+ <y>1080</y>
<w>152</w>
<h>40</h>
</coordinates>
@@ -259,8 +259,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>768</x>
- <y>1096</y>
+ <x>752</x>
+ <y>1072</y>
<w>112</w>
<h>40</h>
</coordinates>
@@ -273,8 +273,8 @@ fontsize=12
<element>
<id>UMLClass</id>
<coordinates>
- <x>384</x>
- <y>944</y>
+ <x>368</x>
+ <y>920</y>
<w>1000</w>
<h>32</h>
</coordinates>
@@ -288,8 +288,8 @@ lw=0.1</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>96</x>
- <y>72</y>
+ <x>80</x>
+ <y>48</y>
<w>1288</w>
<h>32</h>
</coordinates>
@@ -303,8 +303,8 @@ lw=0.1</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>664</x>
- <y>176</y>
+ <x>648</x>
+ <y>152</y>
<w>192</w>
<h>168</h>
</coordinates>
@@ -328,8 +328,8 @@ fg=blue
<element>
<id>UMLClass</id>
<coordinates>
- <x>944</x>
- <y>176</y>
+ <x>928</x>
+ <y>152</y>
<w>176</w>
<h>104</h>
</coordinates>
@@ -347,8 +347,8 @@ fg=blue</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>1216</x>
- <y>248</y>
+ <x>1200</x>
+ <y>224</y>
<w>168</w>
<h>104</h>
</coordinates>
@@ -366,8 +366,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1112</x>
- <y>248</y>
+ <x>1096</x>
+ <y>224</y>
<w>120</w>
<h>32</h>
</coordinates>
@@ -379,8 +379,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>112</x>
- <y>176</y>
+ <x>96</x>
+ <y>152</y>
<w>184</w>
<h>128</h>
</coordinates>
@@ -400,8 +400,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>176</y>
+ <x>528</x>
+ <y>152</y>
<w>136</w>
<h>64</h>
</coordinates>
@@ -413,8 +413,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>376</x>
- <y>424</y>
+ <x>360</x>
+ <y>400</y>
<w>176</w>
<h>120</h>
</coordinates>
@@ -433,8 +433,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>272</y>
+ <x>528</x>
+ <y>248</y>
<w>56</w>
<h>72</h>
</coordinates>
@@ -446,8 +446,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>352</y>
+ <x>528</x>
+ <y>328</y>
<w>136</w>
<h>128</h>
</coordinates>
@@ -459,8 +459,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>1216</x>
- <y>472</y>
+ <x>1200</x>
+ <y>448</y>
<w>168</w>
<h>40</h>
</coordinates>
@@ -472,8 +472,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>848</x>
- <y>176</y>
+ <x>832</x>
+ <y>152</y>
<w>112</w>
<h>56</h>
</coordinates>
@@ -485,8 +485,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1168</x>
- <y>472</y>
+ <x>1152</x>
+ <y>448</y>
<w>64</w>
<h>32</h>
</coordinates>
@@ -498,8 +498,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>848</x>
- <y>224</y>
+ <x>832</x>
+ <y>200</y>
<w>112</w>
<h>96</h>
</coordinates>
@@ -511,8 +511,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>944</x>
- <y>288</y>
+ <x>928</x>
+ <y>264</y>
<w>176</w>
<h>144</h>
</coordinates>
@@ -535,8 +535,8 @@ fg=blue
<element>
<id>UMLClass</id>
<coordinates>
- <x>944</x>
- <y>440</y>
+ <x>928</x>
+ <y>416</y>
<w>176</w>
<h>88</h>
</coordinates>
@@ -553,8 +553,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>848</x>
- <y>304</y>
+ <x>832</x>
+ <y>280</y>
<w>112</w>
<h>168</h>
</coordinates>
@@ -566,8 +566,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>176</y>
+ <x>528</x>
+ <y>152</y>
<w>136</w>
<h>336</h>
</coordinates>
@@ -579,8 +579,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>376</x>
- <y>312</y>
+ <x>360</x>
+ <y>288</y>
<w>176</w>
<h>104</h>
</coordinates>
@@ -598,8 +598,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>392</y>
+ <x>528</x>
+ <y>368</y>
<w>64</w>
<h>64</h>
</coordinates>
@@ -611,8 +611,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>176</y>
+ <x>528</x>
+ <y>152</y>
<w>136</w>
<h>224</h>
</coordinates>
@@ -623,8 +623,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>352</y>
+ <x>528</x>
+ <y>328</y>
<w>136</w>
<h>32</h>
</coordinates>
@@ -634,8 +634,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>664</x>
- <y>352</y>
+ <x>648</x>
+ <y>328</y>
<w>192</w>
<h>104</h>
</coordinates>
@@ -654,21 +654,21 @@ transparency=80</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1112</x>
- <y>176</y>
+ <x>1096</x>
+ <y>256</y>
<w>56</w>
- <h>320</h>
+ <h>216</h>
</coordinates>
<panel_attributes>lt=<.
-m1=0..n
+r1=0..n
fontsize=12</panel_attributes>
- <additional_attributes>10.0;10.0;40.0;10.0;40.0;380.0;10.0;380.0</additional_attributes>
+ <additional_attributes>10.0;20.0;40.0;20.0;40.0;250.0;10.0;250.0</additional_attributes>
</element>
<element>
<id>Relation</id>
<coordinates>
- <x>848</x>
- <y>304</y>
+ <x>832</x>
+ <y>280</y>
<w>56</w>
<h>80</h>
</coordinates>
@@ -680,8 +680,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>624</x>
- <y>1064</y>
+ <x>608</x>
+ <y>1040</y>
<w>152</w>
<h>88</h>
</coordinates>
@@ -699,8 +699,8 @@ Enum : EnumType
<element>
<id>Relation</id>
<coordinates>
- <x>528</x>
- <y>1072</y>
+ <x>512</x>
+ <y>1048</y>
<w>112</w>
<h>64</h>
</coordinates>
@@ -712,8 +712,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>240</y>
+ <x>528</x>
+ <y>216</y>
<w>136</w>
<h>136</h>
</coordinates>
@@ -724,8 +724,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>288</x>
- <y>144</y>
+ <x>272</x>
+ <y>120</y>
<w>392</w>
<h>88</h>
</coordinates>
@@ -736,8 +736,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>544</x>
- <y>256</y>
+ <x>528</x>
+ <y>232</y>
<w>64</w>
<h>192</h>
</coordinates>
@@ -749,8 +749,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>864</x>
- <y>1200</y>
+ <x>848</x>
+ <y>1176</y>
<w>152</w>
<h>40</h>
</coordinates>
@@ -763,8 +763,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>768</x>
- <y>1128</y>
+ <x>752</x>
+ <y>1104</y>
<w>112</w>
<h>104</h>
</coordinates>
@@ -776,8 +776,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>1064</x>
- <y>1216</y>
+ <x>1048</x>
+ <y>1192</y>
<w>168</w>
<h>88</h>
</coordinates>
@@ -794,8 +794,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1008</x>
- <y>1216</y>
+ <x>992</x>
+ <y>1192</y>
<w>72</w>
<h>32</h>
</coordinates>
@@ -807,8 +807,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>1224</x>
- <y>1224</y>
+ <x>1208</x>
+ <y>1200</y>
<w>88</w>
<h>64</h>
</coordinates>
@@ -820,8 +820,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>432</x>
- <y>696</y>
+ <x>416</x>
+ <y>672</y>
<w>176</w>
<h>64</h>
</coordinates>
@@ -837,8 +837,8 @@ fg=blue
<element>
<id>UMLClass</id>
<coordinates>
- <x>928</x>
- <y>696</y>
+ <x>912</x>
+ <y>672</y>
<w>192</w>
<h>56</h>
</coordinates>
@@ -852,8 +852,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>856</x>
- <y>696</y>
+ <x>840</x>
+ <y>672</y>
<w>88</w>
<h>56</h>
</coordinates>
@@ -866,8 +866,8 @@ fontsize=12
<element>
<id>Relation</id>
<coordinates>
- <x>384</x>
- <y>696</y>
+ <x>368</x>
+ <y>672</y>
<w>64</w>
<h>32</h>
</coordinates>
@@ -879,8 +879,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>1208</x>
- <y>696</y>
+ <x>1192</x>
+ <y>672</y>
<w>176</w>
<h>128</h>
</coordinates>
@@ -900,8 +900,8 @@ subdevice
<element>
<id>Relation</id>
<coordinates>
- <x>1112</x>
- <y>696</y>
+ <x>1096</x>
+ <y>672</y>
<w>112</w>
<h>56</h>
</coordinates>
@@ -913,8 +913,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>928</x>
- <y>760</y>
+ <x>912</x>
+ <y>736</y>
<w>192</w>
<h>56</h>
</coordinates>
@@ -928,8 +928,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>856</x>
- <y>744</y>
+ <x>840</x>
+ <y>720</y>
<w>88</w>
<h>48</h>
</coordinates>
@@ -942,8 +942,8 @@ fontsize=12
<element>
<id>Relation</id>
<coordinates>
- <x>1112</x>
- <y>696</y>
+ <x>1096</x>
+ <y>672</y>
<w>112</w>
<h>120</h>
</coordinates>
@@ -955,8 +955,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>688</x>
- <y>696</y>
+ <x>672</x>
+ <y>672</y>
<w>176</w>
<h>64</h>
</coordinates>
@@ -973,8 +973,8 @@ Includes : Include
<element>
<id>Relation</id>
<coordinates>
- <x>600</x>
- <y>704</y>
+ <x>584</x>
+ <y>680</y>
<w>104</w>
<h>56</h>
</coordinates>
@@ -987,8 +987,8 @@ fontsize=12
<element>
<id>UMLClass</id>
<coordinates>
- <x>376</x>
- <y>176</y>
+ <x>360</x>
+ <y>152</y>
<w>176</w>
<h>128</h>
</coordinates>
@@ -1009,8 +1009,8 @@ fg=blue</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>288</x>
- <y>288</y>
+ <x>272</x>
+ <y>264</y>
<w>104</w>
<h>56</h>
</coordinates>
@@ -1022,8 +1022,8 @@ fontsize=12</panel_attributes>
<element>
<id>Relation</id>
<coordinates>
- <x>288</x>
- <y>176</y>
+ <x>272</x>
+ <y>152</y>
<w>104</w>
<h>104</h>
</coordinates>
@@ -1035,8 +1035,8 @@ fontsize=12</panel_attributes>
<element>
<id>UMLClass</id>
<coordinates>
- <x>384</x>
- <y>608</y>
+ <x>368</x>
+ <y>584</y>
<w>1000</w>
<h>32</h>
</coordinates>
diff --git a/SDT/schema4.0/docs/UML Diagram.md b/SDT/schema4.0/docs/UML Diagram.md
index 653717445648c072f09c1149924bb1c736e41da5..4160098c9fcbe776ef41b1c56f2347bdc4086c1d 100644
--- a/SDT/schema4.0/docs/UML Diagram.md
+++ b/SDT/schema4.0/docs/UML Diagram.md
@@ -8,12 +8,18 @@ The source for the diagrams below can be found [here (SDT_UML.uxf)](SDT_UML.uxf)
## Basic Elements
+This diagram presents the main functional elements of the Smart Device Template.
+
## Data Types
+This diagram shows how data types are specified in the Smart Device Temple.
+
## Extend
+Some elements of the Smart Device Template can be extended. This diagram presents the elements that are used to extend elements as well as to include and exclude certain attributs and sub-elements when extending.
+
diff --git a/SDT/schema4.0/docs/images/MC.Action.DataPoint.Event.png b/SDT/schema4.0/docs/images/MC.Action.DataPoint.Event.png
index 67ee56e2689fd24bfb444f281c7bcbc594121fe6..24302d3d185b54aa0f0489fd5146c4c56084ff59 100644
Binary files a/SDT/schema4.0/docs/images/MC.Action.DataPoint.Event.png and b/SDT/schema4.0/docs/images/MC.Action.DataPoint.Event.png differ
diff --git a/SDT/schema4.0/docs/images/ModuleClass.png b/SDT/schema4.0/docs/images/ModuleClass.png
index 3c8fa19e10746abafa6c34400c6ab3a5744f8b50..1056b0d38771e2dbc65cb3c15eb3ddd9373ccf81 100644
Binary files a/SDT/schema4.0/docs/images/ModuleClass.png and b/SDT/schema4.0/docs/images/ModuleClass.png differ
diff --git a/SDT/schema4.0/docs/images/SDT_UML_Basic_Elements.png b/SDT/schema4.0/docs/images/SDT_UML_Basic_Elements.png
index 38fae6a92cde0f2c321e94963313494eb24dfd54..52eccd8f7be8198a17b9956fcebbb6d17a0b4620 100644
Binary files a/SDT/schema4.0/docs/images/SDT_UML_Basic_Elements.png and b/SDT/schema4.0/docs/images/SDT_UML_Basic_Elements.png differ
diff --git a/SDT/schema4.0/docs/images/SDT_simplified.png b/SDT/schema4.0/docs/images/SDT_simplified.png
index f3ff40db0d91f40696e54e5a7e03d980b153214e..f0a82e590db0950bcfaf3deb8cbd35078756ce8b 100644
Binary files a/SDT/schema4.0/docs/images/SDT_simplified.png and b/SDT/schema4.0/docs/images/SDT_simplified.png differ
diff --git a/SDT/schema4.0/docs/images/SubDevice.png b/SDT/schema4.0/docs/images/SubDevice.png
index 50e497d33523029e67129c5138ef93f932d75e0e..64a96571eba1c451d3b4e14e1f5be697ffc82cbb 100644
Binary files a/SDT/schema4.0/docs/images/SubDevice.png and b/SDT/schema4.0/docs/images/SubDevice.png differ