FieldServer LonWorks FS-8700-21 Driver Manual

Driver Version:

1.28

Document Revision:

3

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-21 LonWorks

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after October 2011

A Sierra Monitor Company

FS8700-21 LonWorks Manual Table of Contents

TABLE OF CONTENTS

1 Description ..................................................................................................................................................... 5

2 Definitions ..................................................................................................................................................... 5

2.1 NV Updates/Polls ........................................................................................................................................... 5

2.2 Network Management................................................................................................................................... 5

2.2.1 LonWorks - Program ID Calculation (SPID) ............................................................................................ 5

2.3 Clients/Servers ............................................................................................................................................... 6

2.4 Explicit/Implicit .............................................................................................................................................. 6

2.5 XIF Files .......................................................................................................................................................... 6

2.6 Device Resource Files .................................................................................................................................... 6

2.7 NV Aliases ...................................................................................................................................................... 6

2.8 Configuration Properties ............................................................................................................................... 6

3 Driver Scope of Supply ................................................................................................................................... 7

3.1 Supplied by FieldServer Technologies for this driver ..................................................................................... 7

3.2 Provided by the Supplier of 3rd Party Equipment .......................................................................................... 7

3.3 Additional files required for the Driver .......................................................................................................... 7

4 Hardware Connections ................................................................................................................................... 8

4.1 Service Pin ...................................................................................................................................................... 8

4.2 Neuron ID ....................................................................................................................................................... 8

4.3 Lon LED’s ........................................................................................................................................................ 8

5 Data Array Parameters ................................................................................................................................... 9

6 Implicit Configurations ................................................................................................................................. 10

6.1 Special considerations ................................................................................................................................. 10

6.1.1 Map Descriptor Names (Network Variable Names) ............................................................................. 10

6.1.2 Implicit Lon functions ........................................................................................................................... 10

6.1.3 SNVT_Index .......................................................................................................................................... 10

6.1.4 Address Table Limit .............................................................................................................................. 10

6.1.5 Network Management Capability ........................................................................................................ 11

6.1.6 Client vs Server Mapping ..................................................................................................................... 11

6.2 Client Side Mapping ..................................................................................................................................... 11

6.2.1 Client Side Connection Parameters ...................................................................................................... 11

6.2.2 Client Side Node Parameters ............................................................................................................... 12

6.2.3 Client Side Map Descriptor Parameters ............................................................................................... 12

6.2.4 Client Side Map Descriptor Example .................................................................................................... 14

7 Explicit Configurations ................................................................................................................................. 15

7.1 Special considerations ................................................................................................................................. 15

7.1.1 Map Descriptor Names (Network Variable Names) ............................................................................. 15

7.1.2 Lon functions ........................................................................................................................................ 15

7.1.3 SNVT_Index .......................................................................................................................................... 15

7.1.4 Domain Table Setup ............................................................................................................................. 16

7.1.5 Network Management ......................................................................................................................... 17

7.2 Client Side Configuration ............................................................................................................................. 17

7.2.1 Client Side Connection Parameters ...................................................................................................... 17

7.2.2 Client Side Node Parameters ............................................................................................................... 17

7.2.3 Client Side Map Descriptor Parameters ............................................................................................... 18

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

FS-8700-21 LonWorks Manual Table of Contents

7.2.4 Map Descriptor Example 1 - Explicit Configuration using Network Management Polls ...................... 20

7.2.5 Map Descriptor Example 2 – Polling UNVT’s ....................................................................................... 20

7.2.6 Using Neuron ID to Address Devices (Client Drivers only) .................................................................... 21

7.3 Server Side Configuration ............................................................................................................................ 22

7.3.1 Server Side Connection Parameters ..................................................................................................... 22

7.3.2 Server Side Node Parameters ............................................................................................................... 22

7.3.3 Server Side Map Descriptor Parameters .............................................................................................. 22

7.3.4 Map Descriptor Example ...................................................................................................................... 24

Appendix A. Useful Features ................................................................................................................................ 25

Appendix A.1. Using UNVT’s .................................................................................................................................... 25

Appendix A.2. Using NV_Min, NV_Max etc. ............................................................................................................ 25

Appendix A.3. Throttling Mode ............................................................................................................................... 26

Appendix A.4. XIF Generation .................................................................................................................................. 27

Appendix A.5. Configuration Properties .................................................................................................................. 27

Appendix A.5.1. Example 1 -Configuration Network Variable Map Descriptors applied to Output NV’s ......... 29

Appendix A.5.2. Example 1 -Configuration Network Variable Map Descriptors applied to Input NV’s ........... 29

Appendix A.6. LonMark Object Creation ................................................................................................................. 29

Appendix A.6.1. LonMark Config file Example – Open Loop “Water Temperature” Sensor: ............................ 30

Appendix A.7. Node Status Operation ..................................................................................................................... 31

Appendix A.8. Working with Binary Data ................................................................................................................ 31

