Echelon NodeBuilder FX User Manual

0 7 8 - 0 4 0 5 - 0 1 A®NodeBuilder®FX User’s Guide

x Preface Purpose This document describes how to use the NodeBuilder tool to develop LONWORKS device applications and build and test prototype and p

86 Creating and Using Device Templates 7. Accept the default Create a New NodeBuilder Project option, and then click Next. 8. Accept the default

NodeBuilder FX User's Guide 87 4. The Select NodeBuilder Project File dialog opens. Click the button to the right of the Project File proper

88 Creating and Using Device Templates Opening a NodeBuilder Project from the NodeBuilder Project Manager You can open a NodeBuilder project by star

NodeBuilder FX User's Guide 89 5. If you have previously associated a LonMaker network with this NodeBuilder project, it appears in the Proje

90 Creating and Using Device Templates 4. The LonMaker Backup dialog opens. 5. Select the Backup Drawing, Backup Database, Backup NodeBuilder Pr

NodeBuilder FX User's Guide 91 7. After the backup has been created, copy the LonMaker backup file from the source computer to a USB drive, an

92 Creating and Using Device Templates 12. A message appears informing you that the network restore operation has been completed, and prompting you

NodeBuilder FX User's Guide 93 4. On the source computer, copy any user-defined hardware templates and custom libraries to the USB drive, anot

94 Creating and Using Device Templates install and register the resource files on the target computer. User-defined resource files include the netw

NodeBuilder FX User's Guide 95 5 Creating and Using Device Templates This chapter describes how to use the New Device Template wizard in the

NodeBuilder FX User's Guide xi o Compatible IP-852 routers include the i.LON SmartServer with IP-852 routing, i.LON 100 e3 Internet Server wit

96 Creating and Using Device Templates Introduction to Device Templates Each type of device that you develop with the NodeBuilder tool is defined by

NodeBuilder FX User's Guide 97 3. Proceed to the next section to specify the device template name. Specifying the Device Template Name To s

98 Creating and Using Device Templates 2. Optionally, in the Source File Name property, you can enter the name of the Neuron C source file for this

NodeBuilder FX User's Guide 99 The Standard Program ID Calculator helps you select the appropriate values for the program ID fields. It lets

100 Creating and Using Device Templates c. In the Device Class (CC:CC) property, select the primary function of the device. To enter a device clas

NodeBuilder FX User's Guide 101 3. Click OK to return to the Program ID dialog in the New Device Template wizard. The Program ID property co

102 Creating and Using Device Templates of model numbers specified by the Min Model # and Max Model # properties to avoid two devices having the sam

NodeBuilder FX User's Guide 103 8. Proceed to the next section to specify the hardware templates used by development and release devices. S

104 Creating and Using Device Templates 2. In the Release Build Hardware Template property, select the hardware template to be used for release ta

NodeBuilder FX User's Guide 105 menu. The NodeBuilder Project Properties dialog opens. Click the Options tab, change the setting, and then cl

xii Preface • Debugging a Neuron C Application. Describes how the use the NodeBuilder debugger to troubleshoot your Neuron C application. • Appe

106 Creating and Using Device Templates Output Files in Chapter 8 for more information on removing the files and folders produced by a build. Status

NodeBuilder FX User's Guide 107 menu. When a device template is excluded, you can still explicitly build the device template by right-clicking

108 Creating and Using Device Templates Source Files This folder contains all the source files associated with this device template except for the

NodeBuilder FX User's Guide 109 Managing Development and Release Targets Each NodeBuilder device template in the Project pane contains Developm

110 Creating and Using Device Templates Settings Opens the NodeBuilder Device Template Target Properties dialog, which includes compiling, linking

NodeBuilder FX User's Guide 111 You can set the following properties: Defines You can define a symbol, which can then be tested from the prog

112 Creating and Using Device Templates Debug Kernel Options Disable optimizer Disables the compiler’s code optimizer. Optimization typically gen

NodeBuilder FX User's Guide 113 Enable Function Execute Enables the debugger to get and update the values of system timers and to update the va

114 Creating and Using Device Templates Compatible EEPROM to meet system requirements. In NodeBuilder 3.0 and prior releases, the NodeBuilder too

NodeBuilder FX User's Guide 115 You can set the following properties: Boot ID Generation Select whether the boot ID is generated automatical

NodeBuilder FX User's Guide xiii LONWORKS® USB Network Interface User’s Guide Describes how to install and use the U10 and U20 USB Network Inte

116 Creating and Using Device Templates application image inconsistency, or other fatal application error. • Always. Reboot every time the Neuro

NodeBuilder FX User's Guide 117 You can select the Export Configured check box to enable the NodeBuilder tool build a configured device applic

118 Creating and Using Device Templates is sent using subnet/node addressing regardless of the addressing format of the original message. • D

