OpenLDV Programmer's Guide, xdriver Supplement

Size: px
Start display at page:

Download "OpenLDV Programmer's Guide, xdriver Supplement"

Transcription

1 OpenLDV Programmer's Guide, xdriver Supplement Release C o r p o r a t i o n C

2 Echelon, LON, LONWORKS, NodeBuilder, LonTalk, Neuron, LONMARK, LNS, LonBuilder, LonUsers, BeAtHome, LonManager, 3120, 3150, LonPoint, Digital Home, LONWORLD, ShortStack, i.lon, the Echelon logo, and the LONMARK logo are registered trademarks of Echelon Corporation. LNS Powered by Echelon, LonMaker, LonLink, LonResponse, OpenLDV, LONews, Open Systems Alliance, Panoramix, Panoramix Powered by Echelon, LONMARK Powered by Echelon, Powered by Echelon, LonScanner and LonSupport are trademarks of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders. Neuron Chips and other OEM Products were not designed for use in equipment or systems which involve danger to human health or safety or a risk of property damage and Echelon assumes no responsibility or liability for use of the Neuron Chips in such applications. Parts manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only, and may not have been tested by Echelon. It is the responsibility of the customer to determine the suitability of these parts for each application. ECHELON MAKES AND YOU RECEIVE NO WARRANTIES OR CONDITIONS, EXPRESS, IMPLIED, STATUTORY OR IN ANY COMMUNICATION WITH YOU, AND ECHELON SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Echelon Corporation. Printed in the United States of America. Copyright by Echelon Corporation. Echelon Corporation

3 Purpose xdriver is an extensible network driver that can be used to connect remote LONWORKS networks to an LNS Server. This guide describes how to install and configure xdriver, and how to create LNS applications for use with xdriver. This includes detailed descriptions of the software tools you will use to configure xdriver, and programming samples to assist you when you create LNS applications for xdriver. Audience This guide is intended for software developers creating LNS and OpenLDV applications for xdriver. Programming samples in this document are written in Microsoft Visual Basic. However, applications for xdriver may be written in any language that supports COM Components or ActiveX controls, such as Microsoft Visual C Readers of this guide should have programming experience in such a language, as well as familiarity with LONWORKS technology and COM concepts. An introduction to LONWORKS technology can be found in the Introduction to the LONWORKS System document, and additional information on LNS programming can be found in the LNS Programmer s Guide. Both of these documents can be downloaded from Echelon s website at Examples Throughout this guide, Visual Basic programming samples are used to illustrate concepts. To make these samples more easily understood, they have been simplified. Error checking has been removed, and in some cases, the examples are only fragments that may not compile without errors or warnings. Hardware and Software Requirements Installation requirements and recommendations for the PC on which the xdriver software will be installed are listed below. The xdriver software is installed with LNS 3.0 Service Pack 7 and all subsequent LNS releases, as well as with the OpenLDV software. LNS service packs and updates can be downloaded from Echelon s website at The xdriver automatic reconnection feature is available in LNS 3 Service Pack 8 Update 1, and all subsequent LNS releases. Intel Pentium III 366MHz processor 128MB RAM Microsoft Windows 98SE, Windows 2000, Windows XP or Windows Server MB of available hard-disk space 800x600 screen resolution OpenLDV Programmer s Guide, xdriver Supplement i

4 Table of Contents Purpose...i Audience...i Examples...i Hardware and Software Requirements...i Table of Contents... ii Introduction Introduction to xdriver Getting Started Using the Default xdriver LONWORKS Interfaces Application Using The LONWORKS Interfaces Application Configuring the Default xdriver Profile LNS Applications For xdriver Extending the Default xdriver Extending the Default xdriver xdriver Sessions Downlink Sessions Uplink Sessions Session Control Object Authentication Key Handling Creating a Custom Lookup Extension Component Microsoft Visual C Microsoft Visual Basic.NET Visual Basic xdriver Profiles Using the xdriver Profile Editor Starting the Connection Broker LNS Programming With xdriver Downlink Sample Applications Opening a Single Remote Network With xdriver Opening Multiple Remote Networks Via Downlink Uplink Sample Application LNS Methods and Events For xdriver... A-1 xdriver Methods and Events...A-2 BeginIncomingSessionEvents...A-2 EndIncomingSessionEvents...A-2 OnIncomingSessionEvent...A-3 AcceptIncomingSession...A-3 ReleasePendingUpdates...A-4 Custom Lookup Extension Component Programming... B-1 ILdvxLookup...B-2 DownlinkLookup...B-2 UplinkLookup...B-3 UpdateLookup...B-3 ILdvxConfigure...B-4 SetInstance...B-4 SetOptions...B-4 ii OpenLDV Programmer s Guide, xdriver Supplement

5 ILdvxSCO...B-5 GetSessionControlObjectID...B-5 SetLNSNetworkName...B-6 GetLNSNetworkName...B-6 SetDownlinkKey...B-6 GetDownlinkKey...B-7 SetUplinkKey...B-7 GetUplinkKey...B-8 SetAuthenticationFlag...B-8 GetAuthenticationFlag...B-9 SetCurrentAuthenticationKey...B-9 GetCurrentAuthenticationKey...B-9 SetNextAuthenticationKey...B-10 GetNextAuthenticationKey...B-10 SetAdditionalDownlinkPacketHeader...B-11 GetAdditionalDownlinkPacketHeader...B-11 SetAdditionalDownlinkPacketTrailer...B-12 GetAdditionalDownlinkPacketTrailer...B-12 SetEncryptionType...B-12 GetEncryptionType...B-13 ILdvxSCO_TCP...B-13 SetRemoteTCPAddress...B-14 GetRemoteTCPAddress...B-14 SetRemoteTCPPort...B-15 GetRemoteTCPPort...B-15 Sample Lookup Extension Component... C-1 Sample Lookup Extension Component...C-2 OpenLDV Programmer s Guide, xdriver Supplement iii

6 iv OpenLDV Programmer s Guide, xdriver Supplement

7 1 Introduction This chapter introduces xdriver, and provides an overview of how it provides secure connections between LNS Servers and remote LONWORKS networks. OpenLDV Programmer s Guide, xdriver Supplement 1-1

8 Introduction to xdriver xdriver is an extensible network driver that uses TCP/IP to establish connections between LNS servers and network interfaces such as Echelon s i.lon TM 10 Ethernet Adapter and i.lon 100 Internet Server. xdriver can provide authenticated connections from an LNS server to hundreds or even thousands of remote LONWORKS networks through devices like the i.lon 10 Ethernet Adapter and the i.lon 100 Internet Server. As shown in Figure 1.1, the LNS server accesses the i.lon device, and the LONWORKS channel the device is connected to, through a TCP/IP connection. Figure 1.1 xdriver Overview In Figure 1.1, the LNS Server is using xdriver to connect to two i.lon 10 Ethernet Adapters. xdriver integrates with LNS at the same point as other LNS drivers such as the PCC-10 and the PCLTA-20. For more information on these drivers and how they interact with the LNS server, see Chapter 11 of the LNS Programmer s Guide. NOTE: xdriver cannot be used as a router between remote LONWORKS networks. This document describes the functional characteristics of xdriver. It also provides guidelines to follow when configuring xdriver, and when developing LNS applications for use with xdriver. Getting Started xdriver is an integral part of LNS version 3.07 and higher, and of OpenLDV Version 1.0 and higher. Users of LNS 3.0 can download the most recent LNS service pack from Echelon s website at xdriver supports scalable access to many devices. The default xdriver implementation uses the Windows Registry as a database to store the information it requires to connect to each device. For small-scale deployments, it is most efficient to use this as the xdriver database. 1-2 OpenLDV Programmer s Guide, xdriver Supplement

9 However, for larger deployments (defined to be more than 50 devices), you should conduct a performance characterization to determine whether the performance achieved with the default Windows registry based information store is acceptable for your application. If this performance does not meet your needs, it is recommended that you extend the default xdriver to use an external database of sufficient performance as your information store. xdriver includes an extension mechanism that will support the external database of your choice. If you do not plan to extend the default xdriver implementation to use an external database, you can begin using the default xdriver, as described in Chapter 2, Using the Default xdriver. If you plan to extend the default xdriver implementation, see Chapter 3, Extending the Default xdriver. OpenLDV Programmer s Guide, xdriver Supplement 1-3

10 1-4 OpenLDV Programmer s Guide, xdriver Supplement

11 2 Using the Default xdriver This chapter describes how to use the default xdriver. It includes a description of the LONWORKS Interfaces application in the Windows Control Panel, which you will use to configure the Default xdriver Profile and build an xdriver database into the Windows Registry. OpenLDV Programmer s Guide, xdriver Supplement 2-1

12 LONWORKS Interfaces Application Use the LONWORKS Interfaces application to create RNI definitions for your i.lon 10 Ethernet Adapters and i.lon 100 Internet Servers that will allow LNS and OpenLDVbased applications to use those devices to connect to LONWORKS networks. You can also use the RNI tab to create RNI definitions for your i.lon 100 Internet Servers and i.lon 600 LONWORKS/IP Servers on your network that will allow the LonScanner Protocol Analyzer to use those devices connect to LONWORKS devices. Using The LONWORKS Interfaces Application The following procedure describes how to use the LONWORKS Interfaces application to create an RNI definition for a device: 1. Open the Windows Control Panel and double-click the LONWORKS Interfaces item. This opens the LONWORKS Interfaces application. Select the RNI tab to configure the network interfaces you plan to use with xdriver. Figure 2.1 RNI Tab 2. The Default xdriver Profile, and all the other xdriver Profiles that are using the default xdriver Lookup Extension Component, are listed in the Profile list on the left side of RNI tab. An xdriver Profile is a set of configuration properties that determines how xdriver will handle connections to the devices using that Profile. When you create an RNI definition on a device, you must choose the xdriver Profile that the device will use. Default represents the Default xdriver Profile. Most users use the Default 2-2 OpenLDV Programmer s Guide, xdriver Supplement

13 Profile. This is the set of configuration parameters that determines how the default xdriver will manage connections to your RNIs, and how it will respond if those connections are terminated as a result of some unexpected communication failure. You can review and edit the configuration of the Default Profile by clicking Default, and then clicking the Profile Properties button. For more information on this, see Configuring the Default xdriver on page 2-6. You can click a Profile name in the list to see a list of devices that are using that Profile. When you do so, you will notice that there are two levels of subtrees below the Profile. The first sub-tree level is the IP Address list. This lists the devices that are using the Profile. The devices are listed by their hostnames or IP addresses, depending on how you configure them. In Figure 2.1, there are two devices using the Default Profile: one is identified by its hostname, Host Device One, and the other is identified by its IP address, The next sub-tree level is the Network Interface Name list. This lists the RNI definitions that have been created for each device. In Figure 2.1, there are three RNI definitions for the device called Host Device One, and one for the device using IP address To create an RNI definition on a device, select the Default Profile and then click Add. This starts the Add Network Interface Wizard, which you can use to enter the information xdriver will require to connect to the device. NOTE: You must be logged in as an Administrative user to create an RNI on a device if you are using Windows 2000 Windows or Windows XP. Figure 2.2 Add Network Interface Name Dialog 3. Enter the name of the RNI. This will be used as a lookup key to access the proper Registry entry each time xdriver initiates a connection to the interface. Each RNI must have a unique name. When you have entered a name, click Next. This opens the dialog shown in Figure 2.3. OpenLDV Programmer s Guide, xdriver Supplement 2-3

14 Figure 2.3 Add Network Interface Wizard Type Dialog 4. Select Other if you plan to use the RNI with a custom OpenLDV or LNS application. Or, select LonScanner if you plan to use the RNI with the LonScanner Protocol Analyzer. Then, click Next. This opens the dialog shown in Figure 2.4. Figure 2.4 Add Network Interface Wizard IP Address Dialog 5. Click Use Static IP Address and enter the IP address in the box to manually enter the device s IP address. You must enter an IP address in the form x.x.x.x, where x is an integer in the range You should use this option if your RNI s hostname is not configured in any name servers (e.g. DNS servers, HOSTS file). Click Use Hostname and enter the device s hostname to resolve the device s IP address from its hostname. When you have entered the IP address or hostname, click Finish. This 2-4 OpenLDV Programmer s Guide, xdriver Supplement