Appendix A.9. Filtering SNVT Variables ................................................................................................................... 32

Appendix A.9.1. SNVT_Option Field ................................................................................................................. 32

Appendix A.9.2. SNVT_Units Field .................................................................................................................... 32

Appendix B. Vendor Information ......................................................................................................................... 34

Appendix B.1. Echelon LonMaker ............................................................................................................................ 34

Appendix B.1.1. Using LonMaker to commission the FieldServer .................................................................... 34

Appendix B.1.2. Removing Previous FieldServer Device Templates in LonMaker. ........................................... 34

Appendix B.2. Checking LONWORKS® Network Using Echelon’s NodeUtility.exe .................................................. 35

Appendix B.3. Neuron Systems ............................................................................................................................... 35

Appendix B.4. Honeywell Care ................................................................................................................................ 36

Appendix B.5. CARE and LON PT link Integration .................................................................................................... 36

Appendix B.6. Circon_SI ........................................................................................................................................... 39

Appendix B.7. Tridium JACE ..................................................................................................................................... 40

Appendix B.7.1. Correcting SNVT indexing problem in Tridium Niagara .......................................................... 40

Appendix B.8. Trane Rover ...................................................................................................................................... 40

Appendix C. Troubleshooting ............................................................................................................................... 41

Appendix C.1. Debugging a LonWorks connection: Hints and tips ......................................................................... 41

Appendix C.2. Error Messages ................................................................................................................................. 41

Appendix C.2.1. Error Message Lonlive.c 121 ................................................................................................... 41

Appendix C.3. Communication Errors using Neuron_ID Polling .............................................................................. 41

Appendix C.4. Monitoring Node Status ................................................................................................................... 41

Appendix C.5. Exposing Operation Statistics. .......................................................................................................... 42

Appendix C.6. “Illegal” Characters in Network Variable Names .............................................................................. 43

Appendix C.7. Service types currently supported for network variable messages ................................................. 43

Appendix C.8. Combining Explicit and Implicit ........................................................................................................ 43

Appendix D. Reference ........................................................................................................................................ 44

Appendix D.1. LonMark Profiles .............................................................................................................................. 44

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Table of Contents

Appendix D.2. Performance Tests for LonMark Certified blocks ............................................................................. 45

Appendix D.2.1. Startup times, 10 Input Blocks and 10 Output Blocks totalling 80 NVs.................................. 45

Appendix D.2.2. Startup times, 20 Input Blocks and 20 Output Blocks totalling 160 NVs ............................... 45

Appendix D.3. SNVT_Type ....................................................................................................................................... 45

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 5 of 72

Connections

Adapter

, Protocol

, SPID

Lonworks

, Lonworks

, 80:00:95:48:50:02:04:01

1 DESCRIPTION

The LonWorks driver allows the FieldServer to transfer data to and from devices using LonWorks protocol. The FieldServer
can emulate either a Server or Client. The FS-B2011 and FS-B30 Series FieldServers have a built-in LonWorks Interface. A
Fieldbus connection is available on the FieldServer. The FS-B30 can handle up to 4096 Network Variables and the FS-B2011
up to 1000 which can be of the Standard Network Variable Types (SNVT) and/or User-defined Network Variable Types
(UNVT).

2 DEFINITIONS

2.1 NV Updates/Polls

On LonWorks networks, information is transferred using Network Variable Updates and Network Variable Polls. The Client
requests Network Variables from the Server using Network Variable Polls and Network Variable Updates occur when a Client
sends Network Variables to a Server.

2.2 Network Management

The FieldServer is able to set its own Domain, Subnet and Node ID at start-up using the FieldServer configuration file.
Alternatively, the FieldServer is capable of being commissioned and bound by Network Management Tools such as
LonMaker® - see Appendix B.1.1 for further information.

2.2.1 LonWorks - Program ID Calculation (SPID)

Network management tools use the Program ID to identify the different applications running on each device. Two devices on
a network may have the same Program ID only if they have identical application/configurations

The Program ID for the FieldServer consists of a fixed and a variable field (XX in the Program ID below)..

90:00:95:47:1E:02:04:XX

The fixed part does not change for different configuration files or for different LonWorks driver versions. The variable part
XX, which is also defined as the Model or Revision number, does however change.

The variable part is calculated at start-up when the configuration is loaded on the FieldServer. Certain critical fields in the
configuration file are used to calculate this variable part of the Program ID. Thus if the configuration file changes significantly
(critical fields) the Program ID will change. Also, as we add new features and capabilities to the LonWorks driver, this variable
part of the Program ID may be different between LonWorks driver versions (even though the configuration file is the same).

It is possible though very unlikely that through a change in LonWorks driver and/or configuration file, the program IDs
calculates out identical to another combination of driver and configuration. If this is the case with two FieldServers on the
same network that run different configurations, one of these devices may fail to commission properly.

The following configuration can be used to force the SPID.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 6 of 72

2.3 Clients/Servers

