Skip to content

GitLab

Commit fe127549 authored by Andreas Kraft's avatar Andreas Kraft
Browse files

Copied the schema and build system for version 2.0. 

Applied changes for 2.0
Started on documentation
parent 30a41d1c
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 4177 additions and 11 deletions
Links.md 0 → 100644
View file @ fe127549
# Links & References
- **HGI** : [http://www.homegatewayinitiative.org](http://www.homegatewayinitiative.org)
## XML
- **RELAX NG** : [http://relaxng.org](http://relaxng.org)
- **RELAX NG Tutorial** : [http://relaxng.org/tutorial-20011203.html](http://relaxng.org/tutorial-20011203.html)
## Tools
- **UMLet** : [http://www.umlet.com](http://www.umlet.com)
Free UML drawing tool
- **Apache Ant** : [http://ant.apache.org](http://ant.apache.org)
Build tool
README.md
View file @ fe127549
......@@ -6,12 +6,24 @@ Note that this project runs under Apache 2.0 license. Read the [LICENSE](LICENSE
Any contributions made to this project must comply with the forementioned license.
---
## Content
You can find further Information here:
- [SDT Components](SDT_Components.md)
- [FAQ](FAQ.md)
- [SDT Build System](SDT%20Build%20System.md)
- [FAQ](FAQ.md)
- [Links & References](Links.md)
- [LICENSE](LICENSE)
## Changes in 2.0
- Introduced RootDevice to handle
- Added new data types (byte, float, array, enum, date, time, datetime, blob)
- Added attributes to data points (readable, eventable)
- Added otional ``<SerialNumber>``, ``<VendorURL>`` and ``<FirmwareVersion>`` elements to DeviceInfo
- Added optional ``<Doc>`` element to Event
- Added [UML diagram](SDT_Components.md)
SDT Build System.md
View file @ fe127549
# SDT Build System
This document describes the SDT build system and how to build the SDT and validate new contributions.
The files referenced in this document point to version **2.0** of the SDT.
## Directory Structure and Important Files
- [SDT/schema/](SDT/schema/) : Base directory
- [SDT/schema/src/](SDT/schema/src/) : Source files of the SDT.
- [domain.rng](SDT/schema/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).
- [SDT/schema2.0/](SDT/schema2.0/) : Base directory
- [SDT/schema2.0/src/](SDT/schema2.0/src/) : Source files of the SDT.
- [domain.rng](SDT/schema2.0/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 one wants to make changes to the SDT!**
- [domain.xsd](SDT/schema/src/domain.xsd) : The SDT schema defintion that is generated from *domain.rng*.
- [xml.xsd](SDT/schema/src/xml.xsd) : General schema definitions for the SDT
- [SDT/schema/test/](SDT/schema/test/) : This directory contains all XML files with SDT definitions that should be validated whether they conform to the SDT schema. This could be example definitions or contributions.
- [SDT/schema/build.xml](SDT/schema/build.xml) : This is the definition file for the ant build system.
- [SDT/schema/etc/](SDT/schema/etc/), [SDT/schema/lib/](SDT/schema/lib/), [SDT/schema/style/](SDT/schema/style/) : internal directories for the build system. Please, don't make unnecessary changes to these files.
- [domain.xsd](SDT/schema2.0/src/domain.xsd) : The SDT schema defintion that is generated from *domain.rng*.
- [xml.xsd](SDT/schema2.0/src/xml.xsd) : General schema definitions for the SDT
- [SDT/schema2.0/test/](SDT/schema2.0/test/) : This directory contains all XML files with SDT definitions that should be validated whether they conform to the SDT schema. This could be example definitions or contributions.
- [SDT/schema2.0/build.xml](SDT/schema2.0/build.xml) : This is the definition file for the ant build system.
- [SDT/schema2.0/etc/](SDT/schema2.02.0/etc/), [SDT/schema2.0/lib/](SDT/schema2.0/lib/), [SDT/schema2.0/style/](SDT/schema2.0/style/) : internal directories for the build system. Please, don't make unnecessary changes to these files.
## Installation
- Install Java on your computer
......@@ -23,7 +25,7 @@ This document describes the SDT build system and how to build the SDT and valida
After cloning the repository go to the directoy *SDT/schema* and run commands depending on what you want to achieve.
### Build the Schema
Running *ant* without any parameter builds the schema definition from the rng-definition [SDT/schema/src/domain.rng](SDT/schema/src/domain.rng) and writes it to [SDT/schema/src/domain.xsd](SDT/schema/src/domain.xsd)
Running *ant* without any parameter builds the schema definition from the rng-definition [SDT/schema/src/domain.rng](SDT/schema2.0/src/domain.rng) and writes it to [SDT/schema/src/domain.xsd](SDT/schema/src/domain.xsd)
$ cd SDT/schema
$ ant
......@@ -44,3 +46,21 @@ Otherwise you most likely receive a stacktrace. Search the output for the line *
>[schemavalidate] /Users/someone/Sources/git/RWD050/SDT/schema/test/mseeb.xml:66:18: cvc-elt.1: Cannot find the declaration of element 'Domain'.
>BUILD FAILED
---
## Editing
As mentioned above, the actual schema definition is defined in the file [domain.rng](SDT/schema2.0/src/domain.rng) and converted to the XML schema definition [domain.xsd](SDT/schema2.0/src/domain.xsd) during the build process.
**All changes to the schema must therefore be made in [domain.rng](SDT/schema2.0/src/domain.rng), NOT [domain.xsd](SDT/schema2.0/src/domain.xsd) !**
You may need to make additional changes in the following files, e.g. when the name space or the version number need to be adjusted.
PLEASE ONLY EDIT THESE FILES IF NECESSARY.
- [SDT/schema2.0/build.xml](SDT/schema2.0/build.xml)
e.g. in the *ant* target "validate"
- [SDT/schema2.0/etc/dal.rnc](SDT/schema2.0/etc/dal.rnc)
e.g. the entry "default namespace xsl"
- [SDT/schema2.0/etc/schema.xmlns](SDT/schema2.0/etc/schema.xmlns)
- [SDT/schema2.0/etc/schemas.xml](SDT/schema2.0/etc/schemas.xml)
SDT/schema/test/mseeb.xml 0 → 100644
View file @ fe127549
<?xml version="1.0" encoding="iso-8859-1"?>
<!--tabstop: 4 -->
<!--
+................................................+
:Domain:org.hgi :
: :
: +..........................................+ :
: :Module:BooleanState : :
: : : :
: : +....................................+ : :
: : :Action:get : : :
: : +....................................+ : :
: : : :
: : +....................................+ : :
: : :Action:setTarget : : :
: : +....................................+ : :
: +..........................................+ :
: :
: +..........................................+ :
: :RootDevice:MSEEB.root : :
: : : :
: : +....................................+ : :
: : :Module<REF>:BooleanState : : :
: : +....................................+ : :
: : : :
: : +....................................+ : :
: : :Module:extensionBlockDataPoints : : :
: : : : : :
: : : +..............................+ : : :
: : : :DataPoint:firmwareVersion : : : :
: : : +..............................+ : : :
: : : : : :
: : : +..............................+ : : :
: : : :DataPoint:powerSwitchNames : : : :
: : : +..............................+ : : :
: : +....................................+ : :
: : : :
: : +....................................+ : :
: : :Devices : : :
: : : : : :
: : : +..............................+ : : :
: : : :Device:switch.power.1 : : : :
: : : : : : : :
: : : :+...........................+ : : : :
: : : ::Module<REF>:BooleanState : : : : :
: : : :+...........................+ : : : :
: : : +..............................+ : : :
: : : : : :
: : : +..............................+ : : :
: : : :Device:switch.power.2 : : : :
: : : : : : : :
: : : :+...........................+ : : : :
: : : ::Module<REF>:BooleanState : : : : :
: : : :+...........................+ : : : :
: : : +..............................+ : : :
: : +....................................+ : :
: +..........................................+ :
+................................................+
-->
<Domain xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://hgi.org/xml/dal/2.0"
id="org.hgi">
<Modules>
<!-- The following module should be imported from dal-core.xml.
<Imports>
<xi:include href="./dal-core.xml" parse="xml" />
</Imports>
It is included directly for tangibility.
It is still referenced in this XML via
"<extends domain="hgi.dal.core" class="BooleanState"/>"
-->
<ModuleClass name="BooleanState">
<Doc>
<tt>BooleanState</tt> is the preferred module for modelling a functionality corresponding to an underlying binary state.This module should be used to abstract away from the actual datatype and values in question. Note that the module does not define whether the execution mode is blocking or non-blocking.
</Doc>
<Actions>
<Action name="get" type="boolean">
<Doc>
Obtain the current associated state.
</Doc>
</Action>
<Action name="setTarget">
<Doc>
Set the associated state to the specified value.
</Doc>
<Arg name="value" type="boolean">
<Doc>
The desired value of the associated state.
</Doc>
</Arg>
</Action>
</Actions>
</ModuleClass>
</Modules>
<!-- Definition of the Root Device starts here. -->
<RootDevices>
<!-- The Root Device contains several sub-devices and offers one action on its own. -->
<RootDevice id="MSEEB.root">
<DeviceInfo>
<Name>Multi Socket Electrical-Extension-Block</Name>
<Vendor>HGI</Vendor>
</DeviceInfo>
<Doc>
This device is intended as a demonstration of how to define a Root Device with multiple sub-devices.
</Doc>
<!-- These are the modules for the root device:
- Switch on/off all contained switches. It inherits from hgi.dal.core.BooleanState.
- A module with some data points for the firmware version of the whole device and a list of names of the containted power switches.
-->
<Modules>
<Module name="rootPowerOnOff">
<extends domain="hgi.dal.core" class="BooleanState"/>
<Doc>
The proprietry interface for turning all switches of the extension block on and off.
The action "BooleanState:get" returns "true" when any of the sub-devices is in the state "on", otherwise it returns "false".
</Doc>
</Module>
<Module name="extensionBlockDataPoints">
<Data>
<DataPoint name="firmwareVersion"
type="String"
writeable="false">
<Doc>
This datapoint represents the firmware version of the extension block.
</Doc>
</DataPoint>
<DataPoint name="powerSwitchNames"
type="StringArray"
writeable="false">
<Doc>
This datapoint is an array of strings with the names of the contained devices.
</Doc>
</DataPoint>
</Data>
</Module>
</Modules>
<!-- Definition of sub-devices starts here. -->
<Devices>
<!-- This is the first power switch of the extension block. For sake of simplicity no new ModuleClasses are defined, but only referenced.
-->
<Device id="switch.power.1">
<DeviceInfo>
<Name>PowerSwitch 1</Name>
<Vendor>HGI</Vendor>
</DeviceInfo>
<Doc>
This sub device is intended as a demonstration of how to use the abstract modules defined in the <em>HGI Core</em> domain.
</Doc>
<Modules>
<Module name="power">
<extends domain="hgi.dal.core" class="BooleanState"/>
</Module>
</Modules>
</Device>
<!-- This is the seconcd power switch of the extension block. -->
<Device id="switch.power.2">
<DeviceInfo>
<Name>PowerSwitch 2</Name>
<Vendor>HGI</Vendor>
</DeviceInfo>
<Doc>
This sub device is intended as a demonstration of how to use the abstract modules defined in the <em>HGI Core</em> domain.
</Doc>
<Modules>
<Module name="power">
<extends domain="hgi.dal.core" class="BooleanState"/>
</Module>
</Modules>
</Device>
</Devices>
</RootDevice>
</RootDevices>
</Domain>
SDT/schema2.0/build.xml 0 → 100644
View file @ fe127549
<?xml version="1.0" encoding="UTF-8" ?>
<!-- - HGI Device Abstraction Layer - - - - - - - - - - - - - - - - - - - - -->
<!-- -->
<!-- Extends the standard build with targets for: -->
<!-- - generate XML schema the from Relax NG (xml) description -->
<!-- - validate DAL documents against the XML Schema -->
<!-- - generate HTML documentation from DAL documents -->
<project name="importing" basedir="." default="schemas">
<import file="etc/common.xml"/>
<!-- Read the namespace declarations from a file (to get linebreaks) - - - -->
<loadfile property="schema.xmlns" srcFile="${basedir}/etc/schema.xmlns"/>
<!-- The RNG file the XML and RNC schemas are generaed from - - - - - - - -->
<property name="schema.name" value="domain"/>
<property name="schema.rng" value="${path.src}/${schema.name}.rng"/>
<!-- HTML - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- -->
<!-- Generate HTML documentation from domain definitions in the test -->
<!-- directory. The module classes included via the extends tagged are -->
<!-- included in the documentation - so an xinclude capable XSL engine is -->
<!-- needed. -->
<!-- This needs Ant version 1.8+ and it must be augmented with an current -->
<!-- version of Xerces. Download the binray distribution and place the put -->
<!-- xml-apis.jar and xercesImpl.jar in the Ant lib directory. -->
<target name="html">
<mkdir dir="${path.genbase}" />
<xslt basedir="${basedir}/test" destdir="${basedir}/gen/html"
style="${basedir}/style/html.xsl">
<param name="destdir" expression="${basedir}/gen/html"/>
<sysproperty
key="org.apache.xerces.xni.parser.XMLParserConfiguration"
value="org.apache.xerces.parsers.XIncludeParserConfiguration"/>
</xslt>
</target>
<!-- Schemas - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- -->
<!-- The schema is specified using Relax NG (xml) and trang is used to -->
<!-- generate the XML schema. The schema is also generated in Relay NG -->
<!-- compact syntax, which is used by some validating editors (e.g. emacs) -->
<!-- The resulting schemas need some additional patching before thy are -->
<!-- usable -->
<target name="schemas">
<java jar="${basedir}/lib/trang.jar" fork="true">
<arg value="${schema.rng}"/>
<arg value="${basedir}/etc/${schema.name}.rnc"/>
</java>
<!-- So that the editor does not complain about include directives, the -->
<!-- resulting schema is included in another schema, which includes the -->
<!-- necessary element definitions. To be able to do this the -->
<!-- definition for Imports must be deleted from this generated schema. -->
<replace file="${basedir}/etc/${schema.name}.rnc"
token="Imports = element Imports { Domain* }?" value=""/>
<java jar="${basedir}/lib/trang.jar" fork="true">
<arg value="${schema.rng}"/>
<arg value="${path.src}/${schema.name}.xsd"/>
</java>
<!-- Can't validate against the generated schema unless we add the -->
<!-- target and default namespaces ... -->
<replace file='${path.src}/domain.xsd'
token='xmlns:xs="http://www.w3.org/2001/XMLSchema"'
value='${schema.xmlns}'/>
<!-- In addition the xml:base tag, which is added automatically when -->
<!-- including a document, must also be permitted by out schema. -->
<!-- The schema generated from RNG is almost correct schema ... but -->
<!-- the schemaLocation is wrong. -->
<replace file='${path.src}/domain.xsd'
token="xml.xsd" value="http://www.w3.org/2001/03/xml.xsd"/>
</target>
<!-- Validate - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- -->
<!-- Check the Device Description conforms to the Device Abstraction -->
<!-- Schema. Note that we need to activate support for XML includes -->
<target name="validate" depends="">
<schemavalidate warn="true">
<fileset dir="${basedir}/test" includes="*.xml"/>
<attribute name="http://apache.org/xml/features/xinclude" value="true"/>
<schema namespace="http://hgi.org/xml/dal/2.0"
file="${path.src}/domain.xsd" />
<schema namespace="http://www.w3.org/2001/XInclude"
file="${basedir}/etc/XInclude.xsd" />
<schema namespace="http://www.w3.org/2001/XMLSchema"
file="${basedir}/etc/XMLSchema.xsd" />
</schemavalidate>
</target>
</project>
SDT/schema2.0/etc/XInclude.xsd 0 → 100644
View file @ fe127549
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xi="http://www.w3.org/2001/XInclude"
targetNamespace="http://www.w3.org/2001/XInclude"
finalDefault="extension">
<xs:annotation>
<xs:documentation>
Not normative, but may be useful.
See the REC http://www.w3.org/TR/XInclude for definitive
information about this namespace.
</xs:documentation>
</xs:annotation>
<xs:element name="include" type="xi:includeType" />
<xs:complexType name="includeType" mixed="true">
<xs:choice minOccurs='0' maxOccurs='unbounded' >
<xs:element ref='xi:fallback' />
<xs:any namespace='##other' processContents='lax' />
<xs:any namespace='##local' processContents='lax' />
</xs:choice>
<xs:attribute name="href" use="optional" type="xs:anyURI"/>
<xs:attribute name="parse" use="optional" default="xml"
type="xi:parseType" />
<xs:attribute name="xpointer" use="optional" type="xs:string"/>
<xs:attribute name="encoding" use="optional" type="xs:string"/>
<xs:attribute name="accept" use="optional" type="xs:string"/>
<xs:attribute name="accept-language" use="optional" type="xs:string"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:simpleType name="parseType">
<xs:restriction base="xs:token">
<xs:enumeration value="xml"/>
<xs:enumeration value="text"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="fallback" type="xi:fallbackType" />
<xs:complexType name="fallbackType" mixed="true">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="xi:include"/>
<xs:any namespace="##other" processContents="lax"/>
<xs:any namespace="##local" processContents="lax"/>
</xs:choice>
<xs:anyAttribute namespace="##other" processContents="lax" />
</xs:complexType>
</xs:schema>
SDT/schema2.0/etc/XMLSchema-datatypes.xsd 0 → 100644
View file @ fe127549
<?xml version='1.0'?>
<!-- XML Schema schema for XML Schemas: Part 2: Datatypes -->
<!DOCTYPE schema PUBLIC "-//W3C//DTD XMLSCHEMA 200102//EN" "XMLSchema.dtd" [
<!ENTITY % s ''>
<!ENTITY % p ''>
]>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.w3.org/2001/XMLSchema-datatypes"
version="$Id: XMLSchema-datatypes.xsd,v 1.5 2001/03/16 20:53:32 ht Exp $">
<annotation>
<documentation>Note this schema is NOT a normative schema - -
It contains types derived from all the builtin simple type definitions
with the same local name but in a distinct namespace, for use
by applications which do no wish to import the full XMLSchema
schema. Since derivation is not symmetric, unexpected results may
follow from mixing references to these definitions with references
to the definitions in the XMLSchema namespace. For example,
although dt:positiveInteger is derived from xs:integer, the converse
does not hold.</documentation>
</annotation>
<simpleType name="string">
<restriction base="string"/>
</simpleType>
<simpleType name="boolean">
<restriction base="boolean"/>
</simpleType>
<simpleType name="float">
<restriction base="float"/>
</simpleType>
<simpleType name="double">
<restriction base="double"/>
</simpleType>
<simpleType name="decimal">
<restriction base="decimal"/>
</simpleType>
<simpleType name="dateTime">
<restriction base="dateTime"/>
</simpleType>
<simpleType name="duration">
<restriction base="duration"/>
</simpleType>
<simpleType name="hexBinary">
<restriction base="hexBinary"/>
</simpleType>
<simpleType name="base64Binary">
<restriction base="base64Binary"/>
</simpleType>
<simpleType name="anyURI">
<restriction base="anyURI"/>
</simpleType>
<simpleType name="ID">
<restriction base="ID"/>
</simpleType>
<simpleType name="IDREF">
<restriction base="IDREF"/>
</simpleType>
<simpleType name="ENTITY">
<restriction base="ENTITY"/>
</simpleType>
<simpleType name="NOTATION">
<restriction base="NOTATION"/>
</simpleType>
<simpleType name="normalizedString">
<restriction base="normalizedString"/>
</simpleType>
<simpleType name="token">
<restriction base="token"/>
</simpleType>
<simpleType name="language">
<restriction base="language"/>
</simpleType>
<simpleType name="IDREFS">
<restriction base="IDREFS"/>
</simpleType>
<simpleType name="ENTITIES">
<restriction base="ENTITIES"/>
</simpleType>
<simpleType name="NMTOKEN">
<restriction base="NMTOKEN"/>
</simpleType>
<simpleType name="NMTOKENS">
<restriction base="NMTOKENS"/>
</simpleType>
<simpleType name="Name">
<restriction base="Name"/>
</simpleType>
<simpleType name="QName">
<restriction base="QName"/>
</simpleType>
<simpleType name="NCName">
<restriction base="NCName"/>
</simpleType>
<simpleType name="integer">
<restriction base="integer"/>
</simpleType>
<simpleType name="nonNegativeInteger">
<restriction base="nonNegativeInteger"/>
</simpleType>
<simpleType name="positiveInteger">
<restriction base="positiveInteger"/>
</simpleType>
<simpleType name="nonPositiveInteger">
<restriction base="nonPositiveInteger"/>
</simpleType>
<simpleType name="negativeInteger">
<restriction base="negativeInteger"/>
</simpleType>
<simpleType name="byte">
<restriction base="byte"/>
</simpleType>
<simpleType name="int">
<restriction base="int"/>
</simpleType>
<simpleType name="long">
<restriction base="long"/>
</simpleType>
<simpleType name="short">
<restriction base="short"/>
</simpleType>
<simpleType name="unsignedByte">
<restriction base="unsignedByte"/>
</simpleType>
<simpleType name="unsignedInt">
<restriction base="unsignedInt"/>
</simpleType>
<simpleType name="unsignedLong">
<restriction base="unsignedLong"/>
</simpleType>
<simpleType name="unsignedShort">
<restriction base="unsignedShort"/>
</simpleType>
<simpleType name="date">
<restriction base="date"/>
</simpleType>
<simpleType name="time">
<restriction base="time"/>
</simpleType>
<simpleType name="gYearMonth">
<restriction base="gYearMonth"/>
</simpleType>
<simpleType name="gYear">
<restriction base="gYear"/>
</simpleType>
<simpleType name="gMonthDay">
<restriction base="gMonthDay"/>
</simpleType>
<simpleType name="gDay">
<restriction base="gDay"/>
</simpleType>
<simpleType name="gMonth">
<restriction base="gMonth"/>
</simpleType>
</schema>
SDT/schema2.0/etc/XMLSchema.dtd 0 → 100644
View file @ fe127549
<!-- DTD for XML Schemas: Part 1: Structures
Public Identifier: "-//W3C//DTD XMLSCHEMA 200102//EN"
Official Location: http://www.w3.org/2001/XMLSchema.dtd -->
<!-- $Id: XMLSchema.dtd,v 1.31 2001/10/24 15:50:16 ht Exp $ -->
<!-- Note this DTD is NOT normative, or even definitive. --> <!--d-->
<!-- prose copy in the structures REC is the definitive version --> <!--d-->
<!-- (which shouldn't differ from this one except for this --> <!--d-->
<!-- comment and entity expansions, but just in case) --> <!--d-->
<!-- With the exception of cases with multiple namespace