background image

LonWorks Router User’s Guide 

       53 

  

Configuring a Router 5000 Half-Router 

Before programming, a Router 5000 uses its default communications parameters, 

which define a simplified single-ended mode 78 kbps channel.  The default 

communications parameters allow you to load an application image over a 78 

kbps network, for example during device manufacturing.  Devices that use a 78 

kbps transceiver (such as a 78 kbps EIA-485 transceiver or an LPT-11 Link 

Power Transceiver) can use the default communications parameters within 

development or manufacturing test networks.  For production networks 

(networks with many devices), you should ensure that each device has 

communications parameters defined for the channel; use the NodeBuilder FX 

Development Tool to develop applications with the correct communications 

parameters.   
Note that devices defined for a TP/XF-1250 channel cannot use the default 

communications parameters; each router-half’s external serial non-volatile 

memory must be programmed with the correct communications parameters 

before connecting to the network. 
To create a Router 5000 configuration that you can program into the Router 

5000’s EEPROM serial memory, use the NodeBuilder FX Development Tool to 

create an NME file: 
1.

 

Define a Hardware Template, as described in 

NodeBuilder Hardware 

Template

 

2.

 

Define a Device Template, as described in 

NodeBuilder Device Template

 on 

page 54 

3.

 

Define the buffer configuration for the router-half, as described in 

Buffer 

Configurations

 on page 55 

4.

 

Use a Neuron C source file to define a well-formed NME router image, such 

as the one described in 

Example Neuron C Source

 on page 56 

Because the NodeBuilder FX Development Tool does not produce an NME file 

that allows you control the router mode (configured, learning, repeater) and the 

routing tables, the example Neuron C source code defines a minimal application, 

with 15 address table entries, zero NV entries, and zero NV alias entries.  The 

example Neuron C source code places an unused checksum byte out in the 

EEPROM space that lies in the Domain:0 Group:80-87 forwarding table.  If the 

router will be commissioned by the LNS Server, it will clear this byte and set it to 

the needed value.  If you want to create a preconfigured router image (see 

Creating a Pre-Configured NME File

 on page 55), be sure to clear this byte 

during in the pre-configuration step. 
The router firmware does not use the specific configuration checksum defined in 

example Neuron C source code.   

NodeBuilder Hardware Template  

The hardware template defines the target transceiver configuration in the NME 

file produced by the NodeBuilder FX Development Tool.  The settings for this 

template are (see 

Figure 28

 on page 54 for an example hardware template for a 

Router 5000 device): 

Summary of Contents for 14315R

Page 1: ...LONWORKS Router User s Guide 078 0018 01E...

Page 2: ...manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only and may not have been tested by Echelon It is the responsibility of the cu...

Page 3: ...0202 01D This bulletin describes how to connect a Neuron 5000 Processor s communications port to external transceivers for TP XF 1250 channels or for EIA 485 networks using an external transceiver ci...

Page 4: ...s on the electrical interfaces mechanical interfaces and operating environment characteristics for the PL 3120 PL 3150 and PL 3170 Smart Transceivers Series 5000 Chip Data Book 005 0199 01B This manua...

Page 5: ...ust be approved in writing by the manufacturer s Regulatory Engineering department Changes or modifications made without written approval may void the user s authority to operate this equipment VDE No...

Page 6: ......

Page 7: ...R 10 Message Buffers 14 Router 5000 Message Buffers 15 Router Performance 16 Chapter 2 LonWorks Router Electrical Interfaces 17 Overview 18 Electrical Interface 18 RTR 10 Electrical Interface 18 ACLK2...

Page 8: ...ms for ESD Immunity 63 Chapter 6 Installing a LonWorks Router 65 Introduction 66 Defining a Network Topology 66 Attaching the Router to a Network 66 Connecting Power 67 Installing the Router on a Netw...

Page 9: ...Appendix A Communications Parameters for LonWorks Routers 81 Communications Parameters 82...

Page 10: ......

