README.md 2.27 KB
Newer Older
ankraft's avatar
ankraft committed
1
# Smart Device Template
sayegh's avatar
sayegh committed
2

3
Repository and documentation for the Smart Device Template (SDT).
AS's avatar
2  
AS committed
4

5
**Version 4.0**
6

7
The Smart Device Template is available under the 3-Clause BSD License. Read the [LICENSE](LICENSE) in this repository, or refer to  [https://opensource.org/licenses/BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause).
AS's avatar
2  
AS committed
8

9
Any contributions made to the Smart Device Template format must comply with the aforementioned license. Models defined by using the Smart Device Template can be published under different licenses.
AS's avatar
AS committed
10

ankraft's avatar
ankraft committed
11 12
## Quick Introduction

13 14 15
![](SDT/schema4.0/docs/images/SDT_simplified.png)

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.
ankraft's avatar
ankraft committed
16

17
[Read the full Introduction.](SDT/schema4.0/docs/Introduction.md)
ankraft's avatar
ankraft committed
18

Andreas Kraft's avatar
Andreas Kraft committed
19
## Quick Links
ankraft's avatar
ankraft committed
20
- [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.
21 22
- ['domain.xsd' Version 4.0](SDT/schema4.0/src/domain.xsd) : This is the XSD schema file that defines the SDT XML Schema.

Andreas Kraft's avatar
Andreas Kraft committed
23

24
## Documentation
Andreas Kraft's avatar
Andreas Kraft committed
25

Andreas Kraft's avatar
Andreas Kraft committed
26 27
You can find further Information here:

28 29
- [Introduction to the SDT](SDT/schema4.0/docs/Introduction.md)
- [SDT Components](SDT/schema4.0/docs/SDT_Components.md)
ankraft's avatar
ankraft committed
30
- [JSON Serialization](SDT/schema4.0/docs/SDT_JSON.md)
31
- [Examples](SDT/schema4.0/docs/Examples.md) 
32 33 34
- [SDT Build System](SDT/schema4.0/docs/SDT%20Build%20System.md)

## Further Readings
35
- [Links & References](SDT/schema4.0/docs/Links.md)
ankraft's avatar
ankraft committed
36
- [FAQ](SDT/schema4.0/docs/FAQ.md)
37
- [Changelog](SDT/schema4.0/docs/Changelog.md)
ankraft's avatar
ankraft committed
38
- [SDT Build System Components and Licenses](SDT/schema4.0/docs/SDT%20Build%20System%20Components%20and%20Licenses.md)
Andreas Kraft's avatar
Andreas Kraft committed
39 40
- [LICENSE](LICENSE)

41