NodeBuilder FX User's Guide 119 1. Expand the device template in the Project pane of the NodeBuilder project manager. 2. Right-click the Li

120 Creating and Using Device Templates Select one or more of the following standard libraries in the C:\LonWorks\Images folder to be explicitly in

NodeBuilder FX User's Guide 121 When you build the application image, the NodeBuilder tool first searches for the selected libraries in the fol

122 Creating and Using Device Templates you can use the Insert Copy feature to create your own custom hardware template based on a Standard template

NodeBuilder FX User's Guide 123 New Creates a new hardware template to be added to the selected folder. Selecting this option opens the Hardw

124 Creating and Using Device Templates • Do not modify hardware templates in the Standard Templates folder because any changes that you make will

NodeBuilder FX User's Guide 125 You can set the following properties on the Hardware tab: Hardware Template Name Enter the name of the hardwar

xiv Preface Region Languages Supported Contact Information Europe English German French Italian Echelon Europe Ltd. Suite 12 Building 6 Croxley

126 Creating and Using Device Templates Transceiver Type Select the transceiver type supported by the Neuron Chip or Smart Transceiver model select

NodeBuilder FX User's Guide 127 System Image Version Select the system image version for the selected Neuron Chip or Smart Transceiver model.

128 Creating and Using Device Templates The Memory Addresses box details how on chip and off-chip memory is organized on the selected Neuron Chip or

NodeBuilder FX User's Guide 129 3150 Neuron Core For Neuron 3150 Chips, 3150 FT Smart Transceivers, and 3150 PL Smart Transceivers, the on-chip

130 Creating and Using Device Templates

NodeBuilder FX User's Guide 131 6 Defining Device Interfaces and Creating their Neuron C Application Framework This chapter describes how to u

132 Defining Device Interfaces and Creating their Neuron C Framework Introduction to Device Interfaces The NodeBuilder Code Wizard generates Neuron

NodeBuilder FX User's Guide 133 The NodeBuilder Code Wizard opens. The NodeBuilder Code Wizard user interface is essentially divided into two

134 Defining Device Interfaces and Creating their Neuron C Framework section. For more information on creating and editing resource file sets and r

NodeBuilder FX User's Guide 135 The scope may be one of the following values: Scope Program ID Fields Used 0 Standard 1 Device Class 2 Device

NodeBuilder FX User's Guide 1 1 Introduction This chapter introduces the NodeBuilder Development Tool. It lists the new features in the NodeB

136 Defining Device Interfaces and Creating their Neuron C Framework Resource Description Functional Profiles Functional profiles define a templa

NodeBuilder FX User's Guide 137 Resource Description Italian (default) “ita” Italian (Swiss) “its” Norwegian (Bokmal) “nor” Polish “plk” P

138 Defining Device Interfaces and Creating their Neuron C Framework • The Functional Blocks folder contains all the functional blocks contained in

NodeBuilder FX User's Guide 139 network variables. The Node Object functional block is a standard functional block that is used by network man

140 Defining Device Interfaces and Creating their Neuron C Framework A network variable defines an operational input or output for the device. The

NodeBuilder FX User's Guide 141 Each functional profile has a name and number that is unique for the scope of the resource file set. The numb

142 Defining Device Interfaces and Creating their Neuron C Framework Adding Functional Blocks Functional blocks represent specific device functions.

NodeBuilder FX User's Guide 143 the Use Array checkbox, enter the number of functional blocks in the array in the Size box, and then click OK.

144 Defining Device Interfaces and Creating their Neuron C Framework 5. If any of the mandatory network variables do not have a default type set b

NodeBuilder FX User's Guide 145 4. In the SFPT or UFPT property, select the desired functional profile template. 5. In the Name property, e

2 Introduction Introduction to the NodeBuilder Tool The NodeBuilder FX Development Tool is a complete hardware and software platform for developing,

146 Defining Device Interfaces and Creating their Neuron C Framework 2. The NV Properties dialog opens. 3. Edit the following properties:

NodeBuilder FX User's Guide 147 Name Displays the name of the network variable that will be used in the LonMaker tool and other network manage

148 Defining Device Interfaces and Creating their Neuron C Framework Service Type Displays the service type used by the network variable to send up

NodeBuilder FX User's Guide 149 Modifiers Indicates whether the network variable uses the Synchronized or Polled modifiers. This property i

150 Defining Device Interfaces and Creating their Neuron C Framework 4. Optionally, you can click Advanced to open the Advanced NV Properties dialo

NodeBuilder FX User's Guide 151 memory devices. far The network variable is placed in the far section of the variable space. By default, Neuro

152 Defining Device Interfaces and Creating their Neuron C Framework the network variable must have priority enabled when it is installed. To enabl

