Echelon NodeBuilder Resource Editor User Manual

0 7 8 - 0 1 9 4 - 0 1 C®NodeBuilder®Resource Editor User’s Guide Release 4

Introduction to Resource Files Resource files provide definitions of functional profiles, type definitions, enumerations, and formats that can be use

contain a single value or they can contain a structure or union containing multiple fields (for example, the SNVT_date_cal network variable contains

every language your resource file set supports. When a language file is translated, the references contained in the network variable types, configur

2 Getting Started This chapter describes how to install and start the NodeBuilder Resource Editor. NodeBuilder Resource Editor User's Guide

Installing the Resource Editor The NodeBuilder Resource Editor is available as a standalone application, and is also available as part of certain too

Starting the Resource Editor You can use the NodeBuilder Resource Editor to create, modify, and view resource files, and also to add user resource fi

8 Getting Started

3 Using Resource Folders This chapter describes how to use the resource catalog to view all available resource folders on your computer, and how to

Introduction to Resource Folders A resource folder is a directory containing one or more resource file sets. You will typically create your resource

To view or modify the contents of a resource file set, expand it using the button. When you expand a resource file set you will see six folders c

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

Adding a Resource Folder You can add a new resource folder to the resource catalog. This makes all resource file sets contained within the folder av

Refreshing the Resource Catalog The resource catalog may get out of sync with the resource files on your computer if you update resource files using

example, you can enter “switch” to search for SNVT_switch. Look In The resource catalog, resource folder, resource file set, or resource file to sea

4 Creating and Modifying a Resource File Set This chapter describes how to create or modify a resource file set. NodeBuilder Resource Editor User&a

Creating and Modifying a Resource File Set You can create a new scope 3, 4, 5, or 6 resource file set within any resource folder. Each resource fil

3. Enter the following information about the resource file set: Scope/Program ID Locked Prevents modification of the scope or program ID template

Program ID setting is always ignored for resource files and should be cleared. The required values for each scope are as follows: • Scope 3: Manufa

4. Click the File Header tab. 5. Enter the following company information for the resource file set: Creator The name of the company, and opt

address fields in this tab will not update this string. 6. Click OK. If you are creating a new resource file set, it is created and added to the re

This dialog allows you to choose a value for each part of the standard program ID. The Program ID field at the bottom of the dialog displays the cur

Table of Contents Preface ... v Purpose ...

• If you are using a standard functional profile other than functional profiles 0 through 6 and the functional profile is included in the standard r

from a list of channel types maintained by the LONMARK association. You can update the list by downloading the latest program ID data from www.lonma

any type of device. See the Using the Resource Editor chapter in this document and the Neuron C Programmer’s Guide for more information. Usage Field

5 Creating and Modifying Resources This chapter describes how to define new resources and how to modify existing resources. NodeBuilder Resource Ed

Introduction to Creating and Modifying Resources You can create and modify any resources within a scope 3, 4, 5, or 6 resource file set, though you

The figure above shows the New or Existing Configuration Property Type dialog. The New Network Variable Type dialog is identical except it does no

3. Select the network variable or configuration property data type in Data Type. If you are defining a configuration property type, and the type de

SIGNED_QUAD A 32-bit signed integer value. SIGNED_SHORT An 8-bit signed integer value. STRUCTURE A structure containing multiple fields. See Crea

7. Enter or link to text to provide a language-dependent name for the type, a language-dependent comment about the type, and a language-dependent

11. Set scaling factors for this type. This allows types to represent values outside of the limits of the base type. For example, an UNSIGNED_SHO

Using a Scaling Factor and Unit String ... 61 Using Localized List Separators...

6. Set the individual values of the fields in the structure, union, or the floating-point value to the desired default or override value and then cl

To remove a field, right-click the field in the left pane, and then click Remove Field on the shortcut menu. Creating and Modifying an Enumerated NV

Size The size of the bitfield, in bits, from 1 to 8. The bitfield size determines the maximum value the field can contain. An unsigned bitfield of

2. Set Type Scope to the scope of the resource file set containing the referenced network variable type. You can select a network variable type f

dollar character is not permitted in a functional profile name. By convention, the functional profile name should indicate the application set of th

from the selected standard profile will be referenced by the functional profile (if there is no standard functional profile template with the same pr

FPT Index The index of the functional profile within the resource file set. The FPT Key (the profile number) is typically used to reference the fun

To add mandatory and optional network variables to a functional profile, follow these steps: 1. Drag a network variable type or configuration proper

simplify identifying inputs and outputs in your functional profile. If you do not use one of these prefixes, start the network variable name with an

profile. See Creating and Modifying a Language String for more information on creating and linking to language strings. Referenced Type Range Overri

Preface This document describes LONMARK resource files and how to use the NodeBuilder Resource Editor to view, create, and modify them. . NodeBuilder

property of the same type that applies to the same interface within a functional profile. For example, you can create multiple SCPTmaxSendTime confi

Member A member number of the configuration property within the functional profile. Each configuration property must have a unique member number.

profile may be set by the implementing property, unless this would cause an ambiguous restriction flag set. Applies To Specifies whether the configu

For example, your company may maintain several resource file sets at different scopes: a corporation wide set with general-purpose definitions at man

2. Enter or change the name of the enumeration type in Tag Name. This name is called the tag name. By convention, the tag name is all lower case

Member The name of the enumerator. The name must be unique for all enumeration types that may be used in an application. To ensure uniqueness, sel

Creating and Modifying a Language String You can create and edit language strings that may be referenced by network variable types, configuration p

selected language resource file. See Setting Resource Editor Options for information about setting the active language. The New Resource String dia

The title of the field may vary (this one is intended for entering comments about the resource file element being created), but there is always a t

2. Type a string into Highlight Strings Containing This Text to have all strings containing the specified string highlighted. Set the Match Case c

Purpose This document describes resource files and how to use the NodeBuilder Resource Editor to view, create, and modify them. Audience This docum

You can also search for a language string when using the Link button in the Strings tab when creating or modifying a network variable or configurati

Creating, Modifying, and Translating a Language File You can create a new language file to hold language strings in a new language, you can edit lang

This figure shows the American English language resource file for the Echelon resource file set. 3. In the To box, select the language to which t

You can export the selected language files to text files for use by translation services. To export the selected language files to text files, open

3. Enter the following information: Network Variables Creates a network variable format. Configuration Properties Creates a configuration prope

network variable or configuration property type, but may not always conform to ANSI C language syntax. Modifier Specifies that one of the following

int — The value will be displayed or entered as a signed, 32-bit integer. discrete — The value will be displayed or entered as an 8-bit value that co

EXAMPLE 1: A simple integer that does not require localization, with a “%d” decimal conversion specification: SNVT_count: text("%d"); EXAM

<text format list> = <text format list> ',' <text format> = <text format> <text format> = '(' &

long, bitfield, or enum. You can use a backslash (‘\’) character as an escape character to include other format characters as text. For example, the

LONMARK® SNVT and SCPT Guide Documents the standard network variable types (SNVTs), standard configuration property types (SCPTs), and standard enume

Following are example formats using scaling factors. EXAMPLE 1: The following format definitions define SI and US formats for the SNVT_temp_f standar

1. The time format specifier does not support AM/PM time formats, so this type of time format will be converted to a 24-hour format. 2. The time

reflected in your new profile. See Creating and Editing a Functional Profile for more information. Removing and Obsoleting Resources Resources may r

all deleted resources from the resource file. You must be careful not to purge a resource file that contains deleted resources that are in use by de

File Type Format Version Format Changes Minimum Required Resource File API 1 Initial release. 1.0 2 Added support for larger profiles and for marki

To convert the format of a resource file, follow these steps: 1. Click the Windows Start button, point to Programs, point to Echelon NodeBuilder, an

6. Click Convert. You may choose to convert and purge a resource file set at the same time. In this case, the source file will be purged, and then

6 Generating Resource Files This chapter describes how to generate resource files once you have made changes using the resource editor. NodeBuilder

Generating Resource Files You can generate a resource file set at any time while editing a resource file set. If you have made any changes to a reso

This dialog displays the current versions of the type file, functional profile file, and the language files (File Name for the language file will c

Region Languages Supported Contact InformationEurope English German French Italian Echelon Europe Ltd. Suite 12 Building 6 Croxley Green Busine

See the Resource Report Generator User’s Guide for more information on creating resource reports, available from the Windows Start menu under Echelon

Appendix A Language File Extensions This appendix lists the file extensions used for language files. NodeBuilder Resource Editor User's Guide

Language File Extensions Network variable types, configuration property types, functional profiles, and enumeration types can all reference text info

Appendix B NodeBuilder Resource Editor Software License Agreement When installing the NodeBuilder Resource Editor software, you must agree to the te

NodeBuilder® Resource Editor NOTICE This is a legal agreement between you and Echelon Corporation (“Echelon”). YOU MUST READ AND AGREE TO THE TERMS

• “Standard Resource File” means a Resource File included as part of the Licensed Software. • “User Resource File” means a Resource File You create

This license is not a sale. Title, copyrights and all other rights to the Licensed Software and any copy made by You remain with Echelon and its sup

THE SUPPLY OR USE OF THE LICENSED SOFTWARE, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY (INCLUDING WITHOUT LIMITATION NEGLIGENCE). THIS LIMITATION

SUPPORT You acknowledge that You shall either (i) inform the end-user that You are the support contact for the User Resource Files, and that Echelon

Licensor is Echelon Corporation, 550 Meridian Avenue, San Jose, CA 95126. If You are not a LONMARK Member and wish to obtain license terms for use o

1 Introduction to Resource Files This chapter presents an introduction to resource files. It describes the types of resources contained within reso

www.echelon.com