The FieldServer functions as a Client when polling or sending updates on the LonWorks network and as a Server when being
polled or receiving updates. The FieldServer can be bound to a maximum number of 15 LonWorks Nodes. The FieldServer
recommended point limit is 1000 points for the FS-B2011 Series and 4096 points for the FS-B30.

2.4 Explicit/Implicit

Clients can address Servers using explicit or implicit addressing. Clients using explicit addressing obtain their data transfer
parameters directly from the FieldServer configuration file. Implicit addressing is used when a Network Management Tool
such as LonMaker® is used to connect a FieldServer to other LonWorks Nodes - the FieldServer is assigned its data transfer
(binding) parameters by the Network Management Tool.

2.5 XIF Files

At start-up the FieldServer creates an external interface file (XIF) called fserver.xif based on the configuration file. The
FieldServer differs from most other LonWorks drivers in that it is configurable and therefore its XIF is not fixed for all
applications. The list of points available to the network will vary depending on the other networks connected to the
FieldServer, and the requirements of the particular application. The recommended procedure for obtaining the XIF file for
the FieldServer is to upload it using the RUInet utility. Refer to Appendix A.4 for more information.

2.6 Device Resource Files

The STANDARD device resource file covers FieldServer data type support. All Standard Network Variable Types (SNVTs) in
this file are available to the user. These SNVTs are listed in Section 6.1.3. Please note that due to the sophisticated nature of
LonWorks variables, it may not always be possible to typecast the full information supplied in a LonWorks variable to a simple
Data Type contained in another protocol. The FieldServer supports Move and Logic functions which would allow the
LonWorks variable to be split up and passed to separate simple data types, thus preventing information loss. The FieldServer
supports the sending and receiving of User-defined Network Variable Types (UNVTs) on the LonWorks Network. An UNVT is
simply implemented as an array of bytes of user-defined length.

2.7 NV Al iases

The FieldServer currently supports a default of 63 network variable aliases to avoid network variable connection constraints.
This number may be increased to a maximum of 4096.

2.8 Configuration Properties

Configuration Properties (CP’s) characterize the behavior of a device in the system. Network installation tools realize this
attribute and provide database storage to support maintenance operations. If a device fails and needs to be replaced, the
configuration property data stored in the database is downloaded into the replacement device to restore the behavior of the
replaced device in the system. Configuration properties are implemented on the FieldServer through configuration network
variables. User-defined configuration property types are not supported. Appendix A.5 provides a list of standard
configuration property types that are supported.

The information that follows describes how to expand upon the factory defaults provided in the configuration files included
with the FieldServer.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 7 of 72

FieldServer Technologies Part #

Description

FS-8700-21

Driver Manual.

Part #

Description

N/A

LonMaker® Integration Tool from Echelon Corporation (Optional Network Management Software)

N/A

LonWatcher from Distech Controls Inc. (Optional Network Management Software)

N/A

Circon System Integrator from Circon Systems Corporation (Optional Network Management Software)

PCC10

PCCard LonWorks Adapter (Optional)

Filename

Auto-Created
by driver

"Always Loaded By
FieldServer Technologies

Conditionally
loaded

Comments

Config.csv

X

Template loaded if no custom configuration
ordered, otherwise Custom configuration
loaded.

fserver.xif

X

Generated at power up. Changes if profile in
configuration changes.

lon.ini

X

Used for providing default DSN. Refer to
Section 7.1.4

lonvars.cfg

X

Maintains commissioning settings. If corrupted,
delete it, and reboot FieldServer to create new
one.

3 DRIVER SCOPE OF SUPPLY

3.1 Supplied by FieldServer Technologies for this driver

3.2 Provided by the Supplier of 3

rd

Party Equipme nt

3.3 Additional files required for the Driver

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 8 of 72

FieldBus
Connector

To other

LonWorks

Nodes

To other

LonWorks

Nodes

FieldServer Interface

4 HARDWARE CONNECTIONS

The screw plug supplied with the FieldServer LonWorks interface will connect the FieldServer to the FTT-10 network. The 2­wire twisted-pair connection to the network is polarity insensitive. The FTT-10 network is a free topology network which
supports star, loop and/or bus wiring connections. Please refer to the FTT-10A Free Topology Transceiver User’s Guide from
Echelon Corporation for recommended wiring practices if necessary. Additional information on cabling and junction boxes
that may be used in twisted pair LonWorks networks are detailed in the following Echelon Publication:

http://www.echelon.com/support/documentation/bulletin/005-0023-01O_Jbox_wiring.pdf.

The connection diagram below shows how the FieldServer FS-B2011 and FS-B30 are connected to a LonWorks network:

Configure the remote LonWorks devices according to manufacturer’s instructions.

4.1 Service Pin

The service pin is used to commission the FieldServer onto the network using a LonWorks Network Management tool. On FS­B2011 the node’s unique Neuron ID will be displayed on the Error Screen of the Ruinet utility with every service pin press.

