Page 2
Parts manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only, and may not have been tested by Echelon. It is the responsibility of the customer to determine the suitability of these parts for each application.
This document describes how to design and develop a L router based on ORKS either the Echelon Router 5000 chip or the Echelon RTR-10 Router Core Module. This document does not describe any of the following Echelon prepackaged router products: MPR-50 Multi-Port Router, i.LON 600 L...
Neuron Chip TMPN3150/3120, or Cypress™ Neuron Chip Technical Reference Manual. Getting Support You can get technical support for any of Echelon’s current product offerings by contacting Echelon Support: www.echelon.com/support. You can also search the Echelon Knowledge Base for known product issues: www.echelon.com/support/kb/search.asp.
FCC Notice The RTR-10 Router Core Module is designed to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. The Router 5000 chip is designed to comply with FCC Part 15 Subpart B and EN 55022 Level B. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment.
Table of Contents Welcome ......................iii Audience ......................iii Related Documentation ................iii Getting Support ..................... iv FCC Notice ..................... v VDE Notice ..................... v Canadian DoC Notice ..................v Chapter 1. Introduction to LonWorks Routers.......... 1 Introduction ....................2 LonWorks Router Products ................
Page 8
Chapter 3. LonWorks Router Mechanical Interfaces......39 RTR-10 Mechanical Description ..............40 Router 5000 Mechanical Description ............42 Chapter 4. Developing a LonWorks Router ..........45 Developing a Router with the RTR-10 ............46 Using Predefined Transceivers ............. 48 Using Custom Transceivers ..............48 Developing a Router with the Router 5000 ..........
Page 9
Appendix A. Communications Parameters for LonWorks Routers ..81 Communications Parameters ..............82...
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 buffers. LonWorks Router User’s Guide...
Introduction In general terms, a router is a device that forwards data packets between communications networks. The router connects to the data lines from each network, and reads address information in each data packet to determine the packet’s destination. router connects two communications channels within a L ORKS ORKS network, and routes LonTalk messages between them.
Use a network management tool, such as the LonMaker Integration Tool, to manage network images. LonWorks Router Products Echelon provides the following router products: MPR-50 Multi-Port Router (Model: 42150) • Five-channel (one TP/XF-1250 channel and four TP/FT-10 channels) router.
See the Echelon router ORKS Web page (www.echelon.com/products/routers) for information about the pre- packaged Echelon router products. This manual describes those Echelon router products that allow OEMs to design and build their own custom routers for L channels: the RTR-10 Router ORKS Core Module and the Router 5000 chips.
Page 15
Figure 2. Block Diagram of a LonWorks Router Based on the RTR-10 As the figure shows, an RTR-10 router and two transceiver modules (one to handle each of two channels connected by the router) can be mounted on a motherboard, along with a single power supply and two network connectors. This sub-assembly constitutes a L router.
TP/XF-1250 twisted pair. Router 5000 Overview The Router 5000 chip is an Echelon semiconductor product, based on the Echelon Neuron 5000 Core, that is used to build half-routers and full routers for channels. A L...
Page 17
These external transceivers can run at interface bit rates from 9.8 kbps to 1.25 Mbps. A complete router, using the Router 5000, consists of two Router 5000 half routers, two transceivers, and a motherboard to connect the two half routers, as shown in Figure 3.
Router Types router can use one of four routing algorithms: configured router, ORKS learning router, bridge, and repeater. This selection allows you to trade system performance for ease of installation. The configured router and learning router algorithms create intelligent routers that selectively forward messages based on network topology.
A forwarding table is used for each domain on each side of the router. Each forwarding table contains a forwarding flag for each of the 255 subnets and 255 groups in a domain. As shown in Figure 4 and Figure 5, these flags determine whether or not a message should be forwarded or dropped based on the destination subnet or group address of the message.
Page 20
forwarding is disabled) in the subnet forwarding table. The forwarding flag for the destination address is then checked to determine whether the message should be forwarded or dropped. The forwarding flags are all cleared whenever the router is reset, so the learning process restarts after a reset. The forwarding flag for a given subnet should never be cleared on both sides of a router.
Figure 5. Configured and Learning Router Forwarding Rules, Part 2 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 destination addresses. Their advantage is simplified installation because the installation tool does not need to know the network topology to configure the router.
by router 1 to channel B, then the same message could be forwarded by router 2 back to channel A, starting an endless loop of forwarded messages. Figure 6. Looping Topology The LonTalk protocol does not support topologies where loops can occur. However, looping topologies can be desirable for the following reasons: Increased Reliability.
By default, this queue is limited to two message buffers to ensure that priority messages are never enqueued behind more than one non-priority message. When Echelon’s implementation of the ISO/IEC 14908 Control Network Protocol is called the LonTalk protocol. Echelon has implementations of the LonTalk protocol in several product offerings, including the Neuron firmware, LNS Server, SmartServers, and various network interfaces.
forwarded to the transmitting side of the router, priority messages have their own outgoing buffer queue. Thus, priority processing of these outgoing messages is assured because the transmitting side will send messages from the priority output buffer queue before sending messages from the non-priority output buffer queue.
You can also use the NodeUtil Node Utility, which you can download from the Echelon Web site. However you allocate the buffer sizes and counts, the total memory required by the three buffer queues must not exceed 1254 bytes.
You can also use the NodeUtil Node Utility, which you can download from the Echelon Web site. However you allocate the buffer sizes and counts, the total memory required by the three buffer queues must not exceed 25 K bytes.
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. LonWorks Router User’s Guide...
Overview This chapter describes the electrical interface and power requirements for a router. ORKS Electrical Interface The following sections describe the electrical interface for a L router, ORKS including detailed descriptions of each of the RTR-10 and Router 5000 pins. RTR-10 Electrical Interface Figure 9 shows a schematic view of a connector for the RTR-10 Router Core Module, and Table 4 shows the pinout of the RTR-10 Router Core Module.
Page 29
Pin Name Pin Description Pin Number ASVC~ A-side Service output AXID0 A-side transceiver ID 0 (LSB) AXID1 A-side transceiver ID 1 AXID2 A-side transceiver ID 2 AXID3 A-side transceiver ID 3 AXID4 A-side transceiver ID 4 (MSB) BCLK1 B-side input clock BCLK2 B-side output clock BCP0...
ACLK2, BCLK1, and BCLK2 A 10 MHz crystal is provided for Side A of the RTR-10 router, which can run at only 10 MHz. This clock rate allows Side A to be used with transceivers running at interface bit rates from 9.8 kbps to 1.25 Mbps. The 10 MHz clock is output on the ACLK2 pin, which allows Side B to be tied directly to the same clock through pin BCLK1.
Page 31
reinitialization allows a network services tool to change parameters, such as the number of priority slots, without the new values’ being overwritten by the RTR- 10 firmware. Table 5. RTR-10 Router Transceiver IDs Bit Rate Input Name Media (bps) Clock 01 (0x01) TP/XF-78 Transformer-isolated twisted pair...
See Appendix A, Communications Parameters for LonWorks Routers, on page 81, for a listing of the communications parameters for each transceiver type. The PKT output can be used as a network activity indicator. When packets are passed between the router sides, PKT is active. This signal uses the unbuffered IO0 signal from the Neuron Chips.
RESET~ signal must be driven low by a low voltage protection circuit on the router motherboard as described in Low Voltage Protection on page 37. SERVICE~ The SERVICE~ input drives both sides of the RTR-10 router from a single input. You can connect a pushbutton to this pin broadcast each side’s 48-bit Neuron ID on its channel (for example, during installation).
Page 34
Table 6 lists the pin assignments for the Router 5000 chip. All digital inputs are low-voltage transistor-transistor logic (LVTTL) compatible, 5 V tolerant, with low leakage. All digital outputs are slew-rate limited to reduce Electromagnetic Interference (EMI) concerns. Table 6. Router 5000 Chip Pin Assignments Name Number Type...
Name Number Type Description RST~ Digital I/O Reset (active low) VIN3V3 Power 3.3 V Power Input VDD3V3 Power 3.3 V Power AVDD3V3 Power 3.3 V Power Comm CP0: Receive serial data AGND Ground Ground Comm CP1: Transmit serial data Do Not Connect Ground Ground Comm...
Page 36
multipliers greater than one, the chip uses a phase-locked loop (PLL) to drive and manage the internal on-chip system clock frequency. A Router 5000 chip requires a 10.0 MHz external clock signal for operation. An example part that meets the requirements for a Router 5000 chip is the Abracon Corporation ABMM2-100000MHz-D1 Ceramic Surface Mount Low Profile Quartz Crystal.
Important: Because the Router 5000 A Side XOUT pin drives an input buffer, the values of the external capacitors are not equal. The value for A Side XOUT is specified as 30 pF based on an internal input capacitance of 4.5 pF of the XIN/XOUT pins and internal input capacitance for the buffer/line driver of 3 pF at 25 ºC (so that the total capacitance for the A Side XOUT pin is 33 pF).
The communications port for the Router 5000 is configured to operate in single- ended mode. Table 7 lists the pin assignments for the communications port pins. Table 7. Communications Port Pin Assignments Single-Ended Drive Current Mode (3.3 V) Connect To Data input Transceiver RXD 8 mA...
Figure 14. Digital IO Pin Connections Important: When routing the IO[11..0] signals between the two router halves of your Router 5000 device, keep the traces as short as possible. See the Series 5000 Chip Data Book for more information about the digital I/O pins for a Series 5000 chip, including the Router 5000.
Memory Interface (CS0~, MISO, MOSI, SCK, SCL, and SDA_CS1~) The interface for accessing off-chip non-volatile memory (NVM) is a serial interface that follows either of the following protocols: serial Inter-Integrated Circuit (I C) or serial peripheral interface (SPI). Although a Series 5000 chip supports both Electrically Erasable Programmable Read-Only Memory (EEPROM) devices and flash memory devices, a typical Router 5000 device uses a single 2 KB EEPROM device (using either the I...
Page 41
Series 3100 chip, you need to modify the reset circuit shown in Figure 15 to account for the different voltage standards (3.3 V for the Router 5000 and 5 V for the Series 3100). Contact Echelon Support for additional information. LonWorks Router User’s Guide...
Figure 15. Reset Circuit – Router 5000 for Both Halves Typical applications do not require debounce conditioning of a momentary pushbutton attached to the RST~ pin. The software response time associated with this input is long enough to effectively provide a software debounce for switches with a contact bounce settling time as long as 20 milliseconds.
Page 43
to transmit a network management message containing its unique 48-bit Neuron ID and the application’s program ID. This information can then be used by a network management tool to install and configure the router. Table 8 on page 34 lists the 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.
Table 8. Service LED Behavior during Different States Device State State Code Service LED Applicationless and Unconfigured Unconfigured (but with Flashing an Application) Configured, Hard Offline Configured Defective External — Memory The SVC~ pin is active low, and the service pin message is sent once per SVC~ pin transition.
Figure 17. RX and TX Network Activity Indicator Circuits When packets are transmitted, the TX network activity LED is active for the duration of the entire data transmission. When packets are received, the RX network activity LED is active for each bit received, and inactive between bytes. For both circuits, the approximate time constant for LED visibility is 100 ms.
The supply current requirements for the Router 5000 chip are outlined in Table 9, including typical requirements for the different operating states of the Router 5000 at various system clock rates. Important: Although general Series 5000 chips support 80 MHz operations, the Router 5000 chip does not support this system clock setting.
Low Voltage Protection For a RTR-10 design, it is necessary to include a low voltage protection circuit on the router motherboard to drive the RESET~ line of the RTR-10 router. 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.
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. LonWorks Router User’s Guide...
• However, these Molex SIMM sockets are obsoleted and are unavailable for purchase from Molex. Echelon has a limited supply of these sockets (models 61101R and 61102R); contact Echelon Support for more information. The following figures show recommended mechanical layouts for the RTR-10:...
Figure 21. RTR-10 Recommended PCB Hole Pattern (Component Side, Horizontal Mounting) Decisions about component placement on the motherboard must consider electromagnetic interference (EMI) 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 mechanical description of the Neuron 5000 Processor, described in the Series 5000 Chip Data Book and the data sheet for the Neuron 5000 Processor.
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. LonWorks Router User’s Guide...
Developing a Router with the RTR-10 To create a L router with the RTR-10, perform the following steps: ORKS 1. Build a router motherboard according to the specifications described in Chapter 2, LonWorks Router Electrical Interfaces, on page 17, and the guidelines described in Chapter 5, LonWorks Router Design Issues, on page 59.
Using Predefined Transceivers The RTR-10 router includes built-in transceiver parameters for the transceivers listed in Table 5 on page 21. When using any of these transceivers, the communications parameters are automatically programmed, as described in Chapter 2, LonWorks Router Electrical Interfaces, on page 17. The user's guide for each transceiver contains documentation on the interface requirements.
Installation procedures for the LonMaker Integration Tool are described in Chapter 6, Installing a LonWorks Router, on page 65. The preceding four steps complete the configuration when a single custom transceiver is used. Proceed with the following steps if two custom transceivers are to be used with the RTR-10 router.
Page 60
4. Install the router 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 manufacture, or a production network for field installation. Developing a LonWorks Router...
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.
Platform: Custom • Transceiver Type: (Depends on router type) • Neuron Chip Model: Neuron 5000 • Clock Multiplier: 2 (Recommended) • Important: If the other router-half uses a Series 3100 chip, do not specify a value higher clock multiplier value than 2. You can specify a value of 4 if both sides are Router 5000 chips.
Figure 29. Example NodeBuilder Device Template for the Router 5000 You can also use this template to export a specific domain configuration (limited to domain 0) along with a receive transaction timer (typically, 768 ms) and a location string. Buffer Configurations The NodeBuilder FX Development Tool issues an error if you try to build a target with too large a buffer configuration.
This section shows an example Neuron C file for Router 5000 development. This file primarily controls the router’s buffering, but it also contains important declarations to set up the parallel IO configuration and explicit addressing. // Copyright (c) 2011 by Echelon Corporation. // All Rights Reserved. #include <control.h> #include <msg_addr.h>...
Page 67
// The Transceiver ID is declared 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 ignore_notused mip_eevars #pragma ignore_notused send_msg_dummy LonWorks Router User’s Guide...
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 L ORKS routers. LonWorks Router User’s Guide...
PCB Layout Guidelines Printed circuit board (PCB) layout for a Router 5000 is similar to layout for a Neuron 5000 Processor, and should include the following general features: Star-Ground Configuration: Arrange the various blocks of the device that • directly interface with off-board connections (the network, any external I/O, and the power supply cable) so that they are together along one edge of the PCB.
Page 71
Center of Keepout Star Ground Area Network Power Supply Connector Connector TPT/XF-1250 Power Supply Circuitry Figure 30. Example PCB Layout for a Router 5000 with a TPT/XF-1250 Transceiver In the figure, the area marked CORE represents the essential circuitry for the Router 5000, its serial EEPROM memory chip, its crystal, and associated capacitors and resistors.
For more information about such regulations, see European EMC standards, such as VDE 0871, Class “B” 1984, and CISPR Publications 22. Echelon has designed the RTR-10 router with low enough RF noise levels for design into level “B” products. Echelon encourages level “B” compliance for all compatible products.
Most of the RF noise originates in the CPU portion of the RTR-10 • router—which effectively means the entire board. Most of the RF noise originates with the Router 5000 chip. Most of the EMI will be radiated by the network cable and the power •...
Page 74
When ESD hits to circuitry cannot be avoided through creepage, clearance, and ground guarding techniques (that is, at external connector pins), explicit clamping of the exposed lines is required to shunt the ESD current. In general, exposed lines require diode clamps to the power supply rails or Zener clamps to chassis ground to shunt the ESD current to ground while clamping the voltage low enough to prevent circuit damage.
Introduction To install a L router, perform the following steps: ORKS 1. Define a network topology. 2. Physically attach the router to a L network. ORKS 3. Connect power to the router. 4. Logically install the router on the network. 5.
Proper electrical termination is essential for each twisted-pair channel. Failure to terminate the network can degrade performance, and in some cases, eliminate a device’s ability to communicate with other devices. For TP/XF and TP/RS485 channels, use the terminator circuits shown in Figure 31. You can also use the terminators provided with the NodeBuilder FX Development Tool.
Installing the Router on a Network After a router is physically attached to a network, and powered-up, it must be logically installed on the network. You can install a router using a network management tool, such as the LonMaker Integration Tool. Alternatively, you can use a custom network management tool that uses the router network management messages defined in Chapter 7;...
4. For configured routers, load the group and subnet routing tables on both sides of the router using the Group or Subnet Table Download network management message. There are 255 forwarding flags for subnets and 255 forwarding flags for groups on each side for each domain. 5.
Network Management Messages This chapter describes network management messages for routers. These messages are used for router ORKS installation, as described in Chapter 6, Installing a LonWorks Router, on page 65. LonWorks Router User’s Guide...
Introduction As described in Chapter 6, routers are installed using network management messages. These messages are sent as explicit messages by a network management tool, such as the LonMaker Integration Tool. Routers respond to many of the same messages as any L device, but also have an ORKS additional set of router-specific messages, as listed in Table 10.
typedef enum { NORMAL = 0, // Not a temporary bridge. INIT_RTR_TABLE = 1, // Copy forwarding tables from EEPROM // for configured routers. // Initialize forwarding tables for // learning routers. TEMP_BRIDGE = 2 // Temporarily a bridge until next reset // or NORMAL router mode request.
EEPROM flags are set, otherwise only the RAM flag is set, allowing temporary forwarding for a given group. This message uses the Request-Response protocol. The configuration checksum in EEPROM is updated if EEPROM is changed. typedef struct { unsigned unused1 : 1; unsigned domain_index : 1;...
typedef struct { algorithm type; // CONFIGURED, LEARNING, BRIDGE, // or REPEATER rtr_mode mode; // TEMP_BRIDGE or NORMAL } NM_rtr_status_response; Far Side Escape Code When this message code is placed in the message, and is followed by any network management or network diagnostic message (except the escape message itself), that message is passed to the other (far) router side for processing.
mode = READ_ONLY_RELATIVE (1) offset = 0x0019; count = 1; form = BOTH_CS_RECALC (1) data = buffer_sizes; The buffer_sizes value contains two nibble fields that control the size of both the input and output buffers. The output size value also controls the priority output buffer size.
typedef enum { COUNT_1 = 0x2; COUNT_2 = 0x3; COUNT_3 = 0x4; COUNT_5 = 0x5; COUNT_7 = 0x6; COUNT_11 = 0x7; COUNT_15 = 0x8; COUNT_23 = 0x9; COUNT_31 = 0xA; COUNT_47 = 0xB; COUNT_63 = 0xC; } queue_count_entry; Set Input and Non-Priority Buffer Queue Count The buffer queue counts are selected using a Write Memory network management message with the following paramters:...
Page 91
Communications Parameters for LonWorks Routers routers are initially programmed with ORKS communications parameters as listed in this appendix. Parameters for L approved transceivers correspond to the parameters defined by the L Interoperability ORKS Guidelines. Parameters specified as “Configurable” can be changed by a network services tool.
Communications Parameters Table 14, Table 15 on page 83, Table 16 on page 85, and Table 17 on page 86 together list the communications parameters for L routers. ORKS Table 14. Communications Parameters, Part 1 Parameter TP/XF-78 TP/XF-1250 TP/FT-10 TP/RS485-39 Transceiver ID 1 (0x01) 3 (0x03)
Page 93
Parameter TP/XF-78 TP/XF-1250 TP/FT-10 TP/RS485-39 Alternate Rate Wakeup Pin Direction XCVR Controls Preamble General Purpose Data Allow Node Override Receive Start Delay 2.9 bits 14.0 bits 9.0 bits 2.0 bits Receive End Delay 0.0 bits 0.0 bits 0.0 bits 0.0 bits Indeterminate Time 24.0 bits 25.0 bits...