Page 11: ...s Router User s Guide 1 1 Introduction to LonWorks Routers This chapter describes the router theory of operation including router types LonTalk protocol support for routers and router use of message b...

Page 12: ...uter can connect two channels or multiple routers called redundant routers can connect the same pair of channels Redundant routers provide fault tolerance by providing more than one routing path from...

Page 13: ...tion programs within devices Thus you can develop applications without needing to know the workings of the routers or even if the device s channel will use a router You only need to consider routers w...

Page 14: ...s those Echelon router products that allow OEMs to design and build their own custom routers for LONWORKS channels the RTR 10 Router Core Module and the Router 5000 chips RTR 10 Overview The RTR 10 Ro...

Page 15: ...reconfigured with many common LONWORKS transceiver parameters Two sets of five transceiver identification XID pins on the RTR 10 router select the appropriate transceiver type for each side The transc...

Page 16: ...r different external transceiver types Table 1 lists commonly used channel and transceiver types for Router 5000 based router halves Echelon provides special licensing for other transceiver types such...

Page 17: ...outer can be mounted on a motherboard along with a single power supply and two network connectors This sub assembly constitutes a LONWORKS router It can be packaged in an enclosure to meet unique form...

Page 18: ...he second router transmits the message in a priority slot Repeater A Repeater is a router that forwards all messages in both directions regardless of the message s destination or domain That is a repe...

Page 19: ...sages are forwarded one for each domain Thus the router can drop the service pin message if a loop causes the message to be received again on the same side Learning Router A Learning Router like a con...

Page 20: ...owever the flag can be cleared on both sides if a device is moved from one side of a router to the other side For example if subnet 1 is located on side A of a router the router will learn subnet 1 s...

Page 21: ...ys forward all messages with group destination addresses Their advantage is simplified installation because the installation tool does not need to know the network topology to configure the router Loo...

Page 22: ...nfiguring the routers to prevent message loops For example the topology in Figure 6 can be supported if both routers are configured to forward all messages addressed to subnets on channel B from chann...

Page 23: ...based on the subnet component of a device s logical address To further facilitate the addressing of multiple dispersed devices the LonTalk protocol defines another class of addresses using domain and...

Page 24: ...mited by the amount of RAM on the router RTR 10 Message Buffers Each router side has 1254 bytes of buffer space available By default this space is allocated as two input buffers two priority output bu...

Page 25: ...k traffic can be bursty where many packets appear on the network almost at the same time In these cases the traffic bursts could cause the input queue to become full and lose excess packets In this ca...

Page 26: ...lly does not perform at the wire rate because of latency within the router including the time to receive and buffer the incoming packet at the near side the time to forward the packet between the halv...

Page 27: ...LonWorks Router User s Guide 17 2 LonWorks Router Electrical Interfaces This chapter provides an overview of the electrical interfaces for the RTR 10 Router Core Module and the Router 5000 chip...

Page 28: ...hematic view of a connector for the RTR 10 Router Core Module and Table 4 shows the pinout of the RTR 10 Router Core Module See the Neuron Chip Data Book for more information about the use of the Neur...

Page 29: ...on port 0 37 BCP1 B side network communication port 1 38 BCP2 B side network communication port 2 39 BCP3 B side network communication port 3 36 BCP4 B side network communication port 4 40 BXID0 B sid...

Page 30: ...r for the service pin on each side is enabled The service LEDs reflect the firmware status Blinking means that the router side is unconfigured Off means that the side is configured On means that the s...

Page 31: ...25 EIA 485 twisted pair 625k 10 MHz 11 0x0B TP RS485 125 EIA 485 twisted pair 1 25M 10 MHz 12 0x0C TP RS485 78 EIA 485 twisted pair 78k 10 MHz 16 0x10 PL 20C Power Line C Band 5 4k 10 MHz 17 0x11 PL 2...

Page 32: ...stretcher circuit driven by PKT to make an activity LED flash as in the example circuit shown in Figure 23 on page 47 in chapter 4 RESET The Neuron Chip reset pins are tied together and brought out on...

