Echelon LonBridg Server User Manual

LonBridge Server User’s Guide078-0386-01A®

4 Introduction The LonBridge API supports up to 20 local or remote clients. Each client opens a TCP socket to the Lo

LonBridge Server User’s Guide 5 3. Double click the LonBridge140xxxSetup.exe file that you downloaded (the xxx in the file name represents t

6 Introduction environments, you must port the LonBridge Server to that Linux distribution (see the source code comme

LonBridge Server User’s Guide 7 Windows Switch Linux Switch Description /D -d Enables debug logging; logs events tracing the internal oper

8 Introduction The order of increased level of detail for the event logging switches is: 1. /E (-e) 2. /G (-g): In

LonBridge Server User’s Guide 9 2 Configuring the LonBridge Server This chapter describes how you can configure the LonBridge Server.

10 Configuring the LonBridge Server Configuring the LonBridge Server For the LonBridge Server, you can specify the fo

LonBridge Server User’s Guide 11 Figure 2. LonBridge Control Utility See the LonBridge Control utility online help for information about the

12 Configuring the LonBridge Server <interface value="LON1" /> <ip value="default" /

LonBridge Server User’s Guide 13 <port> The <port> element specifies the IP port for the LonBridge Server. By default, the LonBr

Echelon, LONWORKS, LONMARK, LonTalk, Neuron, 3120, 3150, ShortStack, and the Echelon logo are trademarks of Echelon Corporation registered in the Unit

14 Configuring the LonBridge Server the program ID from the new device and then searches the device class files for a

LonBridge Server User’s Guide 15 Class File Application Program ID isilampmodule3.xml Echelon 3170 Lamp Module 90:00:01:1E:29:4F:11:03 is

16 Configuring the LonBridge Server To add a new device for the LonBridge Server to monitor or control, add an XML fi

LonBridge Server User’s Guide 17 • An indication of the device’s state within LonBridge (the active attribute); this attribute can have one

LonBridge Server User’s Guide 19 3 Using the LonBridge API This chapter describes the tasks performed by a LonBridge application and by the

20 Using the LonBridge API Tasks Performed by a LonBridge Application Using the LonBridge API, a LonBridge applicatio

LonBridge Server User’s Guide 21 The LonBridge Server reads the LonBridge configuration file to determine the name of the network interface (

22 Using the LonBridge API The monitoring method can be specified for each specified network variable. The method ca

LonBridge Server User’s Guide 23 4 LonBridge API This chapter describes the LonBridge application programming interface (API) for input

LonBridge Server User’s Guide iii Welcome The Echelon LonBridge™ Server is a software tool that provides an interface between a TCP/IP network

24 LonBridge API LonBridge API The communications between the LonBridge Server and various LonBridge applications use

LonBridge Server User’s Guide 25 retrieves the id attribute; you can also view the id attribute in the devices.xml file (see Instances Direct

26 LonBridge API Examples: Error deleting non-existing object: <lon _tt="54321"> <o73.delete/&

LonBridge Server User’s Guide 27 posProperty--; } } LonBridge Commands for Input Messages The LonBridge Server sends messages to a LonB

28 LonBridge API can act on the change (for example, update a GUI window) without waiting for the response from the r

LonBridge Server User’s Guide 29 The <lon> element is required, and only one <lon> element is allowed per message. <set> T

30 LonBridge API </xs:complexType> </xs:element> <xs:element name="is_new">

LonBridge Server User’s Guide 31 </lon> Example for the <set> Message: <o17.set brightness="60"/> ... <o17.

LonBridge Server User’s Guide 33 5 LonBridge Device Class File This chapter describes the XML elements for the LonBridge device class fi

iv

34 LonBridge Device Class File LonBridge Device Class File Format A LonBridge device class file is an XML document th

LonBridge Server User’s Guide 35 Attribute Description Required? length Defines the length of an input network variable. Example: For a n

36 LonBridge Device Class File Example: <attributes> <attribute ... > <nvs> <nv ..

LonBridge Server User’s Guide 37 Attribute Description Required? pid Defines the program ID for the device class. During device discover

38 LonBridge Device Class File Attribute Description Required? output For an input network variable, defines the b

LonBridge Server User’s Guide 39 Attribute Description Required? type Specifies the type for the network variable. If the network variabl

40 LonBridge Device Class File XML Schema for Device Class Files To allow you to create well-formed XML documents for

LonBridge Server User’s Guide 41 <xs:attribute name="pid" use="required" > <xs:simpleType>

42 LonBridge Device Class File energy peak use, and one for lowest energy use. These network variables are defined b

LonBridge Server User’s Guide 43 <attribute name="state" enum="true"> <enum input="on&quo

LonBridge Server User’s Guide v Table of Contents Welcome...

44 LonBridge Device Class File 2. Define an <attribute> element for each abstract attribute that the applicati

LonBridge Server User’s Guide 45 network output polled SNVT_power nvoPower nv_properties { cpPwrSendOnDelta }; network inpu

46 LonBridge Device Class File network output polled SNVT_power nvoPower nv_properties { cpPwrSendOnDelt

LonBridge Server User’s Guide 47 ... </attribute> </byte> </nv> <nv index="?" di

48 LonBridge Device Class File To use the Resource Editor to determine the network variable attributes: 1. Start the

LonBridge Server User’s Guide 49 Figure 4. Attribute Information for the SNVT_power Type The first piece of information that you need about

50 LonBridge Device Class File Figure 5. The Scales Tab for the SNVT_power Type For a LonBridge application, you mig

LonBridge Server User’s Guide 51 Figure 6. Attribute Information for the SNVT_switch_2 Type The first piece of information that you need abo

52 LonBridge Device Class File Figure 7. The Scales Tab for the SNVT_switch_2 Type For the enumeration value within

LonBridge Server User’s Guide 53 </nv> The definition still lacks the network variable indices for the nviValue and nvoValueFb network

vi Define <nv> Elements... 46 Use the Resource Editor to Determine Attri

54 LonBridge Device Class File Figure 8. Enumerations within the NodeBuilder Resource Editor Double-click the switch

LonBridge Server User’s Guide 55 Figure 9. The switch_state_t Enumeration For the nviValue network variable, a LonBridge application uses th

56 LonBridge Device Class File <nv index="?" direction="output"> <byte index="0&q

LonBridge Server User’s Guide 57 0 1 63 1 0 1 0 1 0 0 0 0 0 "@0|6 13 * 1 2 0 0 0 0 VAR nvoEnergyLo 8 0 0 0 0 1 63 1 0 1 0 1 0 0 0 0 0

58 LonBridge Device Class File Neuron C Declaration XIF File Definition network output polled SNVT_switch_2 nvoValue

LonBridge Server User’s Guide 59 <byte index="0"> <attribute name="state" enum="true">

60 LonBridge Device Class File </byte> </nv> <nv index="5" direction=&quo

www.echelon.com

LonBridge Server User’s Guide 1 1 Introduction This chapter introduces the LonBridge Server and describes how to install it.

2 Introduction Introduction The Echelon LonBridge Server is a software tool that provides an interface between a TCP/

LonBridge Server User’s Guide 3 TCP SocketTCP Socket Figure 1. LonBridge Server The LonBridge Server provides the following key features: •