4.2 Neuron ID

The driver prints the Neuron ID on the Driver Message Screen as its starts. On FS-B2011 it is possible to print the Neuron ID
on the Error Screen at any time by pushing the Service Button on the side of the FieldServer. On all platforms, the driver can
store the Neuron ID in a Data Array so that it can be read by a Client node – Refer also to Appendix C.5.

4.3 Lon LED’s

The location of the Lon LED varies between FieldServers. Please consult the Start-up guide for the FieldServer in question.
Lon LED is consistent with the table below for all FieldServers. Note that the LED does not indicate Lon communications, but
is a Service LED coupled with the Service Pin which indicates whether the LonWorks interface on the FieldServer is configured
or not. It asks for service when flashing and indicates a problem when flashing as described below:

The LED is solid ON when the neuron is blank or has a hardware failure
The LED blinks as 0.5s intervals when the neuron has not been configured with address information (no Lon DCC loaded)
The LED is OFF when a Lon DCC is loaded.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 9 of 72

Section Title

Data_Arrays

Column Title

Function

Legal Values

Data_Array_Name

Provide name for Data Array

Up to 15 alphanumeric
characters

Data_Array_Format

Provide data format. Each Data Array can only take on one
format.

Float, Bit, UInt16, SInt16, IInt32,
SInt32. Refer to Appendix D

Data_Array_Length

Number of Data Objects. Must be larger than the data storage
area required by the Map Descriptors for the data being placed
in this array.

1-10, 000
// Data Arrays

Data_Arrays

Data_Array_Name

, Data_Array_Format

, Data_Array_Length

DA_AI_01

, UInt16,

, 200

DA_AO_01

, UInt16

, 200

DA_DI_01

, Bit

, 200

DA_DO_01

, Bit

, 200

5 DATA ARRAY PARAMETERS

Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary to declare
the data format of each of the Data Arrays to facilitate correct storage of the relevant data. More information is available in
Appendix D.

Example

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 10 of 72

Lon_Function

Description

Function Field

NVUI

Network Variable Update Input

PASSIVE
NVPO

Network Variable Polled Output

NVPIIMC

Network Variable Polled Input Implicitly addressed Continuously sent

RDBC

NVUOIMC

Network Variable Update Output Implicitly addressed Continuously sent

WRBC

NVUOIMX

Network Variable Update Output Implicitly addressed and sent on Change

WRBX

NVUOIMT

Network Variable Update Output Implicitly addressed sent in Throttling Mode

WRBC See 0

CFG_NVUI

Configuration Network Variable Update Input

PASSIVE

6 IMPLICIT CONFIGURATIONS

6.1 Special considerations

Implicit addressing is used when a Network Management Tool such as LonMaker® is used to connect a FieldServer to other
LonWorks nodes - the FieldServer is assigned its data transfer (binding) parameters by the Network Management Tool.

6.1.1 Map Descriptor Names (Network Variable Names)

When using Implicit configuration, the LonWorks driver provides a table of Network Variables for other Nodes to read. These
Nodes access the variables according to Index numbers which are automatically assigned by the driver according to the Map
Descriptor definition order in the configuration file. The driver also creates an identification table for configuration nodes to
read the name and types of variables available on the FieldServer. Within the LonWorks protocol, this table size is limited to
64K bytes. If the application requires a large number of Server mappings (up to 4096), it will be necessary to limit the
variable name length. Each Server mapping requires 4 bytes plus the length of the name from this 64K block.

6.1.2 Implicit Lon functions

Implicit Map Descriptors are distinguished from Explicit Map Descriptors by the function used in the Lon_Function field of the
Map Descriptor. Depending on the nature and direction of Data Transfer needed, different implicit functions are available as
follows (NOTE: function field MUST pair up with the Lon_Function field as shown in the table):

6.1.3 SNVT_Index

For implicitly addressed Client Map Descriptors and all Server side Map Descriptors the driver will assign an index to each
one, starting from 0 and incrementing to 4095, in the order they appear in the configuration file.

6.1.4 Address Table Limit

It is important to note the limitation within LonWorks Implicit addressing that the Address Table used for storing the
addresses of all active connections made with the FieldServer is limited to 16 Device Addresses including that of the
FieldServer. This is a LonWorks limitation, not a FieldServer limitation, and it means that the FieldServer can only make active
implicit connections to 15 other devices . If active connections to more than 15 devices are required, then it is necessary to
use Explicit Configuration (NMFETCHC is recommended).

Devices that write to passive Map Descriptors in the FieldServer only are not placed in this table and therefore this limitation
does not apply. (A Passive Map Descriptor is recognized by the Passive Parameter in the Function Field).

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 11 of 72

Section Title

Connections

Column Title

Function

Legal Values

Protocol

Specify protocol used

LonWorks

// Client Side Connections

Connections

Adapter

, Protocol

LonWorks

, LonWorks

6.1.5 Network Management Capab ility