NodeBuilder FX User's Guide 153 3. Edit the following properties: Name Displays the name of the configuration property that will be used in

154 Defining Device Interfaces and Creating their Neuron C Framework Implement as CP Array check box is set appropriately and unavailable. If the

NodeBuilder FX User's Guide 155 modified only when the device has been set offline by a network tool such as the LonMaker tool. Do not set thi

NodeBuilder FX User's Guide 3 • Improved performance for arithmetic operations. • User-programmable interrupts. • Additional I/O model s

156 Defining Device Interfaces and Creating their Neuron C Framework cleared by default. Initializer Optionally, you can set the value for the net

NodeBuilder FX User's Guide 157 4. If you have shared two mandatory or optional configuration properties or if you have shared two implementat

158 Defining Device Interfaces and Creating their Neuron C Framework functional block or network variable arrays, or any combination thereof. • A c

NodeBuilder FX User's Guide 159 Alternatively, you can drag a network variable from the functional profile’s Optional NVs folder in the Resou

160 Defining Device Interfaces and Creating their Neuron C Framework The name cannot contain spaces or the following characters: \ / : * ? “ < &g

NodeBuilder FX User's Guide 161 3. In the FPT Member Name property, select the optional configuration property from the list of those that ha

162 Defining Device Interfaces and Creating their Neuron C Framework See the Neuron C Programmer’s Guide and Neuron C Reference Guide for more infor

NodeBuilder FX User's Guide 163 To add an implementation-specific network variable to a functional block, follow these steps: 1. Right-click t

164 Defining Device Interfaces and Creating their Neuron C Framework 3. In the Name property, enter a name for the network variable as it will appe

NodeBuilder FX User's Guide 165 Implementation-specific configuration properties should be avoided as part of a device’s interoperable interfac

4 Introduction Faster System Clock The 5000 Series chips support an internal system clock speed of up to 80 MHz (using an external 10 MHz crystal

166 Defining Device Interfaces and Creating their Neuron C Framework 3. In the Name property, enter a name for the configuration property as it wi

NodeBuilder FX User's Guide 167 of the functional profile containing the configuration property type. To use a User-Defined type, you must fir

168 Defining Device Interfaces and Creating their Neuron C Framework Structure SNVT_switch {200, 0} Enumeration SNVT_hvac_mode HVAC_AUTO If you ne

NodeBuilder FX User's Guide 169 The Structure Fields box displays all the fields in the structured network variable or configuration property

170 Defining Device Interfaces and Creating their Neuron C Framework 3. All other fields in the structure are automatically set to their default v

NodeBuilder FX User's Guide 171 2. Click anywhere in the Value box, and select a value from the list of possible enumeration values. You can

172 Defining Device Interfaces and Creating their Neuron C Framework 3. The current initial value for the float or 32 data type is displayed in th

NodeBuilder FX User's Guide 173 Generating Code with the Code Wizard You can use the NodeBuilder Code Wizard to generate Neuron C source code t

174 Defining Device Interfaces and Creating their Neuron C Framework The following table lists and describes the files created by the NodeBuilder C

NodeBuilder FX User's Guide 175 Source File Description filesys.nc Contains functions used to facilitate transfer of configuration properties

NodeBuilder FX User's Guide 5 Additional I/O Model Support The 5000 Series chips include hardware support for the Serial Peripheral Interface (

176 Defining Device Interfaces and Creating their Neuron C Framework Each time you generate code using the Code Wizard, it checks whether each of th

NodeBuilder FX User's Guide 177 Version 1 Templates The version 1 templates were the initial implementation of the Code Wizard templates, which

178 Defining Device Interfaces and Creating their Neuron C Framework

NodeBuilder FX User's Guide 179 7 Developing Device Applications This chapter provides an overview of the Neuron C Version 2.2 programming la

180 Developing Device Applications Introduction to Neuron C Neuron C Version 2.2 is a programming language based on ANSI C that you can use to dev

NodeBuilder FX User's Guide 181 Each network variable, configuration property, and functional block is defined by a type definition contained i

182 Developing Device Applications Neuron C Variables The following sections briefly discuss various aspects of Neuron C-specific variable declarat

NodeBuilder FX User's Guide 183 the declaration of CP families or configuration network variables. The Neuron C language does not permit the u

184 Developing Device Applications Declaration Example Simple data items int a, b, c; Data types typedef unsigned long ULONG; Enumerations enum hue

NodeBuilder FX User's Guide 185 be completed by the developer. The C language comments supplied in the source files generated by the Code Wiza

ii Echelon, LON, LonWorks, Neuron, 3120, 3150, Digital Home, i.LON, LNS, LonMaker, LONMARK, LonPoint, LonTalk, NodeBuilder, ShortStack, and the Echel

6 Introduction Neuron C Version 2.2 Enhancements The new features in the Neuron C Version 2.2 programming language include interrupt support, non-co

186 Developing Device Applications nv_properties { cpTransInMin = 0, cpTransInMax = 3000L }; // //<Fblock Output NV Declarations> network

NodeBuilder FX User's Guide 187 SetLed( 1, DigitalOutput[1]::cpDigitalDefault.state ); setLockedOutBit( uFblockIndex, FALSE ); } ..

188 Developing Device Applications Another example is a scheduler that can control a variety of device types by allowing the integrator to change th

NodeBuilder FX User's Guide 189 The Code Wizard does not provide framework code for this task, but a commented source code example is provided

190 Developing Device Applications block or functional block array). This restriction applies to both the static and global configuration property

