Commit 975e754f authored by Andreas Kraft's avatar Andreas Kraft
Browse files

Moved documentation to the 2.0 directory.

Added Domain to component documentation.
parent 79ddad20
...@@ -2,23 +2,23 @@ ...@@ -2,23 +2,23 @@
Repository for the Smart Home Device Template (SDT). Repository for the Smart Home Device Template (SDT).
Note that this project runs under Apache 2.0 license. Read the [LICENSE](LICENSE) in this repository, or refer to [http://www.apache.org/licenses/LICENSE-2.0.html](http://www.apache.org/licenses/LICENSE-2.0.html) Note that this project runs under Apache 2.0 license. Read the [LICENSE](LICENSE) in this repository, or refer to [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Any contributions made to this project must comply with the forementioned license. Any contributions made to this project must comply with the forementioned license.
## Quick Links ## Quick Links
- ['domain.xsd' Version 2.0](SDT/schema2.0/src/domain.xsd) - ['domain.xsd' Version 2.0](SDT/schema2.0/src/domain.xsd)
- [UML Diagram of the SDT 2.0](images/SDT2.0_UML.png) - [UML Diagram of the SDT 2.0](SDT/schema2.0/docs/images/SDT2.0_UML.png)
## Content ## Content
You can find further Information here: You can find further Information here:
- [SDT Components](SDT_Components.md) - [SDT Components](SDT/schema2.0/docs/SDT_Components.md)
- [SDT Build System](SDT%20Build%20System.md) - [SDT Build System](SDT/schema2.0/docs/SDT%20Build%20System.md)
- [FAQ](FAQ.md) - [FAQ](SDT/schema2.0/docs/FAQ.md)
- [Links & References](Links.md) - [Links & References](SDT/schema2.0/docs/Links.md)
- [LICENSE](LICENSE) - [LICENSE](LICENSE)
...@@ -28,7 +28,7 @@ You can find further Information here: ...@@ -28,7 +28,7 @@ You can find further Information here:
- Added attributes to data points (readable, eventable) - Added attributes to data points (readable, eventable)
- Added otional ``<SerialNumber>``, ``<VendorURL>`` and ``<FirmwareVersion>`` elements to DeviceInfo - Added otional ``<SerialNumber>``, ``<VendorURL>`` and ``<FirmwareVersion>`` elements to DeviceInfo
- Added optional ``<Doc>`` element to Event - Added optional ``<Doc>`` element to Event
- Added [UML diagram](SDT_Components.md) - Added [UML diagram](SDT/schema2.0/docs/SDT_Components.md)
# SDT Components # SDT Components
In this document an overview about the SDT 2.0 ødefinitions and component hierarchy is given. In this document an overview about the SDT 2.0 ødefinitions and component hierarchy is given.
## SDT Overview ## SDT Overview
...@@ -11,9 +12,35 @@ The syntax used in the diagram to model an XML Schema Definition (XSD) as an UML ...@@ -11,9 +12,35 @@ The syntax used in the diagram to model an XML Schema Definition (XSD) as an UML
- [Design XML schemas using UML](http://www.ibm.com/developerworks/library/x-umlschem/) - [Design XML schemas using UML](http://www.ibm.com/developerworks/library/x-umlschem/)
- [UML For W3C XML Schema Design](http://www.xml.com/pub/a/2002/08/07/wxs_uml.html) - [UML For W3C XML Schema Design](http://www.xml.com/pub/a/2002/08/07/wxs_uml.html)
## Components ## Components
-TBD
---
### Domain ### Domain
The *Domain* is the top-level component that defines all modules and devices of a domain. A *Domain* can import definitions of other domains.
![](images/Domain.png)
#### Example
<Domain xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://hgi.org/xml/dal/2.0"
id="org.hgi">
<Imports>
<xi:include href="./dal-core.xml" parse="xml" />
</Imports>
<Modules>
<!-- Modules go here -->
</Modules>
<RootDevices>
<!-- RootDevices go here -->
</RootDevices>
</Domain>
---
### RootDevice ### RootDevice
#### DeviceInfo #### DeviceInfo
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment