Echelon LONWORKS User Manual

Summary of LONWORKS

  • Page 1

    L o n w orks ® r o u t e r user’s guide revision 3 @ e e e e c c c c h h h h e e e e llll o o o o n n n n ® c o r p o r a t i o n 078-0018-01d.

  • Page 2

    No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of echelon corporation. Echelon, l on , l on w orks , lonbuilder, lonmanager, ...

  • Page 3

    Fcc notice note: this equipment has been tested and found to comply with the limits for a class a digital device, pursuant to part 15 of the fcc rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. ...

  • Page 4: Contents

    L on w orks router user’s guide v contents notices i 1 introduction 1-1 audience 1-4 content 1-4 related documentation 1-4 2 theory of operation 2-1 lontalk ® protocol support for routers 2-2 looping topologies 2-2 power line routers 2-3 routing algorithms 2-4 repeater 2-4 bridge 2-4 configured rout...

  • Page 5

    Vi echelon 6 rtr-10 design issues 6-1 emi design issues 6-2 designing systems for emc (electromagnetic compatibility) 6-2 emc design tips 6-2 esd design issues 6-3 designing systems for esd immunity 6-3 7 installing a router 7-1 introduction 7-2 defining a network topology 7-2 attaching the router t...

  • Page 6: Introduction

    L on w orks router user’s guide 1-1 1 introduction l on w orks routers connect two communications channels, and route lontalk messages between them. Routers connect two communication channels and route lontalk ® messages between them. They support the installation of both small and large networks wi...

  • Page 7

    1-2 introduction routers are used to: • extend the limits of a single channel. A router may be used to add a channel to a l on w orks network to support additional nodes or extend the maximum channel length. Multiple routers may be added, depending on the capacity or distance needed. • interface dif...

  • Page 8

    L on w orks router user’s guide 1-3 packaged routers, fcc- and vde-certified to comply with conducted and radiated emissions specifications and ul-certified for safety, with optional wall-mount power supplies, are also available from echelon. These eliminate the need to build hardware and obtain the...

  • Page 9: Audience

    1-4 introduction audience the l on w orks router user’s guide provides user instructions for users of l on w orks routers and for developers who plan to integrate the rtr-10 router into embedded or standalone routers. Content this manual provides detailed information about the hardware and firmware ...

  • Page 10

    L on w orks router user’s guide 1-5 • the neuron chip data book describes the neuron chip. Descriptions cover cpus, memory subsystems, lontalk protocol, network communications port, programming model, application i/o, and additional functions. • the l on w orks tpt twisted pair transceiver module us...

  • Page 11: Theory of Operation

    L on w orks router user’s guide 2-1 2 theory of operation this chapter describes the router theory of operation. An overview is first presented of how the lontalk protocol supports routers. This is followed by a discussion of looping topologies and how they are handled by routers. Then, routing algo...

  • Page 12: Looping Topologies

    2-2 theory of operation lontalk protocol support for routers the lontalk protocol is designed to provide transparent routing of messages between nodes that communicate via routers. To increase the efficiency of routers, the lontalk protocol defines a hierarchical form of addressing using domain, sub...

  • Page 13: Power Line Routers

    L on w orks router user’s guide 2-3 • support for open media. Open media such as rf may require redundant routers with overlapping coverage to ensure complete coverage of an area. Configured routers can be used to support looping topologies, by configuring the routers to prevent message loops. For e...

  • Page 14: Routing Algorithms

    2-4 theory of operation routing algorithms l o n w orks routers can be installed to use one of four types of routing algorithms: configured router, learning router, bridge, and repeater. This selection allows system performance to be traded for ease of installation. The configured router and learnin...

  • Page 15

    L on w orks router user’s guide 2-5 there are two sets of forwarding tables, one in eeprom and one in ram. The eeprom table is copied to the ram table when the router is initially powered-up, after a reset, and when the router receives the set router mode command with the initialize routing table op...

  • Page 16

    2-6 theory of operation message must be addressed as broadcast or 48-bit n euron id is message addressed to either of the router's domains? Is message domain length zero, source subnet zero, addressed as broadcast? Substitute one or both domains from the router, source subnet = our subnet, dest subn...

  • Page 17: Message Buffers

    L on w orks router user’s guide 2-7 as with configured routers, learning routers sometimes modify source addresses for service pin messages to help prevent message loops. Learning routers, in general, are less efficient in using channel bandwidth because they always forward all messages with group d...

  • Page 18

    2-8 theory of operation q u e u e c o u n t s i z e total bytes input buffer queue 2 66 132 priority output buffer queue 2 66 132 non-priority output buffer queue 15 66 990 t o t a l 1 2 5 4 the default size of 66 bytes allows the router to handle packets with maximum address overhead and data size ...

  • Page 19: Packaged Router Overview

    L on w orks router user’s guide 3-1 3 packaged router overview this chapter provides an overview of the model 71000 l on w orks router hardware. If you are using custom routers based on the rtr- 10 router core module, skip this chapter..

  • Page 20: Mechanical Description

    L on w orks router user’s guide 3-1 mechanical description the following drawings provide the front and back views of the model 71000 router. L on w orks router all dimensions are in inches with equiv. Mm dimensions in brackets. 3.895 [98.93] back view back view ® 6.62 [168.15] 1.163 [29.54] figure ...

  • Page 21

    L on w orks router user’s guide 3-3 switches, indicators, and connectors table 3.1 describes the function of router switches, indicators, and connectors. Table 3.1 router interfaces interface function service request pressing this switch grounds the service pin to both sides of the router. When this...

  • Page 22

    3-4 packaged router overview table 3.1 router interfaces (continued) interface function power input connector for power supply. Net 1 rj-45 modular connector for connecting side one of the router to a twisted-pair channel. Net 2 rj-45 modular connector for connecting side two of the router to a twis...

  • Page 23: Rtr-10 Overview

    L on w orks rtr-10 module user’s guide 4-1 4 rtr-10 overview this chapter provides an overview of the model 61000 rtr-10 router core module. If you are using the model 71000 l on w orks router, skip this chapter..

  • Page 24: Mechanical Description

    4-2 rtr-10 overview mechanical description the rtr-10 router core module consists of a 67mm by 23mm by 7mm (2.65” by 0.9” by 0.3”) module with the core electronics and firmware required to implement a router. The rtr-10 is attached to a motherboard, using a 40-position 0.050-inch spacing simm socket...

  • Page 25

    L on w orks rtr-10 module user’s guide 4-3 recommended pcb hole pattern (component side view) for amp part number 822021-1 (vertical mounting) ±.03 (x2) ±.03 8.26mm 1.27mm 6.35mm 35.56mm 35.56mm 2.54mm 2.54mm 1.27mm 2.41mm 1.63mm 1.02mm (1.400) (0.950 ±.001) (0.640 ±.001) (0.040 ±.003) pin 1 ±.08 x4...

  • Page 26

    4-4 rtr-10 overview recommended pcb hole pattern (component side view) for amp part number 4-382483-0 (horizontal mounting) ±.03 (x2) ±.03 1.27mm 6.35mm 2.54mm 2.54mm (0.064 ±.001) (0.960 ±.001) (0.040 ±.003) pin 1 ±.08 (x40) (2.54) (0.050) (0.100) (0.250) (0.050) (0.325) 8.26mm notes: 1. Dimensions...

  • Page 27: Rtr-10 Power Requirements

    L on w orks rtr-10 module user’s guide 4-5 rtr-10 power requirements the rtr-10 router requires a +5vdc ±10% power source with 200ma current. Power supply decoupling and filtering the design for the rtr-10 power supply must consider filtering and decoupling requirements of the rtr-10 router. The pow...

  • Page 28

    4-6 rtr-10 overview table 4.1 pinout of the rtr-10 router name function pin # aclk2 a-side output clock 27 acp0 a-side network communication port 0 8 acp1 a-side network communication port 1 7 acp2 a-side network communication port 2 6 acp3 a-side network communication port 3 9 acp4 a-side network c...

  • Page 29

    L on w orks rtr-10 module user’s guide 4-7 aclk2, bclk1, and bclk2 a 10-mhz crystal is provided for side a of the rtr-10 router, which can only run at 10 mhz. This clock rate allows side a to be used with transceivers running at interface bit rates from 9.8kbps to 1.25mbps. The 10-mhz clock is outpu...

  • Page 30

    4-8 rtr-10 overview table 4.2 rtr-10 router transceiver ids i d name media bit rate (bps) input clock 01 (01 hex) tp/xf-78 transformer-isolated twisted pair 78k 10mhz 03 (03 hex) tp/xf-1250 transformer-isolated twisted pair 1.25m 10mhz 04 (04 hex) tp/ft-10 free topology and link power 78k 10mhz 05 (...

  • Page 31

    L on w orks rtr-10 module user’s guide 4-9 ~reset the neuron chip reset pins are tied together and brought out on one pin. Figure 4.5 shows the reset circuitry on the rtr-10 router. Typical applications do not require debounce conditioning of a momentary push button attached to the ~reset pin. The s...

  • Page 32: Developing A Router With The

    L on w orks router user’s guide 5-1 5 developing a router with the rtr-10 module this chapter describes the process of developing a router based on the rtr-10 router core module. If you are using the model 71000 l on w orks router, skip this chapter..

  • Page 33: Overview

    5-2 developing a router with the rtr-10 module overview to create a router, follow these steps: 1 build a router motherboard according to the specifications described i n chapter 4 and the guidelines described in chapter 6. The motherboard may be part of custom application hardware, or may be a stan...

  • Page 35: Using Custom Transceivers

    L on w orks router user’s guide 5-4 using custom transceivers the rtr-10 router can be used with transceivers not listed in table 4.2 as long as the communications parameters are reprogrammed to match the custom transceiver. If one side of the router is a predefined transceiver type, this reprogramm...

  • Page 36

    5-4 developing a router with the rtr-10 module the preceding 4 steps complete the configuration when a single custom transceiver is used. Proceed with the following 6 steps if two custom transceivers are to be used with the rtr-10 router. 5 remove power from the rtr-10 router. 6 disconnect the prede...

  • Page 37: Rtr-10 Design Issues

    L on w orks router user’s guide 6-1 6 rtr-10 design issues this chapter examines a number of design issues, including a discussion of electromagnetic interference (emi) and electrostatic discharge (esd). If you are using the model 71000 l on w orks router, skip this chapter..

  • Page 38: Emi Design Issues

    6-2 rtr-10 design issues emi design issues the high-speed digital signals associated with microcontroller designs can generate unintentional electromagnetic interference (emi). High-speed voltage changes generate rf currents that can cause radiation from a product with a length of wire or piece of m...

  • Page 39: Esd Design Issues

    L on w orks router user’s guide 6-3 • early emi testing of prototypes at a certified outdoor range is an extremely important step in the design of level “b” products. This testing ensures that grounding and enclosure design questions are addressed early enough to avoid most last-minute changes. Esd ...

  • Page 40

    6-4 rtr-10 design issues when esd hits to circuitry cannot be avoided through creepage, clearance and ground guarding techniques, i.E., at external connector pins, explicit clamping of the exposed lines is required to shunt the esd current. Consult protection of electronic circuits from overvoltages...

  • Page 41: Installing A Router

    L on w orks router user’s guide 7-1 7 installing a router this chapter describes how to install l on w orks routers..

  • Page 42: Introduction

    7-2 installing a router introduction to install a router, follow these steps: 1 define a network topology. 2 physically attach the router to a l o n w orks network. 3 connect power to the router. 4 logically install the router on the network. 5 test the router installation. These steps are described...

  • Page 43

    L on w orks router user’s guide 7-3 the wire used for the network will affect the overall system performance with respect to distance, stub length, and total number of nodes supported on a single channel. See the l o n w orks ftt-10 free topology transceiver user's guide for wiring guidelines for fr...

  • Page 44: Connecting Power

    7-4 installing a router proper electrical termination is essential for each twisted pair channel. Failure to terminate the network will degrade performance and in some cases eliminate a node’s ability to communicate to other nodes. For tp/xf and tp/rs485 channels, the terminator circuits shown in fi...

  • Page 45

    L on w orks router user’s guide 7-5 any power supply may be used for the model 71000 l on w orks router that meets the following specifications: the power input to the router must be +9 to 15vdc at 500ma, negative tip, outer barrel positive. The connector is a standard female dc power plug with a 2....

  • Page 46

    7-6 installing a router router installation with network management messages routers can be installed using the network management messages described in chapter 8 and in appendix b of the neuron chip data book, but this process is only recommended for simple networks with few routers. The process is...

  • Page 47

    L on w orks router user’s guide 7-7 router installation with the lonbuilder developer's workbench chapter 9 of the lonbuilder user’s guide describes how to define and install routers in a development network using the lonbuilder network manager. A prerequisite to creating router target hardware and ...

  • Page 48: Testing Router Installation

    7-8 installing a router subnet. For managing the assignment of subnets to application nodes, it is helpful to define subnets with meaningful names that correspond to the channels to which they are assigned. Bridges and repeaters may have both sides of the router on the same subnet. Configured and le...

  • Page 49

    L on w orks router user’s guide 7-9 3.00 2.00 .50 .60 6.46 5.26 4x 0.190 thru 4x r.25 3m 4016 dbl side foam tape 0.6 thk. 1.28 3.90 2.00 sq .98 0.6 thk. Ref. 1.37 figure 7.5 router mounting bracket.

  • Page 50: Network Management Messages

    L on w orks router user’s guide 8-1 8 network management messages this chapter describes network management services for l on w orks routers. These services are used for router installation as described in chapter 7..

  • Page 51: Introduction

    8-2 network management messages introduction as described in the previous chapter, routers are installed using network management messages. These messages are sent as explicit messages by a network services tool. Routers respond to many of the same messages as any l on w orks application node, and a...

  • Page 52

    L on w orks router user’s guide 8-3 firmware version 4 5 1 2 5 4 no error version mismatch, incompatible version mismatch, incompatible 5 version mismatch, incompatible no error version mismatch, but compatible 1 2 5 version mismatch, incompatible version mismatch, but compatible no error • the set ...

  • Page 53: Router Specific Messages

    8-4 network management messages table 8.2 network management messages network management messages r e q u e s t c o d e success r e s p o n s e failed r e s p o n s e query id 0x61 0x21 0x01 respond to query 0x62 0x22 0x02 update domain 0x63 0x23 0x03 leave domain 0x64 0x24 0x04 update key 0x65 0x25...

  • Page 54

    L on w orks router user’s guide 8-5 router specific network management messages set router mode this message instructs the router to perform one of several router-related tasks. The normal option returns the router from the temp_bridge mode. The init_rtr_table option copies all forwarding tables fro...

  • Page 55

    8-6 network management messages the least significant bit (lsb) of the table field maps to the lowest subnet or group id in the current set of table entries defined by the index_times_8 field. A value of ‘1’ specifies that forwarding be enabled for the corresponding froup or subnet; a value of ‘0’ d...

  • Page 56

    L on w orks router user’s guide 8-7 group no forward this message clears the forwarding flag in the forwarding table for a given group in the specified domain. If the ram_or_eeprom field is set, both the ram and eeprom flags are cleared, otherwise only the ram flag is cleared, allowing temporary con...

  • Page 57

    8-8 network management messages typedef struct { unsigned group_or_subnet : 1; // 1 => group, 0 => subnet unsigned domain_index : 1; unsigned ram_or_eeprom : 1; // 0 => ram, 1 => eeprom unsigned unused : 3; unsigned index_times_8 : 2; } nm_rtr_table_report_request; typedef struct { unsigned table[8]...

  • Page 58

    L on w orks router user’s guide 8-9 the far side escape tool is not required for the set node mode network management message when it is used to place the router offline and online (the appl_offline and appl_online options). The offline and online commands are automatically forwarded. Byte code; /* ...

  • Page 59

    8-10 network management messages not recommended because the router will not be able to forward network management messages if the buffers are too small. The size values are represented by a code of type buffer_size_entry: typedef enum { size_20 = 0x2; size_21 = 0x3; size_22 = 0x4; size_24 = 0x5; si...

  • Page 60

    L on w orks router user’s guide 8-11 set input and non-priority output buffer queue count the buffer queue counts are selected using a write memory network management message with the following paramters: mode = read_only_relative (1) offset = 0x001c; count = 1; form = both_cs_recalc (1) data = queu...

  • Page 61: Appendix A

    L on w orks router user’s guide a-1 appendix a communications parameters l on w orks routers are initially programmed with communications parameters as listed in this appendix. Parameters for l on m ark - approved transceivers correspond to the parameters defined by the l on w orks interoperability ...

  • Page 62

    *the input clock rate is 10mhz for these transceivers on the model 61000 rtr-10 router core module; the input clock rate is 5mhz for these transceivers on the model 71000 l on w orks router. A-2 communications parameters parameter t p / x f - 7 8 t p / x f - 1 2 5 0 t p / f t - 1 0 t p / r s 4 8 5 -...

  • Page 63

    * the input clock rate is 10mhz for these transceivers on the model 61000 rtr-10 router core module; the input clock rate is 5mhz for these transceivers on the model 71000 l on w orks router. L on w orks router user’s guide a-3 parameter rf-10 pl-10 pl-20c transceiver id 7 (07 hex) 9 (09hex) 16 (10 ...

  • Page 64

    *the input clock rate is 10mhz for these transceivers on the model 61000 rtr-10 router core module; the input clock rate is 5mhz for these transceivers on the model 71000 l on w orks router. A-4 communications parameters parameter pl-20n pl-30 transceiver id 17 (11 hex) 18 (12 hex) media power line ...

  • Page 65

    * the input clock rate is 10mhz for these transceivers on the model 61000 rtr-10 router core module; the input clock rate is 5mhz for these transceivers on the model 71000 l on w orks router. L on w orks router user’s guide a-5 parameter t p / r s 4 8 5 - 6 2 5 t p / r s 4 8 5 - 1 2 5 0 t p / r s 4 ...

  • Page 66

    *the input clock rate is 10mhz for these transceivers on the model 61000 rtr-10 router core module; the input clock rate is 5mhz for these transceivers on the model 71000 l on w orks router. A-6 communications parameters parameter f o - 1 0 d c - 7 8 d c - 6 2 5 d c - 1 2 5 0 transceiver id 24 (18 h...

  • Page 67: Appendix B

    L on w orks router user’s guide b-1 appendix b software license and patent agreement copies of the software license agreement and patent notice for the router are included in this appendix..

  • Page 68

    B-2 attention by opening the bag and/or using the echelon product contained in the bag, you agree to be bound by all the terms and conditions of the software license agreement below. If you do not so agree, you may return the unused echelon product (including documentation) within 15 days to the per...