NodeBuilder FX User's Guide 191 by double clicking it. You can open multiple files in the Edit pane of the NodeBuilder Project Manager. You c

192 Developing Device Applications 3. Enter the text string to search for in Find what. 4. Set Match Whole Word Only to find only whole words th

NodeBuilder FX User's Guide 193 2. In the Text to Find property, enter the text string to be found. 3. In the File Types property, select

194 Developing Device Applications Expression Description ? The question mark replaces one or zero characters. The search must contain at least tw

NodeBuilder FX User's Guide 195 5. In the Where property, select which files to search. You have the following three choices: • Search all F

NodeBuilder FX User's Guide 7 Neuron C Debugger The NodeBuilder debugger provides an option to write all breakpoints to RAM and not have them c

196 Developing Device Applications Alternatively, you can access this tab by clicking Project, clicking Settings, and then clicking the Editor tab,

NodeBuilder FX User's Guide 197 8 Building and Downloading Device Applications This chapter describes how to compile Neuron C source code, b

198 Building and Downloading Device Applications Introduction to Building and Downloading Applications You can build an application image for one or

NodeBuilder FX User's Guide 199 • To build one or more targets in the current NodeBuilder project, click one target device template, optional

200 Building and Downloading Device Applications Note: To stop a build in progress, open the Project menu and then select Stop Build. 6. If the L

NodeBuilder FX User's Guide 201 Downloadable Application Image Files (.APB, .NDL., and NXE,) These files contain the application image used by

202 Building and Downloading Device Applications the application code and data that resides in off-chip EEPROM, flash, or NVRAM (if any). For these

NodeBuilder FX User's Guide 203 Excluding Targets from a Build You can exclude a target or a device template from project builds, and you can e

204 Building and Downloading Device Applications Note: The Clean command only removes files and folders produced by the NodeBuilder tool. It does

NodeBuilder FX User's Guide 205 2. The Build Status dialog opens. 3. Each row in this dialog represents a device template target or a targe

8 Introduction Turbo Edition CD U10/U20 USB Network Interface 5 5  * The NodeBuilder FX/FT Development Tool and NodeBuilder FX/FT Classroom Editi

206 Building and Downloading Device Applications changed. This status is unlikely to occur. Link required. Applies to device template targets only

NodeBuilder FX User's Guide 207 process will move on to the next target, rather than aborting the build. Load after Build Loads the application

208 Building and Downloading Device Applications Processor System Image Memory Type Application Memory Type Application Image File Extension Applica

NodeBuilder FX User's Guide 209 The system image resides in on-chip ROM. The application image and the system image are copied from the extern

210 Building and Downloading Device Applications The following sections provide two sets of diagrams illustrating connection schemes that you could

NodeBuilder FX User's Guide 211 Note: In this diagram, all jumpers are set into position 1-2 for normal operation, and they are set into posit

212 Building and Downloading Device Applications FT 5000SCLSDA_CS1~RST~AardvarkSCLSDAGNDSerial EEPROMDeviceGNDGND45432813210SDASCLGNDVCCR14.99kVCCR2

NodeBuilder FX User's Guide 213 Serial Memory Device-Aardvark Connection Scheme for SPI Interface To connect an external serial EEPROM or flash

214 Building and Downloading Device Applications Note: Pins 2 and 10 on the Aardvark are both connected to ground inside the Aardvark. As

NodeBuilder FX User's Guide 215 When using flash memory, always enable the flash programmer’s software data protect, SDP, feature if possible.

NodeBuilder FX User's Guide 9 includes the following I/O devices that you can use to develop prototype and production devices and test the FT 5

216 Building and Downloading Device Applications areas, as well as in on-chip EEPROM. Whenever the Neuron Chip or Smart Transceiver is reset, the N

NodeBuilder FX User's Guide 217 Upgrading Device Applications The 5000 Series chips are compatible with device applications written for 3150 an

218 Building and Downloading Device Applications The NodeBuilder Basic Shapes 4.00 stencil contains a Development Target Device shape and a Release

NodeBuilder FX User's Guide 219 8. Click Next three times. The window in the New Device Wizard lets you select the application image to be d