15 returns you to the RNI tab shown in Figure 2.1. The new device and RNI will be listed on the tab. To continue configuring the RNI, select it on the RNI tab and click Properties. This opens the dialog shown in Figure 2.5. Figure 2.5 Network Interface Properties Dialog 6. Configure the fields on the Network Interface Properties dialog, and click OK to save your changes and return to the RNI tab. Or, click Apply to save your changes and keep the Network Interface Properties dialog open. Consult the online help for descriptions of the fields on the Network Interface Properties dialog. You can also click RNI Device to configure the address and authentication settings for the device the RNI was created on. This opens the Host Device Properties - LAN/WAN tab. Or, click Test to test the LNS Server s ability to communicate with the device. This opens the Diagnostics dialog. Consult the online help for descriptions of these dialogs. 7. In some cases, you may want to create more than one RNI definition on a device. For example, you may need to do this if you want to use the LonScanner Protocol Analyzer and a custom LNS application with the same device. In this case, select the device s entry in the IP Address list on the RNI tab, and click Add. This starts the Add Network Interface Wizard, which you can use to configure the new RNI. You will not be prompted to re-enter the device s IP address in this case. Instead, you ll be prompted to enter the listener port that the new RNI on the device should use. OpenLDV Programmer s Guide, xdriver Supplement 2-5

16 Configuring the Default xdriver Profile The following section describes how to edit the Default xdriver Profile with the LONWORKS Interfaces application. You can edit the Default xdriver Profile to configure a number of parameters that impact how xdriver will handle uplink and downlink sessions, including the automatic reconnection settings. You can use the automatic reconnection feature to cause xdriver to attempt reconnection when sessions using the Default Profile are terminated as a result of power outages, network interface failures, or other communication failures. With automatic reconnection enabled, xdriver will attempt reconnection until a failed session has been successfully reestablished, or until a time period that you define has expired. 1. Select the Default item on the RNI tab shown in Figure 2.1. Then, click the Profile Properties button. This opens the tab shown in Figure 2.6. Figure 2.6 General Tab 2. You can edit the description of the Default xdriver Profile from this tab using the Profile Description box. You can also click Restore Default Values at any time to restore the default factory settings to the Default xdriver Profile. Click the Downlink Sessions tab to configure how the Default xdriver Profile will manage downlink sessions. A downlink session is an xdriver connection that is initiated by an LNS application. 2-6 OpenLDV Programmer s Guide, xdriver Supplement

17 Figure 2.7 Downlink Sessions Tab 3. Configure the fields on the Downlink Sessions tab, and then click OK to save your changes and return to the RNI tab. Alternatively, click Apply to save your changes and then select the Uplink Sessions tab to configure how the default xdriver will manage uplink sessions. Figure 2.8 Uplink Sessions Tab 4. An uplink session is an xdriver connection that is initiated when an RNI requests connection to the LNS server. In order for xdriver to receive these requests for connection, the xdriver Connection Broker must be running. For instructions on starting the Connection Broker, see Starting the Connection OpenLDV Programmer s Guide, xdriver Supplement 2-7

18 Broker on page To enable uplink sessions, check the Enable Uplink Sessions box, configure the rest of the fields on the tab, and then click OK to save your changes and return to the RNI tab. Consult the online help for descriptions of these fields. Alternatively, click Apply to save your changes and then select the Protocol Options tab to configure protocol options for the default xdriver. Figure 2.9 Protocol Options Tab 5. Configure the fields on the Protocol Options tab, and then click OK to save your changes and return to the RNI tab. Alternatively, click Apply to save your changes and then select the Recovery Options tab to set the recovery options for the default xdriver. 2-8 OpenLDV Programmer s Guide, xdriver Supplement

19 Figure 2.10 Recovery Options Tab 6. You can configure xdriver to automatically attempt reconnection when xdriver sessions using the Default Profile are broken as a result of some unexpected communication failure. To do so, check the Enable Recovery box and configure the rest of the fields on the Recovery Options tab. 7. Click OK to save the configuration changes you have made, and return to the RNI tab shown in Figure 2.1. Or, click Apply to save the configuration changes and continue to edit the Default Profile. LNS Applications For xdriver Once you have created the Registry entries for your RNIs and configured the Default xdriver Profile to meet your requirements, you can begin using LNS applications such as the LonMaker TM Integration Tool to connect the LNS server to your RNIs. For more information on LonMaker, see the LonMaker User s Guide. Alternatively, you can begin creating your own LNS applications for xdriver. Chapter 4, LNS Programming With xdriver, provides sample programs that may assist you when creating these applications. OpenLDV Programmer s Guide, xdriver Supplement 2-9

20 2-10 OpenLDV Programmer s Guide, xdriver Supplement

21 3 Extending the Default xdriver The default xdriver can be extended by creating custom xdriver Lookup Extension Components, and additional xdriver Profiles. The chapter describes why you might need to extend the default xdriver, and how to extend it. OpenLDV Programmer s Guide, xdriver Supplement 3-1

22 Extending the Default xdriver The xdriver software includes the LONWORKS Interfaces application, which can be used to create entries in the Windows Registry for each of your RNIs. Each entry will store the lookup information xdriver will require to connect to one of your RNIs. The default xdriver Lookup Extension Component supplies a COM method that xdriver calls to retrieve this information from the Windows Registry each time an xdriver connection to an RNI is initiated. The information is then used by xdriver to fully establish the connection. If you will be storing information for more than 50 different RNIs in your database, you should consider using an external database management system to store this lookup information. There are many reasons to do so, including the high record-storage capacity an external database management system provides, reliable backup and recovery, faster and more flexible database querying, and security. In addition, an external database can be shared by several machines, while the Windows Registry is machine-specific. Customization of the default xdriver is required if you plan to use an external database management system. The first stage of this customization is to create a custom Lookup Extension Component that retrieves the information xdriver needs to initiate connections from the external database management system. The second stage of this customization is to create an xdriver Profile to use that Lookup Extension Component. An xdriver Profile represents a set of configuration parameters that determines how xdriver will manage a given connection. Before creating your custom Lookup Extension Component, it is necessary to examine how the Lookup Extension Component and the xdriver Session Control Object (SCO) interact when an xdriver connection is initiated. xdriver Sessions An xdriver session involves a single connection between an RNI and an LNS server. A session begins when a request for connection from the LNS server to an RNI is made, or when a request for connection from an RNI to the LNS server is made. When either request is made, xdriver creates a dedicated SCO for the session. The SCO must be filled in by the xdriver Lookup Extension Component with the information xdriver needs to establish the connection. The following sections describe how the SCO is filled in, and how it is used to initiate a connection. Downlink Sessions An xdriver session is considered a downlink session if the connection is initiated by an LNS application. In this case, the LNS application accesses the RNI as though it were opening any other type of network interface. NOTE: If you are using a custom Lookup Extension Component, each RNI will only appear in the NetworkInterfaces collection object during a session involving that RNI. The network interface name to use is passed to LNS as part of the downlink lookup key. Chapter 4 provides programming samples that illustrate this. 3-2 OpenLDV Programmer s Guide, xdriver Supplement

23 The following section lists the events that occur during a downlink session. Refer to Figure 3.1 when reading this section. The steps following this diagram match those labeled in Figure 3.1. Data Base 3 User Application 1 2 xdriver Manager Lookup Extension x.profile.rni Figure 3.1 Downlink Session 1. When LNS initiates the connection, the xdriver manager initializes an SCO for the session, and fills the downlink lookup key (derived from the network interface name of the RNI) into the SCO. 2. The SCO is then passed to the Lookup Extension Component. 3. The Lookup Extension Component extracts the downlink lookup key from the SCO, and uses it to access the database record for the RNI that is to be connected to. The Lookup Extension Component then fills in the SCO with additional information required to establish the connection from the database, including the authentication flag, authentication keys, IP address and port number of the RNI. For more information on the SCO and the information it stores, see Session Control Object on For sample programs that initiate downlink xdriver sessions, see Chapter 4, LNS Programming With xdriver. 4. When this is done, the connection is established and the authentication key is used to validate the connection if authentication is enabled. 5. If the authentication is successful, packets are exchanged in both directions. For more information on authentication, see Authentication Key Handling on page The LNS application performs whatever network operations are required. Figure 3.2 describes the chain of events that occur when a downlink session is initiated within the session-initiating LNS application and the Lookup Extension Component. The events that occur within the LNS application represent a typical LNS application that opens a downlink session. Your application can vary from these steps. OpenLDV Programmer s Guide, xdriver Supplement 3-3

24 In addition, the events that occur within the Lookup Extension Component in this flow chart represent the minimal tasks a Lookup Extension Component needs to perform during a downlink session. This flow chart makes reference to the methods you can use when programming your custom Lookup Extension Component. For more information on these methods, see Appendix B, Custom Lookup Extension Programming. 3-4 OpenLDV Programmer s Guide, xdriver Supplement

25 Call ObjectServer.open() Define network to be opened Typical Downlink Scenario Does the network exist? No Add the network to the network collection Yes Open network in Local or serverindependant mode? Local Indp. Get network from MyVNI network collection Call mynetwork.openindependent() Get the network from Local network collection Call mynetwork.open() Set NetworkServiceDevice.NetworkInterface to desired xdriver networkinterface e.g. x.[profilename].[downlinklookupkey] Open System Object. Yes xdriver Lookup Extension Component called. Code ILdvxConfigure.SetInstance() to return S_OK (This optional method is fired once in the lifetime of an Instance) Code ILdvxConfigure.SetOptions() to return S_OK (This optional method is fired once in the lifetime of an Instance) Code ILdvxLookup.DownlinkLookup() to: Call xsco.getdownlinkkey() Do an external database query using the retrieved DownlinkKey If (query Result = NULL) then Exit by returning an appropriate COM error i.e. E_HANDLE Else Call xsco.setauthenticationflag([recommended: True] [False]) Call xsco.setcurrentauthenticationkey([a]) Call xsco.setnextauthenticationkey(a b) Define ILdvxSCO_TCPPtr pxsco_tcp(pxsco) Call xsco_tcp.setremotetcpaddress("x.x.x.x") Call xsco_tcp.setremotetcpport(n) return S_OK xdriver Lookup Extension Component Do Network and Monitoring Task(s) If Not mynetwork.isopenindependent Then Close System Object If Not mynetwork.isopenindependent Then mynetwork.close() Else mynetwork.closeindependent() Other networks to open? No Call ObjectServer.close() Figure 3.2 Typical Downlink Session OpenLDV Programmer s Guide, xdriver Supplement 3-5

26 Uplink Sessions In an uplink session, an RNI initiates the session by requesting a connection to the LNS server. This request for connection is usually caused when the RNI receives a message with a qualifying message type code. For more information on the messages that cause uplink session requests for a specific RNI, please refer to the documentation for that RNI. In order for xdriver to receive the request, the xdriver Connection Broker must be running. For more information on the xdriver Connection Broker, see Starting the Connection Broker on page There must also be at least one xdriver Profile with uplink session handling enabled for xdriver to receive the uplink session request. You can use the OpenLDV xdriver Profile Editor to create an xdriver Profile that has uplink session handling enabled. Using the Profile editor, you can assign the Profile a port, which the Connection Broker will use to listen for uplink session requests. The Profile will handle all uplink session requests that come in on that port. For more information on xdriver Profiles and the xdriver Profile Editor, see xdriver Profiles on page The following section lists the events that occur during an uplink session. Refer to Figure 3.3 when reading this section. The steps following this diagram match those labeled in Figure 3.3. i.lon 10 Connection Broker 1 3 Lookup Extension 2 Data Base 4 i.lon 10 5 x.profile.rni LCA Object Server 7 6 User Application Figure 3.3 Uplink Session Overview 1. An RNI such as an i.lon 10 requests an uplink session. When the request for connection is made, the Connection Broker receives an identification message from the RNI that has requested the uplink session. From this message, the Connection Broker obtains the uplink lookup key for the RNI. The SCO for the session is then initialized, and the uplink lookup key is inserted into the SCO. 2. The SCO is passed to the Lookup Extension Component, which uses the uplink lookup key to access the database record for the RNI. When this 3-6 OpenLDV Programmer s Guide, xdriver Supplement