When commissioning an implicitly configured FieldServer using the "Traditional" binding method, the configuration
parameters below are all that is needed to achieve this purpose. For hints and tips on how to commission the FieldServer
using the various Vendor devices that do this, see Appendix B

It is possible to set the FieldServer Online and Offline using the Network Management Tools. This is a LonWorks function, and
is different from the traditional Online and Offline Status discussed in other FieldServer documentation. When the
FieldServer is set offline using this LonWorks feature it will not communicate with other LonWorks devices.

6.1.6 Client vs Server Mapping

Distinguishing Client from Server in the LonWorks Environment is more difficult due to the "Peer to Peer" nature of LonWorks
design. Clients and Servers can be identified in this environment as follows:

Clients will write Setpoints and have status written to them, so expect Setpoints and Control Points on the Output side,

and Status and Alarms on the Input side

Servers will have the opposite structure, with Setpoints and Control Points on the Input Side and Staus and Alarms on the

Output side

Distinguishing Client from Server is important to ensure correct matching with other protocols being used on a FieldServer.
For example, it would not be useful to map an Output to a BACnet AI point as both points will be expecting to push data out
of the FieldServer.

Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.

6.2 Client Side Mapping

6.2.1 Client Side Connection Parameters

Example

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 12 of 72

Section Title

Nodes

Column Title

Function

Legal Values

Node_Name

Provide name for Node

Up to 32 alphanumeric characters

Protocol

Specify protocol used

LonWorks

Startup_Write

Initiate a send on startup. Refer to Appendix A.3 for more
information

Enabled, Disabled
// Client Side Nodes

Nodes

Node_Name

, Protocol

LON_1

, LonWorks

Column Title

Function

Legal Values

Map_Descriptor_Name

Name of this Map Descriptor. (Network Variable
Name)

Up to 16 alphanumeric characters.

Data_Array_Name

Name of Data Array where data is to be stored
or fetched from in the FieldServer

One of the Data Array names defined in
Section 5

Data_Array_Offset

Starting location in Data Array

0 to (Data_Array_Length-1) as specified in
Section 5

Lon_Function

Detailed Function of Client Map Descriptor

See Section 6.1.2 for a list of valid entries for
Implicit Connections.

Function

Function of Client Map Descriptor

See Section 6.1.2 for a list of valid entries
based on the Lon_Function.

6.2.2 Client Side Node Parameters

Example

6.2.3 Client Side Map Descriptor Parameters

6.2.3.1 FieldServer Related Map Descriptor Parameters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 13 of 72

Column Title

Function

Legal Values

Node_Name

Name of Node to fetch data from or send data to. Needed for
Explicit Addressing.

One of the Node names
specified in Section 6.2.2

SNVT_Type

Standard network variable type of the data

See Appendix D

SNVT_Option*

Specifies which record out of a complex SNVT we are after.

See Appendix A.9.1

SNVT_Units*

Specifies the measurement units (e.g. Metric or English)

See Appendix A.9.2

UNVT_Byte_Length*

Specifies the length in bytes of an UNVT. This Parameter is
compulsory when SNVT_Type is set to UNVT, the parameter is not
used in conjunction with SNVT’s

1-255. See Appendix A.1

UNVT_ID

Specifies the Type Number to apply to this particular UNVT. This
Parameter is optional when SNVT_Type is set to UNVT, the
parameter is not used on conjunction with SNVT’s

0, 146-255. See Appendix
A.1

NV_Min_Value*

Network Variable updates with values less than specified in this field
will be ignored.

See Appendix A.2

NV_Max_Value*

Network Variable updates with values higher than specified in this
field will be ignored.

See Appendix A.2

NV_Delta_Value*

Network Variable updates where the value’s delta change is less

than specified in this field will be ignored unless the Max_Scan_Time
Condition has been met. Compulsory for Throttling Lon Functions,
used on other Lon Functions. It is possible to configure a start-up
write option for throttling Map Descriptor functions instead of
waiting for the minimum scan time to pass. Refer to Appendix A.3.

See Appendix A.2

NV_Selfdoc_Text*

The Self-Documenting String for this Network Variable.

Normal Text up to a length
of 40 characters. Defaults to
"" for parameters using
string values and 0 for
parameters using numeric
values

Column Title

Function

Legal Values

Scan_Interval

Seconds per scan

0-32000

Min_Scan_Time

Minimum Scan Time in seconds.

See 0

Max_Scan_Time

Maximum Scan Time in seconds.

See 0

6.2.3.2 Driver Related Map Descriptor Parameters

6.2.3.3 Timing Parameters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 14 of 72

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

6.2.4 Client Si de Map Desc riptor Example

// Client Side Map Descriptors

Map_Descriptors

Map_Descriptor_Name

, Data_Array_Name

, Data_Array_Offset

, Lon_Function

, Function

, Node_Name

, SNVT_Type

, Nv_Delta_Value

, Min_Scan_Time

