mseeb.xml 8.61 KB
Newer Older
ankraft's avatar
ankraft committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
<?xml version="1.0" encoding="iso-8859-1"?>

<!--tabstop: 4 -->

<!--

+................................................+
:Domain:org.homegatewayinitiative                                  :
:                                                :
:  +..........................................+  :
:  :Module:BooleanState                       :  :
:  :                                          :  :
:  :  +....................................+  :  :
:  :  :Action:get                          :  :  :
:  :  +....................................+  :  :
:  :                                          :  :
:  :  +....................................+  :  :
:  :  :Action:setTarget                    :  :  :
:  :  +....................................+  :  :
:  +..........................................+  :
:                                                :
:  +..........................................+  :
:  :Device:MSEEB.root                         :  :
:  :                                          :  :
:  :  +....................................+  :  :
:  :  :Module<REF>:BooleanState            :  :  :
:  :  +....................................+  :  :
:  :                                          :  :
:  :  +....................................+  :  :
:  :  :Module:extensionBlockDataPoints     :  :  :
:  :  :                                    :  :  :
:  :  :  +..............................+  :  :  :
:  :  :  :DataPoint:firmwareVersion     :  :  :  :
:  :  :  +..............................+  :  :  :
:  :  :                                    :  :  :
:  :  :  +..............................+  :  :  :
:  :  :  :DataPoint:powerSwitchNames    :  :  :  :
:  :  :  +..............................+  :  :  :
:  :  +....................................+  :  :
:  :                                          :  :
:  :  +....................................+  :  :
:  :  :SubDevices                          :  :  :
:  :  :                                    :  :  :
:  :  :  +..............................+  :  :  :
:  :  :  :SubDevice:switch.power.1      :  :  :  :
:  :  :  :                              :  :  :  :
:  :  :  :+...........................+ :  :  :  :
:  :  :  ::Module<REF>:BooleanState   : :  :  :  :
:  :  :  :+...........................+ :  :  :  :
:  :  :  +..............................+  :  :  :
:  :  :                                    :  :  :
:  :  :  +..............................+  :  :  :
:  :  :  :SubDevice:switch.power.2      :  :  :  :
:  :  :  :                              :  :  :  :
:  :  :  :+...........................+ :  :  :  :
:  :  :  ::Module<REF>:BooleanState   : :  :  :  :
:  :  :  :+...........................+ :  :  :  :
:  :  :  +..............................+  :  :  :
:  :  +....................................+  :  :
:  +..........................................+  :
+................................................+

-->
<Domain xmlns:xi="http://www.w3.org/2001/XInclude"
    xmlns="http://homegatewayinitiative.org/xml/dal/3.0" 
    id="org.homegatewayinitiative">

<!-- The following import statements include ModuleClasses from HGI -->

    <Imports>
        <xi:include href="./dal-core.xml" parse="xml" />
    </Imports>

    <Modules>
        <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" optional="true">
                    <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">
                        <DataType>
                            <PrimitiveDataType type="boolean" />
                        </DataType>
                        <Doc>
                        The desired value of the associated state.
                        </Doc>
                    </Arg>
                </Action>
          </Actions>
          <Events>
                <Event name="stateChanged" optional="true">
                    <Data>
                        <DataPoint name="state" optional="true" type="boolean">
                        </DataPoint>
                    </Data>
                </Event>      
          </Events>
        </ModuleClass>
    </Modules>

<!-- Definition of the Device starts here. -->

    <Devices>

<!-- The Device contains several sub-devices and offers one action on its own. -->

        <Device id="MSEEB.root">
            <DeviceInfo>
                <Name>Multi Socket Electrical-Extension-Block</Name>
                <Vendor>HGI</Vendor>
                <FirmwareVersion>1.0</FirmwareVersion>
                <VendorURL>http://www.homegatewayinitative.org</VendorURL>
                <SerialNumber>1234.5</SerialNumber>
            </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 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" optional="true">
                    <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" 
                                    writable="false">
                            <Doc>
                                This datapoint represents the firmware version of the extension block.
                            </Doc>
                        </DataPoint>
                        
                        <DataPoint  name="powerSwitchNames"
                                    type="array"
                                    writable="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. -->

            <SubDevices>

<!-- This is the first power switch of the extension block. For sake of simplicity no new ModuleClasses are defined, but only referenced.
-->

                <SubDevice 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>
                </SubDevice>

<!-- This is the second power switch of the extension block. -->

                <SubDevice 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>
                </SubDevice>

            </SubDevices>

        </Device>
    </Devices>
</Domain>