Page 33: ...tact bounce settling time as long as 20 milliseconds Router 5000 Electrical Interface The electrical interface for the Router 5000 chip is similar to the electrical interface of the Neuron 5000 Proces...

Page 34: ...e B VDD3V3 8 Power 3 3 V Power IO5 9 Digital I O IO5 side A to side B IO6 10 Digital I O IO6 side A to side B IO7 11 Digital I O IO7 side A to side B IO8 12 Digital I O IO8 side A to side B IO9 13 Dig...

Page 35: ...tal I O for Memory I2C serial data SPI slave select 1 active low VDD1V8 44 Power 1 8 V Power Input from internal voltage regulator SCL 45 Digital I O for Memory I2C serial clock MISO 46 Digital I O fo...

Page 36: ...uit To ensure proper oscillator startup the equivalent series resistance specification for the crystal should be 50 and the crystal shunt capacitance should be no greater than 7 pF Using a 33 pF capac...

Page 37: ...ance can vary over temperature up to 10 pF If your device is likely to experience extreme temperatures consider changing the value for the A Side XOUT capacitor to 27 pF to allow for the change in cap...

Page 38: ...unications parameters within development or manufacturing test networks For production networks networks with many devices you should ensure that each device has communications parameters defined for...

Page 39: ...the Router 5000 JTAG Interface TCK TDI TDO TMS and TRST All Series 5000 chips including the Router 5000 provide an interface for the Institute of Electrical and Electronics Engineers IEEE Standard Te...

Page 40: ...31 to an analog VDD33 source if different from the digital VDD33 source In general the VDD3V3 pins and the AVDD3V3 pin connect to the same VDD33 source The VOUT1V8 pin 27 is the output of the on chip...

Page 41: ...contention between that device and the Router 5000 s internal circuitry could result in anomalous behavior ranging from applicationless errors to device failure A capacitor should be connected between...

Page 42: ...page 37 See the Series 5000 Chip Data Book for more information about the RST pin for a Series 5000 chip including the Router 5000 SVC The SVC pin alternates between input and open drain output at a 7...

Page 43: ...he state of the Service LED for various device states The Neuron firmware samples the SVC pin whenever it is not actively driving the pin low A typical circuit for the SVC pin where the A side and B s...

Page 44: ...lse stretching to the Router 5000 CP0 pin For a TX network activity indicator connect an appropriate LED circuit with pulse stretching to the Router 5000 CP2 pin Figure 17 on page 35 shows example RX...

Page 45: ...active for each bit received and inactive between bytes For both circuits the approximate time constant for LED visibility is 100 ms Power Requirements The following sections describe the power requir...

Page 46: ...ds or writes to the external memory the two wire serial EEPROM which typically add 1 to 2 mA When not in use the EEPROM typically requires only 2 A Power Supply Decoupling and Filtering The design for...

Page 47: ...See Section 9 4 of the Neuron Chip Data Book Failure to include such protection may cause data corruption to configuration data maintained in EEPROM on the RTR 10 Neuron Chips In the sample circuit o...

Page 48: ......

Page 49: ...LonWorks Router User s Guide 39 3 LonWorks Router Mechanical Interfaces This chapter provides an overview of the mechanical interfaces for the RTR 10 Router Core Module and the Router 5000 chip...

Page 50: ...ww molex com customer html supplierPN 015820793 However these Molex SIMM sockets are obsoleted and are unavailable for purchase from Molex Echelon has a limited supply of these sockets models 61101R a...

Page 51: ...LonWorks Router User s Guide 41 Figure 19 RTR 10 Recommended PCB Hole Pattern Component Side Vertical Mounting Figure 20 RTR 10 PCB Footprint Component Side Horizontal Mounting...

Page 52: ...and electrostatic discharge ESD issues see Chapter 5 LonWorks Router Design Issues on page 59 Router 5000 Mechanical Description The mechanical description of the Router 5000 chip is similar to the me...

Page 53: ...LonWorks Router User s Guide 43 Figure 22 Router 5000 Mechanical Specifications...

