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

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

5
**Version 4.0**
6

7
Note that this project runs 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 this project must comply with the aforementioned license.
AS's avatar
AS committed
10

11 12 13 14 15 16 17 18 19 20 21 22
This version contains the following changes comparing to Version 3.0:
1. Rename 'Device' to 'DeviceClass'
2. Remove 'Module' to simplify the SDT model
3. Introduced 'Product' for concrete model definition of real products.
4. Support JSON serialization
5. Support inheritance of 'DeviceClass'
6. Enum type ...
7. Data Type Facets ...
8. ...

*Editor's note: the current change log is just an examplary list (a projection), which lists some initial thoughts that the group is working on based on previous discussion. It needs to be revisited according to all implemented features before SDT4.0 publication.*

ankraft's avatar
ankraft committed
23 24
## Quick Introduction

25
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
26

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

Andreas Kraft's avatar
Andreas Kraft committed
29
## Quick Links
30 31
- ['domain.xsd' Version 4.0](SDT/schema4.0/src/domain.xsd)
- [UML Diagram of the SDT 4.0](SDT/schema4.0/docs/UML%20Diagram.md) ([source](SDT/schema4.0/docs/SDT_UML.uxf))
Andreas Kraft's avatar
Andreas Kraft committed
32 33


34
## Content
35 36 37

You can find further Information here:

38 39 40 41 42 43
- [Introduction to the SDT](SDT/schema4.0/docs/Introduction.md)
- [SDT Components](SDT/schema4.0/docs/SDT_Components.md)
- [SDT Build System](SDT/schema4.0/docs/SDT%20Build%20System.md)
- [Examples](SDT/schema4.0/docs/Examples.md) 
- [Links & References](SDT/schema4.0/docs/Links.md)
- [Changelog](SDT/schema4.0/docs/Changelog.md)
44 45
- [LICENSE](LICENSE)

46