220 Building and Downloading Device Applications 10. The next window lets you set the initial device state and the source of configuration propert

NodeBuilder FX User's Guide 221 13. Press the service pin on the development platform you to be loaded and commissioned. The LonMaker tool l

222 Building and Downloading Device Applications 2. The Insert Device dialog opens. 3. This dialog organizes the devices in currently open LonMa

NodeBuilder FX User's Guide 223 7. Click OK to add the target to the Devices folder in the NodeBuilder Project pane. If this device is commi

224 Building and Downloading Device Applications Remove Removes the device as a target for future builds. The device is removed from the current N

NodeBuilder FX User's Guide 225 3. You can view and set the following properties: Device Name Displays the name of the device specified in t

10 Introduction LTM-10A Platform The LTM-10A Platform is a complete LONWORKS device with downloadable flash memory and RAM that you can use for tes

226 Building and Downloading Device Applications Current LNS Device Template Displays the name of the LNS device template associated with the target

NodeBuilder FX User's Guide 227

NodeBuilder FX User's Guide 229 9 Testing a NodeBuilder Device Using the LonMaker Tool This chapter describes how to use the Data Point shap

230 Testing a NodeBuilder Device Using the LonMaker Tool Introduction to Testing NodeBuilder Devices You can use the LonMaker tool to test your Node

NodeBuilder FX User's Guide 231 3. Expand the Subsystem icon, expand your NodeBuilder device icon, expand a functional block in the device int

232 Testing a NodeBuilder Device Using the LonMaker Tool 7. Double-click the Data Point shape for the input network variable, enter a different va

NodeBuilder FX User's Guide 233 3. The LonMaker Browser opens. It displays the functional blocks in your device interface and the network va

234 Testing a NodeBuilder Device Using the LonMaker Tool 5. The Network Variable Properties or Configuration Property Properties dialog opens.

NodeBuilder FX User's Guide 235 8. Change network variable and configuration property values and confirm that the device hardware works as des

NodeBuilder FX User's Guide 11 A Gizmo 4 I/O library is included with the NodeBuilder software that provides easy-to-use high-level functions f

236 Testing a NodeBuilder Device Using the LonMaker Tool c. In the New FB Name: property under Functional Block, enter the name for the functional

NodeBuilder FX User's Guide 237 b. Drag the other end of the Connector shape to the input network variable of the other functional block unti

238 Testing a NodeBuilder Device Using the LonMaker Tool b. Right-click the new Connector shape it and select Monitor Input Value to display the c

NodeBuilder FX User's Guide 239 9. Toggle a hardware input to test the connection between the network variables change. Observe the hardware

240 Testing a NodeBuilder Device Using the LonMaker Tool

NodeBuilder FX User's Guide 241 10 Debugging a Neuron C Application This chapter describes how the use the NodeBuilder debugger to troublesh

242 Using the NodeBuilder Debugger Introduction to Debugging You can use the NodeBuilder debugger within the NodeBuilder Project Manager to control

NodeBuilder FX User's Guide 243 2. The NodeBuilder debugger opens. 3. The Debug menu appears on the NodeBuilder menu bar and four new pan

244 Using the NodeBuilder Debugger Debug Device Manager Displays which devices are currently being debugged, and lets you pause and resume the appli

NodeBuilder FX User's Guide 245 The following table describes each of the buttons in the Debugger toolbar. View Breakpoint List Toggles the

12 Introduction The U10 USB Network Interface connects directly to TP/FT-10 Free Topology Twisted Pair (ISO/IEC 14908-2) LONWORKS channels through a

246 Using the NodeBuilder Debugger Halting an Application You can stop an application while it is running in debug mode by clicking the halt button

NodeBuilder FX User's Guide 247 Stepping Through Applications You can step through the code in your application one line at a time after you ha

248 Using the NodeBuilder Debugger To add a variable, network variable, or configuration property to the watch list and monitor its value in the Wat

NodeBuilder FX User's Guide 249 4. If you right-clicked a statement, the drop-down list in the Watch Type box is empty and you need to select

250 Using the NodeBuilder Debugger Scalar network variables contain a single field that contains their value. If the variable does not exist, a Sy

NodeBuilder FX User's Guide 251 c. Enter the new value for the variable and then click OK. If you are editing the value of an enumerated type

252 Using the NodeBuilder Debugger Stop All Stops debugging all devices, removes all the devices from the Debug Device Manager pane, and closes the

NodeBuilder FX User's Guide 253 In the Address field, enter the address to start writing in. In the Count field, enter the number of bytes t

254 Using the NodeBuilder Debugger 2. You can set the following options: Default Display Radix Specifies the default format in which data is displ

NodeBuilder FX User's Guide 255 Fonts and Colors Specifies the font, font size, and color used for text in the Breakpoint List, Call Stack, and

