DM-20/21 Device Manager User's Guide Version 2.
Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, the LonUsers logo, the Echelon logo, and the LONMARK logo are registered trademarks of Echelon Corporation. LonPoint, LonPoint Schedule Maker, LonMaker and LonSupport are trademarks of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders.
Contents 1 DM-20/21 Overview 1-1 Introduction Related Documentation Device Manager General Operation Allowable Topologies Using Subsystems Managing Variants Using Multiple Subsystems Device Identification Using #pragma run_unconfigured with the Device Manager Device Manager Runtime Behavior Discovery Automatic Commissioning Pinging Devices When Devices Cannot Be Automatically Discovered 1-2 1-2 1-2 1-3 1-4 1-4 1-5 1-7 1-7 1-8 1-8 1-9 1-9 1-10 2 Description of Device Manager Base Plates 2-1 The DM-21 B
Reset Circuit Service Pin Circuit Power/Wink LED Status LED Power Supply—DM-20 Power Supply—DM-21 Installing the DM-20 Module Installing the DM-21 Module 4-9 4-9 4-9 4-9 4-10 4-10 4-10 4-11 5 Installing and Getting Started With the Device Manager Software Installing the Device Manager Software Creating a Device Manager Managed Network Single Subsystem Network with Unique Device Types (Example 1) Testing the Example Device Manager Single Subsystem Network with Ambiguous Devices (Example 2) Multi Subsystem
1 DM-20/21 Overview This chapter provides an introduction and overview for the DM-20 and DM-21 Device Manager embedded network management devices.
Introduction The DM-20 and DM-21 Device Managers are embedded network management devices. The DM-20 (Model 43201) is designed for embedded applications in which it is mounted on a motherboard. The DM-21 (Model 43202) is a packaged assembly designed for installation in a suitable socket.
Use of a Device Manager is ideal when it is not possible or desirable to leave a management PC on site, or where service personnel are not equipped with portable management PCs. General Operation Figure 1.1 – Overview of Device Manager Installation The diagram above illustrates the three steps necessary to use a Device Manager to manage a network: 1. The network is designed using the LonMaker for Windows Integration Tool; 2.
www.echelon.com/products/DM. The Device Manager’s internal event log can be retrieved using a service tool to assist with diagnosing problems. Periodically, the device manager will search the network for new devices. Any newly found or replacement devices will be integrated into the network as soon as they are detected. The Device Manager will automatically establish or, in the case of a replacement, re-establish all connections with other devices.
Device Managers.) The drawing is divided into three subsystems where each subsystem contains a Device Manager, a router, and several devices. It is recommended that all three subsystems be loaded into all Device Managers using the Device Manager Loading Wizard (see Chapter 2). At runtime, each Device Manager is given a number (via its 4-bit subsystem selection input) representing which subsystem it will manage.
Photocopier + collator 13 nodes total Photocopier + collator + stapler 15 nodes total Photocopier + stapler 12 nodes total For this example, the photocopier contains 10 nodes, the collator contains 3 nodes and the stapler contains 2 nodes. To use a single device manager to handle any of the above configurations, follow these steps: 1.
variables, LONMARK Objects, and configuration properties. Each LonPoint module requires about 2K of storage in the device manager. Device Identification In order for a Device Manager to distinguish between two different devices, there must be some means provided whereby each device can be uniquely identified. This is accomplished by using the device's Program ID and optionally its location string.
The application programmer must follow the convention that a node will not transmit while it is in the hard-offline state. This means that the application must trap the state change and verify that the node is not hard offline prior to any network transmission. The run_unconfigured pragma is incompatible with most self-installation schemes, as it may cause a state semaphore error in the Neuron Chip error log, eventually causing the node to go unconfigured.
If a newly discovered device matches an existing device that has already been discovered, the existing device will be pinged to see if it is still operating and has the correct location string. If it does, the newly discovered device will be ignored. If not, then the existing association of logical and physical device will be removed and the newly found device will be commissioned and added to the Managed Device List.
When Devices Cannot Be Automatically Discovered Devices cannot be discovered by the Device Manager if any of the following conditions are true: • The device is already configured on a different domain from the domain specified for the Device Manager. In this case, the Device Manager can only discover the device if the device broadcasts a service pin message; • The device is configured on the correct domain but has the wrong subnet and is on the far side of the router.
2 Description of the DM-21 Base Plates This chapter provides a description of the LonPoint Type 1 and Type 1D DIN Base Plate mounting enclosures for the DM-21 Device Manager (the DM-20 Device Manager is shipped as a printed circuit board and is designed for mounting on a motherboard).
The DM-21 Base Plate The DM-21 module is installed in a LonPoint Type 1 Base Plate, revision 1A. Wiring connections to the DM-21 module are presented in Chapter 4. The rear of the PCB assembly includes a polarized, shrouded, 14-pin interface connector that connects to a mating socket in a Type 1 Base Plate (for mounting on to 4" square electrical boxes) or Type 1D DIN Base Plate (for mounting to a 35mm DIN rail or a wall).
Figure 2.
18 17 17 16 15 14 13 12 11 10 16 15 14 13 12 11 10 CAUTION I/O 1A Front View Network 1 1 2 2 3 3 4 4 5 6 7 8 9 5 6 7 8 9 Jumper Plug (one supplied with each DIN Base Plate) Figure 2.
The Type 1 Base Plate is mounted to a suitable US 4” square (figure 2.3), 2” deep (10.16cm x 5.08cm) electrical box, US double gang electrical box (figure 2.4), or an IP-65 (NEMA 4) enclosure. DM-21 Module Base Plate 4" Square Electrical Box Figure 2.3 DM-21 Module 4” Square (2” Deep) Electrical Box Mounting Configuration DM-21 Module Base Plate Double Gang Electrical Box Figure 2.
Figure 2.
3 Network Cabling and Base Plate Installation This chapter provides information about network, power, and input/output cabling for the DM-21 Module.
Network Cabling - TP/FT-10 Channel The Device Manager Modules use Echelon’s FTT-10A Free Topology Transceiver for network communications. This transceiver operates at 78 kilobits per second and is designed to support free topology wiring; it will accommodate bus, star, loop, or any combination of these cabling topologies using a twisted pair cable.
Termination Figure 3.4 Mixed Topology (Model 44100 Terminator) Termination Termination Figure 3.5 Doubly Terminated Bus Topology - Used for Very Long Cabling Distances (Two Model 44101 Terminators) A network consisting of devices using the FTT-10A transceiver is said to reside on a “TP/FT-10 channel.” In some cases all of the devices will be connected to a single TP/FT-10 channel.
Power Cabling It is important to note that a maximum of 16 Amperes RMS at 24VAC RMS can be passed through the internal jumpers on the Power terminals of Type 1 Base Plates. This means that if power wiring is looped in and out of the power terminals of the Base Plates, the current load presented by all of the modules and any other devices powered by that circuit must be <16 Amperes, as shown in figure 3.6.
To determine the total power that a power cable must carry, total the VA requirements for all of the devices that will be drawing power from that cable, including both modules and other devices. To determine what gauge cable (in AWG or metric) will be required based on the total distance of the power cabling, refer to the tables 3.1 and 3.2 for cabling measured in AWG and in mm. If the wire gauge used is smaller than required, improper operation of one of more modules will result.
Power Cabling Requirements in AWG (Continued) Load (VA) 3-6 Feet 10 15 20 25 30 40 55 75 100 130 180 200 340 22 22 22 20 20 18 18 16 14 14 12 12 365 22 22 22 20 20 18 16 16 14 14 12 12 375 22 22 22 20 20 18 16 16 14 12 12 12 395 22 22 20 20 20 18 16 16 14 12 12 400 22 22 20 20 18 18 16 16 14 12 12 420 22 22 20 20 18 18 16 14 14 12 12 470 22 22 20 20 18 18 16 14 14 12 475 22 22 20 20 18 16 16 14 14
Table 3.3 - Power Cabling Requirements In mm Load (VA) Feet 10 15 20 25 23.0 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 32.8 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.65 0.65 36.1 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.65 0.65 0.65 42.7 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.65 0.65 0.80 45.9 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.65 0.80 0.80 55.8 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.50 0.65 0.65 0.80 0.80 59.1 0.
Power Cabling Requirements In mm (Continued) Load (VA) Feet 10 15 20 25 387.1 0.50 0.65 0.65 0.80 0.80 1.00 1.30 1.30 1.60 2.00 2.00 390.4 0.50 0.65 0.80 0.80 0.80 1.00 1.30 1.30 1.60 2.00 2.00 400.3 0.50 0.65 0.80 0.80 1.00 1.00 1.30 1.30 1.60 2.00 2.00 413.4 0.50 0.65 0.80 0.80 1.00 1.00 1.30 1.30 1.60 2.00 459.3 0.50 0.65 0.80 0.80 1.00 1.00 1.30 1.60 1.60 2.00 469.2 0.65 0.65 0.80 0.80 1.00 1.30 1.30 1.60 1.60 2.00 518.4 0.65 0.65 0.80 1.00 1.00 1.30 1.30 1.
! Warning The DM-21 requires a Revision 1A Type 1 Base Plate. The power supply internal to the DM-21 will be disabled if used with a revision 1 Base Plate. Be sure to use Revision 1A only. Threaded screw holes for attaching DM-21 to Base Plate. Use 8-32, 3/ 8" screw, Echelon 2050130-01 or equal. Figure 3.8 - Type 1 Base Plate - Front Panel Figure 3.9 shows a detailed view of the rear side of the base plate, the side to which wiring connections are made.
Threaded screw holes fo attaching DM-21 to Base Plate. Use 8-32, 3/8" 0.180" x 0.280" hole for screw, Echelon 205attaching Base Plate to electrical back box or sub- 0130-01 or equal. panel. Use 6-32, flat-head, 3/8" minimum screw. Terminal Screw, Tightening Torque 4 lbs. in.
Figure 3.10 – Type 1 Base Plate Mounting Orientations Connecting Wiring Route network and power cabling into the electrical enclosure using suitable conduit fittings, bushings, or wire glands. Once the cabling has been brought into the electrical enclosure, leave a service loop of <6 inches (15cm) of cable to simplify wiring the Type 1 Base Plate. Dress the cables using tie wraps or tape to ensure that the cabling is not compressed or caught when the base plate is screwed into place.
Table 3.4 - Type 1 Base Plate Terminal Block Color Coding Terminal Number Terminal Color Function 1-4 Orange Network 5 Orange Cable shield, if used 6-9 Black Power 10 – 18 Green 4-bit subsystem selection input Two sets of screw terminals are provided for both the power and network wiring connections. These connections are internally jumpered on the Type 1 Base Plate PCB to provide continuity of the network and power wiring, even if no DM-21 is installed, as shown in figure 3.11.
Terminal screw, tightening torque 4lbs. in. (0.5Nm) maximum Wire entry 18 18 17 16 15 14 13 12 11 10 17 16 15 14 13 12 11 CAUTION 10 I/O Keyhole slot for wall or panel mounting 1A Network 1 1 DIN rail release activate with flathead 2 2 3 4 3 4 5 5 Threaded screw holes for attaching LonPoint modules to the Base Plate. Use 8-32, 3/8" screw, Echelon 205-0130-01 or equal 6 7 6 7 8 8 9 9 Jumper Plug storage location remove before installing DM-21.
The base plate contains two integral DIN rail tabs that securely grab a 35mm DIN rail onto which the base plate is mounted. The base plate may be used on both 35mm x 7.5mm and 35mm x 15mm DIN rails. To release the Base Plate from the DIN rail, sequentially insert a flathead screwdriver into the DIN rail release tabs and gently pull away from the DIN rail (figure 3.13). Four keyhole slots are provided for affixing the Type 1D DIN Base Plate to a wall or panel (figure 3.14).
40.0mm 1.57in 63.0mm 2.48in Figure 3.14 Mounting Hole Pattern Dimensions for Type1D Base Plates Connecting Wiring Route all network, power, and input/output cabling to the pertinent screw terminals located at the top and bottom of the Base Plate. It is good practice to separate the input/output cabling as much as possible from the network and power cabling, especially if low-level analog signals are being supervised. Strip the cable jacket and wire conductors.
Table 3.5 Type 1D Base Plate Terminal Block Connections Terminal Number Function 1 -4 Network 5 Cable shield, if used 6-9 Power 10 – 13, 17, 18 4-bit subsystem selection input Two sets of screws are provided for both the power and network wiring connections. These connections are internally jumpered on the Type 1D Base Plate PCB to provide continuity of the network and power wiring, even if no module is installed, as shown in figure 3.15.
18 1 1 1 1 1 1 1 1 7 6 5 4 3 2 1 0 1A 1 2 3 4 5 6 7 8 9 18 1 1 1 1 1 1 1 1 7 6 5 4 3 2 1 0 1A 1 2 3 4 5 6 7 8 9 Jumper Plug (x-ray view) Figure 3.16 - Mounting Two Base Plates with Jumper Plug Connectors When used with a Type 2D Router Base Plate, there are restrictions about the placement of the Type 2D Router Base Plates (and the routers they contain) relative to the adjacent Type 1D Base Plates.
Type 2D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 2 1 2 3 4 5 6 7 8 9 Type 1D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 Type 1D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 1A 1 2 3 4 5 6 7 8 9 1A 1 2 3 4 5 6 7 8 9 Jumper Plugs (x-ray view) Figure 3.
Type 1D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 1A 1 2 3 4 5 6 7 8 9 Type 2D Type 1D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 2 1A 1 2 3 4 5 6 7 8 9 Type 1D Type 1D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 1A 1 2 3 4 5 6 7 8 9 1A 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 Jumper Plugs (x-ray view) Type 2D 1 1 1 1 1 1 1 1 1 8 7 6 5 4 3 2 1 0 2 1 2 3 4 5 6 7 8 9 Jumper Plugs (x-ray view) Figure 3.
3-20 Network Cabling and Base Plate Installation
4 Device Manager Hardware Description and Installation This chapter explains how to install the Device Manager hardware.
The DM-20 Device Manager Hardware Interfaces Mechanical Figure 4.1 shows a DM-20 module mounted onto a motherboard PCB (all dimensions are in inches): Top View of Motherboard 2x7 Connector and Standoff Positions (as seen looking down on the DM20 when mounted on its Motherboard) 4.0 Chassis Ground 2 4 6 8 10 12 14 2.30 1 3 5 7 9 11 13 1.825 4.0 Service Switch 1.65 3.20 Keep-Out Volume (4 x 4 x 1 inches) DM-20 PCB 0.75 inch Standoffs (4 places) Motherboard 1.0 0.
mounted on its motherboard PCB). All measurements are to the centers of the pins on JP1. The DM-20 occupies a volume of 4 x 4 x 1 inches (10.2 x 10.2 x 2.5 cm), and other components should be kept out of this volume. The four standoffs are 0.75 inches long, and either #4 or #6 standoffs may be used.
Pin Description The DM-20 module has a single 2x7 connector. The pinout is described in table 5.2. Table 4.
Network Access Jack; Use With Echelon PCC-10 Cable Model 78303 Device Manager Model and Software Revision Number DM-21 UL c UL MODEL 43202 972 LISTED 178K SW VERSION ENERGY MANAGEMENT EQUIPMENT SUBASSEMBLY ID NUMBER i DM-21 MODEL 43202 ID DM-21 MODEL 43202 NUMBER ID Peel-Off Code 39 Format Bar Code of Neuron® Chip ID Number Service LED Service Switch Power/Wink LED: Power ON: Illuminated Continuously Wink: Flashing Status LED Figure 4.
DM-21 Pinout Table 4.3 – DM-21 Pinout 4-6 Rear Panel Pin Number (DM-21 only) DM-21 Signal Type Description 1&3 FTT-10A Net 1 2&4 FTT-10A Net 2 5 No Connect 6&8 16 - 30 VAC or DC Power input 16 – 30 VAC or DC power @ 2.4VA 7&9 16 - 30 VAC or DC Power input 16 – 30 VAC or DC power @ 2.
4-bit Subsystem selection Input Pins 0.180" x 0.280" hole for attaching Base Plate to electrical back box or subpanel. Use 6-32, flat-head, 3/8" minimum screw. Threaded screw holes for attaching DM-21 to Base Plate. Use 8-32, 3/8" screw, Echelon 2050130-01 or equal. 16-30VAC or VDC, CLASS 2 Net 2 Shiel d 14-30 14-30 14-30 14-30 +5VDC GROUND RESERVED RESERVED RESERVED DB 3 DB 2 DB 1 DB 0 USE AT LEAST 24 AWG, 90°C RATED WIRE Net 1 1 2 3 4 5 6 7 8 9 Network Terminal Screw, Tightening Torque 4 lbs. in.
DM-20 Subsystem selection (2x7 DM-20 connector J1 pinout) Table 4.
Subsystem 8 + 5VDC GND GND GND Subsystem 9 + 5VDC GND GND + 5VDC Subsystem 10 + 5VDC GND + 5VDC GND Subsystem 11 + 5VDC GND + 5VDC + 5VDC Subsystem 12 + 5VDC + 5VDC GND GND Subsystem 13 + 5VDC + 5VDC GND + 5VDC Subsystem 14 + 5VDC + 5VDC + 5VDC GND Subsystem 15 + 5VDC + 5VDC + 5VDC + 5VDC Reset Circuit The Device Managers incorporate an internal reset circuit. External resets to the Device Manager are accomplished by cycling power to the module.
Table 4.6 – Status LED 5 The Device Manager object is disabled or the DM MODE has been set to disable discovery or commissioning. 4 No database is selected. 3 The Device Manager is commissioning itself. 2 One or more permanent devices have not been discovered/commissioned. 1 The Device Manager has determined that all permanent devices have been correctly installed (commissioned). 0 The Device Manager application is not running (offline, unconfigured).
7. The DM-20 module cannot be hot-plugged: Ensure the motherboard power is off before attaching the DM-20 module. 8. Securely attach the DM-20 module to the motherboard. Installing the DM-21 Module To install the DM-21 module, follow these steps: 1 Follow the node configuration procedure described in Chapter 5 to configure the software in the DM-21 module. 2 Ensure that the Type 1/1D Base Plate has been wired and installed correctly, and is securely fastened to the electrical enclosure.
4-12 Device Manager Hardware Description and Installation
5 Installing and Getting Started with the Device Manager Software This chapter provides instructions for installing the Device Manager software. Also included are several typical network designs using the Device Manager.
Installing the Device Manager Software Before the Device Manager software is installed, the LonMaker for Windows software and any other LONWORKS software to be used must be installed in a designated LONWORKS directory (typically C:\LONWORKS). To install the Device Manager software, insert the CD into the CD-ROM drive. Navigate to the CD-ROM drive and double-click on Setup.exe. Follow the setup wizard’s on screen instructions.
4. From the Device Manager Shapes stencil drag and attach a Device Manager device to the default channel that the LonMaker tool provides upon start up. 5. From the LonPoint Shapes stencil drag and drop a Digital Input functional block to the LonMaker network drawing. When prompted, be sure to specify the DI and not the DM as the source of the input. 6. From the LonPoint Shapes stencil drag and drop a Digital Output functional block to the LonMaker drawing.
8. Start the Device Manager Loading Wizard by selecting it from START | PROGRAMS | Echelon Device Manager | Device Manager Loading Wizard. The window shown in figure 5.2 will appear. Figure 5.2 – Device Manager Loading Wizard From the window, an existing database may be compressed, an existing file may be downloaded to the Device Manager, or an application image may be downloaded to the Device Manager.
9. Click Next. The window shown in figure 5.3 will appear. Figure 5.3 – Select Database The dropdown menu contains a list of all of the LONWORKS databases stored on the PC. Select the network database created in step 1 to compress and load.
10. Click Next. The window shown in figure 5.4 will appear. Figure 5.4 – Select Subsystems Select which subsystems are used to create the managed device list. For this simple network only one subsystem is listed in the left pane. In a more complex network the left pane is used to navigate the subsystem hierarchy to select the subsystems to be loaded. 11. Highlight the existing subsystem, and click Add.
12. Click Next. The window shown in figure 5.5 will appear: Figure 5.5 – Select Database Name Choose a name for the managed device list file. The Loading Wizard will suggest a name consisting of the database name and current date and time. By default this file will be saved in the LONWORKS DM\CompressedDB directory. This path can be changed by clicking on the Browse… button. For convenience, the file is saved on the hard disk so that it can be re-used later if necessary (see step 8 in this example).
14. Click No to move past the dialog box. The window in figure 5.7 will appear: Figure 5.7 – Select Network Interface/XIF This window allows the compressed database to be loaded into a Device Manager. Select the LONWORKS communication interface and the External Interface File (.XIF extension) for the Device Manager version being used. The Loading Wizard will automatically suggest using the XIF that corresponds with the latest version of Device Manager firmware on the PC.
15. Click Next. The window in figure 5.8 will appear. Figure 5.8 – Load Application Image Device Managers are shipped with the firmware pre-loaded, however, this option can be used to load a different firmware version into the Device Manager should this be desirable. For this example, deselect the check box, as the goal is to load the compressed file and not the firmware.
16. Click Next. The window in figure 5.9 will appear: Figure 5.9 – Press Service Pin The Neuron ID of the Device Manager can be entered manually or acquired by pressing the service pin on the Device Manager. Each time the service pin on a Device Manager is pressed its Neuron ID will be added to the list box. Likewise if a Neuron ID is entered manually and the Add button is clicked the Neuron ID will be added to the list box.
17. Click Next. The window in figure 5.10 will appear: Figure 5.10 - Status It may take several minutes to load a Device Manager depending on the size of the managed device list and whether the Device Manager’s application image is also being loaded. Loading progress is displayed by the loading wizard. When all Device Managers are loaded, additional Neuron IDs can be collected, the existing Device Managers can be reloaded, or the loading wizard can be exited. 18. Click Finish to exit the loading wizard.
by pressing and holding the service switches for 10 seconds (see the LonPoint Module Hardware & Installation Guide for more details). 3. Attach and power the Device Manager to the network. 4. Note that the Device Manager’s status LED blinks 4 or 5 times per interval. 4 blinks means that no database is selected. 5 blinks means that the Device Manager object is disabled or the DM MODE has been set to disable discovery or commissioning (see Status LED in Chapter 4 for more information about this LED).
Figure 5.11 – LonMaker Device Creation Wizard A device’s location string may be at most 6 characters in length. If a 4 character location string is entered, the LonMaker tool will fill the remaining characters with the HEX value 00. Choose a 6 character ASCII location for each of the LonPoint DO-10 modules, e.g., “LEFTDO” and RGHTDO”. 4. From the Device Manager Shapes stencil drag and attach a DM-21 Device Manager to the default channel that the LonMaker tool provides upon start up. 5.
The drawing should look like figure 5.12. Figure 5.12 – LonMaker Network Drawing for Example 2 9. Use the Loading Wizard to load the database into a Device Manager (following steps 8 to 18 in Example 1, earlier in this chapter). 10. Physically install the LonPoint DI-10 and DO-10 modules. 11. Using the demonstration location string setting tool available on the Echelon web-site (http://www.echelon.com/products/dm), or an equivalent tool, set the location strings of both DO-10 modules. 12.
1. Download the example photocopier network from www.echelon.com/products/dm. This network is not intended to be operable, however, it is sufficient to illustrate the use of the Loading Wizard when designing a network containing multiple subsystems. 2. Use the LonMaker for Windows Integration Tool to restore the archived network. Browse the network and observe the subsystem hierarchy. 3. Using the Device Manager Loading Wizard, include all four subsystems in the managed device list as shown in figure 5.13.
• On power-up, the Device Manager will first check its DM Pin Usage configuration property to determine whether subsystem 0 or a different subsystem should be used. In Example 3, the DM Pin Usage configuration property was set to Use IO pins as DB number so that the Device Manager would select a subsystem based on the 4-bit subsystem selection input. More information on DM Pin Usage is available in the Device Manager plug-in description below.
EZConfig The EZConfig tab appears in figure 5.14. Figure 5.14 – DM Configuration Plug In, EZConfig Tab This tab is used to set the speed at which the Device Manager tries to discover and ping devices using the following properties: Ping and Discovery Slide Bars Use the slide bars to set aggressive (fast) or relaxed (slow) discovery and ping intervals or specify specific values for the various configuration properties.
the device’s Neuron ID. Forgetting a Neuron ID means that the Device Manager will start a discovery interval to find a replacement for whatever device is now considered missing. Ping: Delay This parameter is used to throttle the pinging (testing) of devices. It represents the delay between pinging individual devices. Click the button to set this property.
to restore all configuration property values to their factory defaults. Note: The Restore Defaults button will restore all values on all tabs of the plug-in. General The General tab appears in figure 5.15. Figure 5.15 - DM Configuration Plug In, General Tab This tab allows following properties to be set: DM Location DM Location is the standard LONMARK location configuration property and is unrelated to the device or Device Manager location strings described above.
power-up Manager to go unconfigured. This feature provides a means of placing the Device Manager in a known state. To cause the Device Manager to go unconfigured, power off the Device Manager, press and hold the service pin, and then power on the Device Manager while still holding the service pin. After the number of seconds defined by this configuration property, the Device Manager will enter the unconfigured state. Setting this value to 0 disables this feature.
Install Off-Channel First This configuration property is only applicable in systems where the Device Manager is responsible for managing a router. In such systems, on power-up, the Device Manager will first search (try to discover) for a router. No devices will be commissioned until the router is found and commissioned. Once the router is commissioned this parameter governs whether the Device Manager installs the local channel first or the far channel first.
this configuration property. Queue Type Determines whether the Device Manager event log is set up as a circular or linear queue. A circular queue overwrites the oldest data point once the available memory for the queue is reached, maintaining only the most recent events or data points. A linear queue does not overwrite old events or data points, and instead writes data until the queue is full. Once full, no more data points are logged, thereby retaining the old data-points.
6 Device Manager Commands, Reports, and Events This chapter describes the various internal functions of the Device Manager that are exposed through the Device Manager's command, report and event interfaces.
Device Manager Functional Blocks The Device Manager contains three functional blocks that can be dropped onto a LonMaker for Windows Integration tool network drawing: the Node object, the Device Manager, and the Event Log. The network variables on these functional blocks are connected and configured as described below. Node Object (LM Object Index 0) FTP_FilePosition FTP_FileRequest Node_Request Node_SetTime FTP_FileStatus Node_Alarm Node_Status Node Object Figure 6.
Node_SetTime 84 Event log timestamps are derived from this reference. Set this network variable using an external device (such as the LonPoint SCH-10 Scheduler Module) to provide a time reference. This network variable should be updated from the external source once every few minutes to ensure synchronized timestamps between devices in the network. If this network variable is not initialized, the Device Manager will use an internal software clock to timestamp events.
Table 6.2 – Device Manager Functional Block Network Variables NV Name DM_VarLocId DM_DBSelection DM_Command SNVT ID 8 8 0 DM_Report 0 DM_Event 0 Comments RESERVED RESERVED Input network variable that allows an external device to interact with the Device Manager. For example, sending the Device Manager a DM_QUERY_DEVICE_PROPS requests the Device Manager to produce a report on device properties. Output network variable that allows the Device Manager to report status information to an external device.
DMREP_DEVICE_PROPS The DMREP_DEVICE_PROPS report is issued by the Device Manager in response to DMCMD_QUERY_DEVICE_PROPS command received on the DM_Command input network variable. This report uses the DmDeviceProps struct defined in dmobj.h. DMREP_DEVICE_DISCOVERED The DMREP_DEVICE_DISCOVERED report is issued by the Device Manager each time a new device is found. If the auto-commission bit of the corresponding entry in the Managed Device List is set to zero (FALSE), commissioning does not occur.
Table 6.3 – Event Log Functional Block Network Variables NV Name DL_Clear_1 SNVT ID 95 DL_Enable_1 95 DL_Level_Full_1 21 Comments Setting this network variable to TRUE clears the event log. FALSE has no effect. Once clear, event logging resumes as events occur. Enables event tracking if set to TRUE, disables event tracking if set to FALSE Emitted as the event log fills depending on Alarm at Percent Full configuration property.
DMEVNT_RESET Event Number: 3 Parameter: None Default Text: DM-20 reset The DMEVNT_RESET event is issued when the Device Manager experiences a reset. This can occur due to a power cycle, power surge, transient, physical reset, or logical reset. The Device Manager Neuron Chip resets and the database selection algorithm is executed. DMEVNT_REBOOT Event Number: 4 Parameter: None Default Text: DM-20 reboot The DMEVNT_REBOOT event is issued when the Device Manager experiences a reboot.
Parameter: Device index of the found device Default Text: Unconfigured device found The DMEVNT_FOUND_UNCNFG event is issued when the Device Manager discovers an unconfigured device. If the device can be uniquely associated with a device in the database using its Program ID and location string, it is integrated into the system.
Parameter: Device index of the commissioned device. Default Text: Device commissioned The DMEVNT_DEVICE_COMMISSIONED event is issued when a device in the system is successfully commissioned by the Device Manager. When this event is generated, the device has been integrated into the network. NOTE: The default Send Async value for this event is TRUE. DMEVNT_DEVICE_COMMISSION_FAILED Event Number: 13 Parameter: Device index of the device that failed to commission.
Start the Event List Editor by selecting PROGRAMS | Echelon Device Manager | Device Manager Event List Editor from the Windows start menu. The Device Manager Event List Editor follows standard Windows conventions to edit, print, save, and retrieve files. Figure 6.4 – Event List Editor File Transfer The following files can be transferred using the LonTalk® File Transfer Protocol (FTP).
ftpDLEventLog The event log. The event code (DmEventType) field is used to correlate entries in this log with the text strings stored in the Device Manager via ftpDM_EventList. Each event requires 10 bytes of storage. The event log can be downloaded using the LonTalk FTP. The record structure is See in DmEventLogEntry. dmobj.h \LONWORKS\DM\include for more details. FILE TYPE FILE INDEX Managed Device List 8010 3 Each entry in the Managed Device List is of the type ManagedDeviceEntry.
6-12 Device Manager Commands, Reports, and Events
7 Device Manager Advanced Topics This chapter describes the various advanced topics that may be of interest for special installations.
Database Synchronization Several Device Managers may be used together to manage a large system (see Using Subsystems in Chapter 1). There were two ways in which this can be accomplished: 1. All subsystems can be loaded into every Device Manager, and each Device Manager can be instructed at runtime as to which subsystem to apply based on its 4-bit subsystem selection input; 2.
Figure 7.1 – Select Database Name Before clicking Next and compressing the database set the database version by clicking the Options button to open the dialog shown in figure 7.2. Figure 7.2 – Database Version Number Select a database version that makes sense for your application. Each version can be numbered from 0 to 65535.
The DMREP_DM_PROPS report contains a field that includes the database number. Updating DM Firmware Newer versions of the Device Manager firmware can be loaded into a Device Manager by using the loading wizard. To load a new firmware version into device manger, follow these steps: 1. Start the Device Manager Compression Wizard and select Download only Application Image to DM. The window shown in figure 7.3 will appear. Figure 7.
2. Click Next. The window shown in figure 7.4 will appear. Figure 7.4 – Select Network Interface and XIF Select the network interface, XIF file, and event list for this download.
3. Click Next. The window shown in figure 7.5 will appear. Figure 7.5 – Select Application Image Select the firmware image to load (.APB file). The APB file selected must match the XIF file specified in the previous step.
4. Click Next. The window shown in figure 7.6 will appear. Figure 7.6 – Select Device Manager Modules Select the Device Managers to be loaded by pressing service pins. The Compression Wizard will cache the Neuron ID numbers of the Device Managers and load them in batch mode. 5. Click Next. The Compression Wizard will display a progress window and load each Device Manager.
Temporary Devices It may be desirable to have devices temporarily integrated into a network supervised by a device manager. Portable test equipment, for example, might need to be bound into the network for service, but generally would be absent when the network is running under normal conditions. In such cases it is usually better if the device is not pinged by the Device Manager.
Unsupported Features The Device Manager does not support the following features: NSI Devices The Device Manager cannot manage NSI devices. Use a network integration tool such as the LonMaker for Windows Integration Tool to manage NSI devices. Dynamic Network Variables and Rate Estimates The Device Manager can add network variables to a device that supports them (such as a host-based MIP device), provided the device is not an NSI and the dynamic network variables were added to the compressed database.
7-10 Advanced Topics
Appendix A Troubleshooting This appendix describes the process of troubleshooting the Device Managers and software.
Troubleshooting the DM-20/21 Hardware Power LED is extinguished • The power supply providing power to the module may have lost primary power. Check the power supply output for the presence of power. • The power wiring may not be correctly connected to the module. Use a volt meter to check for power on Base Plate power terminals. • The input voltage may be too low due to an excessive load on the power supply providing power to the module, excessively long power cabling, or shorted power wiring.
• There may be excessive network cabling. See Chapter 3 for a discussion of the maximum cable distances permissible on the twisted pair channels. If the channel cabling is too long, install one or more LPR Routers in series with the network cabling. Refer to the transceiver user's guides for more detailed cabling information. • There may be improper network cabling. See Chapter 3 for a discussion of the types of cabling that are approved for use on the TP/FT-10 channel.
Subsystem_1 Subsystem_2 DM_1 DM_2 Channel1 Subsystem_combine DM_1 DM_2 Channel1 Figure A-1 - Illustrating recursive compression “This channel contains more than one DM-20/21…” is displayed during compression • A Device Manager may be sharing the same channel in another subsystem. Two Device Managers cannot share the same channel, even if they are used in peer subsystems.
To solve this problem, run the Loading Wizard with the –d flag, and then press the Delete Temporary DB button. This will delete the corrupted database and a new one will be created. Troubleshooting the DM-20/21 Installation The Device Manager status LED should only flash once per interval if it is operating correctly and has finished commissioning all the devices in the managed device list.
7. Configure the new Device Manager shapes using the Device Manger plug-in as described in Chapter 6. The Device Manager status LED is flashing four times (No subsystem selected) • The network input pins may not have the correct value. If the network input pin has a value larger than the largest subsystem index in the Device Manager, then the Device Manager cannot select a subsystem.
Glossary This glossary defines LONWORKS terms that may be encountered when using the Device Manager.
Configuration Property Configuration properties are properties within a device that are set during network design and installation to specify device set points and limits. For example, the Device Manager pings devices on its network at a specified interval where the interval is determined by setting a configuration property within the Device Manager. Configuration properties can be set using the LonMaker browser or a plug-in application specially created for the device whose property is to be to set.
device, routers, channels, default configuration properties, timing parameters, network variable and message tag connections, polling intervals, bound connections, and subsystems. The LonMaker tool combines the information from multiple pages of a Visio drawing into a single LNS database. Location String A six byte area of the Neuron Chip’s internal EEPROM. The installer can initialize this string using a network tool, or it can be initialized by the application running in the Neuron Chip.
device. The Device Manager uses the program ID to identify the devices it discovers. Devices with the same program ID must have identical external interfaces. See the Neuron C Programmer’s Guide, LONMARK 3.0 Application Layer Guidelines, and Neuron Databook for more information about the program ID. Subsystem Devices, routers, and functional blocks are contained within subsystems. With the LonMaker tool, each page in a Visio drawing generally refers to a subsystem.