27 record has been opened, the Lookup Extension Component fills in the SCO with the rest of the information required to establish the connection, including the authentication flag, authentication keys, downlink lookup key and name of the network that has requested connection. 3. If the authentication flag indicates that authentication is enabled for the session, the xdriver protocol engine uses the authentication keys filled into the SCO to verify the identity of the request for connection. The xdriver protocol engine handles authentication and all other message handshaking that needs to be done when a connection between an LNS server and an RNI is initiated. If authentication fails, the connection is terminated. If authentication succeeds, the following steps occur. For more information on authentication, see Authentication Key Handling on page The Connection Broker service creates an entry for the network that has requested the uplink session in the System.NetworkInterfaces collection. 5. The Connection Broker service sends a message to the LNS Object Server. 6. The LNS Object server causes the OnIncomingSessionEvent event to be fired in an LNS application that is programmed to listen for and manage uplink session requests. The application can then accept or reject the session using the AcceptIncomingSession method. These methods have been added to LNS for use with xdriver. For more information, see Appendix A, LNS Methods and Events for xdriver. If the application rejects the session, the session is terminated immediately. If it accepts the session, the connection is established, and packets are exchanged in both directions. The LNS application must be running, and must have registered for the uplink session listener event, to receive the uplink session notification. For a sample application that listens for and manages uplink sessions, see Uplink Sample Application on page 4-9. You can also use the xdriver Profile Editor to specify a command line that will be run each time the listener port for that Profile receives an uplink session. It can be used to start an LNS application to handle each incoming connection to that Profile s listener port. This is not the recommended way to handle uplink sessions. 7. Once the connection has been established, the LNS application can open the remote network that has requested the connection, enable the monitor set and monitor points for the network, receive the monitor point update event that caused the uplink session request, and handle the event accordingly. The monitor set and monitor points can then be closed, followed by the network itself. A new LNS method has been created to allow the withholding of monitor point update events while an uplink session is started. This ensures that monitor point update events sent after a network requests an uplink session but before the network and its monitor set are opened by an LNS application are not lost, so that the user will receive the monitor point update event that caused the uplink session. For more information on this method, see ReleasePendingUpdates on page A-4. NOTE: This OpenLDV Programmer s Guide, xdriver Supplement 3-7

28 feature is only supported by LNS listener applications. It is not supported by command-line initiated uplink event handlers. A network interface may reset after receiving and acknowledging (at OSI layer 2) an alarm event, but before the event has been propagated to the LNS server, causing the event to be lost. As a result of this, it is critical that you program alarm applications that send monitor point update events for your RNIs to the LNS server to resend each monitor point update event persistently to the LNS server until receipt of those events is confirmed. This will result in reliable performance, and will ensure that no monitor point update events are lost before they are processed by the LNS application. NOTE: You should program your LNS application to process uplink request messages, and provide suitable responses to the LONWORKS network, in a timely fashion. This becomes particularly critical when you are using an i.lon 100 Internet Server and the uplink is delivered over PPP, and the PPP profile (connection) is exclusively set up for your i.lon 100 Internet Server. Other i.lon 100 applications will not be able to use the PPP link until the LNS application terminates the xdriver. During this time, i.lon 100 web bindings and alarm notifications which are configured to use a different PPP profile (connection) will fail. Figure 3.4 describes the chain of events that occur during an uplink session within the LNS application that receives the uplink session request and the Lookup Extension Component. The events that occur within the LNS application represent a typical LNS application that registers for uplink session event handling. Your application can vary from these steps. In addition, the events that occur within the Lookup Extension Component in this flow chart represent the minimal tasks a Lookup Extension Component needs to perform during an uplink session. This chart makes reference to the methods you can use when programming your custom Lookup Extension Component. For more information on these methods, see Appendix B, Custom Lookup Extension Programming. 3-8 OpenLDV Programmer s Guide, xdriver Supplement

29 Call ObjectServer.open() Call BeginIncomingSessionEvents(myProfile) Typical Uplink Scenario Uplink session event received, lookup extension launched. Code ILdvxConfigure.SetInstance() to: return S_OK (This optional method is fired once in the lifetime of an Instance) Code ILdvxConfigure.SetOptions() to: return S_OK (This optional method is fired once in the lifetime of an Instance) Code ILdvxLookup.UplinkLookup() to: Call xsco.getuplinkkey() Do an external database query using the retrieved UplinkKey If (query Result = NULL) then Exit by Returning an appropriate COM error e.g. E_ERROR Else Call xsco.setauthenticationflag([recommended: True] [False]) Call xsco.setcurrentauthenticationkey(a) Call xsco.setnextauthenticationkey(a [b]) Call xsco.setdownlinkkey("rni_0001") Call xsco.setlnsnetworkname( mynetworkname ) return S_OK xdriver Lookup Extesnion Component a) OnIncomingSessionEvent(profileName, netname, IntfName, Tag) arrives (IntfName = x.myprofile.rni_name) Accept Incoming Call? No AcceptIncomingSession(tag, false, false) Tag from a) Yes AcceptIncomingSession(tag, true,true) Tag from a) Open network in Local or serverindependant mode? Local Get network from Local network collection Call mynetwork.open() Indp. Get network from MyVNI network collection Call mynetwork.openindependent() Open MonitorSet(s) Call ReleasePendingUpdates() Do Monitoring Task(s) Set NetworkServiceDevice.NetworkInterface to above received IntfName a) networkinterface i.e x.[profilename].[intfname] Close MonitorSet(s) Call mynetwork.closeindependent() Open System Object Open MonitorSet(s). ReleasePendingUpdates() Do network and monitoring task Close MonitorSet(s) Close System Object Close Network Wait for another uplink? No Call EndIncomingSessionEvents(myProfile) Close ObjectServer Figure 3.4 Uplink Session OpenLDV Programmer s Guide, xdriver Supplement 3-9

30 Session Control Object As described in the previous sections, the SCO is created at the beginning of an xdriver session. During its creation, the lookup key of the RNI involved in the session is filled into the SCO. The SCO is then passed to the Lookup Extension Component, which extracts the lookup key from the SCO and uses it to access the xdriver database. The Lookup Extension Component then fills in the rest of the SCO with additional information required to initiate the connection. Table 3.1 describes the fields that are filled into the SCO, and how the lookup extension uses them. If you are using an external database management system as your xdriver database, you must create a custom Lookup Extension Component to access the external database and fill in the SCO fields described in Table 3.1. Creating a Custom Lookup Extension Component on page 3-16 describes how to create the framework for a custom Lookup Extension Component using Microsoft Visual C++ 6.0, Microsoft Visual Basic.NET and Microsoft Visual Basic 6.0. Appendix B, Custom Lookup Extension Component Programming, describes the xdriver methods you can use to read and write to each of these SCO fields when you program your custom Lookup Extension Component. The appendix also contains field types constraints to be used when creating a custom database table. NOTE: The Lookup Extension Component has read/write access to all of these fields, and is required to set each field unless otherwise noted. Table 3.1 Session Control Object Field Session Control Object ID Downlink Lookup Key Description The SCO ID is a unique, read-only, 32-bit field that is filled in when the SCO is created, before the first call to the lookup extension. It can be used to identify the SCO. The downlink lookup key is an ASCII string (105 characters max) that is used by the Lookup Extension Component to access the xdriver database. This field is specified as part of the network interface name for an RNI. For more information on the xdriver network interface naming convention, see Downlink Sample Applications on page 4-2. NOTE: This field is specified in the network interface name of the RNI during a downlink session, and is read-only during downlinks. This field must be filled in during uplink sessions OpenLDV Programmer s Guide, xdriver Supplement

31 Field Uplink Lookup Key Description The uplink lookup key is an ASCII string (105 characters max) passed to the Lookup Extension Component by the RNI during an uplink session. It is used by the lookup extension to access the database record for the RNI that has requested the uplink session, so that the Lookup Extension Component can fill the rest of the fields described in this table into the SCO. For an i.lon 10 or i.lon 100, the uplink lookup key uses the following naming convention: [Hostname].[DNS Suffix] [Hostname] represents the hostname assigned to the i.lon 10 or i.lon 100 during its configuration. [DNS Suffix] is optional, and represents the DNS suffix or domain name assigned to the i.lon 10 or i.lon 100 during its configuration. For example, if the hostname for an i.lon 10 or i.lon 100 is myilon and the DNS suffix is xxx.com, the uplink key would be myilon.xxx.com. NOTE: This field is read-only during uplink sessions, and can be optionally filled in during downlink sessions. If desired, you can set the downlink key to match the uplink key. Authentication Flag Current Authentication Key This Boolean flag tells whether authentication between the LNS server and the RNI being connected to is enabled for the session. This field is always true for the i.lon 10 and i.lon 100. If the authentication flag is enabled, this represents the authentication key to be used for the session. This authentication key must match the MD5 authentication key supplied to the RNI during its configuration. Using an MD5 authentication key prevents the LNS Server or the RNI from responding to unauthorized messages during an xdriver session. The authentication key must be entered as a 32-character hexadecimal string representing a 128-bit MD5 key. For example: A0B0C0D0E0F10 Setting the authentication key to all 0s will cause xdriver to use the pre-defined, default factory authentication key for the RNI. For security reasons, it is not recommended that you use the default factory authentication key. For more information on how the Lookup Extension Component handles authentication, see Authentication Key Handling on page OpenLDV Programmer s Guide, xdriver Supplement 3-11

32 Field Next Authentication Key Description The next authentication key is usually the same as the current authentication key. This field represents the next authentication key to be used by the RNI. The authentication key must be entered as a 32-character hexadecimal string representing a 128-bit MD5 key. For example: A0B0C0D0E0F10 You can initiate a change to the authentication key used by the RNI by changing this field to a value different than the current authentication key. The authentication key configured into the RNI will then be updated to match this field. Setting this field to all 00s will cause xdriver to use the default authentication key as the next key for the RNI. For security reasons, it is not recommended that you use the default factory authentication key. When no change to the current authentication key is desired, this key should be set the same as the current authentication key. For more information on how the Lookup Extension Component handles authentication, see Authentication Key Handling on page LNS Network Name Additional Downlink Packet Header Additional Downlink Packet Trailer Encryption Type The name of the LNS network to be opened. This field should only be filled in during an uplink session, as the network name is specified manually within the LNS application in a downlink session. For an example of such an application, see Opening a Single Remote Network With xdriver on page 4-3. The LNS network name can be a maximum of 85 characters long. These fields are not required under most circumstances, and are only applicable to downlink sessions. They can be used to specify a series of bytes to be prepended or appended to every packet sent during a downlink session if there is an intermediate proxy between the LNS server and the RNI. These bytes can be used to provide routing information the proxy may require. When you configure an xdriver Profile that will use these properties, you may also need to select Send Routing Packet. This will cause xdriver to send the proxy a null packet (with the header and trailer bytes specified here) when the connection is established. This will provide the proxy with the information it requires to route the connection properly. For more information, see Using the xdriver Profile Editor on page The type of encryption used by the RNI. Currently, xdriver supports only RC4 encryption. Selected packets will be encrypted using an RC4 encryption algorithm if this option is selected OpenLDV Programmer s Guide, xdriver Supplement

33 Field Remote TCP Address Remote TCP Port Description The TCP/IP address of the RNI to be connected to. In an uplink session, this field is read-only. The remote TCP address must be specified in the form x.x.x.x, where x represents an integer between 0 and 255. A resolvable hostname can also be specified for this field. The port number that the RNI uses for incoming connections from the LNS server. In an uplink session, this field is read-only. Valid port numbers are 1-65,535. Authentication Key Handling Authentication key handling is an essential part of any Lookup Extension Component. It is critical that your custom Lookup Extension Component fills the authentication key fields into the SCO, and handles changes to the authentication key fields, properly. This section provides an overview of how the Lookup Extension Component should be used to update the authentication key for an RNI. NOTE: This section makes reference to several methods you will use when programming your custom lookup extension component. For more information on these methods, see Appendix B, Custom Lookup Extension Component Programming. Authentication Key Handling RNI Device Authentication Key: ABCD xdriver Connection xdriver Lookup Extension Component Accesses External Database and Returns Current Authentication Key External Database LNS Server with xdriver Figure 3.5 Authentication Key Handling Setting the Current Authentication Key When an xdriver session is initiated, the Lookup Extension Component should access the external database, extract the authentication flag for the RNI from the database, and fill it into the SCO using the SetAuthenticationFlag method. If the authentication flag is True, indicating that authentication is currently enabled, the Lookup Extension Component must also extract the current MD5 authentication key for the RNI from the external database, and fill it into the SCO using the SetCurrentAuthenticationKey method. This authentication key must be a unique, 32-character hexadecimal string representing the 128-bit MD5 key that is used by the RNI. OpenLDV Programmer s Guide, xdriver Supplement 3-13