Page 54: ......

Page 55: ...LonWorks Router User s Guide 45 4 Developing a LonWorks Router This chapter describes the process of developing a router based on the RTR 10 Router Core Module or the Router 5000 chip...

Page 56: ...described in the next section 2 Ensure that the communications parameters in the RTR 10 router are compatible with both of the transceivers The transceivers listed in Table 5 on page 21 are supported...

Page 57: ...LonWorks Router User s Guide 47 Figure 23 RTR 10 Motherboard Example Schematic...

Page 58: ...amming can occur during manufacturing or during field installation The first four steps of the following procedure describe how the custom communications parameters are programmed for one side If both...

Page 59: ...mmunications parameters on side A of the RTR 10 router using the network management tool Side B might be automatically reconfigured at the same time depending on the network management tool Developing...

Page 60: ...r on a network as described in Chapter 6 Installing a LonWorks Router on page 65 The network could be a development network for initial testing a manufacturing network for configuration during manufac...

Page 61: ...LonWorks Router User s Guide 51 Figure 26 Router 5000 Motherboard Example Schematic Core...

Page 62: ...52 Developing a LonWorks Router Figure 27 Router 5000 Motherboard Example Schematic Network...

Page 63: ...d in NodeBuilder Hardware Template 2 Define a Device Template as described in NodeBuilder Device Template on page 54 3 Define the buffer configuration for the router half as described in Buffer Config...

Page 64: ...r 5000 chips Do not specify a value of 8 System image version Ver19 Memory Extended non volatile None Extended on chip RAM 0x8000 0xE7FF All other memory options Leave as default values Figure 28 Exam...

Page 65: ...router When defining the NET buffer sizes you must consider the other router half the input buffer size for Side A should be as large as Side B s output buffer size Likewise the input buffer sizes fo...

Page 66: ...size 42 pragma app_buf_in_size 42 pragma app_buf_out_count 1 pragma app_buf_in_count 2 Router buffer configurations NET pragma net_buf_out_size 255 pragma net_buf_in_size 255 pragma net_buf_in_count 7...

Page 67: ...red here to allocate space for it in the link eeprom unsigned int mip_eevars 2 0x00 M S Designation 0x00 TXID always last not used pragma ignore_notused code_pad pragma ignore_notused pios1 pragma ign...

Page 68: ......

Page 69: ...ser s Guide 59 5 LonWorks Router Design Issues This chapter examines a number of design issues including a discussion of PCB layout electromagnetic interference EMI and electrostatic discharge ESD for...

Page 70: ...he center of the star ground Ground Planes As ground is routed from the center of the star out to the function blocks on the board planes or very wide traces should be used to lower the inductance and...

Page 71: ...ciated capacitors and resistors The figure does not show I O or other connections to the other side of the router The differential driver circuit is shown as U101 and associated parts The comparator c...

Page 72: ...cluding the Router 5000 and has also performed additional tests to ensure immunity and low emissions Specifically Echelon has performed the following immunity tests Electrostatic discharge ESD testing...

Page 73: ...ronments when operators touch electronic equipment The static voltages generated by humans can easily exceed 10 kV Keyboards connectors and enclosures provide paths for static discharges to reach ESD...

Page 74: ...r Zener clamps to chassis ground to shunt the ESD current to ground while clamping the voltage low enough to prevent circuit damage The Neuron Chip s communications port lines are connected directly t...

Page 75: ...LonWorks Router User s Guide 65 6 Installing a LonWorks Router This chapter describes how to install a LONWORKS router...

Page 76: ...be installed loaded and online before you can add the new router to the network When installing routers on a development network you can use the LonScanner Protocol Analyzer to verify that a path exis...

Page 77: ...e 31 You can also use the terminators provided with the NodeBuilder FX Development Tool Figure 31 Network Termination Circuits for TP XF and TP RS485 Networks Connecting Power After the router is phys...

Page 78: ...sure that you have programmed both halves of the router for example see Configuring a Router 5000 Half Router on page 53 and that the reset signals for both halves are tied together for example see R...

