i.LON® SmartServer 2.
Echelon, i.LON, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonPoint and LonSupport are trademarks of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders.
Table of Contents Preface .................................................................................................... vi Welcome.........................................................................................................vii Purpose ..........................................................................................................vii Audience.........................................................................................................vii Models ........................
Entering Device Locations and Neuron IDs............................................ 26 Automatically Acquiring the Neuron ID............................................. 26 Automatically Acquiring the Neuron ID with Overview - Devices Web Page .................................................. 26 Automatically Acquiring the Neuron ID with LON Device Driver Web Page ................................................... 29 Manually Acquiring the Neuron ID....................................................
Connecting Devices on a Power Line Repeating Network........ 109 Connecting Devices Overview..................................................................... 110 Using Type Translators to Connect Devices within a Network ............. 110 Creating a Type Translator............................................................. 110 Selecting Input and Output Points.................................................. 113 Selecting or Creating a Type Translation .......................................
Preface The i.LON® SmartServer can automatically install and manage a LONWORKS network running over a PL-20 power line channel. The SmartServer features a standalone network management mode in which it can install and maintain a LONWORKS network without LNS network management services.
Welcome When running on a noisy PL-20 power line channel, the SmartServer can use a repeating function to transmit network messages to the devices closest to it, which in turn relay the messages to the devices located further down the power line, and so on until the message reaches the target device.
Device Requirements The Neuron-hosted devices and host-based ShortStack devices to be installed on a power line repeating network must be enabled for repeating. This is because the devices may need to be used to relay network messages from the SmartServer to devices located further down the power line. To enable repeating on a device, your device manufacturer must update your devices so that they support the repeating function.
1. Install the applications on the Pocket PC to be used for collecting device coordinates and Neuron IDs and transmitting them to the SmartServer that is attached to the power line repeating network. 2. Copy the application image files (.apb extension) and external interface files (.xml or .xif extensions) provided by the device manufacturer to the lonworks/import folder on the SmartServer flash disk.
i.LON SmartServer 2.0 Documentation The documentation for the SmartServer is provided as Adobe Acrobat PDF files and online help files. The PDF file for this document is installed in the Echelon i.LON SmartServer 2.0 Software program folder when you install the i.LON SmartServer 2.0 software. You can also download the latest SmartServer documentation, including the latest version of this guide, from Echelon’s Website at www.echelon.com/support/documentation/manuals/cis.
• Installing a Power Line Repeating Network. Describes how to acquire the geographic locations (coordinates) and Neuron IDs of the devices to be attached to the PL-20 channel, including how to use a bar code scanner and Pocket PC to acquire the device data. Describes how to transmit the device data to the SmartServer and install the devices, including how to link a Pocket PC to the SmartServer and use the Pocket PC to upload the device data to the SmartServer and install the devices.
If you need help with a particular dialog in the SmartServer Web interface, you can click the “?” icon in the upper-right hand corner of the dialog to open a new window with context-sensitive help for that dialog. Viewing the SmartServer 2.0 ReadMe The SmartServer 2.0 ReadMe provides descriptions of known problems, if any, and their workarounds. To view the SmartServer 2.0 ReadMe, click Start, point to Programs, point to Echelon i.LON SmartServer 2.0 Software, and then select i.LON SmartServer 2.
You can also view free online training or enroll in training classes at Echelon or an Echelon training center to learn more about developing devices. You can find additional information about device development training at www.echelon.com/training. You can obtain technical support via phone, fax, or e-mail from your closest Echelon support center. The contact information is as follows (check www.echelon.
xiv Preface
1 Preparing a Power Line Repeating Network for Installation This chapter describes the tasks required for preparing a PL-20 power line repeating network for installation. It describes how to download the Street Lighting Helper sample application used to store and transmit device locations and Neuron IDs to a Pocket PC that is being used as an installation tool. It describes how to upload application image files, external interface files (XIFs), and resource files to the SmartServer.
Preparation Overview Before a PL-20 power line repeating network can be installed, you need to perform a few tasks to prepare your Pocket PC (if you are using one to install the power line repeating network) and the SmartServer to be attached to the network for the installation. If you are using a Pocket PC as an installation tool, you need to install the Street Lighting Helper application (or your own custom Street Lighting Helper application) and the iLONPocketProxy application to your Pocket PC.
5. Connect the Pocket PC to your computer via a USB or serial connection. 6. Set up a sync partnership between your computer and the Pocket PC. Your computer is now connected to the Pocket PC and you can begin copying files. 7. Download or copy the Street Lighting Helper file to your Pocket PC. To copy the file, skip to step 8. To download the file, follow these steps: a. On your computer, browse to the C:\LonWorks\iLon100\unsupported\iLonProxy\Install folder and then double-click the setup.exe file.
4 d. Click Next to start the Street Lighting Helper installation. e. After Street Lighting Helper has been installed, a window appears stating that the installation has been completed successfully. Click Close. If the Application Already Installed dialog opens, click Yes. The Street Lighting Helper application is downloaded to the Pocket PC. f. When the Street Lighting Helper download is complete, the Application Downloading Complete dialog opens. g. Click OK.
h. 8. On the Pocket PC, tap OK. To copy the Street Lighting Helper files from your computer to the Pocket PC, follow these steps: a. On your computer, browse to the LonWorks\iLon100\unsupported\iLonProxy\bin folder on your computer and then copy the StreetLightingHelper.exe, iLonProxyPocket.exe, and iLonProxy.exe files. b. In Microsoft ActiveSync, click Explore, browse to the Mobile Device\Program Files folder on your Pocket PC, and then paste the files. c.
• Application image files (.apb extension). The application that determines how a device functions. • External interface files. The logical interface to a device. It can either be a device interface file (.xif extension) or a device template (.xml extension). • Resource files. Defines the components of the device interface, including network variable types, configuration property types, format types, and functional profiles implemented by the device application.
device. Note that standard, echelon, bas_controller, and mbus_integrator catalogs are pre-loaded in the root/lonWorks/types/folder of the SmartServer flash disk. To copy a resource file to the SmartServer, follow these steps: 1. Follow steps 1–3 in Copying Application Image Files. 2. Access the root/lonworks/types folder on the SmartServer flash disk. 3. Copy the resource file from the location where it saved to the root/lonWorks/types folder on the SmartServer flash disk.
It may take up to a few minutes for the SmartServer to switch to standalone mode. When the SmartServer has switched to standalone mode, the dialog closes and you can continue preparing your SmartServer for the network installation. Network Limitations in Standalone Mode Managing a power line repeating network in standalone mode has the following restrictions: • Network is limited to a maximum of approximately 200 devices. • Network is limited to a single channel.
5. If a network message fails, a data point and its device are marked offline. You can select the Use Minimal Offline Time check box so that all the data points on the offline device with pending network messages (read/write requests, polls, or heartbeats) are marked offline and network messages are not sent to them. This ensures that network performance is not impacted by an offline device.
between the proxy agent and the target device. If you clear this check box, a default interval is calculated based on the network topology for all hops in the repeating chain. Use Retry Count You can change the number of times a network message is re-sent when no confirmation is received. The default value is 3 attempts. This means that the proxy agent will attempt to re-send a network message to the target device three times.
2 Installing a Power Line Repeating Network This chapter describes how to acquire the coordinates and Neuron IDs of the devices to be attached to a power line repeating network, including how to use a bar code scanner and Pocket PC to acquire the device data. It describes how to transmit the device data to the SmartServer and install the devices, including how to link a Pocket PC to the SmartServer and use the Pocket PC to upload the device data to the SmartServer and install the devices.
Installation Overview You can use the SmartServer to install a power line repeating network. The installation process entails acquiring the coordinates of the devices to be installed (or descriptive strings uniquely identifying their locations) and the Neuron IDs of the devices. After collecting the device data, you transfer it to the SmartServer, which installs the network upon receiving the device data. If you are using a Pocket PC, which is recommended, the installation process is simple and accurate.
Commissioning a Power Line Repeating Network in the Correct Order You must either commission the power line repeating network all at one time, or commission it incrementally starting from the devices closest to the SmartServer. This is because the SmartServer must commission the repeating devices closest to it so that they can be used to reach and commission the devices located further down the power line.
Installing a Three-Phase Power Line Repeating Network You can install the SmartServer (PL model with external coupling option) on a three-phase system using a passive three-phase coupler. For a three-phase power line repeating network, the cabinet in which the SmartServer is mounted must be placed in a location where the SmartServer is within 100m of a repeating device on each of the three phases.
Acquiring Device Locations and Neuron IDs You can use the Street Lighting Helper application on the Pocket PC to acquire or enter the locations and Neuron IDs of the devices being installed. You can use an internal GPS receiver on the Pocket PC or connect an external Bluetooth GPS receiver to the Pocket PC and acquire the geographic locations (coordinates) of the devices. The coordinates of a device enable it to be associated with a specific location.
6. If you are entering the Neuron ID, click Add. The device specified in the Neuron ID box is added to the device list. a. If the device being added has the same location or Neuron ID as an existing device, the Conflict dialog appears. This dialog prompts you to select whether to replace the existing device, add the new device, or cancel the add operation. b.
2. Select the COM ports on the Pocket PC that are used by GPS receiver and the barcode scanner. Tap More to open the Serial Settings dialog in which you can configure the communication properties for the selected port. The default communication properties are 9600-None-8-1-None. Tap OK. Tip: If you are having trouble connecting the GPS receiver to the Pocket PC, you can set the communication properties on the specified COM port to 4800-None-8-1-None. 3.
2. Configure the following settings: Auto Confirm Enables the current device to be stored automatically in the device list when you scan or enter a valid Neuron ID. This check box is selected by default. If this check box is cleared, you need to tap Add/Save to add a device to the list. Auto Location Enables the GPS coordinates of the current geographical location to be entered into the Location property automatically (provided that a GPS signal is available). This check box is selected by default.
4. Select the Auto Resolve ID Conflict check box to set how duplicate Neuron IDs are resolved. You have the following three choices: • Replace Existing. The device specified in the Neuron ID box is added to the list, replacing the currently listed device that has the same Neuron ID. This is the default. • Duplicate Entry. The device specified in the Neuron ID box is added to the list, and the device in the list with that same Neuron ID remains on the list. • Don’t Store.
3. Create a GPRS connection on the external GSM modem. See the i.LON SmartServer 2.0 User’s Guide for information on how to do this. Using iLonProxyPocket The iLonProxyPocket application is used to transmit the device file created with the Street Lighting Helper program to the SmartServer. The iLonProxyPocket application serves as proxy for HTTP requests (Web server/SOAP) between the Pocket PC and the SmartServer. You can transmit SOAP requests using either a serial connection to the console port on the .
3. Verify that the Listen on Port property is set to 80. This is the Web services port used by the Street Lighting Helper application on the Pocket PC to send SOAP requests. 4. Select the serial port used to connect the Pocket PC to the SmartServer. 5. • If you are using a RS-232 serial connection, accept the default port, which is COM1. • If you are using a Bluetooth connection, select any available port.
4. Verify that the Listen on Port property is set to 80. This is the Web services port on the local Pocket PC device. 5. In the Host property under Resend to LAN, enter the IP address or TCP/IP host name of the SmartServer. 6. In the Port property under Resend to LAN, enter the port that the SmartServer uses to transmit and receive HTTP and SOAP messages. The default value is 8080, but you may change it to any valid port number.
3. Verify that you have exited the SmartServer console application if you were accessing it via Telnet. Otherwise, the SmartServer cannot receive the device data from the Pocket PC because the console port is blocked. 4. Tap Send. A dialog appears informing you that the transmission of the device data has started. The device data is sent to the SmartServer via the iLonProxyPocket application. 5.
6. Once the SmartServer receives the device data, it discovers the repeating chain for each device and then commissions the devices. It then downloads the application image files to the devices and loads the device interface (XIF) files (if they have been uploaded on the SmartServer flash disk) to the devices, re-commissions the devices, sets the devices’ applications online, writes the configuration properties to the devices, and resets the devices, which starts their applications.
3. Enter the following device properties: Name Enter a name for the device that is unique to the network. File Name: Displays the full path of the LonMark external interface (.XIF file) or template (.XML file) selected for the device. If you select a LONWORKS TEMPLATE, the program ID of the device is also displayed. Location Select External because you are adding an application device that can be physically installed on a network.
file contains all the functional blocks, network variables, and configuration properties shown on the tree view at the time the device template was created. The .XML file can contain dynamic functional blocks and dynamic network variables. See the i.LON SmartServer 2.0 User’s Guide for more information on creating device templates. 4. Click OK. The device is added to the bottom of the tree of its parent channel. 5. Repeat steps 1–4 for each device on the network to be installed.
4. The Overview – Devices Web page opens. 5. If you are installing an engineered system, observe that the device icons are shaded based on their current commission status (orange for uncommissioned; clear for commissioned). If you are installing an engineered system (you logically created the devices or “placeholders”), select the Auto-Assign Devices to Placeholders check box. This enables the SmartServer to match the discovered devices to the devices you have already logically created 6.
8. In the Geographical Position property, enter a description of the device location such as a light pole number or GPS coordinates that can be associated with the device. 9. Optionally, you can wink or test discovered devices. To do this, right-click anywhere in the device’s row and then click Wink or Query Status on the shortcut menu. • You can wink a device to identify it on the network and verify that it is communicating properly.
11. Click Submit. The SmartServer discovers the repeating path for the device and commissions it. Automatically Acquiring the Neuron ID with LON Device Driver Web Page To automatically acquire the Neuron ID of a LONWORKS from the Overview – Devices Web page, follow these steps: 1. Click Driver. 2. Click one or more devices to be installed in the SmartServer tree or LNS tree. • To select one device, click that device.
5. The SmartServer discovers the selected uncommissioned devices. The Neuron ID property in the Setup - LON Device Driver Web page for each device is populated as the device is discovered. Because you are using Standalone mode, the device discovery process may take a few minutes. 6. The SmartServer discovers the repeating path for the selected devices and commissions them. Manually Acquiring the Neuron ID To manually acquire the Neuron ID of a LONWORKS device, follow these steps: 30 1. Click Driver.
• To use the scanning method, scan the Neuron ID bar code label on the device using a hands-free cordless scanner or a handheld gun-style laser, gun-style LED, and pen-style scanner to scan the bar code and then proceed to step 9. 5. If you are using the service pin method, the LON Device Identification dialog opens. 6. Optionally, you can select the Show Messages with Identical Program ID Only box to limit service pin messages to those devices that have the same program ID. 7.
Selecting Devices After entering the locations and Neuron IDs of the devices to be installed, you select those devices on the tree. To do this, follow these steps: 1. Click Driver. 2. Select one or more devices from the tree to be installed. 3. • To select one device, click that device. • To select multiple devices, click one device and then either hold down CTRL and click all other devices to be installed or hold down SHIFT and select another device to install the entire range of devices.
Installing Devices After enabling smart network management for all the applicable device properties, click Submit. The SmartServer then does the following for each device you are installing: 1. Fetches the program ID of the device (if the Smart Network Management check box is selected for the Program ID property). 2. Downloads the application image file to the device (if the Smart Network Management check box is selected for the Application Image property).
1. Right-click the local SmartServer icon, point to Setup, and then click LON Command Queue on the shortcut menu. Alternatively, you can open the Setup menu and then click LON Command Queue. 2. The LON Command Queue Web page opens. 3. The management commands submitted for all devices and their statuses appear in a table.
Clear Table Clears all entries in the LON Command Queue table. The table will automatically re-list pending commands (STATUS_REQUEST) and update their statuses after the commands successfully complete or fail. Configure Device Opens the Driver or General properties page for the selected device. Cancel Command Cancels the selected command and deletes it from the table. You can select multiple commands by clicking one, holding down CTRL, and clicking the other commands to cancel.
36 Installing a Power Line Repeating Network
3 Maintaining a Power Line Repeating Network This chapter describes how to analyze and debug a power line repeating channel using the Power Line Repeating Analysis Web page on the SmartServer. It explains how to add, upgrade, replace, decommission, place offline, test, and delete devices with the SmartServer. It describes how to switch the network to LNS management mode and synchronize the network to an LNS database so that it can be managed with an LNS application such as the LonMaker tool. i.
Maintenance Overview You can perform routine maintenance to update, repair, and optimize an installed power line repeating network. You can use the SmartServer to maintain the network and its devices. For example, if a device fails, you can replace it on the physical network and then logically replace it on the SmartServer, preserving the device’s configuration.
Alternatively, you can click Setup and then click Power Line Repeating Analysis. 8. The Power Line Repeating Analysis Web page opens. The rows in this Web page represent established repeating paths between the listed devices. The target device in a repeating chain is listed furthest to the right. The current chain of repeating devices used to relay messages to the target device are listed to the left of the target device.
and click all other devices to be viewed, or hold down SHIFT and select another device to view the entire range of devices. 9. You can identify proxies (repeating devices that can relay messages to devices located further down the channel) and target devices (the destination device in a repeating chain) by observing whether there is a device listed in the column to the right. If there is no device listed in the column to the right, that device is a target device.
Last Time Reached Frequency in use Signal Strength Signal Margin Available Proxies Failure History (24h). The time at which the device last responded to a network message. The frequency carrier of the signal at the hop (Primary or Secondary). For more information on the use of these frequency carriers on a LONWORKS power line channel, see the LONWORKS PLT-22 Power Line Transceiver User’s Guide (110kHz - 140kHz Operation).
in the Setup – LON Channel Driver Web page. See Chapter 1, Preparing a Power Line Repeating Network for Installation, for more information on setting this property. 11. You can display the following advanced diagnostic statistics for a given target device by clicking the Display Advanced Information check box: Commission Status Indicates whether the device has been commissioned.
Online Status Indicates the current device state. The values that may appear in this field and their colors depend on whether the device has successfully been installed (black), the device is being installed (orange), or the device is not running because of an error (red). Black (Installed) • Up. The device has been commissioned, it is communicating with the SmartServer, and it does not have any hard message failures. Orange (Installation in Progress) • Nul.
b. The Online Measurement dialog opens. c. This dialog displays the following statistics: Time Stamp Frequency in Use Signal Strength 44 Displays the time at which the device last responded to a network message. Displays the frequency carrier of the signal at the hop (Primary or Secondary). For more information on the use of these frequency carriers on a LONWORKS power line channel, see the LONWORKS PLT22 Power Line Transceiver User’s Guide (110kHz - 140kHz Operation).
Signal Margin Direct Communication Devices: Displays the real-time measurement in dB of the signal margin (the amount that the signal is greater than the noise level) at the device. Proxies and Target Devices: Displays the real-time measurement in dB of the signal margin at the hop. This value is the minimum of the signal margins measured by the device from its proxy and by the proxy from the device. d. You can click New Measurement to get updated real-time values. e.
Primary Frequency Signal Strength Signal Margin Secondary Frequency Signal Strength Signal Margin Failure History Last Time Reached The cached signal strength and signal margin measurements at the hop between the selected device and the proxy on the primary frequency. Direct Communication Devices: Displays the signal strength at the device in decibels (dB). Proxies: The signal strength at the hop in decibels (dB).
Adding Devices After you install a power line repeating network, you can use the Pocket PC or the SmartServer to add new devices to the network. The process in which add new devices is the same as when you initially installed the network. See Chapter 2, Installing to a Power Line Repeating Network, for more information on installing devices with the Pocket PC and the SmartServer. When you add the device to the network, the SmartServer will attempt to commission the new device.
5. b. The Choose File dialog opens. c. Expand the LonMark Image (APB) icon to show the root/lonworks/import folder. Expand the lonworks\import folder to show the application image files in it. d. Select the application image to be downloaded to the devices. e. Click OK to return to the Setup - LON Device Driver Web page. If the external device interface has changed, you need to load a new XIF file for the device onto the SmartServer. To do this follow, these steps: a.
b. The Choose File dialog opens. c. Expand either the LonMark (XIF) or Template folder depending on whether you are using a .xif or .xml file for the external device interface. If the device being upgraded is located in the LNS tree, the Template folder is not available. d. Expand the subfolders containing the XIF file to be loaded onto the SmartServer and then click the XIF file. e. Click OK to return to the Setup - LON Device Driver Web page. i.LON SmartServer 2.
50 6. Click Submit. 7. Download the application image to the selected devices. To do this, right-click one of the selected devices in the SmartServer tree, point to Manage, and then click Download Image in the shortcut menu. Alternatively, you can clear and then select the Smart Network Management check box to the left of the Application Image property in the Setup -LON Device Driver Web page and then click Submit. 8. Activate the XIF files for the devices (if necessary).
the shortcut menu. Alternatively, you can open the Setup menu and then click LON Command Queue. See Checking Device Installation Status in Chapter 2 for more information on using this Web page. Replacing Devices You can use the Pocket PC or SmartServer to replace a device if the device fails or a newer version of the device becomes available. Before you being the device replacement, verify that the replacement device has the same program ID as the original device.
To automatically replace a device, follow these steps: 52 1. Attach the replacement device to the network by applying power to the device and attaching its network connection as documented by the device manufacturer. 2. Click the Driver option at the top of the navigation pane on the left side of the SmartServer Web interface. 3. Open the Overview – Devices Web page. To do this right-click a network or channel, point to Overview, and then click Devices. This example replaces the DIO-1 device. 4.
7. The Replacement ID property of the replacement device is updated with the name of the original device, and the Replacement ID property of the original device becomes unavailable. 8. Click Submit. 9. The SmartServer swaps the configuration of the replacement and original devices, and decommissions the original device (if available).
12. You can detach the original device from the network. Manually Replacing Devices To manually replace a device with the SmartServer, follow these steps: 54 1. Attach the replacement device to the network by applying power to the device and attaching its network connection as documented by the device manufacturer 2. Right-click the original device, point to Manage, and then click Replace on the shortcut menu. 3. The Replace LON Device dialog opens.
4. You can acquire the Neuron ID of the replacement device using a service pin or you can manually enter it. • If you are using the service pin method, press the service pin of the device. The Neuron ID and program ID of the device are both entered into the Incoming Service Pin Messages box and they are input into the Neuron ID or LUID and Program ID boxes, respectively. • If you are using the manual entry method, enter the 12-digit hex string of the device in the Neuron ID or LUID box. 5.
2. 3. Select one or more devices from the tree to be decommissioned. • To select one device, click that device. • To select multiple devices and perform a batch upgrade, click one device and then either hold down CTRL and click all other devices to be decommissioned or hold down SHIFT and select another device to decommission the entire range of devices. The Setup - LON Device Driver Web page opens. Right-click a selected device, point to Manage, and click Decommission.
placed offline, it may cause communication failures for multiple devices. In addition, setting a device offline may affect network performance if the device was polling prior to being set offline. To set a device offline, follow these steps: 1. Click Driver mode. 2. Select one or more devices to place offline. To select one device, click that device.
58 2. The Query Status dialog opens. 3. This dialog lists the following network statistics. Non-zero values indicate that the device was unable to receive and/or respond to a message. Small values are expected; rapidly increasing values may indicate a problem. If the device is consistently reporting failures and new errors are being logged, the device may have a configuration problem or the network may be overloaded.
Name The name of the device in the following format: // Unique ID Displays the Neuron ID of the device as a 12-digit hex string. The Neuron ID is a unique 48-bit number burnt into the device’s Neuron chip. Transmission errors typically indicate cyclical redundancy check (CRC) errors. CRC errors are commonly caused by electromagnetic interference (EMI) on the channel.
3. Click Submit. Deleting Devices You can delete a device to logically remove it from the network. To do this, right-click the device, and then click Delete. The device is removed from the SmartServer. If you delete a device that was serving as a repeating agent, the SmartServer automatically identifies alternate repeating devices to relay network messages to those target devices that were using the deleted device in their repeating chains.
• If the LNS database is not empty, all the LONWORKS CHANNELS and devices on the SmartServer tree are merged into the database. The domain length and domain ID properties in the database are not changed. After the LNS database has been updated, you can synchronize an LNS application such as the LonMaker tool to the LNS database and then use it to manage the network.
3. d. Optionally, you can configure the LNS Server properties (if you want to change the HTTP port, user name, or password used by the SmartServer to access the LNS Proxy Web service). See Chapter 3 of the i.LON SmartServer 2.0 User’s Guide for more information on setting these properties. e. Click Submit to save the changes. Enable your Web browser to access the LNS Proxy Web service on the LNS Server computer. To do this, follow these steps: a.
5. In the Network Management Service property, select the LNS Auto option. In this mode, the SmartServer independently initiates communication with the LNS Proxy Web service, and automatically sends network configuration changes made in the SmartServer tree to the LNS network database. You should select this mode as long as a firewall is not blocking the SmartServer’s access to the port on the LNS Server computer selected for the LNS Proxy Web service (port 80 by default).
9. The LNS Network dialog opens. 10. In the LNS Network property, either select an existing LNS network database to be updated with the network configuration stored in the SmartServer’s internal database (XML files in the root/config/network folder on the SmartServer flash disk), or create a new LNS network database. • To select an existing LNS network database, select the name of the LNS network database from the list and then click Finish.
12. If you created a new LNS network database in step 8, select the Use LNS Network Interface property check box if the LNS Server is attached to the physical network and you want the SmartServer to communicate with the devices on the network, and then select the network interface to be used for communication between the LNS Server and the network. If you selected an existing database in step 9, the Use LNS Network Interface is selected and the network interface is specified automatically. 13.
anytime to return to the SmartServer Web interface and continue using the SmartServer during the synchronization. 17. If you are managing the network with the LonMaker tool, create a new LonMaker drawing from the LNS network database and then synchronize the LonMaker drawing to the LNS network database. See the LonMaker User’s Guide for more information on how to do this. 18. Install the SmartServer and the external devices on the network with the LonMaker tool, LNS tree, or another LNS application.
4 Controlling a Street Lighting Network with the Scheduler Application This chapter describes how to use the Scheduler application on the SmartServer to control the devices on a street lighting network. It explains how to create exception schedules and how to add events to the schedules so that devices such as luminaries can be turned on and off based on calculated sunrise and sundown times.
Scheduling Overview The SmartServer contains an Event Scheduler application that you can use to schedule data point updates (called events) to occur at sunrise and sundown, or a configured amount of time before or after. This means that, for example, you can schedule luminaires to turn on at sundown, dim at the end of the evening rush hour, brighten at the start of the morning rush hour, and then turn off at sunrise. Each Event Scheduler includes day-based daily schedules and date-based exception schedules.
Based on this information, the astronomical position sensor application on the SmartServer calculates the position of the sun relative to the SmartServer and stores this information in nvoElevation_005 and nvoAzimuth_005 SNVT_angle_deg data points. The SmartServer then uses the data points to calculate the sunrise and sundown times and stores the results in nvoSunrise and nvoSunset SNVT_time_stamp data points.
5. The Setup – TimeService Web page opens. 6. Configure the following time (SNTP) server properties: Property 70 Time Server Port The port used by the SmartServer to receive time data. This default value is 123, and it may not be changed. Contact your IS department to make sure that your firewall is configured to allow you to access the time server on this port. Time Synchronization Mode Select the frequency in which the SmartServer is synchronized to the SNTP server.
and it can be used for both LAN and dial-out (modem and GPRS) connections. 7. • Sync when dial-up is active. The SmartServer clock is synchronized when a dial-out connection is established. This option can only be used for dial-out connections (modem and GPRS). • Fixed interval. The frequency in which the SmartServer is synchronized is based on the value in the Synchronization Interval property. This option can only be used for Ethernet connections. • Disabled.
Entering the Location of the SmartServer You can enter the geographic coordinates of the SmartServer. To do this, follow these steps: 1. 2. 72 Open the Real-Time Clock application on the SmartServer. You can do this two ways: • Click General, expand the network icon, expand the LON channel, expand the i.LON App (Internal) device, and then click the Real-Time Clock functional block.
3. Configure the following properties for the real-time clock and astronomical position sensor on the SmartServer: 4. In the Latitude property, enter the north-south location of the SmartServer relative to the equator. Select the first radio button to enter the latitude in sexagesimal notation (degrees, minutes, and seconds); select the second radio button to enter the latitude as a decimal fraction. If the SmartServer is located south of the equator, enter a negative value between 0 and –90.
8. A dialog opens and displays the current sunrise or sundown time stored in the data point in the following format: YYYY-MM-DD hh:mm:ss. Creating Event Schedulers You can create a single Event Scheduler with multiple exception schedules to control a street lighting network.
4. The Add Functional Block dialog opens. 5. Select the Scheduler functional block from the Static or Dynamic LonMark folder. The folder available in the dialog depends on whether the SmartServer is using the static v12 external interface (XIF) file or the dynamic v40 XIF file.
• 76 If the SmartServer is using the dynamic v40 XIF file, you can select the Scheduler functional block from either the Static or the Dynamic folder. To select the Scheduler functional block from the Dynamic folder, expand the Dynamic icon, expand the root/lonworks/types folder, expand the bas_controller folder, select the user-defined functional profile template (UFPT) for the Scheduler, enter a name for the functional block such as “Scheduler 1”, and then click OK.
6. A functional block representing the Scheduler application and all of its static data points are added to the bottom of the i.LON App (Internal) device tree, and the Scheduler: Configure Web page opens application opens in the application frame to the right. Note that construction symbol overlaid onto the Scheduler application icon in the upper-left hand corner of the Web page indicates that the application has not been configured yet. 7.
2. The Scheduler: Data Points Web page opens. Click the data points to be updated by the Event Scheduler from the SmartServer network tree. The selected data points are added to the Web page; any presets defined for the selected data points are displayed to the right. 3. Optionally, you can click the Stagger Delay box to specify the period of time (in seconds) that the Event Scheduler will wait before updating the specified data point at each schedule interval.
• c. 5. To delete an existing preset, click Delete at the top, select the preset to be deleted from the list of presets, and then click Delete next to the list of presets. The preset is removed from the Scheduler: Data Points Web page. Click Close. Optionally, you can edit the values of existing presets. To do this, follow these steps: a. Click the preset to be edited. The Edit Presets dialog opens. b.
Creating Daily Schedules You can set the daily schedules for the Event Scheduler. This entails defining for which days a schedule is applicable and creating events. Defining Daily Schedules By default, the Event Scheduler has two daily schedules: Weekday (Monday–Friday) and Weekend (Saturday–Sunday). You can create separate schedules for individual days and modify for which days the schedules are applicable. To define the scope of the schedules, follow these steps: 80 1.
This dialog functions similarly to the Scheduler: Daily Schedules Web page, except that it also lets you view the current daily schedules as you group days into different schedules. It lists two schedules: Weekday and Weekend. The Monday–Friday check boxes are selected in the daily schedule, and the Saturday–Sunday check boxes are selected in the weekend schedule. This means that the five weekdays use the same daily schedule, and the weekend days use a separate weekend schedule.
You can also re-name any of the daily schedules. When you are done editing and re-naming the daily schedules, click Close. 4. Click Submit. Creating Daily Schedule Events You can add and edit events to the daily schedules. To do this, follow these steps: 1. From the Scheduler: Daily Schedules Web page, click the box corresponding to the day and time for which an event is to be created.
• Enter a valid value to be written to all the data points. To enter a value, all the data points added to the Scheduler must have the same network variable type (e.g., SNVT_switch). 5. To create additional events in the daily schedule, right-click anywhere in the Time or Value boxes, and then click Add in the shortcut menu. A new row for the event is added to the Edit dialog. Repeat steps 3–4 to specify the Time and Value properties of the new event. 6.
Note: To edit an event, click the event in the Scheduler: Daily Schedules Web page, change the time or value, and then click OK. To delete an event, click the event in the Scheduler: Daily Schedules Web page, right-click the event, click Delete on the shortcut menu, and then click OK. 8. Repeat steps 1–6 to create events for other Daily Schedules in the Scheduler. 9. Click Submit. 10. Click Back to return to the Scheduler: Configure Web page.
4. By default, the name of the one-time exception is the date on which it is being created. You can enter a different, descriptive name in the box at the top of the dialog. Additionally, you can click the box to the right of the one-time exception name to open the Edit Exception dialog and change the scope, dates, and recursions of the exception. See Defining Exception Dates and Recursions later in this chapter for more information on the properties in this dialog. 5.
• Select the preset to be used to update the values of all the data points added to the Scheduler that have that preset defined for them. Alternatively, you can enter a new preset and then go back to the Scheduler: Data Points Web page and define the value (or values) for the preset. • Enter a valid value to be written to all the data points. To enter a value, all the data points added to the Scheduler must have the same network variable type (e.g., SNVT_switch). d.
Creating Exceptions You can create an exception or recurring exception in the Event Scheduler. An exception is an alternate daily schedule that is used over a range of dates. A recurring exception is an alternate daily schedule that is used over a range of dates in a specific pattern (such as every third Sunday). To create an exception or recurring exception, you set the dates of the exception and then create the events in the exception.
4. The New Exception dialog opens. 5. Enter a descriptive name for the exception. The default name is the selected start date in the following format: --. 6. Click the Standard or Specific buttons to expand the dialog to show the Recurrence property. • 88 Clicking Standard lets you apply the exception to every month, every other month, every third month, and so on up to every eleventh month.
• 7. Clicking Specific lets you apply the exception to specific months such as January, February, and so on up to December in addition to the monthly options offered by clicking Standard.
90 8. Under Recurrence, select the monthly and daily recursions from the Monthly and Daily lists. The default monthly recursion is every month. This means that if you do not specify a monthly recursion, the events will occur every month within the specified range. The default daily recursion is every day. This means that if you do not specify a daily recursion, the events will occur every day within the specified range. 9.
10. Click OK to add the exception and return to the Scheduler: Exception Schedules Web page (click Cancel to discard all changes and return to the Scheduler: Exception Schedules Web page). The range of dates on which the exception is to occur is highlighted light blue in the calendar and outlined with a color differentiating it from the other exceptions in the calendar. 11. Click Submit. Creating Exception Events This section generally describes how to create events in an exception schedule.
92 2. Click anywhere in the row under the Schedule, Event Time, Value, or Priority columns at the time the event is to occur. The Edit Events of dialog opens. Alternatively, you can right-click a time under the Time column or right-click the column to the right and click Add Event on the shortcut menu to open the Edit Events of dialog. 3. Select the Show Sunrise/Sunset Functions check box to create events based on sundown and sunrise times. A Function field appears in the dialog. 4.
6. If the event is to occur sometime before or after sunrise or sundown, enter that period of time in the Offset box. To schedule an event to occur before sunrise or sundown, enter a negative value; to schedule an event to occur after these times, enter a positive value. For example, if you want an ON event to occur 30 minutes after sundown, enter 00:30. If you want a DIMMING event to occur 15 minutes before sunrise, enter -00:15. 7.
10. Click OK to save your events and return to the Edit: dialog. Click Cancel to delete all changes and return to the Edit: dialog. 11. The Edit: dialog is updated to reflect the events you added to the exception schedule. The events are highlighted light blue. 10. Click OK to save your changes to the Edit: dialog and return to the Scheduler: Exception Schedules Web page.
Demonstrating a Street Lighting Schedule This section demonstrates how you can control a street lighting network using a single Event Scheduler that includes one daily schedule and one exception schedule for weekdays, and one exception group that includes exception schedules for weekends and holidays. The following briefly describes how the street lighting network is controlled on weekdays and weekends/holidays. • Weekdays.
Creating the Weekday Daily Schedule The weekday daily schedule turns on the lights at the start of the evening rush hour, dims them at the end of the evening rush hour, brightens them at the beginning of the morning rush hour, and dims them at the end of the morning rush hour. To create the weekday daily schedule, follow these steps: 96 1. In the Scheduler: Configure Web page, click the Daily Schedules icon. The Scheduler: Daily Schedules Web page opens. 2.
• At the end of the evening rush hour (for example, 20:00), an ON_60 event. This event either dims the lights to 60% if sundown occurs during the evening rush hour, or it turns the lights on and sets them to 60% if sundown occurs after the end of the evening rush hour. For more information on creating events in the Daily Schedule, see Creating Daily Schedule Events previously in this chapter. 4. Click OK to return to the Scheduler: Daily Schedules.
98 3. The New One-Time Exception dialog opens. Click the button to the right of the exception name in the upper right-hand corner of the dialog. 4. The Edit Exceptions dialog opens. Set the name, range of dates, and recursions for the exception following these steps: a. In the Exception Name property, enter a descriptive name for the exception such as “Weekday Exception”. The default name is the selected start date in the following format: --. b.
5. Click OK to return to the New One-Time Exception dialog. 6. Create the sunrise and sundown events for the exception following these steps: a. Select the Show Sunrise/Sunset Functions check box. A Function box appears to the right of the Time boxes under the To and From properties. b. In the Function box under the To property, select the Sunrise icon ( ). The calculated sunrise time appears in the Time box, which becomes read-only, and an Offset box is added to the right of the Time box.
7. Click OK to save your sunrise/sundown events and return to the Scheduler: Exception Schedules Web page. 8. The range of dates on which the exception is to occur is highlighted teal (or dark blue) in the calendar on the Scheduler: Exception Schedules Web page. 9. Click Submit. 10. You can check how the weekday exception schedule has been updated with the morning and evening weekday rush hour events in the daily schedule that are now scheduled before and after the OFF event.
b. The schedule for the selected weekday date shows the lower priority rush hour events (priority 255) that are scheduled before the OFF event at sunrise (priority 220), and it hides the lower priority rush hour events scheduled after the OFF event. The schedule also shows the lower priority rush hour events that are scheduled to occur once the OFF event ends at sundown and resets the data point priority to 255. i.LON SmartServer 2.
Creating the Weekend and Holiday Exception Schedules You can create a schedule that controls the street lighting network on weekends and holidays. This entails creating an exception group that includes an exception that recurs every weekend and exceptions for each holiday that occurs on a weekday in which there is no rush hour.
3. c. In the From and To properties, specify the start and end dates of the exception. d. In the Monthly list under Recurrence, select Every Month. This means that the exception will recur every month in the specified range of dates. In the Daily list, select Every Weekend Day. This means that the exception will recur every weekend day of every month within the specified range of dates.
d. Repeat steps a–c for additional weekday holiday exceptions to be added to the exception group. Notes: 104 • You can click the arrows to scroll through the various exception instances. You can edit the scope (private or public), dates, and recursions for the selected instance. • You can click Delete to remove the selected exception instance from the Event Scheduler. 4. Click OK to save exception and return to the Scheduler: Exception Schedules Web page. 5.
6. Click Submit. 7. Create the sunrise and sundown events for the weekend/holiday exception following these steps: a. Click one of the light blue-highlighted dates in the calendar. The Edit: dialog opens. b. Click anywhere in the row under the Schedule, Event Time, Value, or Priority columns at the time the event is to occur. The Edit Events Of dialog opens.
106 d. In the Function box, select the Sunrise icon ( ). The calculated sunrise time appears in the Time box, which becomes read-only, and an Offset box is added to the right of the Time box. If the event is to occur sometime before or after sunrise, enter that period of time in the Offset box. For example, if you want a DIMMING event to occur 15 minutes before sunrise, enter -00:15 e. In the Value box, select OFF.
j. Click OK to save your events and return to the Edit: dialog. 8. The Edit: dialog is updated to reflect the events you created. Observe that the schedule for the selected weekend day shows the OFF that is scheduled at sunrise, and the ON_60 event that is scheduled at sundown. 9. Click OK to save your changes to the Edit: dialog and return to the Scheduler: Exception Schedules Web page. 10. Click Submit. i.LON SmartServer 2.
Copying Event Schedulers to other SmartServers Once you create Event Schedulers with the appropriate exceptions, you can copy the Event Schedulers to other SmartServer. To do this, you back up the SmartServer App device’s XML configuration on the source SmartServer, copy the backup to one or more target SmartServers that have been reset to their factory default settings, and then reboot the target SmartServers.
5 Connecting Devices on a Power Line Repeating Network This chapter describes how to use type translators and Web connections to connect devices on a power line repeating network together and to devices on other networks. i.LON SmartServer 2.
Connecting Devices Overview You can connect the devices on a power line repeating network though the SmartServer gateway using type translators, Web connections, and freely programmable modules (FPMs). These types of connections provide an alternative to LONWORKS connections, which are not supported on a power line repeating network (devices on a power line repeating network cannot initiate network messages and communicate in a peer-to-peer manner).
1. Click General above the tree view in the left frame of the SmartServer Web interface. 2. Expand the network icon in the SmartServer tree, and then expand the LON channel to show the i.LON App (Internal) device. 3. Right-click the i.LON App (Internal) device and then select Add Functional Block in the shortcut menu. 4. The Add Functional Block dialog opens. 5. Select the Type Translator functional block from the Static or Dynamic LonMark folder.
• 112 If the SmartServer is using the dynamic v40 XIF file, you can select the Type Translator functional block from either the Static or the Dynamic folder.
6. A functional block representing the Type Translator functional block application and all of its static data points are added to the bottom of the i.LON App (Internal) device tree, and the Type Translator: Configure Web page opens in the application frame to the right. Note that construction symbol overlaid onto the Type Translator functional block application icon in the upper-left hand corner of the Web page indicates that the application has not been configured yet. 7. Click Submit.
list of output points. To show the output data points, select the Show Outputs check box. You ) on the can access the list of output by clicking the Output data point icon ( right side of the Type Translator: Configure Web page. 4. Click Submit. Selecting or Creating a Type Translation Type translations specify the conditions in which the values of input points are translated to output points.
rule specifies the value to be copied to the output points. Once you create a custom type translator rule, you can select it from the list of defined rules and use it for other translations. Creating a Custom Scalar-Based Translation You can create a custom scalar-based translation with the Type Translator. This is useful if you need to perform some scaling on the value of the input point before it is translated to the output point.
116 a. Click anywhere in the Copy rule to change the default input or output points, scale the input point, or add an offset. b. If you added more than one input point, you can change the default input point (the first input point added to the type translator) by clicking it and then selecting a different input point from the list. c. If the input point is a structured data point, a list box is added to the right of the input data point.
g. If the output point is a structured data point, a list box is added to the right of the output data point. Select whether to evaluate a field within the structure or the entire structure. By default, the entire structure is evaluated. 7. Click Submit. 8. To add another case to the type translation, right-click the top-level ALWAYS case, click Copy on the shortcut menu, right-click the top-level ALWAYS case again, and then click Paste on the shortcut menu.
c. Select one of the following comparison functions: equal to (default), not equal to, greater than, less than, greater than or equal to, or less than or equal to. Note: If you are evaluating a structured data point as a whole, you can only select the equal (=) or not equal to (!=) comparison functions. d. Enter a comparison value. The default comparison value is 0.
7. Click Submit. 8. You can add another case/rule to the current translation by adding a new one or copying an existing one. The copying method is recommended for creating more complex rule-based translations. The method you choose depends on whether you want to re-use the previous case/rule.
You can use the View – Data Points Web page to enable the type translator and control the switch device. In this Web page, you can add the SNVT_switch data points of the type translator, the switch, and the luminaires. You first set the state of the “Enable” data point on the type translator to ON. You can then change the state and/or value of the “switch ON_OFF” data point on the switch device, and the luminaires will be updated accordingly.
Connecting Repeating Devices on the Same Network To create an internal binding between two repeating devices on the same power line repeating network, follows these steps: 1. From the local SmartServer tree on the left frame, right-click a source data point on the SmartServer attached to the power line repeating network and then click Add Binding in the shortcut menu. 2. The Configure – Web Binder Web page opens and the hostname of the local SmartServer appears in the application frame to the right. i.
3. From the Webbinder Destinations tree on the right frame, expand the SmartServer Webbinder destination icon, expand the network icon, expand the LON channel, expand the device and functional block containing the desired target data point, and then click one or more compatible target data points. 4. Click Submit. References to the target data points are added underneath the source data point in the local SmartServer tree on the left frame.
2. a. Right-click the LAN icon, point to Add Host, and then click i.LON SmartServer 2.0 on the shortcut menu. b. The Setup – Remote i.LON SmartServer 2.0 Web page opens, and a SmartServer node is added to the tree view below the LAN icon. c. Enter the SOAP/HTTP properties of the SmartServer attached to the power line repeating network. See Chapter 3 of the i.LON SmartServer 2.0 User’s Guide for more information on configuring these properties. d. Click Submit.
124 3. The Configure – Web Binder Web page opens and the hostnames of the local SmartServer (the SmartServer attached to the FT-10 or PL-20 non-repeating network) and the SmartServer attached to the power line repeating network, which are collectively referred to as Webbinder Destinations, appear in the application frame to the right.
5. Click Submit. References to the target data points are added underneath the source data point in the local SmartServer tree on the left frame. Testing Web Connections To test that your Web connections are updating the target data points when the value of the source data changes, follow these steps: 1. Click View and then click Data Points. The View – Data Points Web page opens. 2. Close the graph by clicking the ‘X’ in the upper right-hand corner of the application frame. 3.
5. Change the value of the source data point. Observe that the target data point has the same value as the source data point. The Web connection keeps these data points synchronized. For more information on using the Web Binding application, including how to validate, delete, and add attachments to bindings, see Chapter 4 of the i.LON SmartServer 2.0 User’s Guide.
Appendix A Glossary This appendix provides definitions for key terms associated with a power line repeating network. i.LON SmartServer 2.
Glossary Alternative Proxy A repeating device that can directly communicate with a given target device if the current proxy agent fails. Direct Communication State when a repeating device can directly communicate with the SmartServer. A device that has direct communication does not use a repeating chain to receive a network message from the SmartServer.
target device or the next repeating device in the repeating chain. A repeating device may also be referred to as a repeating agent. For a LONWORKS device to function as repeating device, application device repeating must be installed on the device. For more information on installing application device repeating on your LONWORKS devices, contact your Echelon sales representative. Signal Strength The attenuation of the signal.
www.echelon.