NodeBuilder FX User's Guide 13 channel types include TP/FT-10 (ISO/IEC 14908-2 twisted pair free topology channel), TP/XF-1250 (high-speed twis

256 Using the NodeBuilder Debugger

NodeBuilder FX User's Guide 257 Appendix A Using the Command Line Project Make Facility This appendix describes how to use the command line pr

258 Appendix A: Using The Command Line Project Make Facility Using the NodeBuilder Command Line Project Make Facility You can invoke the NodeBuilder

NodeBuilder FX User's Guide 259 --defloc <dir> Specifies a directory to search for the default command file. The default command file f

260 Appendix A: Using The Command Line Project Make Facility -x <nbdt> Indicates that a clean operation will be performed on the specified Nod

NodeBuilder FX User's Guide 261 Appendix B Using Source Control With a NodeBuilder Project This appendix describes how to manage a NodeBuilder

262 Appendix B: Using Source Control with a NodeBuilder Project Using Source Control with a NodeBuilder Project When developing a large NodeBuilder

NodeBuilder FX User's Guide 263 Neuron C Source Files (.nc, .c, and .h) The main source file, <Device Template>.nc, is stored in the C:\L

264 Appendix B: Using Source Control with a NodeBuilder Project

NodeBuilder FX User's Guide 265 Appendix C Glossary This appendix provides definitions for many terms commonly used with NodeBuilder device de

14 Introduction Field Description format 8 or 9. Manufacturer ID (M) A 5 hex-digit ID that is unique to each LONWORKS device manufacturer. The uppe

266 Appendix C: Glossary 3100 Series Chip The term used to collectively refer to all previous-generation Neuron chips, including the 3150 and 3120 Ne

NodeBuilder FX User's Guide 267 Channel The physical media between devices upon which the devices communicate. The LonTalk protocol is media i

268 Appendix C: Glossary Device A device that communicates on a LONWORKS network. A device may be an application device, network service device, or

NodeBuilder FX User's Guide 269 the FT 3150 EVB and FT 5000 EVBs. In a self-installed network, you can use the ISI protocol to connect the FT

270 Appendix C: Glossary IP-852 Network Interface Formally called VNI, an IP-852 network interface enables IP-852 devices such as LNS Server computer

NodeBuilder FX User's Guide 271 LNS Server The computer containing the LNS global database acts as the LNS Server. The LNS global database co

272 Appendix C: Glossary Mandatory Network Variable/Configuration Property A network variable/configuration property that must be implemented by the

NodeBuilder FX User's Guide 273 Neuron C A programming language based on ANSI C that you can use to develop applications for Neuron Chips and S

274 Appendix C: Glossary NodeBuilder Hardware Template A file with a .NbHwt extension that defines the hardware configuration for a target device. I

NodeBuilder FX User's Guide 275 network interface mode. In NSI mode, the host treats the PCNSI card as a smart peripheral device that provides

NodeBuilder FX User's Guide 15 Network variables of identical type and length but opposite directions can be connected to allow the devices to

276 Appendix C: Glossary which implements the ISI protocol) that replaces parts of the network management server’s functionality, resulting in a netw

NodeBuilder FX User's Guide 277 User-defined Configuration Property Type (UCPT) A non-standard data structure used for configuration of the app

278 Appendix C: Glossary

NodeBuilder FX User's Guide 279 Appendix D NodeBuilder Software License Agreement When installing the NodeBuilder software, you must agree to