, Max_Scan_Time

, Scan_Interval

TempOut1

, DA_FO_01

, 0

, NVUOIMT

, Wrbc

, LON_1

, SNVT_Temp_f

, 10

, 5

, 20

, - TempOut2

, DA_FO_01

, 1

, NVUOIMX

, Wrbc

, LON_1

, SNVT_Temp_f

, -

, -

, -

, - TempOut3

, DA_FO_01

, 2

, NVUOIMC

, Wrbc

, LON_1

, SNVT_Temp_f

, -

, -

, -

, 20

TempIn

, DA_FI_01

, 0

, NVPIIMT

, Rdbc

, LON_1

, SNVT_Temp_f

, -

, -

, -

, 5

This field
determines the
Map

Descriptor’s

function. See
Section 6.1.2
for more
information.

Required for Throttling Mode: This field specifies the
minimum change needed for a Network Variable’s
value to invoke an NV Update.

If found during Min_Scan_Time
sampling (Throttling Mode) that
Max_Scan_Time has elapsed since the
last NV Update, a new NV Update will
be transmitted.

For Non-Throttled
Client Map
Descriptors the
Scan_Interval
determines the
update rate.

The Data Array will be
sampled and evaluated for
delta change once every

FS-8700-21 LonWorks Manual Page 15 of 72

Lon_Function

Description

Function Field

NVUI

Network Variable Update Input

SERVER
NVPO

Network Variable Polled Output

NVPIEXC

Network Variable Polled Input Explicitly addressed Continuously sent

RDBC

NVUOEXC

Network Variable Update Output Explicitly addressed Continuously sent

WRBC

NVUOEXX

Network Variable Update Output Explicitly addressed and sent on Change

WRBX

NVUOEXT

Network Variable Update Output Explicitly addressed sent in Throttling Mode

WRBC

NMFETCHC

Network Management Network Variable Fetch Continuously sent (Explicit Addressing only)

RDBC

CFG_NVUI

Configuration Network Variable Update Input

SERVER

7 EXPLICIT CONFIGURATIONS

7.1 Special considerations

With Explicit configuration, the FieldServer communicates directly with other devices by specifying the remote device address
in the FieldServer configuration.

All the Servers and their Clients need to be on the same domain to be able to communicate. If the LonWorks device’s Node
ID is not known, it may be read using a utility program e.g. NodeUtil or using a LonWorks Analyzer. All the Client Node CSV
files need to have their Subnet_ID and Node_ID parameters set to point to their respective Server Subnet and Node ID values.
Once the FieldServers are restarted the network should function correctly.

7.1.1 Map Descriptor Names (Network Variable Names)

As a Server, the LonWorks driver provides a table of Network Variables for other Nodes to read. These Nodes access the
variables according to Index numbers which are automatically assigned by the driver according to the Map Descriptor
definition order in the configuration file. The driver also creates an identification table for configuration nodes to read the
name and types of variables available on the FieldServer. Within the LonWorks protocol, this table size is limited to 64K
bytes. If the application requires a large number of Server mappings (up to 4096), it will be necessary to limit the variable
name length. Each Server mapping requires 4 bytes plus the length of the name from this 64K block.

7.1.2 Lon functions

Explicit Map Descriptors are distinguished from Implicit Map Descriptors by the function used in the Lon_Function field of the
Map Descriptor. Depending on the nature and direction of Data Transfer needed different explicit functions are available as
shown below

NOTE:

Function field MUST pair up with the Lon_Function field as shown in the table
NMFETCHC is the preferred Lon Function for most applications. See Section 7.1.5

7.1.3 SNVT_Index

The SNVT_Index field must be specified for all explicitly addressed Client Map Descriptors. These Client Map Descriptors use
this field to index their relevant Map Descriptors on the Server side.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 16 of 72

FieldServer

System_Station_Address

, Title

[Node_Id]

