I.lon 100 applications and the soap/xml interface, Overview of i.lon 100 applications, Overview of i.lon 100 applications -1 – Echelon i.LON 100 e2 Internet Server User Manual
Page 31: 1 overview of i. lon 100 applications
LON 100 Internet Server Programmer’s Reference
4-1
4
i.
LON 100 Applications and the SOAP/XML Interface
This chapter provides an overview of the applications supported by the
i.
LON 100, and of
how you can use the SOAP/XML interface to configure these applications and use the data
they generate. This chapter includes the following major sections:
•
Overview of
i.
LON 100 Applications. This section provides a description of each of the
applications that the
i.
LON 100 supports.
•
i.LON 100 XML Configuration Files. The configuration of each
i.
LON 100 application is
stored in an XML file. This section lists those XML files, and indicates where they are
stored on the
i.
LON 100.
•
i.LON 100 SOAP Functions. Each
i.
LON 100 application includes a set of SOAP
functions that can be used to configure that application. This section lists and describes
the functions provided for each application, and references where each function is
described in more detail in this document. It also provides information you will require
when constructing the input to be supplied to each function.
•
i.LON 100 Resource Files. The
i.
LON 100 resource files contain information you will
need when using the SOAP functions. This section describes how to use the resource
files.
•
List, Get, Set and Delete Functions. You will notice when reviewing the
i.LON
100
SOAP Functions section that each application has separate List, Get, Set and Delete
functions. Together, these functions form a symmetric interface, and you may find this
symmetry very useful when programming your SOAP applications. This section
describes how you might do so.
•
Performance Issues. This section lists performance issues you should consider when
using the SOAP/XML interface.
•
Getting Started. This section provides a roadmap to follow when configuring the
i.
LON
100 applications. The most important part of this roadmap is that you must configure
the
i.
LON 100 Data Server before configuring any other applications.
4.1 Overview of
i.
LON 100 Applications
You need to build the
i.
LON 100 Data Server and create the data points you need to manage
your control network before using the SOAP/XML interface to configure your applications.
Chapters 5 of this document describes data points, and how to build the
i.
LON 100 Data
Server. Once you have built the Data Server, you can use the SOAP/XML interface to
configure the following
i.
LON 100 applications:
•
Data Logging – You can configure the
i.
LON 100 to record updates to the data points on
your network by creating Data Loggers. Each Data Logger will have its own log file,
which will contain an entries for each of the updates to the data points it is monitoring.
These logs can be downloaded and read using the Internet File Transfer Protocol (FTP),
or retrieved using a SOAP function called DataLoggerRead. Table 6 provides a brief
description of DataLoggerRead and the other functions you can use to create and
manage your Data Loggers. These functions are described in Chapter 6 of this
document.
•
Alarming – You can configure the
i.
LON 100 to trigger alarms based on the values and
statuses of the data points in your control network. The
i.
LON 100 can be configured to
update any data point in the L
ON
W
ORKS
network, log the conditions to one or more data
logs, or send out emails notifying recipients of the alarms and the conditions that