280 Appendix D: Software License Agreement NodeBuilder® Development Tool NOTICE This is a legal agreement between you and Echelon Corporation (“Eche

NodeBuilder FX User's Guide 281 software product shipped with the NodeBuilder Development Tool product and not contained in the NodeBuilder dir

282 Appendix D: Software License Agreement one computer at a time, and provided that such installation and use otherwise comply with all the terms a

NodeBuilder FX User's Guide 283 comply with the above restrictions, will result in automatic termination of this license and will make availabl

284 Appendix D: Software License Agreement MAY NOT APPLY TO YOU. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY FROM STATE TO STATE AND JURISDICTION TO J

NodeBuilder FX User's Guide 285 The parties hereto confirm that it is their wish that this Agreement, as well as other documents relating heret

NodeBuilder FX User's Guide iii Table of Contents Preface ...

16 Introduction for network variable values. Neuron C provides an easy-to-use programming model familiar to any C language programmer that encapsu

www.echelon.com

NodeBuilder FX User's Guide 17 When a functional block is created from a functional profile, the application designer can determine which of t

18 Introduction A text device interface file with a .XIF extension is required by the LonMark Application Layer Interoperability Guidelines. A text

NodeBuilder FX User's Guide 19 2 Installing the NodeBuilder FX Development Tool This chapter describes how to get started with your NodeBuilde

20 Installing the NodeBuilder Development Kit Installing the NodeBuilder FX Development Tool To install your NodeBuilder FX Development Tool, follow

NodeBuilder FX User's Guide 21 7. Connect the NodeBuilder hardware as described in Connecting the NodeBuilder Hardware later in this chapter.

22 Installing the NodeBuilder Development Kit 4. Click Microsoft .NET Framework 3.5 SP1 to install Microsoft .NET Framework 3.5 SP1 and then follo

NodeBuilder FX User's Guide 23 7. Read the license agreement (see Appendix D, NodeBuilder Software License Agreement, for a printed version

24 Installing the NodeBuilder Development Kit your computer. Organization The name of your company. The name may be entered automatically based on

NodeBuilder FX User's Guide 25 11. Select the type of installation to be performed. Select Complete to install NodeBuilder features or select

iv Preface Device Interface Files ...17Resource Files ...

26 Installing the NodeBuilder Development Kit 14. Click Finish. If a window appears prompting you to reboot your computer now or later, click Yes

NodeBuilder FX User's Guide 27 4. Connect the orange network connector on each FT 5000 EVB to the included network cable. 5. Use the includ

28 Installing the NodeBuilder Development Kit If this is the only LONWORKS interface installed on your computer, it will automatically use the de

NodeBuilder FX User's Guide 29 Connecting the NodeBuilder FX/PL Hardware To connect the NodeBuilder FX/PL hardware, follow these steps: 1. Unp

30 Installing the NodeBuilder Development Kit 5. Connect the Gizmo 4 I/O Board to the LTM-10A Platform using the provided ribbon cable. Plug one e

NodeBuilder FX User's Guide 31 3 NodeBuilder Quick-Start Exercise This chapter demonstrates how to create a LONWORKS device using the NodeBuil

32 NodeBuilder Quick-Start Exercise NodeBuilder Quick-Start Exercise The following quick-start exercise demonstrates how to create a LONWORKS devic

NodeBuilder FX User's Guide 33 1. Create a new LonMaker network. To do this, follow these steps: a. Verify that your LonMaker computer is ph

34 NodeBuilder Quick-Start Exercise g. Select the Network Attached check box and then select the network interface attached to your LonMaker compu

NodeBuilder FX User's Guide 35 i. Select OnNet. This means that changes to the LonMaker drawing are sent immediately to your NodeBuilder dev

NodeBuilder FX User's Guide v Specifying the Device Template Name...97Specifying the Program I

36 NodeBuilder Quick-Start Exercise 3. The New Project wizard opens. 4. Accept the default Create a New NodeBuilder Project option, and then clic

NodeBuilder FX User's Guide 37 2. Click Next. The Program ID window appears. 3. Click Calculator. The Standard Program ID Calculator dial

38 NodeBuilder Quick-Start Exercise 4. Enter the following values for the program ID fields: • In the Manufacturer ID (M:MM:MM) property, enter

NodeBuilder FX User's Guide 39 Note: The current list of manufacturer IDs, device classes, usage values, and channel types are defined in an X

40 NodeBuilder Quick-Start Exercise • If you are using the NodeBuilder FX/PL hardware (LTM-10A Platform with Gizmo 4 I/O Board), select LTM-10A R

NodeBuilder FX User's Guide 41 Step 3: Defining the Device Interface and Creating its Neuron C Application Framework You can develop device app

42 NodeBuilder Quick-Start Exercise • A simple Node Object with no configuration properties (the NodeBuilder Code Wizard automatically creates this

NodeBuilder FX User's Guide 43 c. Rename the openLoopSensor functional block to “Switch”. To do this, right-click the openLoopSensor functio

44 NodeBuilder Quick-Start Exercise e. Double-click the nvoValue network variable, or right-click it and then select Properties on the shortcut me

NodeBuilder FX User's Guide 45 2. Create an open-loop actuator with a SNVT_switch network variable. a. Drag a SFPTopenLoopActuator functional

vi Preface 7 Developing Device Applications... 179Introduction to Neuron C ...

46 NodeBuilder Quick-Start Exercise 5. Double-click the NB FX Example Device.nc file in the Project pane to open the main Neuron C file for this

NodeBuilder FX User's Guide 47 follow the section corresponding with the development platform or platforms you are using for the appropriate co

48 NodeBuilder Quick-Start Exercise LTM-10A Platform and Gizmo 4 I/O Board 1. Declare the I/O hardware for the Switch following these steps: a. Do

NodeBuilder FX User's Guide 49 Step 5: Compiling, Building, and Downloading the Application The NodeBuilder tool includes a complete set of too

50 NodeBuilder Quick-Start Exercise The LonMaker tool also displays stencils that contain shapes that you can drag to your LonMaker drawing. The Lo

NodeBuilder FX User's Guide 51 6. Click Next three times. The window in the New Device Wizard lets you select the application image to be do

52 NodeBuilder Quick-Start Exercise 8. The next window lets you set the initial device state and the source of configuration property values when

NodeBuilder FX User's Guide 53 11. Press the service pin on the development platform to be loaded and commissioned. The LonMaker tool loads

54 NodeBuilder Quick-Start Exercise To test your device’s interface with the LonMaker Browser, follow these steps: 1. Right-click the NB FX Example

NodeBuilder FX User's Guide 55 4. Press and hold the left button at the bottom of your development board (SW1 on the FT 5000 EVB; IO_6 on the

NodeBuilder FX User's Guide vii Upgrading Device Applications ...217Adding and Manag

56 NodeBuilder Quick-Start Exercise 3. The NodeBuilder Project Manager appears, and a debug session for the device starts. There is a short pause

NodeBuilder FX User's Guide 57 6. Right-click the nvoSwitch.state = !input_value line, and then click Toggle Breakpoint on the shortcut menu,

58 NodeBuilder Quick-Start Exercise 9. Right-click the input_value variable in the line of code in which you set the breakpoint, and then click Wa

NodeBuilder FX User's Guide 59 11. Click Add Watch. The variable is added to the Watch List pane at the bottom of the NodeBuilder Project Ma

60 NodeBuilder Quick-Start Exercise 16. The NodeBuilder debugger has demonstrated that events occur when the button is both pressed and released.

NodeBuilder FX User's Guide 61 Step 8: Connecting and Testing the Device in a Network Once you determine that your device is functioning as des

62 NodeBuilder Quick-Start Exercise 5. Click Finish. The New Functional Block wizard closes and the LonMaker drawing appears. A new Left Switch

NodeBuilder FX User's Guide 63 7. Click Finish. The New Functional Block wizard closes and the LonMaker drawing appears. A new Left LED fun

64 NodeBuilder Quick-Start Exercise a. Drag the Connector shape from the NodeBuilder Basic Shapes 4.00 stencil to the drawing. Position the left e

NodeBuilder FX User's Guide 65 b. Right-click the new Connector shape and select Monitor Input Value to display the current value of the nvoS

viii Preface

66 NodeBuilder Quick-Start Exercise 10. Press the left button at the bottom of your development board (SW1 on the FT 5000 EVB; IO_6 on the Gizmo 4

NodeBuilder FX User's Guide 67 Additional Device Development Steps After you create your device application and successfully test your device i

68 Creating and Opening NodeBuilder Projects b. The Device Properties dialog opens with the Attributes tab selected. This dialog allows you to re

NodeBuilder FX User's Guide 69 e. Set the Location and Ping Interval properties to the values to be saved with the custom device shape in yo

70 Creating and Opening NodeBuilder Projects g. Set the Non-group Receive Timer property to the value to be saved with the custom device shape in

NodeBuilder FX User's Guide 71 3. Create custom functional block shapes. Custom functional block shapes let you provide network integrators

72 Creating and Opening NodeBuilder Projects Developing an HMI You can create a human machine interface (HMI) for your device so that end users can

NodeBuilder FX User's Guide 73 Programmable Application Image Files (.APB and .NXE) The LonMaker tool and other LNS network tools use programma

74 Creating and Opening NodeBuilder Projects on these device interface files. Device Resource Files (.TYP, .FMT, .FPT) Resource files are the fil

NodeBuilder FX User's Guide 75

NodeBuilder FX User's Guide ix Preface The NodeBuilder FX Development Tool is a complete hardware and software platform that is used to develop

NodeBuilder FX User's Guide 77 4 Creating and Opening NodeBuilder Projects This chapter describes how to create, open, and copy NodeBuilder

78 Creating and Using Device Templates Introduction to the NodeBuilder Project Manager A NodeBuilder project collects all the information about a se

NodeBuilder FX User's Guide 79 Edit Lets you to edit any of the Neuron C source files or header files that are used in the project. See Chapt

80 Creating and Using Device Templates Settings Opens the NodeBuilder Project Properties dialog with the Project tab selected. The Project tab di

NodeBuilder FX User's Guide 81 Creating a NodeBuilder Project from the LonMaker Tool You can create a NodeBuilder project by starting the NodeB

82 Creating and Using Device Templates Network property, and then select the LNS network interface to be used for communication between the LonMaker

NodeBuilder FX User's Guide 83 8. Specify the following properties: Project Name The name of the project as specified in the Specify New Pro

84 Creating and Using Device Templates Creating a NodeBuilder Project from the New Device Wizard You can create a NodeBuilder project from the New D

NodeBuilder FX User's Guide 85 4. Click Next. The next page in the New Device Wizard lets you select the NodeBuilder device template. 5