, :D[Domain_ID]:S[Subnet_ID]:[Title continued…+

7.1.4 Domain Table Setup

To be able to communicate with other Nodes on the LonWorks network, the FieldServer must have its Domain, Subnet and
Node ID’s set. Explicit configuration requires the user to set these parameters.

There are 3 ways in which the FieldServer DSN (Domain, Subnet, Node address) can be set:

Set the DSN using a Network manager by commissioning the FieldServer into the Network Manager Project. When doing

it this way, it is extremely important that the DSN is not forced in the FieldServer Configuration, as the Configuration
address will override the Network Manager Address every time the FieldServer is restarted.

Set the DSN from the Lon.ini file. Using this option provides a default DSN if the FieldServer does not have a DSN

assigned. If a Network Manager or the FieldServer Configuration provides a DSN, then the Lon.ini DSN will be ignored.

Set the DSN in the FieldServer configuration. This option takes precedence over the 2 other addressing options, and

should therefore not be used when commissioning a FieldServer into a Network with a Network Manager.

Example 1 - Setting the Domain and Subnet from the lon.ini file

The Domain Table and Subnet IDs can be set from a lon.ini file on the FieldServer. The FieldServer’s LonWorks Node ID will
be set from the System_Station_Address field in the configuration file if specified; otherwise a default value will be used.

lon.ini file contents:
:D50:S01:

Example 2: Setting the Node, Domain and Subnet in the configuration file

The Title field must start with “:D”, followed by the Domain_ID in hexadecimal notation, followed by “:S”, followed by the
Subnet_ID in hexadecimal notation. The domain length is automatically determined by the number of digits in the
[Domain_ID] field. Since 2 hexadecimal digits constitute 1 byte, “:D123456:” for example would have a length of 3.

Specifying the Domain and Subnet in the configuration file will override the settings from the lon.ini file.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 17 of 72

Section Title

Connections

Column Title

Function

Legal Values

Adapter

Adapter Name

LonWorks

Protocol

Specify protocol used

LonWorks

// Client Side Connections

Connections

Adapter

, Protocol

LonWorks

, LonWorks

Section Title

Nodes

Column Title

Function

Legal Values

Node_Name

Provide name for Node

Up to 32 alphanumeric
characters

Subnet_ID

Server (destination) Node’s Subnet ID of an explicitly addressed
message

1-255
Node_ID

Server (destination) Node’s Node ID of an explicitly addressed message

1-127

Protocol

Specify protocol used

LonWorks

Startup_Write

Initiate a send on startup. Refer to Appendix A.3 for more information

Enabled, Disabled

7.1.5 Network Management

The NVPIEXC command generally used for polling has the limitation that data can only move in one direction (Server to
Client). The added functionality of a Write-through was added to the network management fetch command (NMFETCHC) to
provide movement of data back to the polled node. Thus, should the data in the Data Array linked to a NMFETCHC Map
Descriptor change by another process, the data will be propagated to the polled node by means of a network variable
update.

Another useful feature of the NMFETCHC function is that it can perform reads to any other type of Node function (NVUI,
CFG_NVUI, NVUOEXX, NVPIIMC, etc.) This means that even Client Map Descriptors can be read this way.

Network management fetch requests received on polled nodes are handled differently from normal NV Poll requests. The
response to a NV Poll will contain valid data. Data is valid if the node that is the source of the data is online and if this data is
not too old. The data in the response to a network management fetch will not be checked for validity, however, it will simply
respond with the current data in the variable.

7.2 Client Side Configuration

7.2.1 Client Side Connection Parameters

Example

7.2.2 Client Side Node Param eters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 18 of 72

// Client Side Nodes

Nodes

Node_Name

, Subnet_ID

, Node_ID

, Protocol

LON_1

, 1

, 1

, LonWorks

Column Title

Function

Legal Values

Node_Name

Name of Node to fetch data from or send data to. Needed for
Explicit Addressing.

One of the Node Names
specified in Section 7.2.2

SNVT_Index

Server Network Variable Index

0-4095

SNVT_Type

Standard network variable type of the data

See Appendix D

SNVT_Option*

Specifies which record out of a complex SNVT we are after.

See Appendix A.9.1

SNVT_Units*

Specifies the measurement units if something other than Metric is
required

See Appendix A.9.2

UNVT_Byte_Length*

Specifies the length in bytes of an UNVT. This Parameter is
compulsory when SNVT_Type is set to UNVT, the parameter is not
used on conjunction with SNVT’s

1-255. See Appendix A.1

UNVT_ID

Specifies the Type Number to apply to this particular UNVT. This
Parameter is optional when SNVT_Type is set to UNVT, The
parameter is not used on conjunction with SNVT’s

0, 146-255. See Appendix
A.1.

NV_Min_Value*

Network Variable updates with values less than specified in this field
will be ignored.

See Appendix A.2

NV_Max_Value*

Network Variable updates with values higher than specified in this
field will be ignored.

See Appendix A.2

NV_Delta_Value*

Network Variable updates where the value’s delta change is less
than specified in this field will be ignored unless the Max_Scan_Time
Condition has been met. Compulsory for Throttling Lon Functions,
not used on other Lon Functions. It is possible to configure a start­up write option for throttling Map Descriptor functions instead of
waiting for the minimum scan time to pass. Refer to Appendix A.3.

See Appendix A.2

NV_Selfdoc_Text*

The Self-Documenting String for this Network Variable.

Normal Text up to a length
of 40 characters. Defaults to
"" for parameters using
string values and 0 for
parameters using numeric
values

Column Title

Function

Legal

Example

7.2.3 Client Side Map Descriptor Parameters

7.2.3.1 Driver Related Map Descriptor Parameters

7.2.3.2 Timing Parameters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 19 of 72

Values

Scan_Interval*

Seconds per scan

0-32000,

2s

Min_Scan_Time*

Minimum Scan Time in seconds. Compulsory for Throttling Lon Functions only. Not used
on other Lon Functions.

See 0
Max_Scan_Time*

Maximum Scan Time in seconds. Compulsory for Throttling Lon Functions only. Not used
on other Lon Functions.

See 0

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8700-21 LonWorks Manual Page 20 of 72

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

7.2.4 Map Descriptor E xample 1 - Ex plicit Conf igura t ion using Network Management Polls

The Map Descriptor pollTemp_p shows the use of SNVT_Units for Scaling when polling temperature
The Map Descriptor pollSwitch shows the use of SNVT_Option for Selective data scanning. This only brings in the “State” portion of SNVT_Switch

Map_Descriptors

Map_Descriptor_Name

, Data_Array_Name

, Data_Array_Offset

, Lon_Function

, Function

, Node_Name

, SNVT_Index

, SNVT_Type

, SNVT_Units

, SNVT_Option

, Scan_Interval

pollTemp_p

, DA_Explicit

, 1

, NMFETCHC

, Rdbc

, Remote_Node

, 0

, SNVT_temp_p

, Deg_F

, -

, 1.0s

pollSwitch

, DA_Explicit

, 2

, NMFETCHC

, Rdbc

, Remote_Node

, 1

, SNVT_switch

, -

, State

, 1.0s

7.2.5 Map Descriptor Exampl e 2 – Po lling UNVT’ s

Map_Descriptors

Map_Descriptor_Name

, Data_Array_Name

, Data_Array_Offset

, Lon_Function

, Function

, Node_Name

, SNVT_Index

, SNVT_Type

, UNVT_Byte_Length

, Scan_Interval

pollUNVT

, DA_Explicit

, 101

, NMFETCHC

, Rdbc

, Remote_Node

, 2

, UNVT

, 31

, 1.0s

Explicitly Addressed Client Map Descriptors use
this field to point to their relevant Server Map
Descriptors.

Explicitly addressed Client Map Descriptors
use this field to extract the correct variable
from the remote device's external interface.

This field determines the Map
Descriptor’s function. See
Section 7.1.2 for more
information.

UNVT Byte length must be specified for correct
operation.

FS-8700-21 LonWorks Manual Page 21 of 72

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

7.2.6 Using Neu ron ID to Ad dress Device s (Cl ient D rivers only )

It is possible to poll remote LonWorks devices using their Neuron ID's instead of the traditional Network Manager method. The Neuron ID is the 12 Digit Hex
identifier of the associated LonWorks Device. An example configuration follows.

Note that Neuron ID addressing is considered explicit addressing so the station address, domain ID and subnet ID must be set as described in Section 7.1.4

Neuron ID addressing is independent of domains, subnet, nodes and can therefore reach any device connected to the LonWorks network. The FieldServer
needs to be commissioned with a Network Management tool for the routers to know it's there, and then neuron based packets will be passed through the
router.

Bridge

System_Station_Address

, Title

110

, D01:S01:Neuron ID Example:

On the Client side add a new field under Nodes as shown below:

Nodes

Node_Name

, Node_ID

, Protocol

, Neuron_ID

Lon_Srv_11

, 11

, Lonworks

, F912AB440100

Create a Map Descriptor as Follows:

Map_Descriptors

Map_Descriptor_Name

, Data_Array_Name

, Data_Array_Offset

, Lon_Function

, Function

, Node_Name

, SNVT_Index

, SNVT_Type

, Scan_Interval

1nviAmp1

, DA_001

, 0

, NMFETCHC

, RDBC

, Lon_Srv_11

, 000

, SNVT_amp

, 0s

FS-8700-21 LonWorks Manual Page 22 of 72

Section Title

Connections

Column Title

Function

Legal Values

Adapter

Adapter Name

LonWorks

Protocol

Specify protocol used

LonWorks

// Server Side Connections

Connections

Adapter

, Protocol

LonWorks

, LonWorks

Section Title

Nodes

Column Title

Function

Legal Values

Node_Name

Provide name for Node

Up to 32 alphanumeric characters

Protocol

Specify protocol used

LonWorks

Startup_Write

Initiate a send on startup.

Enabled, Disabled

// Server Side Nodes

Nodes

Node_Name

, Protocol

LON_1

, LonWorks

Column Title

Function

Legal Values

Map_Descriptor_Name

Name of this Map Descriptor

Up to 16 alphanumeric characters.

Data_Array_Name

Name of Data Array where data is to be stored or
fetched from in the FieldServer

One of the Data Array names defined in
Section 5

Data_Array_Offset

Starting location in Data Array

0 to (Data_Array_Length-1) as specified
in Section 5

Lon_Function

Detailed Function of Client Map Descriptor

See Section 7.1.2 for a list of valid
entries.

Function

Function of Client Map Descriptor

7.3 Server Side Configuration

7.3.1 Server Side Connection Parameters

Example

7.3.2 Server Side Node Parameters

Example

7.3.3 Server Side Map Descri ptor Paramete rs

7.3.3.1 FieldServer Related Map Descriptor Parameters

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]