Page 79: ...n line using the Set Node Mode network management message Testing Router Installation After a router has been installed you can use the Query Status network diagnostic message to ensure that it is ope...

Page 80: ......

Page 81: ...uide 71 7 Network Management Messages This chapter describes network management messages for LONWORKS routers These messages are used for router installation as described in Chapter 6 Installing a Lon...

Page 82: ...7E 0x34 to 0x3E 0x14 to 0x1E Several router options are set using the Write Memory network management message These router options include specification of the routing algorithm buffer sizes and non p...

Page 83: ...Chip Data Book The Set Node Mode network management message is automatically processed by both sides of a router when it is used to place the router offline and online the APPL_OFFLINE and APPL_ONLIN...

Page 84: ...network management messages listed in Table 13 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_BRID...

Page 85: ...age configures the entire group or subnet forwarding table in EEPROM for the specified domain for a single router side The download function is segmented into eight byte sections The least significant...

Page 86: ...igned domain_index 1 unsigned unused2 5 unsigned ram_or_eeprom 1 0 RAM 1 RAM EEPROM unsigned subnet NM_rtr_subnet_fwd_request Group No Forward This message clears the forwarding flag in the forwarding...

Page 87: ...message with earlier versions of the router firmware cause the router to become inoperable This message uses the Request Response protocol typedef struct unsigned group_or_subnet 1 1 Group 0 Subnet u...

Page 88: ...offline and online commands are automatically forwarded byte code Destination NM code 0x7E Router Options Set with Write Memory The Write Memory network management message is used to change the routi...

Page 89: ...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 SIZE_2...

Page 90: ...he queue_counts value contains two nibble fields that control the count of both the input and non priority output buffer queues The least significant nibble controls the number of input buffers and th...

Page 91: ...teroperability Guidelines Parameters specified as Configurable can be changed by a network services tool These parameters only apply to routers with router firmware version 5 or newer The firmware ver...

Page 92: ...Input Clock 10 MHz 10 MHz 10 MHz 10 MHz Minimum Clock Configurable default 5 MHz Configurable default 10 MHz Configurable default 5 MHz Configurable default 5 MHz Number of Priority Slots Configurabl...

Page 93: ...0 bits 0 0 bits Turnaround Time 0 sec 0 sec 0 sec 0 sec Missed Preamble 1 0 bits 4 0 bits 4 0 bits 1 0 bits Preamble Length N A N A N A N A Use Raw Data No No No No Table 15 Communications Parameters...

Page 94: ...A N A N A CD through Packet End N A N A N A N A Bit Sync Threshold 7 bits N A N A N A Hysteresis N A N A N A N A Filter N A N A N A N A Network Bit Rate 4 9 kbps 9412 bps 3987 bps 3987 bps Alternate...

Page 95: ...MHz 10 MHz 10 MHz 10 MHz Minimum Clock Configurable default 5 MHz Configurable default 5 MHz Configurable default 5 MHz Configurable default 5 MHz Number of Priority Slots Configurable default 12 slo...

Page 96: ...0 0 bits 0 0 bits Indeterminate Time 0 0 bits 4 0 bits 4 0 bits 4 0 bits Min Interpacket Time 0 0 bits 0 0 bits 0 0 bits 0 0 bits Turnaround Time N A 0 sec 0 sec 0 sec Missed Preamble N A 1 0 bit 1 0...

Page 97: ...Oscillator Wakeup 0 sec 0 sec 0 sec 0 sec Collision Detect CD Yes No No No CD Term after Preamble Yes N A N A N A CD through Packet End Yes N A N A N A Bit Sync Threshold 4 bits 4 bits 4 bits 4 bits H...

Page 98: ...88 Communications Parameters for LonWorks Routers Parameter FO 10 DC 78 DC 625 DC 1250 Missed Preamble 4 0 bits 0 0 bits 0 0 bits 0 0 bits Preamble Length N A N A N A N A Use Raw Data No No No No...

Page 99: ...www echelon com...

Reviews: