Xml schema for the lonbridge api – Echelon LonBridg Server User Manual

Page 35

Advertising
background image

LonBridge Server User’s Guide

29

The <lon> element is required, and only one <lon> element is allowed per

message.

<set>

The <set> message modifies one or more objects. The LonBridge Server

stores the specified attribute values, and overwrites any existing attribute
values. You cannot delete attributes from an object.
Whenever a <set> message causes any change to an object, the LonBridge
Server broadcasts the <is_pending> message for that object, followed by the

<is> message when the device responds that the change is complete.
This LonBridge Server returns an error if the <set> message fails or if any of
the attribute changes cannot be completed.
Table 6 lists the attributes for the <set> message.

Table 6. Attributes for the <set> Message

Attribute

Description

Required?

id

Specifies the ID for the device.

Optional

state

Specifies the state for the device.

Optional

XML Schema for the LonBridge API

To allow you to create well-formed XML documents for LonBridge messages, this

section provides an XML Schema Definition (XSD) that defines the basic syntax
for the LonBridge API. This schema definition does not include definitions for

the

object.element

message format (see

General Message Format

on page 24) or

for tracers (see

Tracers

on page 25).

<?xml version="1.0" encoding="UTF-8" ?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="discover" type="xs:string" />

<xs:element name="error">
<xs:complexType>
<xs:attribute name="code" type="xs:string" use="optional" />
<xs:attribute name="description" type="xs:string" use="optional" />
<xs:anyAttribute />
</xs:complexType>
</xs:element>

<xs:element name="get">
<xs:complexType>
<xs:attribute name="select" type="xs:string" use="optional" />
<xs:attribute name="where" type="xs:string" use="optional" />
</xs:complexType>
</xs:element>

<xs:element name="is">
<xs:complexType>
<xs:anyAttribute />

Advertising