mseeb.xml 13.4 KB
Newer Older
1 2 3 4 5 6 7
<?xml version="1.0" encoding="iso-8859-1"?>

<!--tabstop: 4 -->

<!--

+................................................+
8
:Domain:org.onem2m                               :
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
:                                                :
:  +..........................................+  :
:  :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"
65 66
    xmlns="http://www.onem2m.org/xml/sdt/4.0" 
    id="org.onem2m">
67 68 69 70 71 72 73

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

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

74
    <ModuleClasses>
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
        <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" optional="true">
                    <Doc>
                        Obtain the current associated state.
                    </Doc>
                    <DataType>
                        <SimpleType type="boolean" />
                    </DataType>
                </Action>
                <Action name="setTarget">
                    <Doc>
                        Set the associated state to the specified value.
                    </Doc>
                    <Args>
                        <Arg name="value">
                            <Doc>
                            The desired value of the associated state.
                            </Doc>
                            <DataType>
                                <SimpleType type="boolean" />
                            </DataType>
                        </Arg>
                    </Args>
                </Action>
          </Actions>
          <Events>
                <Event name="stateChanged" optional="true">
                    <Data>
                        <DataPoint name="state" readable="true">
                            <DataType>
                        		<SimpleType type="boolean" />
                            </DataType>
                        </DataPoint>
                    </Data>
                </Event>      
          </Events>
        </ModuleClass>
116
    </ModuleClasses>
117 118 119

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

120
    <DeviceClasses>
121 122 123

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

124
        <DeviceClass id="MSEEB.root">
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
            <Doc>
                This device is intended as a demonstration of how to define a Root Device with multiple sub-devices.
            </Doc>
            <Properties>
                <Property name="Name">
                    <Doc>Original value: Multi Socket Electrical-Extension-Block</Doc>
                    <SimpleType type="string" />
                </Property>
                <Property name="Vendor">
                    <Doc>Original value: HGI</Doc>
                    <SimpleType type="string" />
                </Property>
                <Property name="FirmwareVersion">
                  <Doc>Original value: 1.0</Doc>
                  <SimpleType type="string" />
                </Property>
                <Property name="VendorURL">
142
                  <Doc>Original value: http://www.onem2m.org</Doc>
143 144 145 146 147 148 149 150 151 152 153 154 155
                  <SimpleType type="uri" />
                </Property>
                <Property name="SerialNumber">
                  <Doc>Original value: 1234.5</Doc>
                  <SimpleType type="string" />
                </Property>
            </Properties>

<!-- 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.
-->

156 157
            <ModuleClasses>
                <ModuleClass name="rootPowerOnOff" optional="true">
158 159 160 161
                    <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>
162
                    <Extend domain="hgi.dal.core" entity="BooleanState"/>
163 164 165 166 167 168
                    <Properties>
                        <Property name="version" value="1.0.0">
                            <Doc>Version for this ModuleClass</Doc>
                            <SimpleType type="string" />
                        </Property>
                    </Properties>
169 170
                </ModuleClass>
                <ModuleClass name="power">
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
                    <Actions>
                    	<Action name="getPowerConsumption">
                            <Doc>Get the power consumption.</Doc>
                            <DataType name="consumption">
                    			<Struct>
                                    <DataType name="values">
                        				<Array>
                                           <DataType>
                                                <Doc>This is an example simple data type with a minimum-value constraint.</Doc>
                            					<SimpleType type="float" />
                                                <Constraints>
                                                    <Constraint name="minValue" type="float" value="0.0">
                                                        <Doc>The value must be equal or greater 0.0</Doc>
                                                    </Constraint>
                                                      <Constraint name="step" type="float" value="0.1">
                                                        <Doc>Steps are 0.1</Doc>
                                                    </Constraint>
                                                </Constraints>
                                            </DataType>
                				        </Array>
                                    </DataType>
                                    <DataType name="timeFrame">
                        				<Array>
                                            <DataType>
                            					<SimpleType type="datetime" />
                                            </DataType>
                				        </Array>
                                    </DataType>
                                </Struct>
                            </DataType>
                    	</Action>
                    </Actions>
203
                </ModuleClass>
204

205
                <ModuleClass name="extensionBlockDataPoints">
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
                    <Actions>
                        <Action name="getNames">
                            <DataType name="names">
                                <Array>
                                    <DataType>
                                        <SimpleType type="string" />
                                    </DataType>
                                </Array>
                            </DataType>
                        </Action>
                    </Actions>
                    <Data>
                        <DataPoint  name="firmwareVersion" 
                                    writable="false"
                                    readable="true">
                            <Doc>
                                This datapoint represents the firmware version of the extension block.
                            </Doc>
                            <DataType>
                                <SimpleType type="string" />
                            </DataType>
                        </DataPoint>
                        
                        <DataPoint  name="powerSwitchNames"
                                    writable="false"
                                    readable="true">
                            <Doc>
                                This datapoint is an array of strings with the names of the contained devices.
                            </Doc>
                            <DataType>
                                <Array>
                                    <DataType>
                                        <SimpleType type="string" />
                                    </DataType>
                                </Array>
                            </DataType>
                        </DataPoint>
                    </Data>
244 245
                </ModuleClass>
            </ModuleClasses>
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

<!-- 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">
                    <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>
                    <Properties>
                        <Property name="Name" value="PowerSwitch 1">
                            <SimpleType type="string" />
                        </Property>
                        <Property name="Vendor" value="HGI">
                            <SimpleType type="string" />
                        </Property>
                    </Properties>
266 267
                    <ModuleClasses>
                        <ModuleClass name="power">
268
                            <Extend domain="hgi.dal.core" entity="BooleanState"/>
269 270
                        </ModuleClass>
                    </ModuleClasses>
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
                </SubDevice>

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

                <SubDevice id="switch.power.2">
                    <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>
                    <Properties>
                        <Property name="Name" value="PowerSwitch 2">
                            <SimpleType type="string" />
                        </Property>
                        <Property name="Vendor" value="HGI">
                            <SimpleType type="string" />
                        </Property>
286
                        <Property name="VendorURL" value="http://www.onem2m.org">
287 288 289 290 291 292
                            <SimpleType type="uri" />
                        </Property>
                        <Property name="maximumAltitude" value="2800">
                            <SimpleType type="integer" />
                        </Property>
                    </Properties>
293 294
                    <ModuleClasses>
                        <ModuleClass name="power">
295
                            <Extend domain="hgi.dal.core" entity="BooleanState"/>
296 297
                        </ModuleClass>
                    </ModuleClasses>
298 299 300 301
                </SubDevice>

            </SubDevices>

302 303
        </DeviceClass>
    </DeviceClasses>
304
</Domain>