_________________________________________________________
i.LON100's general declaration of types and enumerations.
The declarations are used for the SOAP interface.
_________________________________________________________
It is prohibited to change any declaration in this file!
Copyright 2007 Echelon Corporation
http://www.echelon.com
_________________________________________________________
THIS SECTION DESCRIBES THE XSD-SCHEMA TYPES VIEW
________________________________________________________________________________________________________________
xsi:type name constraint : [specialized{LON;MOD;..}]_[Layer{Channel;FB;DP;UFPT;..}]_[Meta]_[Cfg or Data]
[gen] shortened [generalized]: a common Item for any specialized Item in the same Layer [Channel;FB;DP;..]
[spc] shortened [specialized]: a specialized Item in a Layer [Channel;FB;DP;..]
[svc] shortened [service] : an Item which provides a service [WebBinder;FileSystem;..]
[abstract] : this Item is decalred but doesn't exist (can't be instantiated)
[L;G;S;D;R;W;C;I] shortened : soap-operations L(ist); G(et); S(et); D(elete); R(ead); W(rite); C(lear); (I)nvoke
________________________________________________________________________________________________________________
Item [xsd-general base type]
|
|
+-- Item_Service [svc] (the Item type for a service [svc] responses)
|
|
| ________________________________________________________________________________
+-- Item_Cfg --+-- Network_Cfg [gen] [L;G;D]
| +-- LON_Network_Cfg [spc] [L;G;S;D]
| +-- MOD_Network_Cfg [spc] [L;G;S;D]
| +-- MBS_Network_Cfg [spc] [L;G;S;D]
| +-- Virtual_Network_Cfg [spc] [L;G;S;D]
| |
| | ________________________________________________________________________________
| +-- Channel_Cfg [gen] [L;G;S;D]
| +-- LON_Channel_Cfg [spc] [L;G;S;D]
| +-- MOD_Channel_Cfg [spc] [L;G;S;D]
| +-- MBS_Channel_Cfg [spc] [L;G;S;D]
| +-- Virtual_Channel_Cfg [spc] [L;G;S;D]
| |
| | ________________________________________________________________________________
| +-- Device_Cfg [gen]
| +-- LON_Device_Cfg [spc] --+-- LON_Device_NetworkInterface_Cfg [L;G;S;D]
| | +-- LON_Device_RNI_Cfg [L;G;S;D]
| | +-- LON_Device_Router_Cfg [L;G;S;D]
| +-- MOD_Device_Cfg [spc] [L;G;S;D]
| +-- MBS_Device_Cfg [spc] [L;G;S;D]
| +-- Virtual_Device_Cfg [spc] [L;G;S;D]
| |
| | ________________________________________________________________________________
| +-- Fb_Cfg [gen] --+-- UFPTalarmGenerator_Cfg [L;G;S;D]
| | +-- UFPTalarmNotifier_Cfg [L;G;S;D]
| | +-- UFPTanalogFunctionBlock_Cfg [L;G;S;D]
| | +-- UFPTcalendar_Cfg [L;G;S;D]
| | +-- UFPTdataLogger_Cfg [L;G;S;D]
| | +-- UFPTdigitalInput_Cfg [L;G;S;D]
| | +-- UFPTdigitalOutput_Cfg [L;G;S;D]
| | +-- UFPTnodeObject_Cfg [L;G;S;D]
| | +-- UFPTpulseCounter_Cfg [L;G;S;D]
| | +-- UFPTrealTimeClock_Cfg [L;G;S;D]
| | +-- UFPTscheduler_Cfg [L;G;S;D]
| | +-- UFPTtypeTranslator_Cfg [L;G;S;D]
| | +-- UFPTtypeTranslator_Rule_Cfg [L;G;S;D]
| | +-- FPM_Cfg [L;G;S;D]
| +-- LON_Fb_Cfg [spc] [L;G;S;D]
| +-- MOD_Fb_Cfg [spc] [L;G;S;D]
| +-- MBS_Fb_Cfg [spc] [L;G;S;D]
| +-- Virtual_Fb_Cfg [spc] [L;G;S;D]
| |
| | ________________________________________________________________________________
| +-- Dp_Cfg [gen] [L;G;S;D]
| +-- LON_Dp_Cfg [spc] [L;G;S;D]
| +-- LON_Cp_File_Cfg [spc] [L;G;S;D]
| +-- LON_Cp_Dp_Cfg [spc] [L;G;S;D]
| +-- MOD_Dp_Cfg [spc] [L;G;S;D]
| +-- MBS_Dp_Cfg [spc] [L;G;S;D]
| +-- Virtual_Dp_Cfg [spc] [L;G;S;D]
| |
| | ================================================================================
| +-- Dp_Ref [svc] [L;G;S;D]
| +-- FileSystem_Cfg [svc] [L;G]
| +-- TemplateManager_Cfg [svc] --+-- TemplateManager_FILE_Cfg [L;G;D]
| +-- TemplateManager_NVT_Cfg [L;G;D]
| +-- TemplateManager_CPT_Cfg [L;G;D]
| +-- TemplateManager_ENUM_Cfg [L;G;D]
| +-- TemplateManager_FPT_Cfg [L;G;D]
| +-- TemplateManager_Surrogate_Cfg [L;G;S;D]
|
| ________________________________________________________________________________
+------------------- LON_Device_Command_Invoke [I]
+------------------- LON_Network_Command_Invoke [I]
+-- Item_Data --+-- LON_Device_StatusData_InvokeResponse [I-Resp]
| +-- LON_Device_RepeatingData_InvokeResponse [I-Resp]
| +-- LON_Device_PowerlineData_InvokeResponse [I-Resp]
| +-- LON_Device_ProxyData_InvokeResponse [I-Resp]
| |
| | ________________________________________________________________________________
| +-- Fb_Data [gen] --+-- UFPTalarmNotifier_Data [Dp_Data] [R;W;C]
| | +-- UFPTalarmNotifier_Meta_Data [R-Resp]
| | +-- UFPTalarmNotifier_ClearResponse [C-Resp]
| | +-- UFPTdataLogger_Data [Dp_Data] [R;C]
| | +-- UFPTdataLogger_Meta_Data [R-Resp]
| | +-- UFPTdataLogger_ClearResponse [C-Resp]
| | +-- UFPTcalendar_Data [R]
| | +-- UFPTrealTimeClock_Data [R]
| | +-- UFPTscheduler_Data [Dp_Data] [R]
| | +-- UFPTscheduler_Meta_Data [Resp]
| | +-- UFPTscheduler_Calendar_Meta_Data [R]
| | +-- UFPTscheduler_Calendar_Request_Data [R]
| | +-- UFPTscheduler_RealTimeClock_Meta_Data [R]
| | +-- UFPTscheduler_RealTimeClock_Request_Data [R]
| | +-- UFPTscheduler_ListSchedules_Invoke [I]
| | +-- UFPTscheduler_ListSchedules_InvokeResponse [I-Resp]
| |
| | ________________________________________________________________________________
| +-- Dp_Data [gen] [R;W;C]
+----------------|-- Dp_ResetPrio_Invoke [I]
| |
| | ================================================================================
| +-- FileSystem_Data [svc] [L;R;W;D]
| +-- TemplateManager_Data_Invoke [svc] [I]
| +-- TemplateManager_Data_InvokeResponse [svc] [I-Resp]
THIS SECTION DESCRIBES THE XML-DOCUMENT VIEW (important for defining 'xSelect' statements)
________________________________________________________________________________________________________________
The iLon100 e4 supports 'xSelect' statements which are used as a request filter.
'xSelect' is "geared to the xPath" expressions and can contain any 'Item'-'xsi:type' as well (see tree below).
The operation 'List' supports only the 'xSelect' statement. All corresponding Item-instances will always return
the 'base type'-'Item' (or exceptionally 'Item_Service' which are derived from 'base type'-'Item').
The operations 'Get', 'Read', 'Delete' and 'Clear' can be called with:
- the 'xSelect' statement. All corresponding Item-instances will be affected.
- and/or a collection of Items. All corresponding Item-instances (with same UCPTname) will be affected.
In this case the 'xSelect' statement will be logically ANDed with the Item-instances' UCPTname.
Each declared xsd:type with the base type 'Item' contains at least one 'xSelect'-example.
Please IGNORE the tag , only the 'xSelect' statement inside is important.
Any example can be appended with:
1. a 'UCPTlastUpdate' expression
="2007-01-15T15:30:21Z" and UCPTlastUpdate<"2007-02-11T15:30:21Z"]")
]]>
2. a 'position()' expression
10 and position()<30]")
]]>
________________________________________________________________________________________________________________
[xml-tag] -------+-- [xml-tag attribute 'xsi:type']
Item ------------+ ["Item" itself has none attribute 'xsi:type'] [gen/spc]
. |
. +-- @xsi:type="Item_Service" [svc]
. |
. | ================================================================================
. +-- @xsi:type="Item_Cfg" [gen/spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Network_Cfg" [gen]
. +-- @xsi:type="LON_Network_Cfg" [spc]
. +-- @xsi:type="MOD_Network_Cfg" [spc]
. +-- @xsi:type="MBS_Network_Cfg" [spc]
. +-- @xsi:type="Virtual_Network_Cfg" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Channel_Cfg" [gen]
. +-- @xsi:type="LON_Channel_Cfg" [spc]
. +-- @xsi:type="MOD_Channel_Cfg" [spc]
. +-- @xsi:type="MBS_Channel_Cfg" [spc]
. +-- @xsi:type="Virtual_Channel_Cfg" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Device_Cfg" [gen]
. +-- @xsi:type="LON_Device_Cfg" [spc]
. +-- @xsi:type="LON_Device_NetworkInterface_Cfg" [spc]
. +-- @xsi:type="LON_Device_RNI_Cfg" [spc]
. +-- @xsi:type="LON_Device_Router_Cfg" [spc]
. +-- @xsi:type="MOD_Device_Cfg" [spc]
. +-- @xsi:type="MBS_Device_Cfg" [spc]
. +-- @xsi:type="Virtual_Device_Cfg" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Fb_Cfg" [gen]
. +-- @xsi:type="UFPTalarmGenerator_Cfg" [gen]
. +-- @xsi:type="UFPTalarmNotifier_Cfg" [gen]
. +-- @xsi:type="UFPTanalogFunctionBlock_Cfg" [gen]
. +-- @xsi:type="UFPTcalendar_Cfg" [gen]
. +-- @xsi:type="UFPTdataLogger_Cfg" [gen]
. +-- @xsi:type="UFPTdigitalInput_Cfg" [gen]
. +-- @xsi:type="UFPTdigitalOutput_Cfg" [gen]
. +-- @xsi:type="UFPTnodeObject_Cfg" [gen]
. +-- @xsi:type="UFPTpulseCounter_Cfg" [gen]
. +-- @xsi:type="UFPTrealTimeClock_Cfg" [gen]
. +-- @xsi:type="UFPTscheduler_Cfg" [gen]
. +-- @xsi:type="UFPTtypeTranslator_Cfg" [gen]
. +-- @xsi:type="UFPTtypeTranslator_Rule_Cfg" [gen]
. +-- @xsi:type="FPM_Cfg" [gen]
. +-- @xsi:type="LON_Fb_Cfg" [spc]
. +-- @xsi:type="MOD_Fb_Cfg" [spc]
. +-- @xsi:type="MBS_Fb_Cfg" [spc]
. +-- @xsi:type="Virtual_Fb_Cfg" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Dp_Cfg" [gen]
. +-- @xsi:type="LON_Dp_Cfg" [spc]
. +-- @xsi:type="LON_Cp_File_Cfg" [spc]
. +-- @xsi:type="LON_Cp_Dp_Cfg" [spc]
. +-- @xsi:type="MOD_Dp_Cfg" [spc]
. +-- @xsi:type="MBS_Dp_Cfg" [spc]
. +-- @xsi:type="Virtual_Dp_Cfg" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Dp_Ref" [gen]
. +-- @xsi:type="FileSystem_Cfg" [svc]
. +-- @xsi:type="TemplateManager_Cfg" [svc]
. +-- @xsi:type="TemplateManager_FILE_Cfg" [svc]
. +-- @xsi:type="TemplateManager_NVT_Cfg" [svc]
. +-- @xsi:type="TemplateManager_CPT_Cfg" [svc]
. +-- @xsi:type="TemplateManager_ENUM_Cfg" [svc]
. +-- @xsi:type="TemplateManager_FPT_Cfg" [svc]
. +-- @xsi:type="TemplateManager_Surrogate_Cfg" [svc]
. +-- @xsi:type="TemplateManager_Data_Invoke" [svc]
. +-- @xsi:type="TemplateManager_Data_InvokeResponse" [svc]
. |
. | ================================================================================
. +-- @xsi:type="Item_Data" [gen/spc]
. | ________________________________________________________________________________
. +-- @xsi:type="LON_Device_StatusData_InvokeResponse" [spc]
. +-- @xsi:type="LON_Device_RepeatingData_InvokeResponse" [spc]
. +-- @xsi:type="LON_Device_PowerlineData_InvokeResponse" [spc]
. +-- @xsi:type="LON_Device_ProxyData_InvokeResponse" [spc]
. | ________________________________________________________________________________
. +-- @xsi:type="Fb_Data" [gen]
. +-- @xsi:type="UFPTalarmNotifier_Data" [gen]
. +-- @xsi:type="UFPTalarmNotifier_Meta_Data" [gen]
. +-- @xsi:type="UFPTalarmNotifier_ClearResponse" [gen]
. +-- @xsi:type="UFPTdataLogger_Data" [gen]
. +-- @xsi:type="UFPTdataLogger_Meta_Data" [gen]
. +-- @xsi:type="UFPTdataLogger_ClearResponse" [gen]
. +-- @xsi:type="UFPTcalendar_Data" [gen]
. +-- @xsi:type="UFPTrealTimeClock_Data" [gen]
. +-- @xsi:type="UFPTscheduler_Data" [gen]
. +-- @xsi:type="UFPTscheduler_Meta_Data" [gen]
. +-- @xsi:type="UFPTscheduler_Calendar_Meta_Data" [gen]
. +-- @xsi:type="UFPTscheduler_Calendar_Request_Data" [gen]
. +-- @xsi:type="UFPTscheduler_RealTimeClock_Meta_Data" [gen]
. +-- @xsi:type="UFPTscheduler_RealTimeClock_Request_Data" [gen]
. +-- @xsi:type="UFPTscheduler_ListSchedules_Invoke" [gen]
. +-- @xsi:type="UFPTscheduler_ListSchedules_InvokeResponse" [gen]
. | ________________________________________________________________________________
. +-- @xsi:type="Dp_Data" [gen]
. +-- @xsi:type="Dp_ResetPrio_Invoke" [gen]
. | ________________________________________________________________________________
. +-- @xsi:type="FileSystem_Data" [svc]
THIS SECTION DESCRIBES THE LOGICAL INTERPRETATION OF THE XML-ITEM INSTANCES
________________________________________________________________________________________________________________
1. iLon100 e4 supports only one Network which contains a unbounded count of Channel-, Device-, Fb- and Dp-Items.
2. The Network-, Channel-, Device-, Fb- and Dp-Items are not orgonized in a structure, but they are loosely
coupled according the naming convention UCPTname="NetworkName/ChannelName/DeviceName/FbName/DpName"
3. All other Items are a Service. They have no further dependencies.
________________________________________________________________________________________________________________
[..]
|
+-- Network --+
| /
| +--Channel --+
| /
| +-- Device --+
| /
| +-- Fb --+
| /
| +-- Dp
|
+-- Service ---+-- Dp_Ref
| +-- FileSystem
| +-- TemplateManager
|
Dp_Cfg classes
]]>
="2007-01-15T15:30:21Z"][position()<=60][UCPTalarmLog="SUMMARY"]"
]]>
="2007-01-15T15:30:21Z" and UCPTlastUpdate<"2007-02-11T15:30:21Z"][UCPTexceptionName="Holiday"][position()<500]"
]]>
="2007-01-15T15:30:21Z"][position()<50]"
Example: xSelect="//Item[@xsi:type="UFPTdataLogger_Data"][UCPTpointName="Net/LON/BAS/Data Logger 1/nviInput"][UCPTlastUpdate>="2007-01-15T15:30:21Z"][position()<50]"
]]>
="2007-01-15T15:30:21Z" and UCPTlastUpdate<"2007-02-11T15:30:21Z"][position()<500]"
]]>
This type is a common surrogate for any Item with the 'Item_Cfg'-base.
The embedded item will be stored as a template in the 'TemplateManager'.
The storage path (directory + filename) is set in the 'UCPTname'.