34 NOTE: For ease of understanding, the sample authentication keys in this section do not use the required format. For example, in Figure 3.5 the authentication key configured into the RNI is listed as ABCD. The xdriver lookup interface includes another method, SetNextAuthenticationKey(). This method fills the next authentication key to be used by the RNI into the SCO. If no change the authentication key being used by the RNI is desired, the next authentication key should be the same as the current authentication key. This field should be filled in immediately after the current authentication key is filled in. Once these SCO fields are filled in, the xdriver protocol engine generates a 128-bit digest based on the current authentication key that is sent as part of every message to the RNI at the other end of the connection. The digest is extracted by the RNI and compared to a digest produced by the authentication key configured into the RNI. If the two digests match, then the two keys must match and the authentication succeeds. The current and next authentication keys filled into the SCO should match the authentication key configured into the RNI. Alternatively, you can fill in an authentication key of all 00s to use the pre-defined, default factory authentication key for the RNI as the current authentication key. This is not the recommended way to set the current authentication key, as it is not as secure as specifying a secret authentication key. Changing the Current Authentication Key You can use the SetNextAuthenticationKey method from your Lookup Extension Component to change the authentication key within an RNI by filling a next authentication key into the SCO that is different from the current authentication key. Doing so will initiate an incremental change to the authentication key configured into the RNI, so that it will end up with the key specified as the Next Authentication Key as its authentication key. When this change is complete, xdriver will call the UpdateLookup method in the Lookup Extension Component to acknowledge the change to the RNI s authentication key. The Lookup Extension Component should implement an update to the external database from the UpdateLookup method, so the new current value of the authentication key is recorded in the database. Therefore, the current authentication key in the database will match the key in the RNI the next time it is connected to. The current and next authentication keys should always be stored in the external database, and should only be updated when the UpdateLookup method is called. Table 3.2 shows the chain of events that occurs when the next authentication key field is used to update the authentication key of an RNI OpenLDV Programmer s Guide, xdriver Supplement

35 Table 3.2 Changing Authentication Keys Phase One, Lookup Extension Component Is Called In this example, the lookup extension fills different MD5 authentication keys into the current authentication key and next authentication key fields into the SCO. Initially, the current authentication key must match the authentication key configured into the RNI for the connection to be established. The authentication key fields start with the following values: RNI Authentication Key: ABCD SCO Current Authentication Key: ABCD SCO Next Authentication Key: EFGH Current Authentication Key in the External Database: ABCD Next Authentication Key in the External Database: EFGH Phase Two, RNI s Key Updated Because the current and next authentication keys filled into the SCO differ, the authentication key configured into the RNI is incremented so that it matches the next authentication key, EFGH. In addition, the current authentication key stored in the SCO is updated to match the next authentication key. The authentication key fields now have the following values: RNI Authentication Key: EFGH SCO Current Authentication Key: EFGH SCO Next Authentication Key: EFGH Current Authentication Key in the External Database: ABCD Next Authentication Key in the External Database: EFGH Phase Three, Update Lookup Method Called The UpdateLookup method is called once the authentication key configured into the RNI, and the current authentication key in the SCO, have been changed. This method should implement code to update the external database, so that it is updated with the new values of the current authentication key and the next authentication key from the SCO. The current and next authentication keys should always be stored in the external database, and should only be updated when the UpdateLookup method is called. The next time there is a session with this RNI, the lookup extension will fill in the proper value for the current authentication key. After update lookup has been called, the authentication key fields should have the following values: RNI Authentication Key: EFGH SCO Current Authentication Key: EFGH SCO Next Authentication Key: EFGH Current Authentication Key in the External Database: EFGH Next Authentication Key in the External Database: EFGH OpenLDV Programmer s Guide, xdriver Supplement 3-15

36 Creating a Custom Lookup Extension Component This section provides procedures to follow when creating the framework for your custom Lookup Extension Component using Microsoft Visual C++ 6.0, Microsoft Visual Basic.NET and Microsoft Visual Basic 6.0. Microsoft Visual C The following procedure describes how to create the framework for a custom Lookup Extension Component using Microsoft Visual C You must install the LNS Application Developer s Kit and Microsoft Visual C before following this procedure. 1. Open the Microsoft Visual C development environment and create an ATL COM server. From the File menu, select New. This opens the tab shown in Figure 3.6. Figure 3.6 Projects Tab 2. Select ATL COM AppWizard. Then, enter the name of your project in the Project Name text box, select a location for the project, and click OK. This opens the dialog shown in Figure 3.7. Any project location is suitable for development purposes. However, it is suggested that you install the custom Lookup Extension Component in the LonWorks/xDriver/Components/CompanyName/Lookup folder when distributing the DLL for your application OpenLDV Programmer s Guide, xdriver Supplement

37 Figure 3.7 Select Server Type 3. Select Dynamic Link Library (DLL) as the server type. Click Finish. 4. Add a COM object to the project. From the Insert menu, select New ATL Object. From the Category list, select Objects. Then, select the Simple Object icon and click Next. This opens the tab shown in Figure 3.8. Figure 3.8 Names Tab 5. Enter a name for the Lookup Extension Component in the Short Name text box and fill in the rest of the fields as required. None of these fields should OpenLDV Programmer s Guide, xdriver Supplement 3-17

