| Target Namespace | None |
|---|---|
| Version | 0.2 |
| Element and Attribute Namespaces |
|
| Schema Composition |
|
| Documentation |
AMIS XML communication declarationsAll communication within AMIS are handled with XML.All commands in the system are defined as separate global elements, which are then aggregated into super elements, that define all commands for a given module. All replies in the system are defined as separate global elements, which are then aggregated into super elements, that define all possible replies from a given module. WARNINGchanges in this document may lead to severe product failures and misbehavior of the system Copyright SAT Consulting ApS 2006 © |
| Prefix | Namespace |
|---|---|
| xml | http://www.w3.org/XML/1998/namespace |
| html | http://www.w3.org/1999/xhtml |
| amis | http://www.w3.org/2001/XMLSchema |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | appl_equipment |
|---|---|
| Abstract | no |
| Documentation | used to define/update/delete/list equipment. define/updatechoice, will be compared against the database, and in case of differences, equipment will be updated. deletechoice, will cause a database deletion, and equipment is treated as undefined. listchoice, will list the equipment in question, wildcards are allowed tsTypeoptional, transactionserver type, defines combination of other types tariffTypeoptional, contract like e.g. household 1 phase meter tariffUnitoptional, wildcard to use when addressing a group of tariffs loadprofileTypeoptional, collection setup loadprofileUnitoptional, wildcard to use when addressing a group of loadprofiles pqprofileTypeoptional, collection setup pqprofileUnitoptional, wildcard to use when addressing a group of power quality profiles loadswitchTypeoptional, setup loadswitchUnitoptional, wildcard to use when adressing a group of load switches haTypeoptional, setup haUnitoptional, wildcard to use when adressing a group of home automation idmandatory, equipment decimal address typemandatory namemandatory |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | appl_group |
|---|---|
| Abstract | no |
| Documentation | used to define/update/delete/list relationship between unit name and equipment A group may contain an indefinite number of equipment, however a physical limit is imposed on the defining XML in order to keep the memory foot print acceptable. tariffUnitchoice, command relate to tariff loadprofileUnitnitchoice, command relate to load profile pqprofileUnitchoice, command relate to power quality profile loadswitchUnitchoice, command relate to load switch haUnitchoice, command relate to home automation equipmentAddressarray of addresses belonging to group |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | appl_requestProfile |
|---|---|
| Abstract | no |
| Documentation | request profile (load/tariff/pq) from either a single equipment or a group of equipment. activateDateoptional, time to issue request responseDateoptional, time to deliver reply groupchoice, wildcard addressing equipmentchoice, direct addressing |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_config_direct |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_load): download binary configuration to equipment. configurationis the file image to download Equipment will itself determine if the configuration should be activated |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_config_interpreted |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_load): download interpreted configuration to equipment. configurationis the file image to download Equipment will itself determine if the configuration should be activated |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_cumulate |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_setTimed) voidno dedicated parameters activate cumulation in meter |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_cumulation |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_requestTimed): actualget actual values cumulatedget last automatically cumulated values |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_deactivation |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_set): ididentification of equipment to be deactivated send meter deactivation to concentrator, this will allow the concentrator to "forget" about equipment, in case it is no longer available or jumped to another concentrator. If the equipment is "seen" by the concentrator, the concentrator will send a activation message |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_diagnose |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_set): secondsinterval between sending spontan data activatestop/start diagnose for testing purposes only ... It will set the equipment in a mode where it returns the same data all time |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_error_info |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_request): voidno dedicated parameters request equipment status from concentrator(s) |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_firmware |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_load): download firmware to equipment. firmwareis the file image to download Equipment will itself determine if the configuration should be activated |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_gateway_data |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_request): request data from meters connected to the meter gateway. fromTimemandatory, oldest time for data search toTimeoptional, newest time for data search, not present or 0 means all deviceTimeoptional, address of meter, if not present all meters are selected data are transferred as binary files to external applications, and not interpreted |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_incasso |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_setTimed): wattHourmax. watt/hour to be consumed before releasing power relay set incasso mode |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_info |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_set): infoFieldmax. 9 characters set info field in meter |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_load |
|---|---|
| Abstract | no |
| Documentation | commModule: activateTimeis a common timestamp defining when the command is to be executed config_directload binary configuration config_interpretedload interpreted configuration firmwareload firmware This group of commands load a "file" to the equipment as a sequence of messages |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_loadprofile |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_requestTimed): fromTimemandatory, oldest time for data search toTimeoptional, newest time for data search, not present or 0 means all register150optional, select set of register whether or not it is released register250optional, select set of register whether or not it is released register350optional, select set of register whether or not it is released register450optional, select set of register whether or not it is released registerReleasedoptional, select only released set of registers request load profile |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_log |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_requestTimed): fromTimemandatory, oldest time for data search toTimeoptional, newest time for data search, not present or 0 means all request log or power quality log |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_reactivation |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_set): typetype of equipment (or all) to reactivate ask concentrator to send activation messages for all connected equipment of type |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_relay |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_setTimed): activeTimetime to activate command relayCommandactual command manipulate relay in meter |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_request |
|---|---|
| Abstract | no |
| Documentation | commModule: commandSequenceidentifier to match with reply error_inforequest status information of all equipment from concentrator gateway_datarequest data from non-amis meters spontan_datarequest selected data from all reqister in equipment statusrequest configuration status of equipment this group of commands send a request for information to the equipment. Responses are "files" |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_requestTimed |
|---|---|
| Abstract | no |
| Documentation | commModule: activateTimeis a common timestamp defining when the command is to be executed commandSequenceidentifier to match with reply loadprofilerequest loadprofile logrequest log file from equipment pqrequest cumulated/actual power quality pq_logrequest power quality log file from equipment tariffrequest cumulated/actual tariff this group of commands send a request for information to the equipment. Responses are "files" |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_sequence |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_request): startSequenceNumberfirst sequence number to be resend countnumber of sequence numbers to be resend ask concentrator for missing sequence numbers |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_set |
|---|---|
| Abstract | no |
| Documentation | commModule: deactivationdelete meter from concentrator table diagnoseset equipment in diagnose mode infoset info field reactivationask concentrator to activate all connected equipment sequencerequest missing spontanious messages from concentrator textset text field this group of commands set information in the equipment, without response |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_setTimed |
|---|---|
| Abstract | no |
| Documentation | commModule: activateTimeis a common timestamp defining when the command is to be executed cumulateask meter to cumulate incassoset incasso relaymanipulate relay this group of commands set information in the equipment, without response |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_spontan_data |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_request): preValueTimetime to use when retrieving one of the 99 preValues arraymax. 8 different sets can be requested, each set consist of: groupSelectionselect group: all, powerquality, tariff obis_coptional, select C register, if not present wildcard (*.x.y) is used obis_doptional, select D register, if not present wildcard (x.*.y) is used obis_eoptional, select E register, if not present wildcard (x.y.*) is used obis_preValueoptional, select value for prevalue register |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_status |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_request): voidno dedicated parameters request information about the equipment, like firmware version |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | elm_comm_text |
|---|---|
| Abstract | no |
| Documentation | commModule (comm_set): infoFieldmax. 50 characters set text field in meter |
| Diagram |
|
| Super-types: | Address < AusAddress (by extension) |
|---|---|
| Sub-types: |
|
| Name | AusAddress |
|---|---|
| Abstract | no |
The XML Instance Representation table above shows the schema component's content as an XML instance.
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.