System information
Table Of Contents
- Table of Contents
- 1 Introduction to the SmartServer SOAP/XML Interface
- 2 SOAP Messages and the SmartServer WSDL File
- 2.1 SmartServer Naming Structure
- 2.2 SmartServer WSDL File
- 2.3 Security
- 2.4 SOAP Request and Response Message Structure
- 2.5 SOAP Messages Formats
- 2.6 Data Point References
- 2.7 UCPTcurrentConfig
- 2.8 Fault Structure
- 2.9 LonString type
- 2.10 SOAP Message Examples
- 3 SmartServer Applications and the SOAP/XML Interface
- 3.1 Overview of SmartServer Applications
- 3.2 SmartServer XML Configuration Files
- 3.3 SmartServer Resource Files
- 3.3.1 Standard Network Variable Type (SNVT) Device Resource Files
- 3.3.2 Standard Configuration Property Type (SCPT) Device Resource Files
- 3.3.3 User Defined Network Variable Type (UNVT) Device Resource Files
- 3.3.4 User Defined Configuration Property Type (UCPT) Device Resource Files
- 3.3.5 Data Point Templates
- 3.3.6 Data Formatting
- 3.4 SOAP Functions
- 3.5 Performance Issues
- 4 Using the SmartServer Data Server
- 4.1 Creating and Modifying the Data Point XML Files
- 4.2 Overview of the Data Point XML File
- 4.3 Data Server SOAP Interface
- 4.3.1 Using the List Function on the Data Server
- 4.3.2 Using the Get Function on the Data Server
- 4.3.3 Using the Set Function on the Data Server
- 4.3.4 Using the Read Function on the Data Server
- 4.3.5 Using the Write Function on the Data Server
- 4.3.6 Using the Invoke Function to Reset Data Point Priorities
- 4.3.7 Data Point Values and Priority Levels
- 4.3.8 Using the Delete Function on the Data Server
- 4.4 Using the Web Binder Application
- 5 Data Loggers
- 5.1 Overview of the Data Logger XML File
- 5.2 Creating and Modifying the Data Logger XML File
- 5.3 Data Logger SOAP Interface
- 6 Alarm Generator
- 6.1 Overview of the Alarm Generator XML File
- 6.2 Creating and Modifying the Alarm Generator XML File
- 6.3 Alarm Generator SOAP Interface
- 7 Alarm Notifier
- 7.1 Overview of the AlarmNotifier XML File
- 7.2 Creating and Modifying the Alarm Notifier XML File
- 7.3 Alarm Notifier SOAP Interface
- 7.3.1 Using the List Function on an Alarm Notifier
- 7.3.2 Using the Get Function on an Alarm Notifier
- 7.3.3 Using the Set Function on an Alarm Notifier
- 7.3.4 Using the Read Function on an Alarm Notifier
- 7.3.5 Using the Write Function on an Alarm Notifier Log File
- 7.3.6 Using the Clear Function on an Alarm Notifier Log File
- 7.3.7 Using the Delete Function on an Alarm Notifier
- 8 Analog Function Block
- 9 Scheduler
- 9.1 Overview of the Scheduler XML File
- 9.2 Creating and Modifying the Scheduler XML File
- 9.3 Scheduler SOAP Interface
- 10 Calendar
- 10.1 Overview of the Calendar XML File
- 10.2 Creating and Modifying the Calendar XML File
- 10.3 Calendar SOAP Interface
- 11 Real Time Clock
- 12 Type Translator
- 12.1 Overview of the Type Translator XML File
- 12.2 Creating and Modifying the Type Translator XML File
- 12.3 Type Translator SOAP Interface
- 12.3.1 Using the List Function on a Type Translator
- 12.3.2 Using the Get Function on a Type Translator
- 12.3.3 Using the Set Function on a Type Translator
- 12.3.4 Pre Defined Type Translator Rules
- 12.3.4.1 16xSNVT_switch_TO_SNVT_state
- 12.3.4.2 SNVT_lev_disc_TO_SNVT_occupancy
- 12.3.4.3 SNVT_lev_disc_TO_SNVT_switch
- 12.3.4.4 SNVT_occupancy_TO_SNVT_setting
- 12.3.4.5 SNVT_scene_TO_SNVT_setting
- 12.3.4.6 SNVT_scene_TO_SNVT_switch
- 12.3.4.7 SNVT_setting_TO_SNVT_switch
- 12.3.4.8 SNVT_state_TO_16xSNVT_switch
- 12.3.4.9 SNVT_switch_TO_SNVT_lev_disc
- 13 Type Translator Rules
- 14 LonWorks Driver
- 14.1 LonWorks Networks
- 14.2 LonWorks Channels
- 14.3 LonWorks Devices
- 14.4 Routers
- 14.5 Remote Network Interface
- 14.6 LonWorks Functional Blocks
- 14.7 Network Variables (LonWorks Data Points)
- 14.8 Configuration Properties (LonWorks Data Points)
- 14.9 LonWorks Connections
- 15 Modbus Driver
- 16 M Bus Driver
- 17 Virtual Driver
- 18 File System Data
- 19 System Information Methods
- 20 Using the SOAP Interface as a Web Service
- 21 Programming Examples
- 21.1 Visual C#.NET Examples
- 21.1.1 Reading and Writing Data Point Values in Visual C# .NET
- 21.1.2 Creating and Reading a Data Logger in Visual C# .NET
- 21.1.3 Creating a Scheduler and Calendar in Visual C# .NET
- 21.1.4 Creating and Installing a LonWorks Device in Visual C# .NET
- 21.1.5 Commissioning External Devices in Visual C# .NET
- 21.1.6 Discovering and Installing External Devices in Visual C# .NET
- 21.1.7 Configuring the SmartServer in Visual C# .NET
- 21.2 Visual Basic.NET Examples
- 21.2.1 Reading and Writing Data Point Values in Visual Basic.NET
- 21.2.2 Creating and Reading a Data Logger in Visual Basic. NET
- 21.2.3 Creating a Scheduler and Calendar in Visual Basic.NET
- 21.2.4 Creating and Installing a LonWorks Device in Visual Basic.NET
- 21.2.5 Commissioning External Devices in Visual Basic.NET
- 21.2.6 Discovering and Installing External Devices in Visual Basic.NET
- 21.2.7 Configuring the SmartServer in Visual Basic.NET
- 21.1 Visual C#.NET Examples
- 22 Programming the SmartServer with Java
- Appendix A: SOAP Tester Example
i.LON SmartServer 2.0 Programmer’s Reference
7-1
7 Alarm Notifier
Use the Alarm Notifier application to log user-defined alarm conditions, and to generate e-mail
messages and data point updates each time an alarm condition occurs. This section provides an
overview of how Alarm Notifiers work, including how you can define alarm conditions and program
your Alarm Notifiers to respond to them.
User-Defined Alarm Conditions
When you create an Alarm Notifier, you will specify a group of input data points. The Alarm Notifier
will read the status of these data points each time they are updated to determine if they have reached
alarm conditions. The statuses that the Alarm Notifier will consider alarm conditions are user-defined.
You will define these conditions by creating active and passive alarm condition sets for the Alarm
Notifier.
For each condition set you create, you will select an alarm type (active or passive) and a data point
status. Each time an input data point is updated and its <UCPTpointStatus> matches the selected
status, an alarm notification will occur. If it is generated based on a status assigned to an active alarm
condition set, it is considered an active alarm. If it is generated based on a status assigned to a passive
condition set, it is considered a passive alarm. You can create as many active and passive alarm
condition sets as you like per Alarm Notifier.
There are several scenarios you could consider when creating Alarm Notifiers. For example, you
could set up Alarm Notifiers to generate alarm notifications based on the statuses of the data points
updated by your Alarm Generators. For more information on Alarm Generators, see
Chapter 6.
You may also recall from Chapter 5 that some data points exist in the Data Server to monitor the
amount of memory that an Alarm Generator’s log file has consumed. You could set up an Alarm
Notifier to generate alarm notifications when a log file becomes full.
Alarm Destinations
You can create destinations for your Alarm Notifiers. These destinations determine how the Alarm
Notifier will respond when an alarm occurs. You can create as many active and passive destination
sets as you like per Alarm Notifier. The passive destination will be used when a passive alarm
notification occurs, and the active destinations will be used when an active alarm notification occurs.
For each destination, you can specify an output data point. This data point will be updated each time
an alarm notification occurs and uses that particular destination. You can also specify an e-mail profile
for each destination. The e-mail profile will cause an e-mail to be sent to an address of your choice
each time the destination is used. The next section provides more information on e-mail profiles.
You can create e-mail profiles and assign these profiles to the destination sets you have created for
your Alarm Notifier. Each e-mail profile contains an e-mail address. When a destination using an
e-mail profile is used, an e-mail will be sent to the address defined for that profile.
You can specify the message text, subject heading, and attachment to be included with each e-mail.
E-mail profiles allow you to notify different people when different alarms occur. This is useful if
different groups of people need to receive notifications about the various alarm conditions that might
occur on your network.
Auto-Generated Log Files
Each Alarm Notifier will generate its own log file. It will add an entry to this log file each time it
generates an alarm notification. You can find these log files in the /root/AlarmLog directory of
the SmartServer. These files are named histlogX, where X represents the index number assigned to the
Alarm Notifier when it was created. An Alarm Notifier will not generate a log file until it has
generated an alarm notification.