38 begin with xdriver. In addition, the short name should not match the project name entered in step 2 of this procedure. The program ID should not match the program ID for any other lookup or COM component on your machine, or on any machine the application will be installed on, as it will be used by the Profile editor to identify the Lookup Extension Component. For this reason, it is recommended that you fill in the program ID using the following naming convention: [Company Name].Lookup.[Type] [[Company Name] represents the name of your company and [Type] represents the type of external database this Lookup Extension Component uses. For example: MyCompany.Lookup.ODBC. 6. Select the Attributes tab. Figure 3.9 Attributes Tab 7. For optimal performance, select Free as the threading model. This requires that your extension be multithread safe, and allows your component to directly access other xdriver extension components. Click OK. 8. Select the Class View tab. The class you created in the step 5 will be listed under the Lookup classes item. Import and implement the OpenLDV RNI into your project. Right click CLookup class (or the name of the class you created in step 5) and select Implement Interface, as shown in Figure OpenLDV Programmer s Guide, xdriver Supplement

39 Figure 3.10 Implement Interface 9. Click OK on the prompt that displays to open the Browse Type Libraries dialog. Select Echelon OpenLDV xdriver 3.20 Type Library and click OK. This opens the dialog shown in Figure Figure 3.11 Select Interfaces 10. Check the ILdvxConfigure (optional) and ILdvxLookup (required) checkboxes, and click OK. You can now modify the lookup extension by replacing the E_NOTIMPL stubs in Lookup.h with your own extension- OpenLDV Programmer s Guide, xdriver Supplement 3-19

40 #include "ldvxtypes.h" specific code. Please see the Appendix B, Custom Lookup Extension Component Programming, for more information on Lookup Extension Component programming. 11. Add the following line of code to the beginning of your Lookup Extension Component s header file: 12. Add the following three lines to your component's header file after END_COM_MAP: // COM component category map (CATID_LdvxLookup is defined in LdvxTypes.h) BEGIN_CATEGORY_MAP(CLookup) `CLookup represents the class name entered in step 5. IMPLEMENTED_CATEGORY(CATID_LdvxLookup) END_CATEGORY_MAP() This implements the xdriver Lookup Extension Component category and will allow you to assign this component to an xdriver Profile with the xdriver Profile Editor. 13. Optional step. The header file of your project contains the following line of code: #import "C:\LonWorks\Bin\Ldvx.tlb" raw_interfaces_only, raw_native_types, no_namespace, named_guids #include "LdvxResult.h" You can remove the "raw_interfaces_only, raw_native_types" attributes of this line to create high-level wrappers within your Lookup Extension Component. These wrappers will make it easier to call the SCO and other objects. However, you must implement the raw versions of each method included in the lookup and configure interfaces (e.g. UpdateLookup becomes raw_updatelookup). The sample Lookup Extension Component included with the xdriver software uses this option. You can find this sample at LonWorks/xDriver/Examples/Lookup. NOTE: Symbol conflicts may occur if you include the #import statement described above and the following statement: You can eliminate these symbol conflicts by removing the #include "LdvxResult.h" statement from your project, in which case you can get the LdvxResult types from the project type library. Or, you can add "LDVX_EXCLUDE_ENUMS" to the end of the #import statement described in this step as follows: #import "C:\LonWorks\Bin\Ldvx.tlb" raw_interfaces_only, raw_native_types, no_namespace, named_guids, LDVX_EXCLUDE_ENUMS In this case, the enumeration symbols for your project will come from the header file. 14. Build and register the COM server. From the Build menu, select Build LookupSample.DLL. This adds the custom Lookup Extension Component to the Windows Registry. NOTE: You will need to attach the debugger for your project to the VniServer.exe process in order to troubleshoot the extension. Please see Appendix B, Custom Lookup Extension Component Programming, for more information on custom Lookup Extension Component programming. This appendix 3-20 OpenLDV Programmer s Guide, xdriver Supplement

41 contains descriptions of the methods you can use to program your custom Lookup Extension Component. Microsoft Visual Basic.NET The following procedure describes how to create the framework for a custom Lookup Extension Component using Microsoft Visual Basic.NET. You must install the LNS Application Developer s Kit and Microsoft Visual Studio.NET before following this procedure. 1. Open the Microsoft Visual Studio.NET development environment, and create a class library project. From the File menu, select New>Project. This opens the dialog shown in Figure Figure 3.12 Create New Project 2. Select Visual Basic Projects as the project type, and Class Library as the template. Enter a name and location for the project. It is recommended that you fill in a project name that uses the following naming convention: [CompanyName]LookupVBNetLib, where [CompanyName] represents the name of your company. You will use this name with the Profile editor to identify the Lookup Extension Component later. Any project location is suitable for development purposes. However, it is suggested that you install this custom Lookup Extension Component in the LonWorks/xDriver/Components/CompanyName/Lookup folder when distributing the DLL for your application. OpenLDV Programmer s Guide, xdriver Supplement 3-21

42 Click OK. 3. Next, add a reference to the Echelon OpenLDV xdriver 3.20 Type Library to your project. From the Project menu, select Add Reference. This opens the Add Reference window. Click the COM tab. This opens the dialog shown in Figure Figure 3.13 Add Reference 4. Choose Echelon OpenLDV xdriver 3.20 Type Library from the Component Name list, and click Select. Then, click OK to add the reference to your project. 5. From the Project menu, select Add Class. Select COM Class as the template. This will generate the proper GUIDs, and the required New Sub method, for your project. If you copy the sample files to use as a base for your project, you must change the GUIDs. It is recommended that you use the name Lookup[Database Type] as the name of the class you create here, where [Database Type] represents the type of external database management system you are using. You will use this name with the xdriver Profile Editor to identify the Lookup Extension Component later. 6. Use the Solution Explorer to delete Class1.vb, the class that was initially created with the project. Right-click Class1.vb,and select Delete. 7. Add the following lines to the beginning of your source code: 3-22 OpenLDV Programmer s Guide, xdriver Supplement

43 Imports LdvxLib Imports LdvxLib.LdvxEncryption Imports LdvxLib.LdvxResult This adds the properties, methods and types of the Echelon OpenLDV xdriver 3.20 Type Library to the System namespace of your project. 8. Add the following lines of code at the beginning of your class: Implements ILdvxConfigure Implements ILdvxLookup This specifies the interfaces that will be implemented in your lookup extension. The ILdvxConfigure interface is optional. 9. Open the Object Browser. From the View menu, select Other Windows>Object Browser. Expand Interop.LdvxLib to see a list of the methods associated with each RNI. You must implement the DownlinkLookup, UpdateLookup, and UplinkLookup members of the ILdvxLookup interface, in your class. You can optionally implement the SetIntance and SetOptions members of the ILdvxConfigure interface To do so, select the interface name from the [Class Component Name] pull-down list above the code box. Then, select each method for the interface from the Declarations pull-down list, as in Figure This will generate the declaration and end statements required for each subroutine. Figure 3.14 Implementing Methods NOTE: You will need to attach the debugger for your project to the VniServer.exe process in order to troubleshoot the extension. You can now begin coding your Lookup Extension Component. Please see Appendix B, Custom Lookup Extension Component Programming, for more information on Custom Lookup Extension Component programming. This appendix contains descriptions of the methods you can use to program your custom Lookup Extension Component. OpenLDV Programmer s Guide, xdriver Supplement 3-23

44 Visual Basic 6.0 The following procedure describes how to create the framework for a custom Lookup Extension Component using Microsoft Visual Basic 6.0. You must install the LNS Application Developer s Kit software and Microsoft Visual Studio 6.0 before following this procedure. 1. Open the Microsoft Visual Basic 6.0 development environment and create an ActiveX DLL project. From the File menu, select New Project. Select ActiveX DLL as the project type and click Open. 2. Save the project. From the File menu, select Save Project to open the Save File dialog. Enter a name and location for the project and click OK. It is recommended that you name the project [MyCompany]LookupVBLib, where [MyCompany] represents your company name. You will use this name with the Profile editor to identify the Lookup Extension Component later. Any project location is suitable for development purposes. However, it is suggested that you install this custom Lookup Extension Component in the LonWorks/xDriver/Components/CompanyName/Lookup folder when distributing the DLL for your application. 3. From the File menu, select Save Class As to save the class for your project. It is recommended that you use the following naming convention for your class name: Lookup[Type], where [Type] represents the type of external database management system you are using. You will use this name with the Profile editor to identify the Lookup Extension Component later. 4. Import a reference to the Echelon OpenLDV xdriver 3.20 Type Library into your project. From the Project menu, select References. This opens the dialog shown in Figure OpenLDV Programmer s Guide, xdriver Supplement

45 Figure 3.15 Import Reference 5. Select Echelon OpenLDV xdriver 3.20 Type Library and click OK. 6. Insert the following lines at the beginning of the source code for your application: Implements ILdvxLookup Implements ILdvxConfigure This specifies the interfaces that will be implemented in your lookup extension. The ILdvxConfigure interface is optional. 7. Open the Object Browser. From the View menu, select Object Browser. Then, select LdvxLib from the drop-down list at the top of the browser. You will see a list of the methods associated with each RNI. You must implement the DownlinkLookup, UpdateLookup, and UplinkLookup members of the ILdvxLookup interface in your class. You can optionally implement the SetInstance and SetOptions members of the IldvxConfigure interface in your class. To do so, select the interface name from the General pull-down list above the code box. Then, select each applicable method name for each interface from the Declarations pull-down list, as in Figure This will generate the declaration and end statements required for each subroutine. OpenLDV Programmer s Guide, xdriver Supplement 3-25

46 Figure 3.16 Implementing Methods NOTE: You must define each method if the interfaces you implement in your project. Otherwise, a compiler error will be generated. 8. After you initially compile the project, change the compatibility type to binary. From the Project menu, select [Project Name] Properties. Click the Component tab. This opens the tab shown in Figure Figure 3.17 Component Properties Tab 9. Choose Binary Compatibility as the Version Compatibility type. Click OK. NOTE: You will need to attach the debugger for your project to the VniServer.exe process in order to troubleshoot the extension OpenLDV Programmer s Guide, xdriver Supplement

47 You can now begin coding your Lookup Extension Component. Please see Appendix B, Custom Lookup Extension Component Programming, for more information on Lookup Extension Component programming. This appendix contains descriptions of the methods you can use to program your custom Lookup Extension Component. xdriver Profiles Once you have finished programming your custom Lookup Extension Component, you can create an xdriver Profile to use it. An xdriver Profile represents a set of configuration parameters that determines how xdriver will manage sessions. This includes a variety of factors, such as the port that xdriver will use to listen for uplink connection requests, and the port that xdriver will use to initiate downlink connections. It also includes the xdriver automatic reconnection feature. If you enable this feature, xdriver will attempt to reconnect any uplink or downlink session that is broken as a result of some unexpected connection failure. With automatic reconnection enabled, you can configure xdriver to attempt reconnection as soon as it detects a failed session. When this happens, xdriver will attempt reconnection until the session has been successfully reestablished, or until a time period that you define has expired. All of this is described in more detail in the next section, Using the xdriver Profile Editor. The Profile to be used for each session is determined on a session-by-session basis. In a downlink session, the Profile to use is specified in the network interface name of the RNI. The network interface name for an RNI using xdriver must use the following naming convention: X.[Profile Name].[Downlink Lookup Key] [Profile Name] represents the name of the Profile to use for the session. [Downlink Lookup Key] represents the downlink lookup key assigned to the RNI when it was added to the xdriver database. For sample programs that use this naming convention, see Downlink Sample Applications on page 4-2. In an uplink session, the request for connection will come in on a specific TCP port. The xdriver Profile using that port as its listener port will handle the uplink session. You can set the listener port a Profile will use with the OpenLDV xdriver Profile Editor. Using the xdriver Profile Editor The following procedure describes how to use the OpenLDV xdriver Profile Editor to create an xdriver Profile, and to edit, delete or copy existing Profiles. 1. Click the Windows Start button, and select Programs>Echelon LNS Utilities>OpenLDV xdriver Profile Editor. This opens a window similar to the one shown in Figure OpenLDV Programmer s Guide, xdriver Supplement 3-27

48 Figure 3.18 List of Registered Profiles 2. This window lists all xdriver Profiles that have been created with the Profile editor, as well as the Default xdriver Profile included with the xdriver software. You can select a Profile by clicking its name. You will then have the following options: Click Copy to copy the parameters for the selected Profile into a new Profile. You will be prompted to enter the name of the new Profile. Click Remove to delete the selected Profile. Click Export to save the Profile as a.reg file. You will be prompted to select a directory location and file name for the.reg file. You can then import the.reg file to another PC to use the Profile on that PC. Note that the Lookup properties of the imported profile will be read-only. Click Properties to view or edit the configuration parameters defined for the selected Profile. Steps 4-8 of this procedure describe how to do so. Click Help to access the online help for the Profile editor. Click Add to create a new Profile. This opens the dialog shown in Figure NOTE: You can create a maximum of 59 xdriver Profiles per PC. Figure 3.19 New Profile Dialog 3. Enter the name of the new Profile in the Profile Name text box (20 characters maximum). Click OK. This opens the tab shown in Figure OpenLDV Programmer s Guide, xdriver Supplement

49 Figure 3.20 General Tab 4. Enter a description of the Profile in the Profile Description box. This may be useful if you plan on creating multiple Profiles. You can click Restore Default Values to restore the default factory settings to a Profile at any time from this tab. Next, click the Downlink Sessions tab. OpenLDV Programmer s Guide, xdriver Supplement 3-29

50 Figure 3.21 Downlink Sessions Tab 5. Configure the fields on the Downlink Sessions tab. Consult the online help for descriptions of these fields. When you are finished, click the Uplink Sessions tab. Figure 3.22 Uplink Sessions Tab 3-30 OpenLDV Programmer s Guide, xdriver Supplement

51 6. To enable this xdriver Profile to handle uplink session requests, check the Enable Uplink Calls box and then configure the rest of the fields on the tab. Consult the online help for descriptions of these fields. You must start the Connection Broker for xdriver to receive uplink session requests. For instructions, see Starting the Connection Broker on page When you have finished configuring the fields on the Uplink Sessions tab, click the Lookup tab. Figure 3.23 Lookup Tab 7. Configure the fields on the Lookup tab. Consult the online help for descriptions of these fields. NOTE: The fields on the Lookup tab can only be modified during development of the Profile. Once a profile has been installed on a PC via the Export function or an installer utility, the fields on the Lookup tab become read-only. In addition, the fields on the Lookup tab are read-only for the Default xdriver Profile. When you have finished configuring the fields on the Lookup tab, click the Protocol Options tab. OpenLDV Programmer s Guide, xdriver Supplement 3-31

52 Figure 3.24 Protocol Options Tab 8. Configure the fields on the Protocol Options tab. Consult the online help for descriptions of these fields. When you are finished, click the Recovery Options tab. Figure 3.25 Recovery Options Tab 3-32 OpenLDV Programmer s Guide, xdriver Supplement

53 9. You can configure xdriver to automatically attempt reconnection when xdriver sessions using this Profile are broken as a result of some unexpected communication failure. To do so, check the Enable Recovery box, and configure the rest of the fields on the Recovery Options tab. Consult the online help for descriptions of these fields. 10. When you have finished configuring the fields on the Recovery Options tab, click OK. You will return to the Window shown in Figure 3.18, and the new Profile will be listed in the Currently Registered Profiles list. You can also click Apply at any time to save your changes and continue editing the Default Profile. NOTE: There are two ways to install these Profiles when distributing your application with a tool like InstallShield. The first way is to install the Profiles as permanent Registry entries that will never be uninstalled or overwritten. A disadvantage to this is that re-installing the software will not return the default values to these Profiles. However, the xdriver Profile Editor provides a button to restore any Profiles to its default value. The second way is to install your Profiles as temporary Registry entries that are overwritten each time the software is installed. In this case, the default values would be restored each time the software is installed. In this case, all changes that were configured by the user since the last installation would be lost. It is important to consider both of these options before distributing your application. Once you have created a Profile to use your custom Lookup Extension Component and started the Connection Broker, you can begin using LNS applications such as LonMaker to access the networks you will be using with xdriver. Alternatively, you can begin creating LNS applications for xdriver. Chapter 4, LNS Programming With xdriver, provides programming samples to assist you in creating these new applications. Starting the Connection Broker The following procedure describes how to start the Echelon OpenLDV xdriver Broker. The Connection Broker must be running for xdriver to receive uplink session requests. However, it is not required for downlink sessions. NOTE: Uplink sessions are not supported by the Windows 98 and Windows Me platforms. The Connection Broker will automatically stop if there are no Profiles with uplink session handling enabled. In addition, the Connection Broker must be stopped and restarted each time uplink session handling for a Profile is enabled or disabled. 1. Open the Services administrative control panel applet. You will see an entry in the list called Echelon OpenLDV xdriver Broker. OpenLDV Programmer s Guide, xdriver Supplement 3-33

54 Figure 3.26 Services Administrative Control Panel Applet 2. To start the Connection Broker, select Echelon OpenLDV xdriver Connection Broker and click the start button on the Computer Management toolbar. Or, right-click the Echelon OpenLDV xdriver Connection Broker entry and select Properties. This opens the Echelon OpenLDV Connection Broker Properties dialog. 3. To enable the Connection Broker service permanently, select Automatic from the Startup Type pull-down list. Then, click Start OpenLDV Programmer s Guide, xdriver Supplement

55 4 LNS Programming With xdriver This chapter provides sample programs that may assist you when creating LNS applications to manage downlink and uplink xdriver sessions. Several changes and additions to LNS have been made for use with xdriver. These changes are reflected in the sample programs in this chapter, so it is important that you review them before creating your own LNS applications for xdriver. OpenLDV Programmer s Guide, xdriver Supplement 4-1

56 Downlink Sample Applications The following sample applications initiate downlink sessions. LNS applications that manage downlink sessions operate as though the LNS server is using any other type of network interface. However, the network interface name for an xdriver RNI must use the following naming convention: X.[Profile Name].[Downlink Lookup Key] [Profile Name] represents the name of the xdriver Profile to be used in this session. [Downlink Lookup Key] represents the downlink lookup key assigned to the RNI when it was added to the xdriver database. xdriver network interface names are caseinsensitive. For example, if the downlink lookup key assigned to an RNI is RNI-0001 and this RNI uses Profile Default, the network interface name for that device would be X.Default.RNI NOTE: All physical local interfaces appear in the NetworkInterfaces collection. However, xdriver RNIs that use custom Lookup Extension Components will not appear in the NetworkInterfaces collection until a session with that RNI has been fully established. This is not true for the Default xdriver Profile, which uses the Windows Registry to ensure that all configured RNIs will show up in the LCA s NetworkInterfaces collection. For other Profiles, it is still possible to create the appropriate NetworkInterface object by name from the LCA s Network Interfaces collection using the NetworkInterfaces.Item(NetworkInterfaces As String) method. For example: NetworkInterfaces.Item( X.Default.RNI-0001 ) This is demonstrated in the second downlink programming sample on page OpenLDV Programmer s Guide, xdriver Supplement

57 Opening a Single Remote Network With xdriver The following Visual Basic programming sample is an LNS application that creates, opens and closes a single remote network with xdriver. At the completion of the subroutine, the Object Server will contain a new network named "Network1" whose database is stored in "c:\network1", and a new subsystem named "Subsystem1." The network interface name used to access the new network is X.Default.RNI This sample demonstrates the use of the xdriver network interface naming convention. Comments relevant to this are in bold. Dim LcaOs As LcaObjectServer Dim ActiveNetwork As LcaNetwork Dim ActiveSystem As LcaSystem Dim ActiveSubsystem As LcaSubsystem Dim TempNetworkInterface As LcaNetworkInterface Private Sub InitializeObjectServer() 'Initialize the global LNS database. Set lcaos.remoteflag = False Set lcaos.singleusermode = False lcaos.open 'Add a new network object and open the 'network database. Network1 represents the name 'of the network and c:\network1 represents the path to the 'network database. Set ActiveNetwork = lcaos.networks.add _ ("Network1", "c:\network1", True) ActiveNetwork.Open 'Fetch the system from the network. Set ActiveSystem = ActiveNetwork.Systems.Item(1) 'Select a network interface. Note the use of the xdriver naming 'convention in this line: X.[Profile Name].[Downlink Lookup Key]. Default 'represents the Profile name to use. RNI-0001 represents the downlink 'lookup key for the RNI to be opened. Set TempNetworkInterface _ = lcaos.networkinterfaces.item("x.default.rni-0001") Set ActiveSystem.NetworkServiceDevice.NetworkInterface _ = TempNetworkInterface 'Set up the NSS engine and open an xdriver downlink session by opening 'the System object. ActiveSystem.Open 'Set the system into OnNet management mode. ActiveSystem.MgmtMode = lcaonnet 'Create a subsystem object to hold your AppDevice objects. Set ActiveSubsystem = ActiveSystem.Subsystems.Add("Subsystem1") 'Any other code goes here. OpenLDV Programmer s Guide, xdriver Supplement 4-3

58 ActiveSystem.Close ActiveNetwork.Close LcaOS.Close End Sub 4-4 OpenLDV Programmer s Guide, xdriver Supplement

59 Opening Multiple Remote Networks Via Downlink The following Visual Basic sample program opens multiple remote networks simultaneously. It uses xdriver to connect to two remote LONWORKS networks. The information required to open each network (network name, xdriver Profile name, and the RNI lookup key) for this program is hard coded into the application. Figure 4.1 shows the form that was created for this application. Figure 4.1 Downlink Application Form This application can open either of the two remote LONWORKS networks by clicking the Open Network A and Open Network B buttons. Once either network has been opened, the applicable Close Network button becomes enabled, so that a user can close the network. When both networks are opened at the same time, each network is assigned its own xdriver network interface. From this example, you should be able create your own application that will use xdriver to open multiple remote networks simultaneously. The comments in this sample program explain the purpose of each line of code within this application. For more information on any of the LNS commands used in this sample program, please see the LNS Programmer s Guide. OpenLDV Programmer s Guide, xdriver Supplement 4-5

LonScanner TM Protocol Analyzer User's Guide

LonScanner TM Protocol Analyzer User's Guide LonScanner TM Protocol Analyzer User's Guide @ 078-0305-01A Echelon, LNS, LonTalk, LONWORKS, i.lon, LONMARK, NodeBuilder, Neuron and the Echelon logo are registered trademarks of Echelon Corporation. LonMaker

More information

NodeBuilder 3.1 Development Tool Model 10020

NodeBuilder 3.1 Development Tool Model 10020 Description The NodeBuilder tool is a hardware and software platform that is used to develop applications for Neuron Chips and Echelon Smart Transceivers. The NodeBuilder tool includes a complete suite

More information

IzoT TM Plug-in for WireShark

IzoT TM Plug-in for WireShark IzoT TM Plug-in for WireShark Monitor, analyze, and troubleshoot IzoT networks using the Wireshark packet analyzer. 078-0511-01A Echelon, LonTalk, LNS, IzoT, and the Echelon logo are trademarks of Echelon

More information

NodeLoad Utility User s Guide

NodeLoad Utility User s Guide NodeLoad Utility User s Guide @ ECHELON C o r p o r a t i o n 078-0286-01C Echelon, LON, LONWORKS, i.lon, LonTalk, 3120, 3150, and the Echelon logo are trademarks of Echelon Corporation registered in the

More information

LONMANAGER NSS-10 MODEL

LONMANAGER NSS-10 MODEL LONMANAGER NSS-10 MODEL 34000-100 FEATURES Host processor and operating system independent design Register-based host interface provides high packet throughput for system-level monitoring and control applications

More information

A. LonTalk Stack Developer's Guide

A. LonTalk Stack Developer's Guide 078-0483-01A LonTalk Stack Developer's Guide Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, LNS, ShortStack, and the Echelon logo are trademarks of Echelon Corporation registered

More information

i.lon SmartServer Models 7210xR-4xx, , 72160, and Description Programmable

i.lon SmartServer Models 7210xR-4xx, , 72160, and Description Programmable i.lon SmartServer Models 7210xR-4xx, 72111-409, 72160, and 72161 t Programmable t LNS mode with direct LNS SOAP interface t Standalone network management mode t Data point trend graphs t ModBus IP t Upgraded

More information

Pyxos FT Network Chip 11500R

Pyxos FT Network Chip 11500R Pyxos FT Network Chip 11500R Features Low-cost embedded control networking chip for use inside machines and for extending control networks to high-performance sensor networks Miniaturized form factor fits

More information

Office and Express Print Release High Availability Setup Guide

Office and Express Print Release High Availability Setup Guide Office and Express Print Release High Availability Setup Guide Version 1.0 2017 EQ-HA-DCE-20170512 Print Release High Availability Setup Guide Document Revision History Revision Date May 12, 2017 September

More information

FTXL User s Guide A

FTXL User s Guide A FTXL User s Guide 078-0363-01A Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, LNS, i.lon, ShortStack, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered

More information

ShortStack FX User s Guide

ShortStack FX User s Guide ShortStack FX User s Guide 078-0365-01B Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, LNS, i.lon, ShortStack, LonMaker, and the Echelon logo are trademarks of Echelon Corporation

More information

FT 5000 EVB Examples Guide

FT 5000 EVB Examples Guide FT 5000 EVB Examples Guide 078-389-01B Echelon, LON, LonWorks, Neuron, 3120, 3150, Digital Home, i.lon, LNS, LonMaker, LonMark, LonPoint, LonTalk, NodeBuilder, ShortStack, and the Echelon logo are trademarks

More information

SmartRouters Optionally with Bus Diagnostics RTRS RTRSD

SmartRouters Optionally with Bus Diagnostics RTRS RTRSD SmartRouters Optionally with Bus Diagnostics RTRS RTRSD Data Sheet Revision 3 GmbH Dresden The present instruction is intended to support you concerning installation and use of the device. The information

More information

LNT 505 Installation and Commissioning Manual

LNT 505 Installation and Commissioning Manual 1MRS751705-MUM Issued: 10.11.99 Program rev.: 1.1.1 Doc. version: B Data subject to change without notice LNT 505 Commissioning Manual 1MRS 751705-MUM LNT 505 Table of Content 1 Legal notes...1 1.1 Trademarks...

More information

Product Catalog

Product Catalog Product Catalog 2006-2007 www.echelon.com Product Catalog 2006-2007 Edition Version A For detailed information on Echelon s products, including the most up-to-date data sheets for the products covered

More information

Configuration Guide for Microsoft Internet Connection Sharing

Configuration Guide for Microsoft Internet Connection Sharing Configuration Guide for Microsoft Internet Connection Sharing HUB INTERNET HOST CLIENTS Copyright 2002 Hughes Network Systems, Inc., a wholly owned subsidiary of Hughes Electronics Corporation. All rights

More information

Pyxos FT Network Chip 11500R

Pyxos FT Network Chip 11500R Pyxos FT Network Chip 11500R Introduction The Pyxos platform is a high-speed sensor network ideal both for stand-alone applications and the ones extending LONWORKS networks down to sensor and actuator

More information

ilon100 SOAP /XML to LONWorks Device Driver Guide

ilon100 SOAP /XML to LONWorks Device Driver Guide ilon100 SOAP /XML to LONWorks Device Driver Guide Version 4.0 rev 3 Advantech Corp., Ltd. page 1-1 Table of Contents ilon100 SOAP /XML to LONWorks Device Driver Guide 1-1 1. ilon100 SOAP/XML Ethernet Device

More information

LONWORKS Plug-In Software

LONWORKS Plug-In Software Installation and Maintenance Manual IM 933 Group: McQuay Controls Part Number: IM 933 Date: September 2008 Supercedes: New LONWORKS Plug-In Software For use with the MicroTech III Unitary Controller -

More information

setting manual VRF System UTY-ASGX Ver. 1.0 Please read the LICENSE AGREEMENT in the manual first

setting manual VRF System UTY-ASGX Ver. 1.0 Please read the LICENSE AGREEMENT in the manual first setting manual SERVICE TOOL for VRF System UTY-ASGX Ver. 1.0 caution Please read the LICENSE AGREEMENT in the manual first. 9708313023-01 LICENSE AGREEMENT for SERVICE TOOL for VRF SYSTEM (Version 1.0)

More information

LNS Turbo Edition Features

LNS Turbo Edition Features LNS Turbo Edition Features Copyright 2004, Echelon Corporation. All rights reserved. LNS Turbo Edition Key New Features Compatibility Performance improvements Enhanced scalability LONMARK support Database

More information

Office and Express Print Submission High Availability for DRE Setup Guide

Office and Express Print Submission High Availability for DRE Setup Guide Office and Express Print Submission High Availability for DRE Setup Guide Version 1.0 2016 EQ-HA-DRE-20160915 Print Submission High Availability for DRE Setup Guide Document Revision History Revision Date

More information

Smart Access Control System Software. User Manual. Version 1.0

Smart Access Control System Software. User Manual. Version 1.0 Smart Access Control System Software User Manual Version 1.0 Copyright MaCaPS International Ltd. 2002 This manual was produced by MaCaPS International Ltd. MaCaPS International Ltd. http://www.macaps.com.hk

More information

FieldView. Management Suite

FieldView. Management Suite FieldView The FieldView Management Suite (FMS) system allows administrators to view the status of remote FieldView System endpoints, create and apply system configurations, and manage and apply remote

More information

Quest Collaboration Services 3.6. Installation Guide

Quest Collaboration Services 3.6. Installation Guide Quest Collaboration Services 3.6 Installation Guide 2010 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide

More information

LONWORKS. PCLTA-21 PCI Interface User s Guide. Version 1. C o r p o r a t i o n A

LONWORKS. PCLTA-21 PCI Interface User s Guide. Version 1. C o r p o r a t i o n A LONWORKS PCLTA-21 PCI Interface User s Guide Version 1 C o r p o r a t i o n 078-0271-01A Echelon, LON, LONWORKS, LonTalk, LonBuilder, NodeBuilder, LONMARK, Neuron, i.lon, LonManager, 3120, and 3150 are

More information

Pyxos FT EVK User s Guide

Pyxos FT EVK User s Guide @ECHELON Pyxos FT EVK User s Guide @ 078-0342-01A Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, LNS, i.lon, ShortStack, LonMaker, and the Echelon logo are trademarks of Echelon

More information

IzoT TM Resource Editor s Guide

IzoT TM Resource Editor s Guide IzoT TM Resource Editor s Guide Create, view, and modify resource definitions for IzoT and LONWORKS applications and devices. 078-0508-01A Echelon, FTXL, LonScanner, LonSupport, LON, LonWorks, Neuron,

More information

INSTALLATION AND STARTUP

INSTALLATION AND STARTUP MCL TOOL 5.3 - SECTION TWO INSTALLATION AND STARTUP Chapters 1. MCL Tool Software Installation 2. Hardware Installation 3. Getting Started 2003 Johnson Controls, Inc. Literature # - TD-2059 Installation

More information

Mini FX User s Guide

Mini FX User s Guide Mini FX User s Guide 0 7 8-0 3 9 8-0 1 A Echelon, LON, LONWORKS, Neuron, 3120, 3150, Digital Home, i.lon, LNS, LonMaker, LONMARK, LonPoint, LonTalk, NodeBuilder, ShortStack, and the Echelon logo are trademarks

More information

NodeBuilder User s Guide

NodeBuilder User s Guide NodeBuilder User s Guide Release 3.1 Revision 3 @ ECHELON C o r p o r a t i o n 078-0141-01E Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, NodeBuilder, ShortStack, the LonUsers logo, the

More information

Mini EVK Hardware Guide Revision 3

Mini EVK Hardware Guide Revision 3 Mini EVK Hardware Guide Revision 3 @ 078-0303-01C Echelon, LONWORKS, Neuron, 3120, 3150 and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. i.lon

More information

Redirector User Guide

Redirector User Guide Redirector User Guide Revision B November 04, 2005 Part Number GC-800-235 Copyright and Trademark Copyright 2004, Grid Connect, Inc. All rights reserved. No part of this manual may be reproduced or transmitted

More information

DocAve v5 Installation Configure your DocAve 5 Platform Quickly and Easily

DocAve v5 Installation Configure your DocAve 5 Platform Quickly and Easily How to Guide DocAve v5 Installation Configure your DocAve 5 Platform Quickly and Easily This document is intended for anyone wishing to familiarize themselves with the basic installation and navigation

More information

MX-AOPC UA Server User s Manual

MX-AOPC UA Server User s Manual User s Manual Edition 3.1, November 2016 www.moxa.com/product 2016 Moxa Inc. All rights reserved. User s Manual The software described in this manual is furnished under a license agreement and may be used

More information

GIFTePay 5.0. Synergy World. Installation & Configuration Guide. Part Number: With Dial Backup

GIFTePay 5.0. Synergy World. Installation & Configuration Guide. Part Number: With Dial Backup GIFTePay 5.0 Installation & Configuration Guide Synergy World With Dial Backup Part Number: 8662.86 GIFTePay 5.0 Installation & Configuration Guide Copyright 2006-2017 Datacap Systems Inc. All rights reserved.

More information

Guest Management Software Administrator Guide. Installation and Getting Started Guide Administrator Guide

Guest Management Software Administrator Guide. Installation and Getting Started Guide Administrator Guide Guest Management Software Administrator Guide Guest ProCurve Management 5400zl Switches Software Installation and Getting Started Guide Administrator Guide Guest Management Software Administrator Guide

More information

9936A LogWare III. User s Guide. Revision

9936A LogWare III. User s Guide. Revision 9936A LogWare III User s Guide Revision 850701 Table of Contents 1 Introduction...1 1.1 Symbols Used... 1 1.2 Conventions... 1 1.3 What is LogWare?... 1 1.4 License Agreement... 2 1.5 Requirements...

More information

Equitrac Office and Express DCE High Availability White Paper

Equitrac Office and Express DCE High Availability White Paper Office and Express DCE High Availability White Paper 2 Summary............................................................... 3 Introduction............................................................

More information

NodeBuilder FX User s Guide

NodeBuilder FX User s Guide NodeBuilder FX User s Guide 0 7 8-0 4 0 5-0 1 A Echelon, LON, LonWorks, Neuron, 3120, 3150, Digital Home, i.lon, LNS, LonMaker, LONMARK, LonPoint, LonTalk, NodeBuilder, ShortStack, and the Echelon logo

More information

LONWORKS. PCLTA-10 PC LonTalk Adapter User s Guide. E C o r p o r a t i o n. Version B

LONWORKS. PCLTA-10 PC LonTalk Adapter User s Guide. E C o r p o r a t i o n. Version B LONWORKS PCLTA-10 PC LonTalk Adapter User s Guide Version 2 123 E C o r p o r a t i o n 078-0159-01B Echelon, LON, LonTalk, LonBuilder, Neuron, LonManager, LONWORKS, and 3150 are registered trademarks

More information

ShortStack 2.1 ARM7 Example Port User s Guide

ShortStack 2.1 ARM7 Example Port User s Guide ShortStack 2.1 ARM7 Example Port User s Guide 078-0366-01A Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, ShortStack, LonMaker, and the Echelon logo are trademarks of Echelon Corporation

More information

Embedded Connector for IKON DocSend Setup Guide

Embedded Connector for IKON DocSend Setup Guide Embedded Connector for IKON DocSend Setup Guide Version 1.1 2016 IKON-20160314 Equitrac Embedded Connector for IKON DocSend Setup Guide Document History Date Description of Change April 18, 2013 Updated

More information

Proficy* HMI/SCADA - ifix LAN R EDUNDANCY

Proficy* HMI/SCADA - ifix LAN R EDUNDANCY Proficy* HMI/SCADA - ifix LAN R EDUNDANCY Version 5.5 February 2012 All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical means, including photocopying

More information

Mbx.Net Help Mbx.Net Configuration Editor

Mbx.Net Help Mbx.Net Configuration Editor Mbx.Net Help Mbx.Net Configuration Editor Version 1 Version 1 MBX.NET CONFIGURATION EDITOR HELP Copyright 1994-2017, Cyberlogic Technologies Inc. All rights reserved. This document and its contents are

More information

BlackBerry Enterprise Server for Lotus Domino 2.0 Service Pack 5 Readme file

BlackBerry Enterprise Server for Lotus Domino 2.0 Service Pack 5 Readme file BlackBerry Enterprise Server for Lotus Domino 2.0 Service Pack 5 Readme file PLEASE READ THE LEGAL NOTICES SET OUT AT THE END OF THIS DOCUMENT. This document provides information about BlackBerry Enterprise

More information

Ethernet DHX Driver Help Ethernet DHX Driver for Allen-Bradley TCP/IP Networks

Ethernet DHX Driver Help Ethernet DHX Driver for Allen-Bradley TCP/IP Networks Ethernet DHX Driver Help Ethernet DHX Driver for Allen-Bradley TCP/IP Networks Version 9 ETHERNET DHX DRIVER HELP Ethernet DHX Driver for Allen-Bradley TCP/IP Networks Version 9 Copyright 1994-2017, Cyberlogic

More information

SIOS Protection Suite for Linux v Postfix Recovery Kit Administration Guide

SIOS Protection Suite for Linux v Postfix Recovery Kit Administration Guide SIOS Protection Suite for Linux v8.3.1 Postfix Recovery Kit Administration Guide September 2014 This document and the information herein is the property of SIOS Technology Corp. (previously known as SteelEye

More information

Product Update Notification

Product Update Notification Product Update Notification Subject: Support of Distech Controls products on the Microsoft Windows Vista Operating System. Product All Distech Controls Applications, LNS Configuration & Monitoring Plug-ins

More information

MX-AOPC UA Server User s Manual

MX-AOPC UA Server User s Manual User s Manual Edition 3.3, February 2018 www.moxa.com/product 2018 Moxa Inc. All rights reserved. User s Manual The software described in this manual is furnished under a license agreement and may be used

More information

PMS 138 C Moto Black spine width spine width 100% 100%

PMS 138 C Moto Black spine width spine width 100% 100% Series MOTOROLA and the Stylized M Logo are registered in the US Patent & Trademark Office. All other product or service names are the property of their respective owners. 2009 Motorola, Inc. Table of

More information

GIFTePay 5.0. Perk Network (UniPerk) Installation & Configuration Guide. Part Number:

GIFTePay 5.0. Perk Network (UniPerk) Installation & Configuration Guide. Part Number: GIFTePay 5.0 Installation & Configuration Guide Perk Network (UniPerk) Part Number: 8662.70 GIFTePay 5.0 Installation & Configuration Guide Copyright 2011 Datacap Systems Inc. All rights reserved. This

More information

FRONTLINE TEST SYSTEM

FRONTLINE TEST SYSTEM FRONTLINE TEST SYSTEM SETUP AND QUICK START GUIDE ETHERTEST 04 Feb 09 300 DOC ET 000 Copyright 2000 2009 Frontline Test Equipment, Inc. All rights reserved. You may not reproduce, transmit, or store on

More information

GIFTePay 5.0. Profit Point. Installation & Configuration Guide. Part Number: With Dial Backup

GIFTePay 5.0. Profit Point. Installation & Configuration Guide. Part Number: With Dial Backup GIFTePay 5.0 Installation & Configuration Guide Profit Point With Dial Backup Part Number: 8662.69 GIFTePay 5.0 Installation & Configuration Guide Copyright 2011 Datacap Systems Inc. All rights reserved.

More information

NDA ISSUE 1 STOCK # MATWorX 32 User s Guide. December, NEC America, Inc.

NDA ISSUE 1 STOCK # MATWorX 32 User s Guide. December, NEC America, Inc. NDA-24215 ISSUE 1 STOCK # 151942 MATWorX 32 User s Guide December, 1997 NEC America, Inc. LIABILITY DISCLAIMER NEC America, Inc. reserves the right to change the specifications, functions, or features,

More information

SOHO 6 Wireless Installation Procedure Windows XP with Internet Explorer 5.x & 6.0

SOHO 6 Wireless Installation Procedure Windows XP with Internet Explorer 5.x & 6.0 SOHO 6 Wireless Installation Procedure Windows XP with Internet Explorer 5.x & 6.0 Before you Begin Before you install the SOHO 6 Wireless, you must have: A computer with a 10/100BaseT Ethernet card installed

More information

Copyright 2009 All rights reserved.

Copyright 2009 All rights reserved. 85Mbps HomePlug Copyright 2009 All rights reserved. No part of this document may be reproduced, republished, or retransmitted in any form or by any means whatsoever, whether electronically or mechanically,

More information

Wireless Data Privacy Configuration Guide. HP ProCurve Secure Access 700wl Series.

Wireless Data Privacy Configuration Guide. HP ProCurve Secure Access 700wl Series. Wireless Data Privacy Configuration Guide HP ProCurve Secure Access 700wl Series www.hp.com/go/hpprocurve HP PROCURVE SECURE ACCESS 700WL SERIES WIRELESS DATA PRIVACY CONFIGURATION GUIDE Copyright 2003

More information

LONWORKS Power Line Communication Adapter

LONWORKS Power Line Communication Adapter ABB AB P.O. Box 1005 SE-611 29 NYKÖPING Sweden Tel: +46-155 295000 Fax: +46-155 288110 LONWORKS Power Line Communication Adapter CAL 06000/CCL 06000 User s Manual Rev A Page 1 of 15 Table of Contents 1

More information

LumInsight Web Portal User s Guide

LumInsight Web Portal User s Guide LumInsight Web Portal User s Guide This guide introduces the LumInsight Web Portal dashboard. Use this guide to set up Geozones, update and delete devices, manage alarms, manage group controllers, manage

More information

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Console Client for Microsoft Windows

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Console Client for Microsoft Windows EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Console Client for Microsoft Windows Installation Guide P/N 300-009-578 REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103

More information

Power Line Repeating Network Management Guide

Power Line Repeating Network Management Guide i.lon SmartServer Power Line Repeating Network Management Guide C o r p o r a t i o n 078-0348-01B Echelon, i.lon, LON, LONORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo

More information

Veritas System Recovery 18 Management Solution Administrator's Guide

Veritas System Recovery 18 Management Solution Administrator's Guide Veritas System Recovery 18 Management Solution Administrator's Guide Documentation version: 18 Legal Notice Copyright 2018 Veritas Technologies LLC. All rights reserved. Veritas and the Veritas Logo are

More information

Installation Guide for Pulse on Windows Server 2012

Installation Guide for Pulse on Windows Server 2012 USER GUIDE MADCAP PULSE 4 Installation Guide for Pulse on Windows Server 2012 Copyright 2018 MadCap Software. All rights reserved. Information in this document is subject to change without notice. The

More information

Symantec Backup Exec System Recovery Granular Restore Option User's Guide

Symantec Backup Exec System Recovery Granular Restore Option User's Guide Symantec Backup Exec System Recovery Granular Restore Option User's Guide Symantec Backup Exec System Recovery Granular Restore Option User's Guide The software described in this book is furnished under

More information

USER S GUIDE FOR NOKIA PC SUITE 6.2. Copyright Nokia. All rights reserved. 1/20

USER S GUIDE FOR NOKIA PC SUITE 6.2. Copyright Nokia. All rights reserved. 1/20 USER S GUIDE FOR NOKIA PC SUITE 6.2 1/20 Copyright 2002-2004 Nokia. All rights reserved. Legal Notice Copyright 2002-2004 Nokia. All rights reserved. Reproduction, transfer, distribution or storage of

More information

Veeam Cloud Connect. Version 8.0. Administrator Guide

Veeam Cloud Connect. Version 8.0. Administrator Guide Veeam Cloud Connect Version 8.0 Administrator Guide June, 2015 2015 Veeam Software. All rights reserved. All trademarks are the property of their respective owners. No part of this publication may be reproduced,

More information

FX Tools Software Package - FX CommPro LON User Guide

FX Tools Software Package - FX CommPro LON User Guide User Guide FX CommPro LON Issue Date June 22, 2009 FX Tools Software Package - FX CommPro LON...2 Introduction...2 Installation...4 Installing FX CommPro LON Tool...4 Install the OpenLDV Driver...4 Install

More information

Overview. Borland VisiBroker 7.0

Overview. Borland VisiBroker 7.0 Overview Borland VisiBroker 7.0 Borland Software Corporation 20450 Stevens Creek Blvd., Suite 800 Cupertino, CA 95014 USA www.borland.com Refer to the file deploy.html for a complete list of files that

More information

Getting started with System Center Essentials 2007

Getting started with System Center Essentials 2007 At a glance: Installing and upgrading Configuring Essentials 2007 Troubleshooting steps Getting started with System Center Essentials 2007 David Mills System Center Essentials 2007 is a new IT management

More information

Application Notes for Empirix OneSight with Avaya Aura Suite - Issue 1.0

Application Notes for Empirix OneSight with Avaya Aura Suite - Issue 1.0 Avaya Solution & Interoperability Test Lab Application Notes for Empirix OneSight with Avaya Aura Suite - Issue 1.0 Abstract These Application Notes describe the configuration steps required to integrate

More information

NETWRIX PASSWORD EXPIRATION NOTIFIER

NETWRIX PASSWORD EXPIRATION NOTIFIER NETWRIX PASSWORD EXPIRATION NOTIFIER QUICK-START GUIDE Product Version: 3.3.247 March 2014. Legal Notice The information in this publication is furnished for information use only, and does not constitute

More information

PRODUCT GUIDE. N u c l e u s D a t a R e c o v e r y. C o m P r i v a t e L i m i t e d

PRODUCT GUIDE. N u c l e u s D a t a R e c o v e r y. C o m P r i v a t e L i m i t e d PRODUCT GUIDE Table of Contents 1. Introduction to Kernel for Tape... 4 1.1 Using this Manual... 4 1.2 About Kernel for Tape... 5 1.3 Salient Features... 5 1.4 Who Should Use this Software?... 5 2. Getting

More information

Dameware ADMINISTRATOR GUIDE. Version Last Updated: October 18, 2017

Dameware ADMINISTRATOR GUIDE. Version Last Updated: October 18, 2017 ADMINISTRATOR GUIDE Dameware Version 12.0 Last Updated: October 18, 2017 Retrieve the latest version from: https://support.solarwinds.com/success_center/dameware_remote_support_mini_remote_control 2017

More information

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 SP1 Console Client for Microsoft Windows

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 SP1 Console Client for Microsoft Windows EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 SP1 Console Client for Microsoft Windows P/N 300-012-249 REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000

More information

ControlLogix OPC Driver Agent Help OPC Server Driver Agent for ControlLogix Controllers

ControlLogix OPC Driver Agent Help OPC Server Driver Agent for ControlLogix Controllers ControlLogix OPC Driver Agent Help OPC Server Driver Agent for ControlLogix Controllers Version 9 CONTROLLOGIX OPC DRIVER AGENT HELP For ControlLogix Programmable Controllers Version 9 Copyright 1994-2017,

More information

8.2. Quick Start Guide

8.2. Quick Start Guide 8.2 Quick Start Guide 2012 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software

More information

Remote Backup Software. User Manual

Remote Backup Software. User Manual Remote Backup Software User Manual Legal Information About this Manual This Manual is subject to domestic and international copyright protection. Hangzhou Hikvision Digital Technology Co., Ltd. ("Hikvision")

More information

Installation & Configuration Guide Version 1.6

Installation & Configuration Guide Version 1.6 TekConSer Installation & Configuration Guide Version 1.6 Document Revision 2.0 http://www.kaplansoft.com/ TekConSer is built by Yasin KAPLAN Read Readme.txt for last minute changes and updates which can

More information

Configuring Passwords and Privileges

Configuring Passwords and Privileges Configuring Passwords and Privileges Using passwords and assigning privilege levels is a simple way of providing terminal access control in your network. This chapter describes the following topics and

More information

Lenovo Storage DX8200D System Installation Guide (Additional Appliances in Existing Server Group)

Lenovo Storage DX8200D System Installation Guide (Additional Appliances in Existing Server Group) Lenovo Storage DX8200D System Installation Guide (Additional Appliances in Existing Server Group) First Edition (December 2016) Copyright Lenovo 2016. LIMITED AND RESTRICTED RIGHTS NOTICE: If data or software

More information

Network Guide NPD EN

Network Guide NPD EN NPD5659-00 EN Copyright and Trademarks No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, mechanical, photocopying, recording, or otherwise,

More information

ForeScout Open Integration Module: Data Exchange Plugin

ForeScout Open Integration Module: Data Exchange Plugin ForeScout Open Integration Module: Data Exchange Plugin Version 3.2.0 Table of Contents About the Data Exchange Plugin... 4 Requirements... 4 CounterACT Software Requirements... 4 Connectivity Requirements...

More information

System Management Guide Version 7.52

System Management Guide Version 7.52 Sage 500 Budgeting and Planning 2013 System Management Guide Version 7.52 Copyright Trademarks Program copyright 1995-2013 Sage Software, Inc. This work and the computer programs to which it relates are

More information

Safe AutoLogon Password Server

Safe AutoLogon Password Server Safe AutoLogon Password Server Product Overview White Paper Software version: 8.0 www.wmsoftware.com Contents Introduction... 1 Safe AutoLogon... 1 A Complete Solution: Safe AutoLogon + Safe AutoLogon

More information

Configuring PPP And SIP

Configuring PPP And SIP Copyright Copyright 2005. All rights reserved. The content of this manual is subject to change without notice. The information and messages contained herein are proprietary to. No part of this manual may

More information

PPP Configuration Options

PPP Configuration Options PPP Configuration Options 1 PPP Configuration Options PPP can be configured to support various functions including: Authentication using either PAP or CHAP Compression using either Stacker or Predictor

More information

NIC. User Manual. LOYTEC Network Interfaces. LOYTEC electronics GmbH

NIC. User Manual. LOYTEC Network Interfaces. LOYTEC electronics GmbH NIC LOYTEC Network Interfaces User Manual Contact LOYTEC Blumengasse 35 A-1170 Vienna AUSTRIA/EUROPE support@loytec.com http://www.loytec.com Version 4.1 Document No. 88067216 LOYTEC MAKES AND YOU RECEIVE

More information

GIFTePay XML. SecurePay. Installation & Configuration Guide. Version Part Number: (ML) (SL)

GIFTePay XML. SecurePay. Installation & Configuration Guide. Version Part Number: (ML) (SL) GIFTePay XML Installation & Configuration Guide SecurePay Version 4.00 Part Number: 8662.82 (ML) 8662.83 (SL) GIFTePay XML Installation & Configuration Guide Copyright 2009 Datacap Systems Inc. All rights

More information

NETWRIX INACTIVE USER TRACKER

NETWRIX INACTIVE USER TRACKER NETWRIX INACTIVE USER TRACKER QUICK-START GUIDE Product Version: 3.0.106 March 2014. Legal Notice The information in this publication is furnished for information use only, and does not constitute a commitment

More information

Legal Notes. Regarding Trademarks. Models supported by the KX printer driver KYOCERA Document Solutions Inc.

Legal Notes. Regarding Trademarks. Models supported by the KX printer driver KYOCERA Document Solutions Inc. Legal Notes Unauthorized reproduction of all or part of this guide is prohibited. The information in this guide is subject to change without notice. We cannot be held liable for any problems arising from

More information

WebAccess Device Driver Guide. LNS to LONWorks Device Driver Guide

WebAccess Device Driver Guide. LNS to LONWorks Device Driver Guide LNS to LONWorks Device Driver Guide Version 4.0 rev 3 Broadwin Technology, Inc. Table of Contents LNS to LONWorks Device Driver Guide 1 1. LNS to LONWorks Device Communications 2 1.1 Introduction to LNS

More information

Veritas Desktop and Laptop Option 9.2

Veritas Desktop and Laptop Option 9.2 1. Veritas Desktop and Laptop Option 9.2 Quick Reference Guide for DLO Installation and Configuration 24-Jan-2018 Veritas Desktop and Laptop Option: Quick Reference Guide for DLO Installation and Configuration.

More information

MSX-Agent Installation Guide. Version

MSX-Agent Installation Guide. Version MSX-Agent Installation Guide Version 1026 Table of Content 1 INTRODUCTION...4 2 CONFIGURING MS EXCHANGE SERVER...4 3 REDDOXX MSX AGENT...20 4 CONFIGURATION OF THE REDDOXX APPLIANCE...25 2 Copyright 2009

More information

µtasker Document µtasker MQTT/MQTTS

µtasker Document µtasker MQTT/MQTTS Embedding it better... µtasker Document /MQTTS utasker_mqtt.doc/v1.00 Copyright 2018 M.J.Butcher Consulting Table of Contents 1. Introduction...3 2. Enabling MQTT...4 3. MQTT Operation and Interface...5

More information

Transport Gateway Installation / Registration / Configuration

Transport Gateway Installation / Registration / Configuration CHAPTER 2 Transport Gateway Installation / Registration / Configuration This chapter covers the following areas: Transport Gateway requirements. Security Considerations When Using a Transport Gateway.

More information

Equitrac Embedded Connector for EFI SendMe. Setup Guide Equitrac Corporation Equitrac Corporation

Equitrac Embedded Connector for EFI SendMe. Setup Guide Equitrac Corporation Equitrac Corporation Equitrac Embedded Connector for EFI SendMe 1.1 Setup Guide 2012 Equitrac Corporation 2012 Equitrac Corporation Equitrac Embedded Connector for EFI SendMe Setup Guide Document History Date Description of

More information

You have accessed an older version of a Paradyne product document.

You have accessed an older version of a Paradyne product document. You have accessed an older version of a Paradyne product document. Paradyne is no longer a subsidiary of AT&T. Any reference to AT&T Paradyne is amended to read Paradyne Corporation. Paradyne 6700-A2-GB41-10

More information

Reporting for Contact Center Setup and Operations Guide. BCM Contact Center

Reporting for Contact Center Setup and Operations Guide. BCM Contact Center Reporting for Contact Center Setup and Operations Guide BCM Contact Center Document Number: Document Status: Standard Document Version: 05.01 Date: September 2006 Copyright 2005 2006 Nortel Networks, All

More information

Intel Small Business Extended Access. Deployment Guide

Intel Small Business Extended Access. Deployment Guide Intel Small Business Extended Access Deployment Legal Notices and Disclaimers Disclaimers INTEL CORPORATION MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE

More information