FieldServer FS-8700-21 LonWorks

FieldServer
FS-8700-21 LonWorks
Driver Manual
(Supplement to the FieldServer Instruction Manual)
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after July 2016.
Driver Revision: 1.33
Document Revision: 1.A
FS-8700-21 LonWorks Manual
Technical Support
Please call us for any technical support needs related to the FieldServer product.
Sierra Monitor Corporation
1991 Tarob Court
Milpitas, CA 95035
Website: www.sierramonitor.com
U.S. Support Information:
+1 408 262-6611
+1 800 727-4377
Email: support@sierramonitor.com
EMEA Support Information:
+44 2033 1813 41
Email: support.emea@sierramonitor.com
Contact Information
FS-8700-21 LonWorks Manual
TABLE OF CONTENTS
1
Description ........................................................................................................................................................... 6
2
Definitions ............................................................................................................................................................ 6
2.1
NV Updates/Polls ........................................................................................................................................... 6
2.2
Network Management .................................................................................................................................... 6
2.2.1
LonWorks - Program ID Calculation (SPID) ............................................................................................ 6
2.3
Clients/Servers ............................................................................................................................................... 7
2.4
Explicit/Implicit ................................................................................................................................................ 7
2.5
XIF Files ......................................................................................................................................................... 7
2.6
Device Resource Files.................................................................................................................................... 7
2.7
NV Aliases ...................................................................................................................................................... 7
2.8
Configuration Properties ................................................................................................................................. 7
3
Driver Scope of Supply ....................................................................................................................................... 8
3.1
Supplied by Sierra Monitor for this Driver ....................................................................................................... 8
rd
3.2
Provided by the Supplier of 3 Party Equipment ........................................................................................... 8
3.3
Additional files required for the Driver ............................................................................................................ 8
4
Hardware Connections ....................................................................................................................................... 9
4.1
Service Pin ..................................................................................................................................................... 9
4.2
Neuron ID ....................................................................................................................................................... 9
4.3
Lon LED’s ....................................................................................................................................................... 9
5
Data Array Parameters ...................................................................................................................................... 10
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 ............................................................................................................................. 11
6.1.3
SNVT_Index .......................................................................................................................................... 11
6.1.4
Address Table Limit............................................................................................................................... 11
6.1.5
Network Management Capability .......................................................................................................... 11
6.1.6
Client vs Server Mapping ...................................................................................................................... 12
6.2
Client Side Mapping ..................................................................................................................................... 12
6.2.1
Client Side Connection Parameters ...................................................................................................... 12
6.2.2
Client Side Node Parameters ................................................................................................................ 12
6.2.3
Client Side Map Descriptor Parameters ................................................................................................ 13
6.2.3.1
FieldServer Related Map Descriptor Parameters .......................................................................... 13
6.2.3.2
Driver Related Map Descriptor Parameters ................................................................................... 13
6.2.3.3
Timing Parameters ......................................................................................................................... 14
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 ................................................................................................................ 18
7.2.3
Client Side Map Descriptor Parameters ................................................................................................ 19
7.2.3.1
Driver Related Map Descriptor Parameters ................................................................................... 19
7.2.3.2
Timing Parameters ......................................................................................................................... 19
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
Table of Contents
FS-8700-21 LonWorks Manual
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.3.1
FieldServer Related Map Descriptor Parameters .......................................................................... 22
7.3.3.2
Driver Related Map Descriptor Parameters ................................................................................... 23
7.3.3.3
Timing Parameters ......................................................................................................................... 23
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 (Send Heartbeat) ................................................................................................... 25
Appendix A.4. XIF Generation ................................................................................................................................ 26
Appendix A.5. Configuration Properties .................................................................................................................. 26
Appendix A.5.1. Example 1 – Configuration Network Variable Map Descriptors applied to Output NV’s .......... 27
Appendix A.5.2. Example 1 – Configuration Network Variable Map Descriptors applied to Input NV’s ............. 28
Appendix A.6. LonMark Object Creation ................................................................................................................. 28
Appendix A.6.1. LonMark Config file Example – Open Loop “Water Temperature” Sensor ............................... 28
Appendix A.7. Node Status Operation .................................................................................................................... 29
Appendix A.8. Working with Binary Data ................................................................................................................ 29
Appendix A.9. Filtering SNVT Variables ................................................................................................................. 30
Appendix A.9.1. SNVT_Option Field ................................................................................................................... 30
Appendix A.9.2. SNVT_Units Field ...................................................................................................................... 30
Appendix A.9.3. Map Descriptor Example – Selecting Multiple Convert Units on SNVT_flow and SNVT_flow_f
............................................................................................................................................................................. 31
Appendix A.10. Accessing Remote Configuration Properties (CPs) Implemented as Embedded Files................. 32
Appendix A.10.1. General Notes ......................................................................................................................... 32
Appendix A.10.2. Determining if NVs are used to expose CPs .......................................................................... 32
Appendix A.10.2.1. Accessing CPs exposed as NVs ..................................................................................... 32
Appendix A.10.3. Determining if embedded files are used to expose CPs ......................................................... 32
Appendix A.10.3.1. Accessing CPs exposed as files ..................................................................................... 33
Appendix B. Vendor Information ............................................................................................................................. 40
Appendix B.1. Echelon LonMaker ........................................................................................................................... 40
Appendix B.1.1. Using LonMaker to commission the FieldServer ...................................................................... 40
Appendix B.1.2. Removing Previous FieldServer Device Templates in LonMaker ............................................ 40
®
Appendix B.2. Checking LonWorks Network Using Echelon’s NodeUtility.exe .................................................... 41
Appendix B.3. Neuron Systems .............................................................................................................................. 42
Appendix B.4. Honeywell Care ............................................................................................................................... 42
Appendix B.5. CARE and LON PT link Integration ................................................................................................. 43
Appendix B.6. Circon_SI ......................................................................................................................................... 45
Appendix B.7. Tridium JACE ................................................................................................................................... 46
Appendix B.7.1. Correcting SNVT Indexing Problem in Tridium Niagara ........................................................... 46
Appendix B.8. Trane Rover ..................................................................................................................................... 46
Appendix B.9. Trane Tracer SC .............................................................................................................................. 46
Appendix C. Troubleshooting.................................................................................................................................. 47
Appendix C.1. Debugging a LonWorks connection: Hints and tips ........................................................................ 47
Appendix C.2. Error Messages ............................................................................................................................... 47
Appendix C.2.1. Error Message Lonlive.c 121 .................................................................................................... 47
Appendix C.3. Communication Errors using Neuron_ID Polling ............................................................................. 47
Appendix C.4. Monitoring Node Status ................................................................................................................... 47
Appendix C.5. Exposing Operation Statistics.......................................................................................................... 48
Appendix C.6. “Illegal” Characters in Network Variable Names ............................................................................. 49
Appendix C.7. Service types currently supported for network variable messages ................................................. 49
Appendix C.8. Combining Explicit and Implicit ........................................................................................................ 49
Table of Contents
FS-8700-21 LonWorks Manual
Appendix D. Reference ............................................................................................................................................. 50
Appendix D.1. LonMark Profiles .............................................................................................................................. 50
Appendix D.2. Performance Tests for LonMark Certified blocks ............................................................................ 51
Appendix D.2.1. Startup Times, 10 Input Blocks and 10 Output Blocks Totalling 80 NVs .................................. 51
Appendix D.2.2. Startup Times, 20 Input Blocks and 20 Output Blocks Totalling 160 NVs ................................ 51
Appendix D.3. SNVT_Type ..................................................................................................................................... 51
Appendix D.4. SNVT_Type by Number .................................................................................................................. 79
Appendix D.5. How to Interpret an XIF file .............................................................................................................. 81
Table of Contents
FS-8700-21 LonWorks Manual
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-B30, QuickServer and SlotServer Series FieldServers
have a built-in LonWorks Interface. A Fieldbus connection is available on the FieldServer. The FS-B30 and the
SlotServer can handle up to 4096 Network Variables which can be of the Standard Network Variable Types (SNVT)
and/or User-defined Network Variable Types (UNVT), and the QuickServer can handle 250 Network Variables (or a
limit of 500 for the enhanced model).
2
2.1
DEFINITIONS
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 LonW orks - 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 calculated SPID can be found in line 5 of the fserver.xif file uploaded from the FieldServer.
The following configuration can be used to force the SPID:
Connections
Adapter
LonWorks
, Protocol
, LonWorks
, SPID
, 80:00:95:48:50:02:04:01
Page 6 of 82
FS-8700-21 LonWorks Manual
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 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.
NOTE: Updating a configuration file or a profile change may result in a change in the XIF file. Any changes
in the XIF will require the FieldServer to be recommissioned.
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 is to upload it using the FieldServer FS-GUI page. 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. However, 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 also 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 userdefined length.
2.7
NV Aliases
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.
Page 7 of 82
FS-8700-21 LonWorks Manual
3
DRIVER SCOPE OF SUPPLY
3.1
Supplied by Sierra Monitor for this Driver
Part #
FS-8700-21
3.2
Provided by the Supplier of 3 rd Party Equipment
Part #
N/A
N/A
N/A
PCC10
3.3
Description
Driver Manual
Description
®
LonMaker Integration Tool from Echelon Corporation (optional network management software)
LonWatcher from Distech Controls Inc. (optional network management software)
Circon System Integrator from Circon Systems Corporation (optional network management software)
PCCard LonWorks Adapter (optional hardware)
Additional files required for the Driver
Filename
Auto-Created
by driver
Config.csv
fserver.xif
Conditionally
loaded
X
X
lon.ini
lonvars.cfg
"Always Loaded
By Sierra
Monitor
X
X
Page 8 of 82
Comments
Template loaded if no custom configuration
ordered, otherwise Custom configuration
loaded.
Generated at power up. Changes if profile in
configuration changes.
Used for providing default DSN. Refer to
Section 7.1.4.
Maintains
commissioning
settings.
If
corrupted, delete it, and reboot FieldServer to
create new one.
FS-8700-21 LonWorks Manual
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. 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 FS-B30 is connected to a LonWorks network:
To other
LonWorks
Nodes
FieldServer Interface
FieldBus
Connector
To other
LonWorks
Nodes
NOTE: 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.
4.2
Neuron ID
The driver prints the Neuron ID on the Driver Message Screen as its starts. 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.
Lon LED’s
4.3
The location of the Lon LED varies between FieldServers. Consult specific FieldServer start-up guides for details.
The 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.
Page 9 of 82
FS-8700-21 LonWorks Manual
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.
Section Title
Data_Arrays
Column Title
Function
Data_Array_Name
Provide name for Data Array.
Data_Array_Format
Data_Array_Length
Example
// Data Arrays
Data_Arrays
Data_Array_Name
DA_AI_01
DA_AO_01
DA_DI_01
DA_DO_01
6
6.1
Provide data format. Each Data Array can only take on one
format.
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.
, Data_Array_Format
, UInt16,
, UInt16
, Bit
, Bit
Legal Values
Up to 15 alphanumeric
characters.
Float, Bit, UInt16, SInt16,
IInt32, SInt32 (Appendix D)
1-10, 000
, Data_Array_Length
, 200
, 200
, 200
, 200
IMPLICIT CONFIGURATIONS
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.
Page 10 of 82
FS-8700-21 LonWorks Manual
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 (function field MUST pair up with the Lon_Function field as shown in the table):
Lon_Function
NVUI
NVPO
NVPIIMC
NVUOIMC
NVUOIMX
NVUOIMT
CFG_NVUI
Description
Network Variable Update Input
Network Variable Polled Output
Network Variable Polled Input Implicitly addressed Continuously sent
Network Variable Update Output Implicitly addressed Continuously sent
Network Variable Update Output Implicitly addressed and sent on
Change
Network Variable Update Output Implicitly addressed sent in Throttling
Mode
Configuration Network Variable Update Input
Function Field
PASSIVE
RDBC
WRBC
WRBX
WRBC (Appendix
A.3)
PASSIVE
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).
6.1.5 Network Management Capability
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 refer to 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.
Page 11 of 82
FS-8700-21 LonWorks Manual
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: In the tables below, * indicates an optional parameter, with the bold legal value being the default.
6.2
Client Side Mapping
6.2.1 Client Side Connection Parameters
Section Title
Connections
Column Title
Protocol
Function
Specify protocol used
Legal Values
LonWorks
Example
// Client Side Connections
Connections
Adapter
LonWorks
, Protocol
, LonWorks
6.2.2 Client Side Node Parameters
Section Title
Nodes
Column Title
Node_Name
Protocol
Startup_Write
Function
Provide name for Node.
Specify protocol used.
Initiate a send on startup. Refer to Appendix A.3 for
more information.
Example
// Client Side Nodes
Nodes
Node_Name
LON_1
, Protocol
, LonWorks
Page 12 of 82
Legal Values
Up to 32 alphanumeric characters
LonWorks
Enabled, Disabled
FS-8700-21 LonWorks Manual
6.2.3 Client Side Map Descriptor Parameters
6.2.3.1 FieldServer Related Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Name
Function
Name of this Map Descriptor. (Network
Variable Name)
Name of Data Array where data is to be
stored or fetched from in the FieldServer.
Data_Array_Offset
Starting location in Data Array.
Lon_Function
Detailed Function of Client Map
Descriptor.
Function
Function of Client Map Descriptor.
Legal Values
Up to 16 alphanumeric characters.
One of the Data Array names defined in
Section 5.
0 to (Data_Array_Length-1) as specified in
Section 5.
See Section 6.1.2 for a list of valid entries
for Implicit Connections.
See Section 6.1.2 for a list of valid entries
based on the Lon_Function.
6.2.3.2 Driver Related Map Descriptor Parameters
Column Title
Node_Name
SNVT_Type
SNVT_Option*
SNVT_Units*
UNVT_Byte_Length*
UNVT_ID
NV_Min_Value*
NV_Max_Value*
NV_Delta_Value*
NV_Selfdoc_Text*
Function
Name of Node to fetch data from or send data to. Needed
for Explicit Addressing.
Standard network variable type of the data.
Specifies which record out of a complex SNVT we are after.
Specifies the measurement units (e.g. Metric or English).
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.
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.
Network Variable updates with values less than specified in
this field will be ignored.
Network Variable updates with values higher than specified
in this field will be ignored.
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.
The Self-Documenting String for this Network Variable.
Page 13 of 82
Legal Values
One of the Node names
specified in Section 6.2.2.
Appendix D
Appendix A.9.1
Appendix A.9.2
1-255 (Appendix A.1)
0, 146-255 (Appendix A.1)
Appendix A.2
Appendix A.2
Appendix A.2
Normal Text up to a length
of 40 characters. Defaults
to "" for parameters using
string values and 0 for
parameters using numeric
values.
FS-8700-21 LonWorks Manual
6.2.3.3 Timing Parameters
Column Title
Scan_Interval
Min_Scan_Time
Max_Scan_Time
Function
Seconds per scan.
Minimum Scan Time in seconds.
Maximum Scan Time in seconds.
Legal Values
0-32000
Appendix A.3
Appendix A.3
6.2.4 Client Side Map Descriptor Example
//
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
TempOut1
TempOut2
TempOut3
TempIn
, Data_Array_Name
, DA_FO_01
, DA_FO_01
, DA_FO_01
, DA_FI_01
, Data_Array_Offset
,0
,1
,2
,0
This field determines the Map
Descriptor’s function. See Section
6.1.2 for more information.
, Nv_Delta_Value
, 10
,,,-
, Min_Scan_Time
,5
,,,-
The Data Array will be sampled and
evaluated for delta change once
every Min_Scan_Time (seconds).
, Lon_Function
, NVUOIMT
, NVUOIMX
, NVUOIMC
, NVPIIMT
, Function
, Wrbc
, Wrbc
, Wrbc
, Rdbc
, Node_Name
, LON_1
, LON_1
, LON_1
, LON_1
, SNVT_Type
, SNVT_Temp_f
, SNVT_Temp_f
, SNVT_Temp_f
, SNVT_Temp_f
Required for Throttling Mode: This field specifies the
minimum change needed for a Network Variable’s
value to invoke an NV Update.
, Max_Scan_Time
, 20
,,,-
, Scan_Interval
,,, 20
,5
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.
Page 14 of 82
For Non-Throttled Client
Map Descriptors the
Scan_Interval determines
the update rate.
FS-8700-21 LonWorks Manual
7
7.1
EXPLICIT CONFIGURATIONS
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. (Section 7.1.5)
Lon_Function
NVUI
NVPO
NVPIEXC
NVUOEXC
NVUOEXX
NVUOEXT
NMFETCHC
CFG_NVUI
Description
Network Variable Update Input
Network Variable Polled Output
Network Variable Polled Input Explicitly addressed Continuously sent
Network Variable Update Output Explicitly addressed Continuously sent
Network Variable Update Output Explicitly addressed and sent on Change
Network Variable Update Output Explicitly addressed sent in Throttling Mode
Network Management Network Variable Fetch Continuously sent (Explicit
Addressing only)
Configuration Network Variable Update Input
Function Field
SERVER
RDBC
WRBC
WRBX
WRBC
RDBC
SERVER
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.
Page 15 of 82
FS-8700-21 LonWorks Manual
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
FieldServer
System_Station_Address , Title
[Node_Id]
, :D[Domain_ID]:S[Subnet_ID]:[Title continued…]
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.
Page 16 of 82
FS-8700-21 LonWorks Manual
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
Section Title
Connections
Column Title
Adapter
Protocol
Default_Service*
Function
Adapter Name
Specify protocol used
Specify messaging service used
Legal Values
LonWorks
LonWorks
1
Ack, UnAck
Example
// Client Side Connections
Connections
Adapter
LonWorks
1
, Protocol
, LonWorks
, Default_Service
, Ack
Only applies to explicit addressing mode. Use Network Management Tool to set desired service type for implicit messaging. UnAck Service is
commonly used to achieve quicker network variable update rates, but message delivery is not guaranteed.
Page 17 of 82
FS-8700-21 LonWorks Manual
7.2.2 Client Side Node Parameters
Section Title
Nodes
Column Title
Node_Name
Subnet_ID
Node_ID
Protocol
Startup_Write
NM_Extended_Commands*
Readback_Option*
Function
Provide name for Node.
Server (destination) Node’s Subnet ID of an
explicitly addressed message.
Server (destination) Node’s Node ID of an
explicitly addressed message.
Specify protocol used.
Initiate a send on startup. Refer to Appendix
A.3 for more information.
Used to enable Wink install type network
management messages on network variable
updates from NMFETCHC function WriteThroughs. Certain devices only allow Wink
install messages updating network variables.
This Client Side parameter enables the user to configure
the timing of a read after a write. The Readback
operation will apply to all drivers that support Active
Reads and Write-Through operations.
Readback_Asynchronously - When a write occurs, the
read will occur when scheduled.
Readback_On_Write - When a write occurs, set the
timer to 0, so Responsible Map Descriptor gets queued
in the next cycle.
Readback_Immediately_On_Write - Prioritize both
write and read to happen in a higher priority queue than
normal reads. The Readback operation will apply to all
drivers that support Active Reads and Write-Through
operation.
Legal Values
Up to 32 alphanumeric characters.
1-255
1-127
LonWorks
Enabled, Disabled
Enabled, Disabled
Readback_Asynchronously,
Readback_Asynchronously,
Readback_Immediately_On_Write
Example
// Client Side Nodes
Nodes
Node_Name , Subnet_ID , Node_ID , Protocol , NM_Extended_Commands , Readback_Option
LON_1
,1
,1
, LonWorks , Enabled
, Readback_Asynchronously
Page 18 of 82
FS-8700-21 LonWorks Manual
7.2.3 Client Side Map Descriptor Parameters
7.2.3.1 Driver Related Map Descriptor Parameters
Column Title
Node_Name
SNVT_Index
SNVT_Type
SNVT_Option*
SNVT_Units*
UNVT_Byte_Length*
UNVT_ID
NV_Min_Value*
NV_Max_Value*
NV_Delta_Value*
NV_Selfdoc_Text*
Function
Name of Node to fetch data from or send data to. Needed
for Explicit Addressing.
Server Network Variable Index.
Standard network variable type of the data.
Specifies which record out of a complex SNVT we are after.
Specifies the measurement units when units other than
Metric are required.
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.
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.
Network Variable updates with values less than specified in
this field will be ignored.
Network Variable updates with values higher than specified
in this field will be ignored.
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.
The Self-Documenting String for this Network Variable.
Legal Values
One of the Node Names
specified in Section 7.2.2.
0-4095
Appendix D
Appendix A.9.1
Appendix A.9.2
1-255 (Appendix A.1)
0, 146-255 (Appendix A.1)
Appendix A.2
Appendix A.2
Appendix A.2
Normal Text up to a length
of 40 characters. Defaults
to "" for parameters using
string values and 0 for
parameters using numeric
values.
7.2.3.2 Timing Parameters
Column Title
Scan_Interval*
Min_Scan_Time*
Max_Scan_Time*
Function
Seconds per scan.
Minimum Scan Time in seconds. Compulsory for Throttling Lon
Functions only. Not used on other Lon Functions.
Maximum Scan Time in seconds. Compulsory for Throttling Lon
Functions only. Not used on other Lon Functions.
Page 19 of 82
Legal Values
0-32000, 2s
Appendix A.3
Appendix A.3
FS-8700-21 LonWorks Manual
7.2.4 Map Descriptor Example 1 - Explicit Configuration 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
pollTemp_p
pollSwitch
, Data_Array_Name
, DA_Explicit
, DA_Explicit
, Data_Array_Offset
,1
,2
, Lon_Function
, NMFETCHC
, NMFETCHC
, Function
, Rdbc
, Rdbc
, Node_Name
, Remote_Node
, Remote_Node
This field determines the Map Descriptor’s
function. See Section 7.2.3 for information.
, SNVT_Index
,0
,1
, SNVT_Type
, SNVT_temp_p
, SNVT_switch
, SNVT_Units
, Deg_F
,-
, SNVT_Option
,, State
Explicitly addressed Client Map Descriptors use
this field to extract the correct variable from the
remote device's external interface.
, Scan_Interval
, 1.0s
, 1.0s
Explicitly Addressed Client Map Descriptors use
this field to point to their relevant Server Map
Descriptors.
7.2.5 Map Descriptor Example 2 – Polling UNVT’s
Map_Descriptors
Map_Descriptor_Name
pollUNVT
, Node_Name
, Remote_Node
, Data_Array_Name
, DA_Explicit
, SNVT_Index
,2
, Data_Array_Offset
, 101
, SNVT_Type
, UNVT
, Lon_Function
, NMFETCHC
, UNVT_Byte_Length
, 31
UNVT Byte length must be
specified for correct operation.
Page 20 of 82
, Scan_Interval
, 1.0s
, Function
, Rdbc
FS-8700-21 LonWorks Manual
7.2.6 Using Neuron ID to Address Devices (Client Drivers 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
110
, Title
, D01:S01:Neuron ID Example:
On the Client side add a new field under Nodes as shown below:
Nodes
Node_Name
Lon_Srv_11
, Node_ID
, 11
, Protocol
, LonWorks
, Neuron_ID
, F912AB440100
Create a Map Descriptor as Follows:
Map_Descriptors
Map_Descriptor_Name
1nviAmp1
, Node_Name
, Lon_Srv_11
, Data_Array_Name
, DA_001
, SNVT_Index
, 000
, SNVT_Type
, SNVT_amp
, Data_Array_Offset
,0
, Scan_Interval
, 0s
Page 21 of 82
, Lon_Function
, NMFETCHC
, Function
, RDBC
FS-8700-21 LonWorks Manual
7.3
Server Side Configuration
7.3.1 Server Side Connection Parameters
Section Title
Connections
Column Title
Adapter
Protocol
Function
Adapter Name
Specify protocol used
Legal Values
LonWorks
LonWorks
Example
// Server Side Connections
Connections
Adapter
LonWorks
, Protocol
, LonWorks
7.3.2 Server Side Node Parameters
Section Title
Nodes
Column Title
Node_Name
Protocol
Startup_Write
Function
Provide name for Node
Specify protocol used
Initiate a send on startup.
Legal Values
Up to 32 alphanumeric characters
LonWorks
Enabled, Disabled
Example
// Server Side Nodes
Nodes
Node_Name
LON_1
, Protocol
, LonWorks
7.3.3 Server Side Map Descriptor Parameters
7.3.3.1 FieldServer Related Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Name
Function
Name of this Map Descriptor.
Name of Data Array where data is to be stored
or fetched from in the FieldServer.
Data_Array_Offset
Starting location in Data Array.
Lon_Function
Function
Detailed Function of Client Map Descriptor.
Function of Client Map Descriptor.
Page 22 of 82
Legal Values
Up to 16 alphanumeric characters.
One of the Data Array names defined
in Section 5.
0 to (Data_Array_Length-1) as
specified in Section 5.
See Section 7.1.2 for a list of valid
entries.
FS-8700-21 LonWorks Manual
7.3.3.2 Driver Related Map Descriptor Parameters
Column Title
Function
Node_Name
Name of Node to fetch data from or send data to.
Needed for Explicit Addressing.
SNVT_Index
SNVT_Type
SNVT_Option
SNVT_Units
UNVT_Byte_Length*
UNVT_ID
NV_Min_Value*
NV_Max_Value*
NV_Delta_Value*
Server Network Variable Index.
Standard network variable type of the data.
Specifies which record out of a complex SNVT we
are after.
Specifies the measurement units if units other than
Metric is required.
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.
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.
Network Variable updates with values less than
specified in this field will be ignored.
Network Variable updates with values higher than
specified in this field will be ignored.
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
only. Not used on other Lon Functions.
NV_Selfdoc_Text
The Self-Documenting
Variable.
String for
this
Network
Bad_Value_Validation*
Set to Disabled to allow the out of range value.
Legal Values
One of the node names
specified under Client Node
Parameters.
0-4095
Appendix D
Appendix A.9.1
Appendix A.9.2
1-255 (Appendix A.1)
0, 146-255 (Appendix A.1)
Appendix A.2
Appendix A.2
Appendix A.3
Normal Text up to a length of 40
characters. Defaults to "" for
parameters using string values
and 0 for parameters using
numeric values.
Enabled, Disabled
7.3.3.3 Timing Parameters
Column Title
Scan_Interval*
Min_Scan_Time*
Max_Scan_Time*
Function
Seconds per scan.
Minimum Scan Time in seconds. Compulsory for Throttling Lon Functions
only. Not used on other Lon Functions.
Maximum Scan Time in seconds. Compulsory for Throttling Lon Functions
only. Not used on other Lon Functions.
Page 23 of 82
Legal Values
0-32000, 2s
Appendix A.3
Appendix A.3
FS-8700-21 LonWorks Manual
7.3.4 Map Descriptor Example
// Server Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
, Data_Array_Name
NviTemp
, DA_FI_01
NviTemp
, DA_FO_01
NviTemp
,-
, Data_Array_Offset
,0
,1
,-
Server NVUI can be grouped with Client NV Update
types and NMFETCHC. Server NVPO can be
grouped with Client NV Poll types and NMFETCHC.
, Nv_Delta_Value
, 10
,,-
, SNVT_Type
, SNVT_Temp_f
, SNVT_Temp_f
, SNVT_Temp_f
Required for Throttling Mode: This
field specifies the minimum change
needed for a Network Variable’s
value to invoke an NV Update.
, Nv_Min_Value
,0
,0
,-
, Lon_Function
, NVUI
, NVPO
, CFG_NVUI
, Function
, Server
, Server
, Server
, Node_Name
, LON_1
, LON_1
, LON_1
, SNVT_Index
,,,-
Explicitly Addressed Client Map
Descriptors use this field to point to their
relevant Server Map Descriptors.
, Nv_Max_Value
,, 150
, 150
, Nv_Selfdoc_text
, “@0|1;WaterTemp”
, “&200\x8023”
, “&200\x8020
If specified for a Floating point or
Integer SNVT then NV Updates
with values higher than specified
here will not be written to its
relevant Data Array location.
If specified for a Floating point or Integer
SNVT then NV Updates with values
lower than specified here will not be
written to its relevant Data Array location.
Page 24 of 82
The Self-documenting String
for a Network Variable can
be up to 40 characters wide.
FS-8700-21 LonWorks Manual
Appendix A. USEFUL FEATURES
Appendix A.1. Using UNVT’s
UNVT’s are User-defined Network Variable Types and are defined in the configuration file by filling the SNVT_Type
field with “UNVT”. The UNVT’s size in bytes should also be added to the UNVT_Byte_Length field and the UNVT’s
type number in the UNVT_ID field. Valid UNVT_IDs are 0 and the range 146 to 255. The UNVT_ID value will be
substituted with the default value of 0 if the field is left empty. Refer to the example in Section 7.2.3.
Appendix A.2. Using NV_Min, NV_Max etc.
The NV_Min_Value, NV_Max_Value functionality were added to stop the propagation of ‘out of bounds’ network
variables across a LonWorks network. NV values higher than assigned by the NV_Max_Value field or lower than
assigned by NV_Min_Value field will not be sent out on the network or copied to their relevant Data Arrays. If one
or both of these fields are not assigned values, limit checking will not be performed on that particular field. This
functionality applies only to SNVT's of either Floating point or Integer formats. Refer to the examples in Section
6.2.4 and Appendix A.6.1.
One or both of these fields can be linked to a configuration network variable update input in order to create an
interoperable configuration property. For further information refer to Appendix A.5.
Appendix A.3. Throttling Mode (Send Heartbeat)
When the Lon_Function field specifies a Throttling Mode Client Map Descriptor the NV_Delta_Value,
Min_Scan_Time and Max_Scan_Time fields all need to be assigned values.
When operating in Throttling Mode, a Network Variable’s value will be sampled at the Min_Scan_Time period. If the
value differs by an amount greater than or equal to that specified by the NV_Delta_Value field from the previously
transmitted value, the NV update will be transmitted. Otherwise an NV update will be only sent if the time since the
last update is greater than or equal to the Max_Scan_Time field value. Refer to the examples in Sections 6.2.4.
This functionality applies only to SNVT’s of either Floating point or Integer formats.
The driver can be configured to initiate a send on startup rather than waiting for the minimum scan interval to pass.
The following example describes the configuration required:
Nodes
Node_Name
Lon_Srv_11
, Node_ID
, 11
Map_Descriptors
Map_Descriptor_Name
nvoAmp
, SNVT_Index
, 000
, Protocol
, LonWorks
, Data_Array_Name
, DA_001
, SNVT_Type
, SNVT_amp
, Startup_Write
, Enabled
, Data_Array_Offset
,0
, Min_Scan_Time
, 30s
, Lon_Function
, NVUOEXT
, Max_Scan_Time
, 60s
, Function
, WRBC
, Node_Name
, Lon_Srv_11
,NV_Delta_Value
, 30
NOTE: Refer to Appendix A.5.1. To configure Send Heartbeat parameters dynamically the
NV_Min_Send_Time, NV_Max_Send_Time and NV_Delta_Value should be used with Configuration
Network Variables.
Page 25 of 82
FS-8700-21 LonWorks Manual
Appendix A.4. XIF Generation
After start-up the FieldServer creates a XIF (version 4.0) according to the configuration loaded. This file is called
fServer.xif and can be uploaded from the FieldServer using the FieldServer FS-GUI.
To upload the XIF file using the FS-GUI:

Enter the FieldServer IP Address followed by \fserver.xif into a web browser.
o For example: 192.168.2.101\fserver.xif
The FieldServer’s XIF file is internally generated by the LonWorks driver using the information contained in the
FieldServer’s configuration file (CONFIG.CSV). It is not possible to download an externally created XIF file using
®
NodeUtil or LonMaker . Additionally, it is also not possible to download any type of externally created network
variables default values file. The FieldServer’s configuration can be changed by uploading and editing the
CONFIG.CSV file, and therefore the XIF file must be obtained by uploading it from the FieldServer.
NOTE: The XIF file will change whenever the configuration file has been changed, downloaded and the
FieldServer restarted.
Appendix A.5. Configuration Properties
Configuration Properties are implemented on the FieldServer using configuration Network Variables. Configuration
Network Variables take the form of update inputs in order to be updated or read by a network management tool.
Each Configuration Network Variable will have its own Map Descriptor. Since the data carried by a Network
Variable is intended as a configuration property for other already declared non-configuration Network Variable(s),
no Data Array needs to be assigned to its Map Descriptor.
The following configuration property types are supported:
 Apply gain to Input and Output Network Variable values via SNVT_nv_type.

Add Offset values to Input and Output Network Variable Values via SNVT_nv_type.

Enforce Minimum and Maximum Range on Network Variables.

Set Update Rate on Active Network Variables.

Set Throttling Mode (Min/MaxSendTime, DeltaValue) properties on Active Network Variables.

Allow adjusting of scan interval on active LonWorks Map Descriptors (SCPTupdateRate (98)).

SCPTGain (31) for Modbus Translations via SNVT_muldiv.

Allow changing of the NV_Delta_Value (SCPTsndDelta (27)).

SCPTnvType that is mandatory on changeable type interfaces for FieldServer specific LonMark certification
of the protocol gateway profile.
Configuration Properties can be declared to belong to the entire Node, to an Object(s) or to a Network Variable(s).
This declaration defines the scope of the Configuration Property. Configuration Properties that belong to an Object
are declared as a part of the Object; Configuration Properties associated with a Network Variable(s) are declared
as belonging to the Network Variable(s) etc.
Page 26 of 82
FS-8700-21 LonWorks Manual
A Configuration Property’s Type and Responsible Map Descriptor(s) are declared by the Configuration Network
Variable’s self-documentation string as follows:
For linking to the entire node:
“&0, , 0\x80, [SCPT Index]”
Example: “&0, , 0\x80, 20”
For linking to object(s):
“&1, [Object Index(s)], 0\x80, [SCPT Index]”
Example: “&1, 0.2.3, 0\x80, 23”
For linking to network variable(s):
“&2, [NV Index(s)], 0\x80, [SCPT Index]”
Example: “&2, 0.1.2.4.7, 0\x80, 20”
Appendix A.5.1. Example 1 – Configuration Network Variable Map Descriptors applied to Output NV’s
Map_Descriptors
Map_Descriptor_Name
nciOut01a
nciOut01b
nciOut01c
nciOut01d
nciOut01e
nciOut01f
nciOut01g
nciOut01h
nciOut01i
nciOut01j
nciOut01k
nciOut01l
nciOut01m
nciOut01n
nciOut01o
nciOut01p
nciOut01q
nciOut01r
nciOut01s
, NV_Min_Send_Time
,,,,,, 1.00
,,,,,,,,, 1.00
,,,,-
, Data_Array_Name
,,,,,,,,,,,,,,,,,,,-
, Data_Array_Offset
,,,,,,,,,,,,,,,,,,,-
, NV_Max_Send_Time
,,,,, 10.00
,,,,,,,,, 10.00
,,,,,-
, Lon_Function
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, NV_Delta_Value
,,,, 1.00
,,,,,,,,, 1.00
,,,,,,-
, Function
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, NV_Value_String
, "0 52 12 4 1 0 0"
,"
"
,"
"
,"
"
,"
"
,"
"
, "0 52 12 4 1 0 0"
,"
"
,"
"
"0 8 6 2 1 0 0 "
,"
"
,"
"
,"
"
,"
"
,"
"
, "0 8 6 2 1 0 0 "
,"
"
,"
"
,"
"
, Node_Name
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, SNVT_Type
, SNVT_nv_type
, SNVT_count_inc_f
, SNVT_count_inc_f
, SNVT_count_inc_f
, SNVT_time_sec
, SNVT_time_sec
, SNVT_nv_type
, SNVT_count_inc_f
, SNVT_count_inc_f
, SNVT_nv_type
, SNVT_count
, SNVT_count
, SNVT_count
, SNVT_time_sec
, SNVT_time_sec
, SNVT_nv_type
, SNVT_count
, SNVT_count
, SNVT_muldiv
, Nv_Selfdoc_text
, "&2, 0, \x80, 254"
, "&2, 2, 0\x80, 23"
, "&2, 2, 0\x80, 20"
, "&2, 2, 0\x80, 27"
, "&2, 2, 0\x80, 49"
, "&2, 2, 0\x80, 52"
, "&2, 3, 0\x80, 254"
, "&2, 3, 0\x80, 23"
, "&2, 3, 0\x80, 20"
, "&2, 4, 0\x80, 254"
, "&2, 4, 0\x80, 23"
, "&2, 4, 0\x80, 20"
, "&2, 4, 0\x80, 27"
, "&2, 4, 0\x80, 49"
, "&2, 4, 0\x80, 52"
, "&2, 5, 0\x80, 254"
, "&2, 5, 0\x80, 23"
, "&2, 5, 0\x80, 20"
, "&1, 1, 0\x80, 31"
Page 27 of 82
, NV_Gain
,,,,,,,,,,,,,,,,,,, 1.00
, NV_Min_Value
,, -3.40282e+038
,,,,,, -3.40282e+038
,,,0
,,,,,,0
,,-
, NV_Max_Value
,,, 3.40282e+038
,,,,,, 3.40282e+038
,,, 65535
,,,,,, 65535
,-
FS-8700-21 LonWorks Manual
Appendix A.5.2. Example 1 – Configuration Network Variable Map Descriptors applied to Input NV’s
Map_Descriptor_Name
nciIn01a
nciIn01b
nciIn01c
nciIn01d
nciIn01e
nciIn01f
nciIn01g
nciIn01h
nciIn01i
nciIn01j
nciIn01k
nciIn01l
nciIn01m
nciIn01n
nciIn01o
, NV_Min_Send_Time
,,,,,,, 1.00
,,,,,,, 1.00
,-
, Data_Array_Name
,,,,,,,,,,,,,,,-
, Data_Array_Offset
,,,,,,,,,,,,,,,-
, NV_Max_Send_Time
,,,,,,,,,,,,,,,-
, Lon_Function
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, CFG_NVUI
, NV_Delta_Value
,,,,,,,,,,,,,,,-
, Function
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, NV_Value_String
, "0 52 12 4 1 0 0"
,"
"
,"
"
, "0 52 12 4 1 0 0"
,"
"
,"
"
,"
"
, "0 8 6 2 1 0 0 "
,"
"
,"
"
, "0 8 6 2 1 0 0 "
,"
"
,"
"
,"
"
,"
"
, Node_Name
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, Lon_Srv_1
, SNVT_Type
, SNVT_nv_type
, SNVT_count_inc_f
, SNVT_count_inc_f
, SNVT_nv_type
, SNVT_count_inc_f
, SNVT_count_inc_f
, SNVT_time_sec
, SNVT_nv_type
, SNVT_count
, SNVT_count
, SNVT_nv_type
, SNVT_count
, SNVT_count
, SNVT_time_sec
, SNVT_muldiv
, NV_Gain
,,,,,,,,,,,,,,, 1.00
, NV_Min_Value
,, -3.40282e+038
,,, -3.40282e+038
,,,,0
,,,0
,,,-
, NV_Max_Value
,,, 3.40282e+038
,,, 3.40282e+038
,,,, 65535
,,, 65535
,,-
, Nv_Selfdoc_text
, "&2, 6, 0\x80, 254"
, "&2, 6, 0\x80, 23"
, "&2, 6, 0\x80, 20"
, "&2, 7, 0\x80, 254"
, "&2, 7, 0\x80, 23"
, "&2, 7, 0\x80, 20"
, "&2, 7, 0\x80, 98"
, "&2, 8, 0\x80, 254"
, "&2, 8, 0\x80, 23"
, "&2, 8, 0\x80, 20"
, "&2, 9, 0\x80, 254"
, "&2, 9, 0\x80, 23"
, "&2, 9, 0\x80, 20"
, "&2, 9, 0\x80, 98"
, "&1, 2, 0\x80, 31”
Appendix A.6. LonMark Object Creation
For more information on filling out the Node Self-Documentation String as well as the relevant Network Variable
Self-Documentation Strings in order to create a LonMark Object, consult the following documentation from the
LonMark Interoperability Association at www.lonmark.org:

Understanding LonMark Self-Documentation

LonMark Application Layer Interoperability Guidelines
The example below shows how LonMark Objects can be assigned in FieldServer configuration files.
In this example the standard Open Loop Sensor Object (Type 1) is used to create a Water Temperature Sensor
that will send out its current status via Network Variable Updates.
Appendix A.6.1. LonMark Config file Example – Open Loop “Water Temperature” Sensor
//
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
nvoTemp
NviTempMin
NviTempMax
, SNVT_Type
, SNVT_Temp_f
, SNVT_Temp_f
, SNVT_Temp_f
, Data_Array_Name
, DA_FI_01
,,-
, Nv_Min_Value
,, 10
,-
, Data_Array_Offset
,0
,,-
, Nv_Max_Value
,,, 300
, Lon_Function
, NVUOIMC
, CFG_NVUI
, CFG_NVUI
, Nv_Selfdoc_Text
, “@0|1;WaterTemp”
, “&200\x8023”
, “&200\x8020”
Page 28 of 82
, Function
, Wrbc
, Server
, Server
, Node_Name
, LON_1
, LON_1
, LON_1
, SNVT_Index
,,,-
FS-8700-21 LonWorks Manual
The entries under Nv_Selfdoc_Text are described in more detail below:
The Node Self-Documentation String defines one
LonMark object of type 1 – Open Loop Sensor.
The object index is 0 and
this Map Descriptor
st
defines the 1 Network
Variable of the object.
, Nv_Selfdoc_Text
, “@0|1;WaterTemp”
, “&200\x8023”
, “&200\x8020”
These two configuration network variables will be linked to the
first Map Descriptor declared. The NV_Min_Value and
NV_Max_Value fields define the defaults for these Configuration
Properties. These defaults are loaded by the FieldServer after a
restart only when re-commissioning is required.
Appendix A.7. Node Status Operation
When binding network variables on the FieldServer, the node status will be on-line before binding as well as after
un-binding network variables. A Node will go off-line only when a bound network variable of that node goes off-line
(e.g. is disconnected).
When using a network tool to commission the FieldServer (implicit addressing), the FieldServer LonWorks Node
must be placed ONLINE on the LonWorks network before it will pass data with other bound network variables. The
following messages may appear on the driver screen when using the FS-GUI which indicates that the FieldServer
has not been put into the ONLINE state yet:
"Not sending NV msg for [variable name], Node OFFLINE!"
To set the FieldServer to ONLINE using LonMaker:
Right-click on the FieldServer device and select Manage.
On the Devices Tab, click the ONLINE button.
The FieldServer LonWorks Node is always ONLINE when using explicit addressing.
NOTE: The FieldServer Node_Status function (refer to the FieldServer Configuration Manual) looks at the
Node_ID configured in order to monitor Node status. In implicit applications this may not be the real
Node_ID since Node_ID is allocated by the network manager.
Appendix A.8. Working with Binary Data
When sending binary data on a LonWorks network, there are two SNVT’s that are most commonly used, namely
SNVT_State and SNVT_Switch.
SNVT_State is a 16 bit integer that allows the user to send 16 data bits to the remote device. To do this, the 16
data bits need to be packed into an integer word. If this packing is already done when the value is transferred into
the FieldServer, then the SNVT need only be linked to the relevant Data Array offset for transfer out of the
FieldServer. However, if the FieldServer is picking up 16 separate bits from another network for this variable, then
the FieldServer Packed_Bit function can be used to achieve the packing. See the FieldServer Configuration manual
for more details on the Packed_Bit function.
SNVT_Switch is a two byte value consisting of an analog value in the left hand byte (VALUE portion), and a binary
state in the right hand byte (STATE portion). LonMark guidelines for this SNVT stipulate that the VALUE portion
has a range from 0-100%, and that the STATE portion can assume a value of 1 or 0. However, since the raw data
type for these two values is byte (a value ranging from 0-255), care needs to be taken when transferring values into
this SNVT to make sure the source values are within the legal range. If a value is placed into one of these bytes
that is deemed out of range, then a -1 value will be sent on the LonWorks network to indicate out of range. Also
note that when sending binary status in a SNVT Switch, some devices expect the VALUE portion to change when
the STATUS portion changes, so an analog value that changes in sympathy with the binary state may be
necessary.
Page 29 of 82
FS-8700-21 LonWorks Manual
Appendix A.9. Filtering SNVT Variables
Appendix A.9.1. SNVT_Option Field
This field can be used to isolate a specific record within a complex SNVT. Appendix D shows which SNVTs are
currently attributed with SNVT_Option capabilities.
Appendix A.9.2. SNVT_Units Field
The measurement units of a SNVT is fixed as far as it is transported across the LonWorks network, but by the
setting of the SNVT_Units field it is possible to specify how the data is made available in Data Arrays. For example
SNVT_temp_f is always transported across the LonWorks network as degrees Celsius, but by setting the
SNVT_Units field to Deg_F the measurement units of the Map Descriptor’s data will be set to degrees Fahrenheit.
The following table shows which SNVT’s currently have SNVT_Units capabilities.
SNVT_Type
SNVT_Option
SNVT_flow
N/A
SNVT_flow_f
N/A
SNVT_press_f
SNVT_press_p
N/A
N/A
SNVT_temp
N/A
SNVT_temp_f
N/A
SNVT_temp_p
N/A
All
SNVT_switch
2
Value
State
2
SNVT_Units
Length
Liters/Second
1
Cubic-feet-per-minute
1
Gallons-per-minute
1
Liters/Second
1
Cubic-feet-per-minute
1
Gallons-per-minute
1
Inch_H20
1
Inch_H20
1
Raw
1
Deg_C
1
Deg_F
1
Deg_C
1
Deg_F
1
Raw
1
Deg_C
1
Deg_F
1
Raw
2
Raw
1
Percent
1
Raw
1
See also Appendix A.8.
Page 30 of 82
Measurement Units
Liters per Second
Cubic-feet-per-minute
Gallons-per-minute
Liters per Second
Cubic-feet-per-minute
Gallons-per-minute
Inches of water
Inches of water
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Raw, unadjusted data
Percent (%)
Raw, unadjusted data
FS-8700-21 LonWorks Manual
SNVT_Type
SNVT_Option
All
Occupied_cool
Standby_cool
SNVT_temp_setpt Unoccupied_cool
Occupied_heat
Standby_heat
Unoccupied_ heat
SNVT_Units
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Deg_C
Deg_F
Length
12
6
6
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
Measurement Units
Raw, unadjusted data
Degrees Celsius (C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Raw, unadjusted data
Degrees Celsius (°C)
Degrees Fahrenheit (°F)
Appendix A.9.3. Map Descriptor Example – Selecting Multiple Convert Units on SNVT_flow and
SNVT_flow_f
//
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
nviFlow1
nviFlow1_f
nviFlow2
nviFlow2_f
, Data_Array_Name
, DA_001
, DA_001
, DA_001
, DA_001
, Data_Array_Offset
,0
,1
,2
,3
, Lon_Function
, NVPIEXC
, NVPIEXC
, NVPIEXC
, NVPIEXC
The same Map Descriptor can be used on the Server Side but the Function
must be changed to Passive.
, Node_Name
, Lon_Srv_11
, Lon_Srv_11
, Lon_Srv_11
, Lon_Srv_11
, SNVT_Index
,0
,1
,2
,3
, SNVT_Type
, SNVT_flow
, SNVT_flow_f
, SNVT_flow
, SNVT_flow_f
, SNVT_Units
, Cubic-feet-per-minute
, Cubic-feet-per-minute
, Gallons-per-minute
, Gallons-per-minute
SNVT_flow and SNVT_flow_f is always transported across the LonWorks
network as liters/second, but by setting the SNVT_Units field the units of
the Map Descriptor’s data can be changed.
Page 31 of 82
, Function
, RDBC
, RDBC
, RDBC
, RDBC
FS-8700-21 LonWorks Manual
Appendix A.10. Accessing Remote Configuration Properties (CPs) Implemented as Embedded Files
Appendix A.10.1. General Notes
A device's Configuration Properties can be exposed as Network Variables (NVs) that can be viewed in LonMaker,
or as embedded files that cannot be viewed in LonMaker.
Appendix A.10.2. Determining if NVs are used to expose CPs

View the XIF file with a text viewer.

Search for lines starting with VAR.

A first indication that it uses NVs is the name of the VAR that starts with nci (network configuration input).

A second determination that NVs are used is the 2nd line below VAR (the self-documentation string line)
that contains a ‘&’ character after the " (eg. “&1,0,0).

Finally, at the end of the file there should be a NVVAL section that will give default values for all
Configuration Properties exposed as Network Variables.
Appendix A.10.2.1. Accessing CPs exposed as NVs
CPs exposed as NVs can be accessed either with:
 Implicit Addressing – where a network management tool such as LonMaker is simply used to bind to the
network variable.

Explicit Addressing – where it is accessed using the SNVT_Index.
Example: If the CP exposed as a NV is the 5th entry in the XIF file from the top, the SNVT_Index will be 4.
Looking at the complete VAR line of the CP to be accessed:
VAR nciDevMinVer 4 0 0 0 -- the number just after the name is always the SNVT_Index, in this case 4.
Appendix A.10.3. Determining if embedded files are used to expose CPs

View the XIF file with a text viewer.

Search for lines starting with VAR.

A first indication that embedded files are used is names such as nvoFileDirectory, and a second
determination is the SNVT_Type number in the 3rd of 4th lines below the VAR line. This line will always
have a number followed by a star and an additional number (eg. 73 * 1).

The first number is the SNVT_Type and these numbers indicate that embedded files are used:
73 *
( SNVT_file_req )
74 *
( SNVT_file_status )
114 *
( SNVT_address )

Finally, at the end of the file there will be FILE sections to confirm embedded files are used.
Page 32 of 82
FS-8700-21 LonWorks Manual
Appendix A.10.3.1. Accessing CPs exposed as files3
Currently, the FieldServer driver can only access CPs exposed as files where the SNVT_address of the files are
exposed, such as done by all the LonPoint modules. Therefore, the existence of the 114 * line in the XIF indicates
that the device exposes the address of the files which the FieldServer driver will use to access the files.
STEP 1:
Add a map descriptor to the config file that will read the address of the embedded files.
Example from the DI-10V3.XIF file:
VAR Node_Directory 4 0 0 0
0 1 63 1 0 1 0 1 0 0 0 0 0
"@0|8;Address offset of the node file directory. For tool-use" only 114 * 1
Map_Descriptors
Map_Descriptor_Name
nviFDAddress
, Function
, RDBC
, Data_Array_Name
, File_Address
, Node_Name
, Lon_Remote
Note this value
from the VAR line.
, Data_Array_Offset
,0
, SNVT_Index
, 004
, Lon_Function
, NMFETCHC
, SNVT_Type
, SNVT_address
Note this value from
the SNVT Type line.
In the following excerpt taken from the Echelon SNVTs document, 114 refers to SNVT_Address which is the
Type of SNVT:
3
Warning: This method uses direct memory write LonWorks messages that could corrupt a remote device’s configuration property files if the
incorrect memory address is determined by the outlined steps. Do not allow write-throughs to happen until the configuration property’s value is
correctly read and displayed in the FieldServer Data Array. Verify correct configuration property and values by adding the device to a network
management tool and changing the values with the tool making sure the corresponding FieldServer Data Array values match before using the
device in explicit messaging mode.
Page 33 of 82
FS-8700-21 LonWorks Manual
STEP 2:
st
Add a map descriptor that will read the first 16 bytes at the address provided by the 1 map descriptor. These 16
bytes are the file directory table of the device and indicate the types and addresses of the files that need to be
accessed to read or write the Configuration Properties:
Map_Descriptors
Map_Descriptor_Name
Poller 1
, Data_Array_Name
, CP_Info
, Data_Array_Offset , DA_Address
,0
, File_Address
st
The first 16 bytes of the file
directory table will be stored in
this data array.
, Function
, RDBC
, Node_Name
, Lon_Remote
, Lon_Function
, NM_MEMORY
NOTE: This is the data array from the 1
mapdesc that will give this mapdesc the
address of the file directory table.
, UNVT_ID
,-
, SNVT_Type
, Not SNVT
, UNVT_Byte_Length
, 16
STEP 3:
Create a moves function to extract the address of the file where the Configuration Properties are located.
This table is for Version 1.1 File Table Format - the 1st byte of CP_Info shows the version:
0x11 = Version 1.1
Version 1.1 uses 1 byte for the file-type entries.
Moves
Source_Data_Array
CP_Info
, Source_Offset
, 10
, Target_Data_Array
, CPs_Address
NOTE: The CP_Info data array is populated by the
nd
2 mapdesc from the previous step and
contains the first 16 bytes of the file directory
table on the device.
, Target_Offset
,0
, Length
,1
This function will take the 2 bytes at offset 10 from
the CP_Info data array and combine them into a
word address and store that value in the
CPs_Address data array at offset 0.
In practice, here is how the CP_Info data array will look like for a version 1.1 file directory table:
Data_Array
Data_Array_Name
CP_Info
Bytes:
Offset:
11
0
03
1
09
2
, Data_Array_Length
, 16
5a
3
02
4
cd
5
31
6
, Data format
, Byte
04
7
fa
8
01
9
, Function
, Join_Int16
d7
10
, Bytes Per Item
,1
16
11
Page 34 of 82
00
12
31
12
01
14
d6
15
FS-8700-21 LonWorks Manual
These bytes can be interpreted as follows for version 1.1 and version 2.0:
Offset
(v1.1)
Offset
(v2.0)
Description
0
0
File directory table format version
1
2-3
1
2-3
4
4-5
5-6
7-8
6-7
8-9
9
10-11
10-11
12-13
Number of files on the device
Filesize of 1st file in bytes
* File type of 1st file
2 = template file (XIF)
Address of 1st file
Filesize of 2nd file on the device
* File type of 2nd file
1 = configuration properties
Address of 2nd file
Example
11 -> version 1.1
20 -> version 2.0
03 -> 3 files
095a -> 2,394 bytes
02 -> 2 (v1.1)
00 02 -> 2 (v2.0)
cd31
04fa -> 1,274 bytes
01 -> 1 (v1.1)
00 01 -> (v2.0)
d716
nd
* The first file will always be the template (XIF) file and the 2 file will always be the configuration properties file according to the
LonMark Interoperability Guidelines document, section 4-6 and 4-13.
The version of the file director format can be determined beforehand from the device’s XIF file by searching for the
st
1 FILE section, example:
FILE template 0 2
"1.1;"
Here it shows version 1.1, so Source_Offset 10 can be used.
For version 2.0 it would show “2.0;” and Source_Offset 12 would be used.
Page 35 of 82
FS-8700-21 LonWorks Manual
STEP 4:
Create map descriptors for the configuration properties of the device.
At this stage in the example, the CPs_Address data array will now contain an address value of d716 which is the
start address of the first configuration property on the device.
View the device’s XIF file again and search for the FILE template section which will be the first FILE section
encountered.
FILE template 02:
"1.1;"
"1,0,3\x84,62,1;"
"1,0,3\xA4,63,1;"
"1,0,3\x84,64,1;"
"1,0,3\xA4,65,1;"
"1,0,0\x82,17,31;"
"1,0,0\x82,22,7;"
"1,0,3\x82,2,7;"
"1,0,3\x82,3,7;"
"1,1,3\x85,38,3;"
"1,1,3\x84,64,1;"
"1,1,3\xA4,65,1;"
"1,1,0\x81,17,31;"
"1,1,3\x81,4,7;"
"1,1,3\x81,16,1;"
"1,1,3\x81,5,1;"
"1,1,3\x81,17,7;"
"1,1,3\x81,18,7;"
// UCPTdeviceMajorVersion (unsigned int)
// UCPTdeviceMinorVersion (unsigned int)
// UCPTobjectMajorVersion (unsigned int)
// UCPTobjectMinorVersion (unsigned int)
// SCPT_location (SNVT_str_asc) Label, Location
// SCPT_max_snd_t (SNVT_elapsed_tm) Send Time, Max
// UCPTgoUncnfgT (SNVT_elapsed_tm)
// UCPTgoUncnfgPrwupT (SNVT_elapsed_tm)
// UCPTobjectType (struct ObjectType)
// UCPTobjectMajorVersion (unsigned int)
// UCPTobjectMinorVersion (unsigned int)
// SCPT_location (SNVT_str_asc) Label, Location
// UCPTdebounceT (SNVT_elapsed_tm)
// UCPTdioType (struct DioType)
// UCPTinvertInput (boolean)
// UCPTonDelay (SNVT_elapsed_tm)
// UCPToffDelay (SNVT_elapsed_tm)
rd
Each line starting from the 3 line eg. “1,0,3\x84 … “ defines a configuration property on the device. All lines that
contain an x84 or x85 or xA4 are constant configuration properties which cannot be accessed and are not part of
the addressing offsets into the file, so these lines should be ignored.
The following description is a quick way to determine the address offset and type of each configuration property for
the most common declaration, but there may be variations so the LonMark Interoperability Guidelines document
section 4-6 can be studied further for more complex definitions of configuration properties.
The format of each entry is basically:
“<header>,<select>,<flag\attributes>,<config_index>,<length>;”
eg. “
1
, 0
, 0\x82
, 17
, 31
;”
The comments after each entry can be used to ascertain the type of CP.
For the example above the flag is 0 which always points to a SCPT type CP. Any non-zero flag value points to a
UCPT type CP.
So, from this example, flag is 0, and config_index is 17, so it is SCPT 17 that should be used to determine the type
of the CP.
Page 36 of 82
FS-8700-21 LonWorks Manual
From the Echelon SCPT list:
The Measurement shows SNVT_str_asc should be used as the data-type to store the value from this configuration
property. The comment in the XIF file confirms this:
// SCPT_location (SNVT_str_asc) Label, Location
Finally, the length is 31 bytes.
At this stage the following is determined:
The first accessible Configuration Property on this device is at address d716 (hex) offset 0 and it is 31 bytes long.
Page 37 of 82
FS-8700-21 LonWorks Manual
To create a mapdesc to read and write to this CP, it is defined:
Map_Descriptors
Map_Descriptor_Name
CP_CMD001
,Function
, RDBC
,Scan_Interval
, 0s
,Data_Array_Name
, DA001
,Node_Name
, Lon_Remote
,Data_Array_Offset
,0
,SNVT_Type
, SNVT_str_asc
,DA_Address
,CPs_Address
,UNVT_ID
,-
,Address_Offset
, 000
, UNVT_Byte_Length
,-
A UCPT example:
"1,1,3\x81,5,1;" // UCPTinvertInput (boolean)
the format is:
“<header>,<select>,<flag\attributes>,<config_index>,<length>;”
flag is non-zero so this is UCPT that is defined in resource file scope 3 index 5 and it is 1 byte long.
The resource editor shows the Echelon scope 3 file at index 5:
Page 38 of 82
,Lon_Function
,NM_MEMORY
FS-8700-21 LonWorks Manual
In this example, it isn’t necessary to check the resource files. This is a simple example; the comment was enough
to indicate the use of an UNVT type of length 1, other UCPTs may be structures with elements that need to be
interpreted by the front-end to decide which offsets to read or write to inside the data bytes.
To create a mapdesc to read and write to this CP, it is defined:
Map_Descriptors
Map_Descriptor_Name
CP_CMD008
, Function
, RDBC
, Data_Array_Name
, DA008
, Scan_Interval
, 0s
, Node_Name
, Lon_Remote
, Data_Array_Offset
,0
, SNVT_Type
, Not SNVT
, DA_Address
, CPs_Address
, UNVT_ID
,-
, Address_Offset
, 091
, Lon_Function
, NM_MEMORY
, UNVT_Byte_Length
, 01
NOTE: The SNVT_Type is set to Not SNVT to indicate this is an UNVT and the UNVT_Id is set to 1 which is
the first UNVT. The next UNVT will be 02. And finally the type size of 1 as per the example is set as
the UNVT_Byte_Length.
Page 39 of 82
FS-8700-21 LonWorks Manual
Appendix B. VENDOR INFORMATION
Appendix B.1. Echelon LonMaker
Appendix B.1.1. Using LonMaker to commission the FieldServer

Ensure that the correct firmware and latest configuration is loaded on the FieldServer (Each change in the
FieldServer requires re-commissioning of the FieldServer in LonMaker).

Ensure that the FieldServer and the LonMaker machine are on the same network.

Open the existing Network in LonMaker, or create a new Network.

Click on “Create New Network” and follow the network wizard, making the following selections:
o
Network Interface: Choose Network Attached
o
Management Mode: Choose Onnet unless working offline
o
Register Plug-ins required: None

Once Visio is open with the Network showing, drag a new device onto the drawing from the toolbox.

Follow the Device Network, making the following selections:
o
Enter Device Name: Choose commission device
o
Specify Device Template: Choose upload from device
o
Specify Device Channel: Choose Auto Detect
o
Specify Device Properties: Leave as is (Ping is optional)
o
Identify Device: Choose service pin
o
Device Application Image: Leave unchecked
o
Initial State: Leave as is

Press the service pin on the FieldServer when asked to do so, and the FieldServer will be commissioned.

Drag a new function block onto the drawing from the toolbox. Give the function block a name and ensure
that it is allocated to the FieldServer device.

Once the function block is on the drawing, drag input and output variables onto the function block.
LonMaker will display the variables available for binding. Click on the required variables (or use the select
all option), and they will be commissioned onto the function block.

Connect these variables to other devices by dragging connections from the toolbox and connecting the
variables.
Appendix B.1.2. Removing Previous FieldServer Device Templates in LonMaker
If using a previously used LonMaker to commission a FieldServer or ProtoCessor onto a LonWorks network,
LonMaker saves the properties of that device as a device template. It is important to remove all previous device
templates from LonMaker when moving onto the next FieldServer product as some parameters might transfer to
the new device.
To remove the device templates, open the LonMaker workspace as normal. Then choose the LonMaker toolbar
and choose the Device Templates option. This will bring up a list of all device templates. Highlight and then remove
all device templates that do not contain “Echelon” or “LNS”. This will ensure a fresh commission of the FieldServer
product.
Page 40 of 82
FS-8700-21 LonWorks Manual
Appendix B.2. Checking LonWorks® Network Using Echelon’s NodeUtility.exe

Run Nodeutil.exe.

Press Service Pin on all LonWorks Devices.

Press ‘F’ to find Nodes.

Press ‘L’ to List Nodes, Confirm that all Nodes can be seen.

Press ‘G’ (Goto) each Node and:

Dump Node Domain Table ( ‘D’, Enter ).
®
o
Confirm Domain ID is correct ( usually , “F” ).
o
Record Node.
o
Confirm that Subnet is “1”.
o
Confirm that Size is “1”.

Press ‘L’ (List) Network Variables.

Record SNVT Type and Index.
Page 41 of 82
FS-8700-21 LonWorks Manual
Appendix B.3. Neuron Systems
Newron Systems may produce the following Error message “bindings lost after power-cycle”. This can be fixed by
placing the FieldServer in the Configured state which will cause the bindings to be committed to the Neuron and
they will remain after a power cycle.
Procedure:
1) Make the bindings in NL220.
2) Place devices in ONLINE mode or state.
3) Refer to the following Screencap for assistance in placing the FieldServer in the Configured state.
Appendix B.4. Honeywell Care
This system uses unacknowledged service as default.
Page 42 of 82
FS-8700-21 LonWorks Manual
Appendix B.5. CARE and LON PT link Integration
The procedure that follows describes a successful integration from a LonPtLink using Honeywell Care ver 7.0:

Set the PT Link configuration file as follows for LonWorks: Implicit, Update, Update.

Open the device library in Care and create a new Lon device as shown in the example below.

Connect to the Lon side of the PT Link using the Lon network interface cable and set Care to Onnet.

Right click on the new Lon device created in the device library and select Import Lon Object>From Online.
This will upload the PT Link configuration into the new device.
NOTE: All Controllers that will be connected to the PT Link must be powered up and communicating to the
PT Link before uploading the new device.

Rename the new device e.g. LonPtLink, and drag it into the default channel.
Page 43 of 82
FS-8700-21 LonWorks Manual

Create the pseudo points to be bound to the PT Link. Leave them as non Lon Points for now and setup any
engineering units.

Open the Controller that is being binded from in the network tree and go to the Terminal Assignments tab.

Drag the newly created LonPtLink device into the Terminal Assignment window.

Now drag the pseudo points from the XL5000 controller and drop them onto the appropriate NV’S.
The example below shows the pseudo digital 2 stat RTU_01_ENABLE in the XL50 bound to the NVI schedule force
(shcdfrc) on the PT Link. Using the autobind in Care will automatically configure the required snvt and lon nv.
NOTE: The schdfrc nv is the occupancy point. The pseudo point has to be set to a logical 1 for occupied
and a logical 0 for unoccupied.
Page 44 of 82
FS-8700-21 LonWorks Manual

Open up the nv points bound from the controller under the controller in the network tree and set the nvo
points to Ackd bindings in the service type as shown below.
o

Care automatically defaults to unacknowledged bindings
Now go onnet in Care and commission the controllers.
NOTE: If installing on a SymmetrE front end, create an XIF file for LNS to use to commission the device on
synchronization. Use FS GUI or NodeUtil182 (available for free download at www.echelon.com).
Ensure that the XIF is not created until everything has been configured and commissioned
properly.
Appendix B.6. Circon_SI
NOTE: Circon_SI does not recognize whitespace; %; -.
NOTE: The maximum number of Network Variables under Circon_SI is limited to 255 per node.

Set the Connection_Type parameter in the configuration file per the following example. This will ensure that
all illegal characters are replaced with underscores, and that the number of Network Variables per Node is
limited to 255 in the configuration.
Example
// Client Side Connections
Connections
Adapter
LonWorks
, Protocol
, LonWorks
, Connection_Type
, Circon_SI
Page 45 of 82
FS-8700-21 LonWorks Manual
Appendix B.7. Tridium JACE
This system uses unacknowledged service as default.
NOTE: Tridium calls Acknowledged service “critical bindings”.
Appendix B.7.1. Correcting SNVT Indexing Problem in Tridium Niagara
The procedure below was done in Niagara AX-Workbench Rev 3.4.X. It may not work in prior revs or with R2
because the menus are different.
If after a dynamic device is created and the nv (Network Variable) index of a monitored device does not match the
XIF file of the device being monitored, the XIF can be imported by first converting the XIF to an LNML file. There is
a menu item under tools in AX Workbench to do this.

Obtain a copy of the correct XIF file.

Choose the option for LON XML conversion under Tools.

In the LON XML converter, browse to the XIF file.

Choose a working directory for the new LNML file and convert the file.

In LON Device manager, double click the device with the problem nv index.

In the LNML file select box, browse to the newly created LNML file.

Commission the device.

Right click on the device, select Actions and then Upload.

Compare the nv index with the XIF file index. If the numbers match, data should be correctly displayed after
deleting and re-generating the proxy points.
Appendix B.8. Trane Rover
Use Trane Rover Service Pack 4 or later when commissioning the FieldServer. This does not ship from Trane by
default and may have to be requested from the local Trane representative.
When using Pre-Service Pack 4 software, the FieldServer will appear in Rover, but none of the FieldServer
variables will be available for binding even though they are present. Service Pack 4 has been tested to ensure that
the variables show and the bindings work well.
Appendix B.9. Trane Tracer SC
The Trane Tracer SC is unable to deal with devices on remote subnets cleanly and all precautions needs to be
taken to ensure that the FieldServer presents itself to the SC in an unconfigured manner so that the SC can
allocate a Domain, SubNet and Node to the FieldServer on the same subnet.
The FieldServer LonWorks Configuration must be set up for implicit addressing by not specifying the Domain,
Subnet and Node_ID in the Title section of the Configuration file, to ensure that the Trane Tracer SC tool will
successfully find the FieldServer on the LonWorks Network. To this end ensure the following:

The FieldServer needs to be configured as LonWorks Implicit on the Server Side of the configuration file.

The DSN information needs to be completely removed from the Title section of the configuration file.
Page 46 of 82
FS-8700-21 LonWorks Manual
Appendix C. TROUBLESHOOTING
Appendix C.1. Debugging a LonWorks connection: Hints and tips

To test connections, set the configuration tool into a mode that will display service requests, and then push
the button on the FieldServer. A request should appear.

In order for variables to appear as outputs, they need to be declared as write variables in the FieldServer.
Declaring the Map Descriptor functions as WRBC, or WRBX can do this. See Section 6.1.2 for more
information.

If the domain and Subnet ID are defined in the configuration file of the FieldServer, these values will be
used when power is cycled to the FieldServer. If the values set here are different to what the Network
Manager has set up for the FieldServer for clients using implicit addressing, the FieldServer will stop
communicating. In this case, change these settings or remove them from the configuration file completely
and recommission the FieldServer.
Appendix C.2. Error Messages
Message
"LON:#03 FYI. Standard driver build. This is normal.
Description
This message is informational and can be safely ignored.
Appendix C.2.1. Error Message Lonlive.c 121
If the following error message is returned:
DRIVER-> LON : Error, timeout while waiting for Lon I/F to reset!-------- Configuration Error -----It is possible that the FieldServer hardware in use may not support LonWorks, or the firmware loaded contains
LonWorks but is the wrong firmware for the application. Remove LonWorks from the configuration or get new
firmware/hardware.
Appendix C.3. Communication Errors using Neuron_ID Polling
In order to allow communication across routers when using Neuron_ID based polling, routers need to be set up to
forward NID addressed messages to/from the connected channels.
Appendix C.4. Monitoring Node Status
When monitoring Node Status with a configuration using implicit addressing, it is important that at least one of the
Map Descriptors has active functions (Wrbc, Rdbc). This will cause traffic and when the traffic stops, this will
indicate that the Node is offline.
Page 47 of 82
FS-8700-21 LonWorks Manual
Appendix C.5. Exposing Operation Statistics
If this driver is appropriately configured, it can expose operation statistics in a Data Array which can be monitored
by a remote device to check that the driver is performing without error.
The lines from the example below can be cut and pasted into a configuration file to expose these stats.
Data_Arrays,
Data_Array_Name
Lonworks-stats
Data Array
Offset
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
30
31
32
33
34
35
36
37
38
, Data_Format
, UINT32
, Data_Array_Length
, 1000
Description
Increments when Neuron ID is read. Used for scripting.
Overwritten when Neuron ID is read. Contains 1st byte of Neuron ID.
Overwritten when Neuron ID is read. Contains 2nd byte of Neuron ID.
Overwritten when Neuron ID is read. Contains 3rd byte of Neuron ID.
Overwritten when Neuron ID is read. Contains 4th byte of Neuron ID.
Overwritten when Neuron ID is read. Contains 5th byte of Neuron ID.
Overwritten when Neuron ID is read. Contains 6th byte of Neuron ID.
Not Used.
Not Used.
Overwritten when Neuron ID is read. Contains 1st nibble of 1st byte of Neuron ID as an ASCII char.
e.g. if 1st byte=0x12 then the value stored here is 0x32 - the ASCII char for the digit 2.
Overwritten when Neuron ID is read. Contains 2nd nibble of 1st byte of Neuron ID as an ASCII char.
e.g. if 1st byte=0x12 then the value stored here is 0x31 - the ASCII char for the digit 1.
Overwritten when Neuron ID is read. Contains 1st nibble of 2nd byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 2nd nibble of 2nd byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 1st nibble of 3rd byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 2nd nibble of 3rd byte of Neuron ID as ASCII char.
Overwritten when Neuron ID is read. Contains 1st nibble of 4th byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 2nd nibble of 4th byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 1st nibble of 5th byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 2nd nibble of 5th byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 1st nibble of 6th byte of Neuron ID as an ASCII char.
Overwritten when Neuron ID is read. Contains 2nd nibble of 6th byte of Neuron ID as an ASCII char.
Domain Table Subnet ID
Domain Table Node ID
Domain Table Domain ID - length in bytes
Domain Table Domain ID - Byte 1
Domain Table Domain ID - Byte 2
Domain Table Domain ID - Byte 3
Domain Table Domain ID - Byte 4
Domain Table Domain ID - Byte 5
Domain Table Domain ID - Byte 6
Page 48 of 82
FS-8700-21 LonWorks Manual
Appendix C.6. “Illegal” Characters in Network Variable Names
Spaces:
Brackets:
Spaces may not be used in Network Variable Names. The driver automatically replaces all spaces
with underscores at startup.
LonMaker truncates a name from where a bracket is used e.g. a name like nviTest[1]Input shows as
nviTest. Brackets are therefore not able to be used in Network Variable Names.
Appendix C.7. Service types currently supported for network variable messages
The default service type for network variable update messages is fixed to acknowledged service. This can be
changed to unacknowledged service (Section 7.2). Request-response service is used for network variable poll and
network management fetch messages.
Appendix C.8. Combining Explicit and Implicit
To ensure undisturbed communication between the network management tool and the FieldServer during the
commissioning, binding or monitoring processes, the timeouts of the explicitly addressed variables (Map
Descriptors) might need to be set to values lower than the message timeouts used by the network management
tool (LonMaker for Windows).
LonWorks FieldServer Performance
No.
Description
1
FieldServer startup time with 4096 network variables
2
Time to commission FieldServer with 4096 network variables
Time to complete a network variable update between two
3
FieldServers (acknowledged service)
Time to complete a network poll message between two FieldServers
4
(request/response service)
Time to complete a network management variable fetch message
5
between two FieldServers (request/response service)
Page 49 of 82
-
Min
Typ
6.5
-
Max
40
Units
Minutes
Minutes
-
40
-
Milli-seconds
-
125
-
Milli-seconds
-
125
-
Milli-seconds
FS-8700-21 LonWorks Manual
Appendix D. REFERENCE
Appendix D.1. LonMark Profiles
The following FieldServer Platforms are LonMark XIF version 3.4 certified:
FS-B35XX-05
FS-SlotServer
FS-QuickServer-Lon
ProtoCessor-Lon
The following Profiles are certified on LonMark.org.
GATEWAYS
Gateways
®
FS-B3510 Serial/Ethernet/LonWorks Multiport Gateway
ProtoCarrier/ProtoCessor FPC-CD2 Daughter Card Gateway for OEMs
ProtoCessor FPC-F04 Embedded Gateway Module for OEMs
ProtoNode LER External Protocol Gateway for OEMs
®
QuickServer FS-QS-1011 Gateway for LonWorks
HVAC Gateways
®
Liebert SiteLink-12 LonWorks Adapter
Industrial Gateways
®
SlotServer LonWorks Open Interface
HVAC
Boiler Controller
®
Cleaver Brooks Adapter for LonWorks
Discharge Air Controller
®
FieldServer Data Aire DAP Adapter for LonWorks
INDUSTRIAL
Generator Set
FieldServer Caterpillar EMCP II Adapter
FieldServer Kohler 550 Adapter
Page 50 of 82
FS-8700-21 LonWorks Manual
Appendix D.2. Performance Tests for LonMark Certified blocks
Appendix D.2.1. Startup Times, 10 Input Blocks and 10 Output Blocks Totalling 80 NVs
Device
FFPLon/QuickServer
FS-B30
Startup Time
without a
config
48 seconds
57 seconds
1st Startup
Time with
config
193 seconds
63 seconds
Restart
Startup Time
with config
135 seconds
62 seconds
Commission
Time (load
XIF first)
Commission
Time (upload
from dev.)
Appendix D.2.2. Startup Times, 20 Input Blocks and 20 Output Blocks Totalling 160 NVs
Device
FFPLon/QuickServer
FS-B30
Startup Time
without a
config
48 seconds
57 seconds
1st Startup
Time with
config
460 seconds
63 seconds
Restart
Startup Time
with config
306 seconds
62 seconds
Commission
Time (load
XIF first)
260 seconds
Commission
Time (upload
from dev.)
802 seconds
Appendix D.3. SNVT_Type
The following section describes each SNVT as implemented on the FieldServer LonWorks driver.
Data Length – The number of Data Array elements required when specifying a Data Array name under a Map
Descriptor.
Suggested Data Array Formats – This field suggests FieldServer Data Array formats in ascending order of
storage space required while ensuring data integrity. It is not recommended to store a byte value in a bit Data Array
since only the values 0 and 1 will be retained from the byte value resulting in a loss of resolution. If a byte value is
stored in a Floating point Data Array, 3 bytes will go to waste. A SNVT with more than one data item may require a
float Data Array format to prevent loss of resolution. Since FieldServer Map Descriptors can only work with one
type of Data Array format for all the data items in a SNVT, it is sometimes necessary to use a Float Data Array
element for all data items of which some may only have required a Byte. Fortunately, all SNVT’s are short in length
and RAM is adequately provided for on the FieldServer. If a loss in resolution can be tolerated, any Data Array
format may be used.
The range of FieldServer Data Arrays formats are:
Data Array Format
BIT
BYTE
SINT16
UINT16
SINT32
UINT32
FLOAT
Description
1-bit
8-bit Byte
16-bit Signed Integer
16-bit Unsigned Integer
32-bit Signed Integer
32-bit Unsigned Integer
32-bit Float
Values Range
0, 1
0.. 255
-32, 768... 32, 767
0.. 65, 535
-2, 147, 483, 647... 2, 147, 483, 647
0.. 4, 294, 967, 295
-3.40282E38... 3.40282E38
Values Range – These are the only values that will be allowed for the SNVT, e.g. a value of 101 will not be
processed in a read or write on SNVT_Switch’s Value data item.
Page 51 of 82
FS-8700-21 LonWorks Manual
Invalid Value – The Invalid value is used to force the data item’s value should a value outside the value range be
encountered in a read or write. Should the invalid value be N/A ( Not Applicable ), the data item’s value will be
bounded by the indicated values range, e.g. an incoming read value of 101 will be stored as 100 for SNVT_Switch’s
Value data item. Note that in some cases both the type and raw values are specified. Raw values are not of the
same type of the SNVT’s measurement type, i.e. they are not scaled.
Data Item – SNVT’s containing more than one data item have a name specified for each item. This name can be
used in the SNVT_Option field of a Map Descriptor to isolate only this one item.
SNVT_abs_humid
SNVT_address
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Absolute humidity
gram/kilogram
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Neuron Chip Address
16-bit address value
Data Length
Suggested Data Array Formats
1
Float
Values Range
0.. 655.34
Invalid Value
Raw:
65,535
Type: 655.35
1
Uint16, Float
Values Range
16,384 .. 64,767
Units
Values Range
Invalid Value
N/A
25
Uint16, Float
Alm_Location00,
..Alm_Location05
Invalid Value
8-bit unsigned byte
0 .. 255
N/A
Data Item 1-6
SNVT_alarm
Measurement
Location
element
Data Item 7
Measurement
Object ID
Data Item 8
Measurement
alarm_type_t
Data Item 9
Measurement
Priority_level_t
Data Item 10
Measurement
array
Index to NV
Data Item 11-14
Measurement
Value array element
Data Item 15
Measurement
Year
Data Item 16
Measurement
Month
Data Item 17
Measurement
Day
Units
object index
Values Range
0 .. 65,535
Units
N/A
Values Range
0 .. 254
Units
N/A
Values Range
0 .. 11
Units
Values Range
index of NV causing
0 .. 65,535
alarm
Units
specific to NVT
Values Range
0 .. 255
Units
year
Values Range
0 .. 3000
Units
month of year
Values Range
0 ..12
Units
day of month
Values Range
0 ..31
Page 52 of 82
(0xFFFF)
Object_ID
Invalid Value
N/A
Alarm_type
Invalid Value
255 (0xFF)(AL_NUL)
Priority_level
Invalid Value
255 (0xFF)(PR_NUL)
Index_to_SNVT
Invalid Value
N/A
Alm_Value00, ..Alm_Value03
Invalid Value
N/A
Year
Invalid Value
N/A
Month
Invalid Value
N/A
Day
Invalid Value
N/A
FS-8700-21 LonWorks Manual
SNVT_alarm_2
SNVT_amp
SNVT_amp_ac
SNVT_amp_f
Data Item 18
Measurement
Units
Hour
Hour of day
Data Item 19
Measurement
Units
Minute
Minutes
Data Item 20
Measurement
Units
Second
Seconds
Data Item 21
Measurement
Units
Millisecond
Milliseconds
Data Item 22-25
Measurement
Units
Alarm
limit
array
specific to NVT
element
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
alarm_type_t
N/A
Data Item 2
Measurement
Units
Priority_level_t
N/A
Data Item 3
Measurement
Units
time
seconds
Data Item 4
Measurement
Units
Millisecond
Milliseconds
Data Item 5
Measurement
Units
Number
Milliseconds
Data Item 6-27
Measurement
Units
ASCII character string N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric current
Amperes
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Alternating
electric Amperes
current
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Page 53 of 82
Values Range
Hour
Invalid Value
N/A
Minute
Invalid Value
N/A
Second
Invalid Value
N/A
Millisecond
Invalid Value
N/A
Alm_limit00, ..Alm_limit03
Invalid Value
0 .. 255
N/A
Values Range
0 ..23
Values Range
0 ..59
Values Range
0 ..59
Values Range
0 ..999
Values Range
0 .. 32
Values Range
0 .. 11
Values Range
0 .. 4,294,967,294
Values Range
0 .. 999
Values Range
0 .. 255
Values Range
0 .. 255
27
Uint32
Alarm_type
Invalid Value
255 (0xFF)(AL_NUL)
Priority_level
Invalid Value
255 (0xFF)(PR_NUL)
Alarm_time
Invalid Value
4,294,967,295 (0xFFFFFFFF)
milliseconds
Invalid Value
-1 (0xFFFF)
Sequence_number
Invalid Value
N/A
description
Invalid Value
N/A
1
Float
Values Range
Invalid Value
-3,276.8... 3,276.7 N/A
1
Uint16, Float
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
1
Float
Values Range
Invalid Value
FS-8700-21 LonWorks Manual
Electric current
SNVT_amp_mil
SNVT_angle
SNVT_angle_deg
SNVT_angle_f
SNVT_angle_vel
SNVT_angle_vel_f
SNVT_area
SNVT_btu_f
SNVT_btu_kilo
Amperes
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric current
Milli-amperes
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Phase/Rotation
Radians
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Angular distance
degrees
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Phase/Rotation
Radians
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Angular velocity
Radians/second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Angular Velocity
Radians/Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Area
Square meters (m²)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Thermal Energy
British Thermal Units
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Thermal Energy
Kilo-British
Thermal
Units
Page 54 of 82
-3.40282E38
3.40282E38
.. N/A
1
Float
Values Range
-3,276.8.. 3,276.7
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65.535
Invalid Value
N/A
1
Float
Values Range
-359.98 .. 360.00
Invalid Value
Type: 655.34 Raw: 32,767
(0x7FFF)
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Float
Values Range
Invalid Value
-3,276.8 .. 3,276.7 N/A
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Float
Values Range
0 .. 13.1068
Invalid Value
Type: 13.107
(65,535)
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
Raw: 0xFFFF
FS-8700-21 LonWorks Manual
SNVT_btu_mega
SNVT_char_ascii
SNVT_chlr_status
SNVT_color
SNVT_config_src
SNVT_count
SNVT_count_f
SNVT_count_inc
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Thermal Energy
Mega-British Thermal
Units
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Character
8-bit ASCII Character
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Byte, Uint16, Float
8-bit ASCII Character
Data Item 2
Measurement
Units
hvac_t
N/A
Data Item 3
Measurement
Units
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Lightness
Lightness
Data Item 2
Measurement
Units
Redness/Greenness
Redness/Greenness
Data Item 3
Measurement
Units
Yellowness/Blueness
Yellowness/Blueness
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Config_source_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Event Count
Count
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Event Count
Count
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Page 55 of 82
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 255
Values Range
0 .. 255
Values Range
0 .. 17
Values Range
0 .. 255
Values Range
0.0 .. 100.0
Values Range
-200.0 .. 200.0
Values Range
-200.0 .. 200.0
Invalid Value
N/A
3
Byte, Uint16, Float
chlr_run_mode
Invalid Value
N/A
chlr_op_mode
Invalid Value
255 (0xFF)(HVAC_NUL)
chlr_state
Invalid Value
N/A
3
Float
L_star
Invalid Value
N/A
a_star
Invalid Value
N/A
b_star
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 1
Invalid Value
255 (0xFF)(CFG_NUL)
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Sint16, Float
Values Range
Invalid Value
FS-8700-21 LonWorks Manual
SNVT_count_inc_f
SNVT_ctrl_req
SNVT_ctrl_resp
SNVT_currency
SNVT_date_day
Incremental Count
Count
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Incremental Count
Count
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Receiver ID
ID number
Data Item 2
Measurement
Units
Sender ID
ID number
Data Item 3
Measurement
Units
Sender priority
Priority value
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
control_resp_t
N/A
Data Item 2
Measurement
Units
Sender ID
ID number
Data Item 3
Measurement
Units
Sender Range Lower ID number
ID
Data Item 4
Measurement
Units
ctl_rsp_snd_rupper
ID number
Data Item 5
Measurement
Units
Controller ID
ID number
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Currency_t
N/A
Data Item 2
Measurement
Units
Magnitude
Power of 10
Data Item 3
Measurement
Units
Value
Currency Value
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
days_of_week_t
N/A
Page 56 of 82
-32,768 .. 32,767
Values Range
-3.40282E38
3.40282E38
Values Range
1 .. 65,535
Values Range
1 .. 65,534
Values Range
0 .. 200
Values Range
0 .. 5
Values Range
1 .. 65,534
Values Range
1 .. 65,534
N/A
1
Float
Invalid Value
.. N/A
3
Uint16, Float
ctl_req_rcvr_id
Invalid Value
0
ctl_req_sndr_id
Invalid Value
65,535 (0xFFFF)
ctl_req_sndr_pri
Invalid Value
N/A
5
Uint16, Float
ctl_rsp_status
Invalid Value
255 (0xFF)(CTRLR_NUL)
ctl_rsp_snd_id
Invalid Value
65,535 (0xFFFF)
ctl_rsp_snd_rlower
Invalid Value
65,535 (0xFFFF)
ctl_rsp_snd_rupper
Invalid Value
65,535 (0xFFFF)
ctl_rsp_cntrl_id
Values Range
Invalid Value
1 .. 65,534
65,535 (0xFFFF)
3
Sint32
Currency
Values Range
Invalid Value
0 .. 56
255 (0xFF)(CU_NUL)
Power_of_10
Values Range
Invalid Value
-128 .. 127
N/A
Currency_Value
Values Range
Invalid Value
-2,147,483,648 .. N/A
2,147,483,647
1
Byte, Uint16, Float
Values Range
1 .. 65,534
Values Range
0 .. 6
Invalid Value
255 (0xFF)
FS-8700-21 LonWorks Manual
SNVT_defr_mode
SNVT_defr_state
SNVT_defr_term
SNVT_density
SNVT_density_f
SNVT_dev_c_mode
SNVT_earth_pos
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
defrost_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
defrost_state_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
defrost_term_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Density
Kg/m³: kilograms per
cubic meter
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Density
Kilograms per Cubic
Meter (kg/m³)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
device_c_mode_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Latitude/Longitude
Direction
Data Item 2
Measurement
Units
Latitude degrees
Degrees
Data Item 3
Measurement
Units
Latitude Minutes
Minutes
Data Item 4
Measurement
Longitude Degrees
Data Item 5
Measurement
Longitude Minutes
1
Byte, Uint16, Float
Values Range
0 .. 2
Invalid Value
255
(0xFF)(DFM_MODE_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 4
Invalid Value
255 (0xFF)(DFS_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 100
Invalid Value
255 (0xFF)(DFT_NUL)
1
Float
Values Range
0 .. 32,767.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
1
Byte, Uint16, Float
Values Range
0 .. 29
Values Range
0 .. 255
Values Range
1 .. 90
Values Range
1 .. 59.999
Units
Degrees
Values Range
1 ..180
Units
Minutes
Values Range
1 .. 59.999
Page 57 of 82
Invalid Value
N/A
Invalid Value
255 (0xFF)(DCM_NUL)
6
Float
epos_dir_bits
Invalid Value
N/A
epos_lat_degs
Invalid Value
255 (0xFF)
epos_lat_mins
Invalid Value
Raw:
65,535
(0xFFFF)
Type: 65.535
epos_long_degs
Invalid Value
255 (0xFF)
epos_long_mins
Invalid Value
Raw:
65,535
(0xFFFF)
Type: 65.535
FS-8700-21 LonWorks Manual
SNVT_elapsed_tm
SNVT_elec_kwh
SNVT_elec_kwh_l
SNVT_elec_whr
SNVT_elec_whr_f
SNVT_enthalpy
SNVT_evap_state
Data Item 6
Measurement
Units
Height Above Sea Meters (m)
Level
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Days
Days
Data Item 2
Measurement
Units
Hours
Hours
Data Item 3
Measurement
Units
Minutes
Minutes
Data Item 4
Measurement
Units
Seconds
Seconds
Data Item 5
Measurement
Units
Milliseconds
Milliseconds
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electrical energy
Kilowatt-hours
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electricity
Kilowatt-hour
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric energy
Watt-hours
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Energy
Watt-hour
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Enthalpy
KiloJoules
Kilogram kJ/kg
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
evap_t
N/A
Page 58 of 82
Values Range
-3.40282E38
3.40282E38
Values Range
0 .. 65,534
Values Range
0 .. 23
Values Range
0 .. 59
Values Range
0 .. 59
Values Range
0 .. 999
epos_htabv_sea
Invalid Value
.. N/A
5
Uint16, Float
etm_day
Invalid Value
65,535 (0xFFFF)
etm_hour
Invalid Value
N/A
etm_minute
Invalid Value
N/A
etm_second
Invalid Value
N/A
etm_millisecond
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Sint32
Values Range
-214,748,364.8
..214,748,364.6
Invalid Value
-214,748,364.7
(0x7FFFFFFF)
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
per -327.68 .. 327.66
Values Range
0 .. 2
Invalid Value
Raw:
32,767
(0x7FFF)
Type: 327.67
1
Byte, Uint16, Float
Invalid Value
255 (0xFF)(EVAP_NUL)
FS-8700-21 LonWorks Manual
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
ex_control_t
N/A
Values Range
0 .. 2
Data Item 2-7
SNVT_ex_control
SNVT_file_pos
SNVT_file_req (only
raw data supported)
SNVT_file_status
(only raw data
supported)
SNVT_fire_indcte
SNVT_fire_init
SNVT_fire_test
SNVT_flow
Measurement
Units
Domain ID
Byte
Data Item 8
Measurement
Units
Domain length
Number of bytes
Data Item 9
Measurement
Units
Subnet
Subnet number
Data Item 10
Measurement
Units
Node
Node number
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Read/Write Pointer
File Byte Address
Data Item 2
Measurement
Units
Read/Write Length
Number of Bytes
Data Length
Suggested Data Array Formats
Data Length
Suggested Data Array Formats
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
fire_indicator_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
fire_initiator_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
fire_test_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Flow volume
Liters/Second
Page 59 of 82
Values Range
0 .. 255
Values Range
0 .. 6
Values Range
1 .. 255
Values Range
1 .. 127
Values Range
0 .. 2,147,483,647
Values Range
0 .. 65,535
10
Byte, Uint16, Float
ex_ctrl_status
Invalid Value
255
(0xFF)(EX_CONTROL_NUL)
ex_ctrl_domid_0,
..ex_ctrl_domid_5
Invalid Value
N/A
ex_ctrl_domid_len
Invalid Value
N/A
ex_ctrl_subnet
Invalid Value
N/A
ex_ctrl_node
Invalid Value
N/A
2
Uint32
ops_rw_ptr
Invalid Value
N/A
ops_rw_len
Invalid Value
N/A
12
Byte
27
Byte
1
Byte, Uint16, Float
Values Range
0 .. 8
Invalid Value
255 (0xFF)(FN_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 16
Invalid Value
255 (0xFF)(FI_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 3
Invalid Value
255 (0xFF)(FT_NUL)
1
Uint16, Float
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
FS-8700-21 LonWorks Manual
SNVT_flow_f
SNVT_flow_mil
SNVT_flow_p
SNVT_freq_f
SNVT_freq_hz
SNVT_freq_kilohz
SNVT_freq_milhz
SNVT_gfci_status
SNVT_grammage
SNVT_grammage_f
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Flow Volume
Liters/Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Flow volume
Milliliters/Second
(ml/s)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Flow volume
Cubic metres per hour
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Frequency
Hertz
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Frequency
Hertz
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Frequency
Kilohertz
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Frequency
Hertz
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
gfci_status_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Grammage
Grams/Square-meter
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Page 60 of 82
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Float
Values Range
0 .. 655.34
Invalid Value
Raw:
65,535
Type: 655.35
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6.5535
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 5
Invalid Value
255 (0xFF)(GFCI_NUL)
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
Invalid Value
(0xFFFF)
FS-8700-21 LonWorks Manual
SNVT_hvac_emerg
SNVT_hvac_mode
SNVT_hvac_overid
Grammage
Grams/Square-meter
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
emerg_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Hvac_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
hvac_overid_t
N/A
Data Item 2
Measurement
Units
Percent
Percent of Full Scale
Data Item 3
Measurement
Units
Flow
Liters per Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
hvac_t
N/A
Data Item 2
Measurement
Units
Primary Heat Output
Percent of Full Scale
SNVT_hvac_status
SNVT_hvac_type
0 .. 3.40282E38
N/A
1
Byte, Uint16, Float
Values Range
0 .. 5
Invalid Value
255 (0xFF)(EMERG_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 17
Invalid Value
255 (0xFF)(HVAC_NUL)
3
Float
hvac_ord_state
Invalid Value
255 (0xFF)(HVO_NUL)
hvac_ord_percent
Invalid Value
Type: 163.835 Raw: 32,767
(0x7FFF)
hvac_ord_flow
Invalid Value
65,535 (0xFFF)
7
Float
hvac_sts_mode
Invalid Value
255 (0xFF)(HV_NUL)
hvac_heat_out_pri
Invalid Value
Type: 163.835 Raw: 32,767
(0x7FFF)
hvac_heat_out_sec
Invalid Value
Type: 163.835 Raw: 32,767
(0x7FFF)
hvac_cool_out
Invalid Value
Type: 163.835 Raw: 32,767
(0x7FFF)
hvac_econ_out
Invalid Value
Type: 163.835
Raw:
32,767 (0x7FFF)
hvac_fan_out
Invalid Value
Type: 163.835 Raw: 32,767
(0x7FFF)
hvac_in_alarm
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 48
Values Range
-163.840
163.830
..
Values Range
0 .. 65,534
Values Range
0 .. 17
Values Range
-163.840
163.830
..
Units
Heat Percent of Full Scale
Values Range
-163.840
163.830
..
Units
Percent of Full Scale
Values Range
-163.840
163.830
..
Data Item 5
Measurement
Economizer Output
Units
Percent of Full Scale
Values Range
-163.840
163.830
..
Data Item 6
Measurement
Fan Output
Units
Percent of Full Scale
Values Range
-163.840
163.830
..
Data Item 3
Measurement
Secondary
Output
Data Item 4
Measurement
Cooling Output
Data Item 7
Measurement
Units
In Alarm State
Alarm value
Data Length
Suggested Data Array Formats
Page 61 of 82
Values Range
0 .. 1
FS-8700-21 LonWorks Manual
SNVT_length
SNVT_length_f
SNVT_length_kilo
SNVT_length_micr
SNVT_length_mil
SNVT_lev_cont
SNVT_lev_cont_f
SNVT_lev_disc
SNVT_lev_percent
SNVT_lux
Data Item 1
Measurement
Units
Hvac_hvt_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Length
Meters (m)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Length
Meters
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Length
Kilometers (km)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Length
Micrometers, Microns
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Length
Millimeters (mm)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Continuous Level
Percent of Full Level
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Continuous Level
Percent of Full Scale
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Discrete_levels_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Percentage Level
Percent of Full Scale,
or Parts-per Million
(ppm)
Data Length
Suggested Data Array Formats
Page 62 of 82
Values Range
0 .. 9
Invalid Value
255 (0xFF)(HVT_NUL)
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 100.0
Invalid Value
N/A
1
Float
Values Range
0 .. 100
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 4
Invalid Value
255 (0xFF)(ST_NUL)
1
Float
Values Range
-163.840
163.830
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
1
Uint16, Float
Raw:
FS-8700-21 LonWorks Manual
SNVT_magcard
(only raw data
supported)
SNVT_mass
SNVT_mass_f
SNVT_mass_kilo
SNVT_mass_mega
SNVT_mass_mil
SNVT_motor_state
SNVT_mul_div
SNVT_multiplier
SNVT_nv_type
Data Item 1
Measurement
Units
Illumination
Lux
Data Length
Suggested Data Array Formats
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Mass
Grams
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Mass
Grams
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Mass
Kilograms (kg)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Mass
Metric Tons; Tonne
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Mass
Milligrams (mg)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
motor_state_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Multiplier
N/A
Data Item 2
Measurement
Units
Divisor
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Multiplier
N/A
Data Length
Suggested Data Array Formats
Data Item 1-8
Page 63 of 82
Values Range
0 .. 65,535
Invalid Value
N/A
20
Byte
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 7
Invalid Value
255 (0xFF)(MOTOR_NUL)
2
Uint16, Float
Multiplier
Invalid Value
N/A
Divisor
Invalid Value
0
1
Float
Values Range
0 .. 65,535
Values Range
1 .. 65,535
Values Range
0 .. 32.7675
Invalid Value
N/A
15
Byte, Uint16, Float
nv_type_pid0, ..nv_type_pid7
FS-8700-21 LonWorks Manual
SNVT_obj_request
SNVT_obj_status
SNVT_occupancy
SNVT_override
SNVT_pH
Measurement
Units
Program ID
N/A
Data Item 9
Measurement
Units
Scope
N/A
Data Item 10
Measurement
Units
Type index
N/A
Data Item 11
Measurement
Units
nv_type_category_t
N/A
Data Item 12
Measurement
Units
Type length
Bytes
Data Item 13
Measurement
Units
Scaling multiplier
N/A
Data Item 14
Measurement
Units
Scaling exponent
N/A
Data Item 15
Measurement
Units
Scaling offset
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
obj_request_id
File Byte Address
Data Item 2
Measurement
Units
object_request_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Functional Block ID
N/A
Data Item 2
Measurement
Units
object_status_bits
Bits
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Occup_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
override_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Page 64 of 82
Values Range
0 .. 255
Values Range
0 .. 6
Values Range
1 .. 65,535
Values Range
1 .. 14
Values Range
1 .. 31
Values Range
-32,768 .. 32,766
Values Range
-32,768 .. 32,766
Values Range
-32,768 .. 32,766
Values Range
0 .. 2,147,483,647
Values Range
0 .. 17
Values Range
0 .. 65,535
Values Range
0 .. 4,294,967,295
Invalid Value
N/A
nv_type_scope
Invalid Value
N/A
nv_type_index
Invalid Value
0
nv_type_cat
Invalid Value
255 (0xFF)(NVT_CAT_NUL)
nv_type_length
Invalid Value
0
nv_type_scale_a
Invalid Value
32,767
nv_type_scale_b
Invalid Value
32,767
nv_type_scale_c
Invalid Value
32,767
2
Uint16, Float
obj_request_id
Invalid Value
N/A
obj_request
Invalid Value
255 (0xFF)(RQ_NUL)
2
Uint32
obj_status_id
Invalid Value
N/A
obj_status_bits
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 3
Invalid Value
255 (0xFF)(OC_NUL)
1
Byte, Uint16, Float
Values Range
0 .. 2
Invalid Value
255 (0xFF)(OV_NUL)
1
Float
Values Range
Invalid Value
FS-8700-21 LonWorks Manual
SNVT_pH_f
SNVT_pos_ctrl
SNVT_power
SNVT_power_f
SNVT_power_kilo
Acidity
pH
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Acidity
pH
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Receiver ID
ID number
Data Item 2
Measurement
Units
Controller ID
ID number
Data Item 3
Measurement
Units
Controller priority
Priority value
Data Item 4
Measurement
Units
cam_func_t
N/A
Data Item 5
Measurement
Units
cam_act_t
N/A
Data Item 6
Measurement
Units
Action number
Action number
Data Item 7
Measurement
Units
Pan position
Degrees
-32.768 .. 32.767
Values Range
-3.40282E38
3.40282E38
N/A
1
Float
Invalid Value
.. N/A
9
Float
pos_ctrl_rcvr_id
Values Range
Invalid Value
1 .. 65,535
0
pos_ctrl_cntrl_id
Values Range
Invalid Value
1 .. 65,534
65,535 (0xFFFF)
pos_ctrl_cntrl_prio
Values Range
Invalid Value
0 .. 200
N/A
pos_ctrl_function
Values Range
Invalid Value
0 .. 2
255 (0xFF)(CMF_NUL)
pos_ctrl_action
Values Range
Invalid Value
0 .. 2
255 (0xFF)(CMA_NUL)
pos_ctrl_number
Values Range
Invalid Value
1 .. 255
0
pos_ctrl_pan
Values Range
Invalid Value
-359.98 .. 360.00
Raw:
32,767
(0x7FFF)
Type: 655.34
Data Item 8
pos_ctrl_tilt
Measurement
Units
Values Range
Invalid Value
Tilt position
Degrees
-359.98 .. 360.00
Raw:
32,767
(0x7FFF)
Type: 655.34
Data Item 9
pos_ctrl_zoom
Measurement
Units
Values Range
Invalid Value
Zoom position
Percent of full-scale or -163.840
.. Raw:
32,767
(0x7FFF)
ppm
163.830
Type: 163.835
Data Length
1
Suggested Data Array Formats
Float
Data Item 1
Measurement
Units
Values Range
Invalid Value
Power
Watts (W)
0 .. 6,553.5
N/A
Data Length
1
Suggested Data Array Formats
Float
Data Item 1
Measurement
Units
Values Range
Invalid Value
Power
Watts
-3.40282E38
.. N/A
3.40282E38
Data Length
1
Suggested Data Array Formats
Float
Data Item 1
Page 65 of 82
FS-8700-21 LonWorks Manual
SNVT_ppm
SNVT_ppm_f
Measurement
Units
Power
KiloWatts
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Concentration
Parts per Million (ppm)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Concentration
Parts per Million
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
learn_mode_t
N/A
Data Item 2
Measurement
Units
Selector
N/A
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
11
Uint16, Float
preset_learn
Invalid Value
255 (0xFF)(LN_NUL)
preset_selector
Invalid Value
N/A
preset_value00,
..preset_value03
Invalid Value
N/A
preset_day
Invalid Value
65,535 (0xFFFF)
preset_hour
Invalid Value
N/A
preset_minute
Invalid Value
N/A
preset_second
Invalid Value
N/A
preset_millisec
Invalid Value
N/A
1
Float
Values Range
0 .. 3
Values Range
0 .. 65,535
Data Item 3-6
SNVT_preset
SNVT_press
SNVT_press_f
SNVT_press_p
Measurement
Units
Value
Specific to SNVT
Data Item 7
Measurement
Units
Days
Days
Data Item 8
Measurement
Units
Hours
Hour
Data Item 9
Measurement
Units
Minutes
Minutes
Data Item 10
Measurement
Units
Seconds
Seconds
Data Item 11
Measurement
Units
Milliseconds
Milliseconds
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Pressure (gauge)
KiloPascals
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Pressure (gauge)
Pascals
Data Length
Suggested Data Array Formats
Page 66 of 82
Values Range
0 .. 255
Values Range
0 .. 65,534
Values Range
0 .. 23
Values Range
0 .. 59
Values Range
0 .. 59
Values Range
0 .. 999
Values Range
Invalid Value
-3,276.8 .. 3,276.6 Type: 3,276.7
32,767 (0x7FFF)
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Sint16, Float
Raw:
FS-8700-21 LonWorks Manual
SNVT_privacyzone
SNVT_ptz
SNVT_pump_sensor
Data Item 1
Measurement
Units
Pressure (gauge)
Pascals
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
privacyzone_t
N/A
Data Item 2
Measurement
Units
Zone number
Privacy zone number
Data Item 3
Measurement
Units
Camera ID
ID number
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
ptz_pan_dir
Direction
Data Item 2
Measurement
Units
Pan speed
Percent of full level
Data Item 3
Measurement
Units
tilt_dir_t
N/A
Data Item 4
Measurement
Units
Tilt speed
Percent of full level
Data Item 5
Measurement
Units
zoom_t
N/A
Data Item 6
Measurement
Units
ptz_zoom_speed
Meters (m)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Frequency
Hertz
Data Item 2
Measurement
Units
Body temperature
Degrees celcius
Data Item 3
Measurement
Units
Motor
external Degrees celcius
temperature
Data Item 4
Measurement
Units
Motor
internal Degrees celcius
temperature
Data Item 5
Page 67 of 82
Values Range
-32,768 .. 32,766
Values Range
0 .. 5
Values Range
1 .. 255
Values Range
1 .. 65,535
Values Range
0 .. 255
Values Range
0.0 .. 100.0
Values Range
0 .. 2
Values Range
0.0 .. 100.0
Values Range
0 .. 2
Values Range
-3.40282E38
3.40282E38
Invalid Value
32,767 (0x7FFF)
3
Uint16, Float
priv_zn_action
Invalid Value
255 (0xFF)(PZ_NUL)
priv_zn_number
Invalid Value
0
priv_zn_camera_id
Invalid Value
0
6
Float
ptz_pan_dir
Invalid Value
N/A
ptz_pan_speed
Invalid Value
N/A
ptz_tilt_dir
Invalid Value
255 (0xFF)(TILT_NUL)
ptz_tilt_speed
Invalid Value
N/A
ptz_zoom
Invalid Value
255 (0xFF)(ZOOM_NUL)
ptz_zoom_speed
Invalid Value
.. N/A
Values Range
-274.0 .. 6,279.4
13
Float
pump_sn_rot_speed
Invalid Value
N/A
pump_sn_body_temp
Invalid Value
N/A
pump_sn_mot_ext_temp
Invalid Value
N/A
Values Range
-274.0 .. 6,279.4
pump_sn_mot_int_temp
Invalid Value
N/A
Values Range
0 .. 6,553.4
Values Range
-274.0 .. 6,279.4
pump_sn_mot_overload
FS-8700-21 LonWorks Manual
Measurement
Boolean
Data Item 6
Measurement
Boolean
Data Item 7
Measurement
Boolean
Data Item 8
Measurement
Electric current usage
Data Item 9
Measurement
Power usage
Data Item 10
Measurement
unit_temp_t
Data Item 11
Measurement
Boolean
Data Item 12
Measurement
Boolean
Data Item 13
Measurement
Boolean
Units
Bit
Units
Bit
Units
Bit
Units
Ampere
Units
Kilowatts
Units
N/A
Units
Bit
Units
Bit
Units
Bit
Page 68 of 82
Values Range
0, 1
Invalid Value
255 (0xFF)(BOOL_NUL)
pump_sn_oil_low
Values Range
Invalid Value
0, 1
255 (0xFF)(BOOL_NUL)
pump_sn_ph_imbal
Values Range
Invalid Value
0, 1
255 (0xFF)(BOOL_NUL)
pump_sn_curr_use
Values Range
Invalid Value
-3,276.8 .. 3,276.6 N/A
pump_sn_pwr_usage
Values Range
Invalid Value
0 .. 6,553.4
N/A
pump_sn_temp_ctrl
Values Range
Invalid Value
0 .. 3
255 (0xFF)(TEMP_NUL)
pump_sn_em_brake_act
Values Range
Invalid Value
0, 1
255 (0xFF)(BOOL_NUL)
pump_sn_fric_brk_act
Values Range
Invalid Value
0, 1
255 (0xFF)(BOOL_NUL)
pump_sn_gas_brk_act
Values Range
Invalid Value
0, 1
255 (0xFF)(BOOL_NUL)
FS-8700-21 LonWorks Manual
SNVT_pumpset_mn
SNVT_pumpset_sn
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
motor_state_t
N/A
Data Item 2
Measurement
Units
motor_state_t
N/A
Data Item 3
Measurement
Units
priority_level_t
N/A
Data Item 4
Measurement
Units
Boolean_t
Bit
Data Item 5
Measurement
Units
Boolean_t
Bit
Data Item 6
Measurement
Units
Boolean_t
Bit
Data Item 7
Measurement
Units
Boolean_t
Bit
Data Item 8
Measurement
Units
Boolean_t
Bit
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Total Dilution Flow Milliliters per second
Volume
Data Item 2
Measurement
Units
Exhaust Temperature Degrees Celcius
Data Item 3
Measurement
Units
Exhaust Pressure
Kilo-pascals
Data Item 4
Measurement
Units
Shaft
seal
purge Kilo-pascals
pressure
Data Item 5
Measurement
Units
Inlet vacuum pressure Kilo-pascals
Data Item 6
Measurement
Supply voltage
Data Item 7
Measurement
Total coolant flow
Data Item 8
Units
Volts
Units
Milliliters per second
Page 69 of 82
Values Range
0 .. 7
Values Range
0 .. 7
Values Range
0 .. 11
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0 .. 65,534
8
Byte, Uint16, Float
pset_main_pump
Invalid Value
255 (0xFF)(MOTOR_NUL)
pset_booster_pump
Invalid Value
255 (0xFF)(MOTOR_NUL)
pset_prio_level
Invalid Value
255 (0xFF)(PR_NUL)
pset_process_ready
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_emerg_stop
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_main_pumpd_ena
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_boost_pumpd_ena
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_maint_req
Invalid Value
255 (0xFF)(BOOL_NUL)
14
Float
pset_sn_dil_flow
Invalid Value
N/A
pset_sn_exh_temp
Invalid Value
N/A
pset_sn_exh_press
Values Range
Invalid Value
-3,276.8 .. 3,276.6 N/A
pset_sn_seal_press
Values Range
Invalid Value
-3,276.8 .. 3,276.6 N/A
Values Range
-274.0 .. 6,279.4
Values Range
-3.40282E38
3.40282E38
pset_sn_inlet_vacuum
Invalid Value
.. N/A
pset_sn_supply_volts
Values Range
Invalid Value
-3,276.8 .. 3,276.6 N/A
pset_sn_cool_flow
Values Range
Invalid Value
0 .. 65,534
N/A
pset_sn_cool_fl_low
FS-8700-21 LonWorks Manual
SNVT_pwr_fact
SNVT_pwr_fact_f
SNVT_reg_val
SNVT_reg_val_ts
Measurement
Units
Boolean
Bit
Data Item 9
Measurement
Units
Boolean
Bit
Data Item 10
Measurement
Units
Boolean
Bit
Data Item 11
Measurement
Units
Boolean
Bit
Data Item 12
Measurement
Units
Boolean
Bit
Data Item 13
Measurement
Units
Boolean
Bit
Data Item 14
Measurement
Units
Boolean
Bit
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Power Factor
Multiplier
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Power Factor
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Raw value
Defined by unit field
Data Item 2
Measurement
reg_val_unit_t
Data Item 3
Measurement
Decimal Place
Units
N/A
Units
Digits to Right
Decimal Point
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Raw Value
Data Item 2
Measurement
Units
Page 70 of 82
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
0, 1
Values Range
-1.00000
1.00000
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_dil_active
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_bal_dil_act
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_inl_p_dil_act
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_exh_dil_act
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_dil_fl_oor
Invalid Value
255 (0xFF)(BOOL_NUL)
pset_sn_pwr_sup_on
Invalid Value
255 (0xFF)(BOOL_NUL)
1
Float
Invalid Value
.. N/A
1
Float
Values Range
-1 .. 1
Invalid Value
N/A
3
Sint32
reg_val_value
Values Range
Invalid Value
-2,147,483,638 .. N/A
2,147,483,647
reg_val_unit
Values Range
Invalid Value
0 .. 43
255 (0xFF)(RVU_NUL)
reg_val_decimals
Values Range
Invalid Value
of 0 ..7
N/A
9
Sint32
reg_val_ts_raw
Values Range
Invalid Value
-2,147,483,648 .. N/A
2,147,483,647
reg_val_ts_unit
Values Range
Invalid Value
FS-8700-21 LonWorks Manual
SNVT_res
SNVT_res_f
SNVT_res_kilo
SNVT_rpm
SNVT_sblnd_state
reg_val_unit_t
N/A
Data Item 3
Measurement
Units
See SNVT tables
See SNVT tables
Data Item 4
Measurement
Units
Year
Year
Data Item 5
Measurement
Units
Month
Month of Year
Data Item 6
Measurement
Units
Day
Day of Month
Data Item 7
Measurement
Units
Hour
Hour of day
Data Item 8
Measurement
Units
Minutes
Minute of Hour
Data Item 9
Measurement
Units
Minutes
Minute of Hour
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electrical Resistance
Ohms
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electrical Resistance
Ohms
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electrical Resistance
KiloOhms
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Angular Velocity
Revolutions per Minute
(RPM)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
setting_t
N/A
Data Item 2
Measurement
Units
Scene setting Level
Percent of Full Level
Page 71 of 82
0 .. 43
Values Range
0 .. 255
Values Range
0 .. 300
Values Range
0 .. 12
Values Range
0 .. 31
Values Range
0 .. 23
Values Range
0 .. 59
Values Range
0 .. 59
255 (0xFF)(RVU_NUL)
reg_val_ts_bits
Invalid Value
N/A
reg_val_ts_year
Invalid Value
N/A
reg_val_ts_month
Invalid Value
N/A
reg_val_ts_day
Invalid Value
N/A
reg_val_ts_hour
Invalid Value
N/A
reg_val_ts_min
Invalid Value
N/A
reg_val_ts_secs
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
Values Range
0 .. 5
5
Float
function
Invalid Value
255 (SET_NUL)
setting
Invalid Value
N/A
Values Range
0 .. 100
FS-8700-21 LonWorks Manual
SNVT_scene
SNVT_scene_cfg
SNVT_setting
Data Item 3
Measurement
Units
Rotation Angle
Degrees
Data Item 4
Measurement
Units
sblnd_cmd_source_t
N/A
Data Item 5
Measurement
Units
sblnd_error_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Scene_t
N/A
Data Item 2
Measurement
Units
Scene Number
Scene Number
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
scene_config_t
N/A
Data Item 2
Measurement
Units
Scene Number
Scene Number
Data Item 3
Measurement
Units
Scene Setting Level
Percent of Full Level
Data Item 4
Measurement
Units
Scene Rotation Angle Degrees
Values Range
-359.98 .. 360.00
Values Range
0 .. 127
Values Range
0 .. 14
Values Range
0 .. 23
Values Range
1 .. 255
Values Range
0 .. 4
Values Range
1 .. 255
Values Range
0 .. 100.0
Values Range
-359.98 .. 360.00
Data Item 5
Measurement
Scene Fade Time
Units
Seconds
Values Range
0.0 to 6,553.4
Data Item 6
Measurement
Scene Delay Time
Units
Seconds
Values Range
0.0 to 6,553.4
Data Item 7
Measurement
Units
Scene Priority
Priority Value
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
setting_t
N/A
Data Item 2
Measurement
Units
Scene Setting Level
Percent of Full Level
Data Item 3
Measurement
Units
Page 72 of 82
Values Range
0 .. 255
Values Range
0 .. 5
Values Range
0 .. 100.0
Values Range
rotation
Invalid Value
32,767 (0x7FFF)
cmd_source
Invalid Value
-1 (0xFF)
error_code
Invalid Value
-1 (0xFF)
2
Byte, Uint16, Float
Function
Invalid Value
255 (0xFF)(SC_NUL)
Scene_Number
Invalid Value
N/A
7
Float
scn_cfg_func
Invalid Value
255 (0xFF)(SCF_NUL)
scn_cfg_scene
Invalid Value
N/A
scn_cfg_setting
Invalid Value
N/A
scn_cfg_rotation
Invalid Value
Raw:
32,767
(0x7FFF)
Type: 655.34
scn_cfg_fade_tim
Invalid Value
Raw:
65,535
(0xFFFF)
Type: 6553.5
scn_cfg_dly_tim
Invalid Value
Raw:
65,535
(0xFFFF)
Type: 6553.5
scn_cfg_scn_proi
Invalid Value
N/A
3
Float
setting_function
Invalid Value
255 (0xFF)(SET_NUL)
setting_setting
Invalid Value
N/A
setting_rotation
Invalid Value
FS-8700-21 LonWorks Manual
Rotation Angle
SNVT_smo_obscur
SNVT_sound_db
SNVT_sound_db_f
SNVT_speed
SNVT_speed_f
SNVT_speed_mil
SNVT_state
SNVT_state_64
Degrees
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Smoke Obscuration
Percent Obscuration
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Sound Level
Decibels
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Sound Level
Decibels from Sound
Pressure Level
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Linear Velocity
Meters per Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Speed
Meters per Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Linear Velocity
Millimeters per Second
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
16 state bits
Bits
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Boolean
Bit
Data Item 2
Measurement
Boolean
Units
Bit
Data Item 3
Measurement
Units
Page 73 of 82
-359.98 .. 360.00
Raw:
(0x7FFF)
Type: 655.34
1
Float
Values Range
0.000 .. 5.000
Invalid Value
N/A
1
Float
Values Range
-327.68 .. 327.67
Invalid Value
N/A
1
Float
Values Range
-3.40282E38
3.40282E38
32,767
Invalid Value
.. N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Float
Values Range
0 .. 65,535
Values Range
0 .. 65,535
Invalid Value
N/A
1
Uint16, Float
Invalid Value
N/A
4
Packed_Bit, Uint16, Float
state_64_word0
Values Range
Invalid Value
0, 1 per bit ( 16 N/A
bits in word )
state_64_word1
Values Range
Invalid Value
0, 1 per bit ( 16 N/A
bits in word )
state_64_word2
Values Range
Invalid Value
FS-8700-21 LonWorks Manual
SNVT_str_asc
SNVT_str_int
SNVT_switch
SNVT_telcom
SNVT_temp
SNVT_temp_diff_p
SNVT_temp_f
SNVT_temp_p
Boolean
Bit
Data Item 4
Measurement
Boolean
Units
Bit
Data Length
Suggested Data Array Formats
Data Item 1 - 31
Measurement
Units
Character String
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Locale Code
N/A
Data Item 2 - 16
Measurement
Units
Wide-character string N/A
with NULL terminator
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Value
Percentage
of
scale
Data Item 2
Measurement
Units
State
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
telcom_states_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Temperature
Degrees Celsius
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Temperature
Degrees Celsius
difference
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Incremental Count
Degrees Celsius
Data Length
0, 1 per bit ( 16 N/A
bits in word )
state_64_word3
Values Range
Invalid Value
0, 1 per bit ( 16 N/A
bits in word )
31
Byte, Uint16, Float
ascii00, ascii01, .. ascii30
Values Range
Invalid Value
0 .. 255
N/A
16
Uint16, Float
char_set
Values Range
Invalid Value
0 .. 255
N/A
wide_char00, .. wide_char14
Values Range
Invalid Value
0 .. 65,535
N/A
Values Range
full 0 .. 100.0
Values Range
0 .. 1
2
Float
Value
Invalid Value
N/A
State
Invalid Value
-1
1
Byte, Uint16, Float
Values Range
0 .. 20
Invalid Value
255 (0xFF)(TEL_NUL)
1
Float
Values Range
-274.0 .. 6,279.5
Invalid Value
N/A
1
Float
Values Range
-327.68 .. 327.66
Invalid Value
Raw:
32,767
Type: 655.34
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Page 74 of 82
(0x7FFF)
FS-8700-21 LonWorks Manual
Suggested Data Array Formats
Data Item 1
Measurement
Units
Temperature
Degrees Celsius
SNVT_temp_ror
SNVT_temp_setpt
SNVT_therm_mode
SNVT_time_f
SNVT_time_hour
Float
Values Range
-273.17 .. 327.66
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Temperature Rate of Degrees Celsius per -16,384.0
..
Change/Rise
Minute (˚C/min)
16,383.0
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Occupied
Cooling Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Item 2
Measurement
Units
Values Range
Standby
Cooling Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Item 3
Measurement
Units
Values Range
Unoccupied Cooling Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Item 4
Measurement
Units
Values Range
Occupied
Heating Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Item 5
Measurement
Units
Values Range
Standby
Heating Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Item 6
Measurement
Units
Values Range
Unoccupied Heating Degrees Celsius
-273.17 .. 327.66
Setpoint
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
therm_mode_t
N/A
0 .. 2
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Elapsed Time
Seconds
-3.40282E38
..
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Page 75 of 82
Invalid Value
Type: 327.67
(0x7FFF)
1
Float
Raw: 32,767
Invalid Value
Raw:
32,767
(0x7FFF)
Type: 16,383.5
6
Float
Occupied_cool
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
Standby_cool
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
Unoccupied_cool
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
Occupied_heat
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
Standby_heat
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
Unoccupied_heat
Invalid Value
Type: 327.67
Raw: 32,767
(0x7FFF)
1
Byte, Uint16, Float
Invalid Value
255 (0xFF)(THERM_NUL)
1
Float
Invalid Value
N/A
1
Uint16, Float
Invalid Value
FS-8700-21 LonWorks Manual
SNVT_time_min
SNVT_time_sec
SNVT_time_stamp
SNVT_time_zone
(only raw data
supported)
SNVT_tod_event
SNVT_trans_table
Elapsed Time
Hours
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Elapsed Time
Minutes
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Elapsed time
Seconds
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Year
Year
Data Item 2
Measurement
Units
Month
Month of Year
Data Item 3
Measurement
Units
Day
Day of Month
Data Item 4
Measurement
Units
Hours
Hours of Day
Data Item 5
Measurement
Units
Minutes
Minute of Hour
Data Item 6
Measurement
Units
Second
Second of Minute
Data Length
Suggested Data Array Formats
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
occup_t
N/A
Data Item 2
Measurement
Units
occup_t
N/A
Data Item 3
Measurement
Units
Time to Next State
Minute of Hour
Data Length
Suggested Data Array Formats
Data Item 1-7
Measurement
Units
Axis-points Array
N/A
Data Item 8
0 .. 65,535
N/A
1
Float
Values Range
0 .. 65,535
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.4
Invalid Value
65,535 (0xFFFF)
6
Uint16, Float
ts_year
Invalid Value
65,535 (0xFFFF)
ts_month
Invalid Value
N/A
ts_day
Invalid Value
N/A
ts_hour
Invalid Value
N/A
ts_minute
Invalid Value
N/A
ts_second
Invalid Value
N/A
15
Byte
Values Range
0 .. 3000
Values Range
0 .. 12
Values Range
0 .. 31
Values Range
0 .. 23
Values Range
0 .. 59
Values Range
0 .. 59
Values Range
0 .. 3
Values Range
0 .. 3
Values Range
0 .. 65,535
Values Range
-3.40282E38
3.40282E38
3
Uint16, Float
tod_cur_state
Invalid Value
255 (0xFF)(OC_NUL)
tod_nxt_state
Invalid Value
255 (0xFF)(OC_NUL)
tod_tm_to_nxt
Invalid Value
N/A
8
Float
tr_point00, ..tr_point06
Invalid Value
.. N/A
interp_methods
Page 76 of 82
FS-8700-21 LonWorks Manual
SNVT_turbidity
SNVT_turbidity_f
SNVT_valve_mode
SNVT_vol
SNVT_vol_f
SNVT_vol_kilo
SNVT_vol_mil
SNVT_volt
SNVT_volt_ac
SNVT_volt_dbmv
Measurement
Units
interp_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Turbidity
Nephelometric
Turbidity Units (NTU)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Turbidity
Nephelometric
Turbidity Units (NTU)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
valve_mode_t
N/A
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Volume
Liters
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Volume
Liters
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Volume
Kiloliters (kl)
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Volume
Milliliters
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Volts
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Volts,
Alternating
Current (VAC)
Data Length
Page 77 of 82
Values Range
0 .. 65,535
Invalid Value
N/A
1
Float
Values Range
0 .. 65.534
Invalid Value
65,535 (0xFFFF)
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Byte, Uint16, Float
Values Range
0 .. 7
Invalid Value
255 (0xFF)(VALVE_NUL)
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Values Range
-3,276.8…3,276.7
Invalid Value
N/A
1
Uint16, Float
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
1
FS-8700-21 LonWorks Manual
SNVT_volt_f
SNVT_volt_kilo
SNVT_volt_mil
SNVT_zerospan
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Decibels-milliVolts,
Direct Current
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Volts
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Kilovolts
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Electric Voltage
Millivolts
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Zero-term
Percent (%) or Partsper-Million (ppm)
Data Item 2
Measurement
Units
Span-factor
Percent (%) or Partsper-Million (ppm)
Page 78 of 82
Float
Values Range
Invalid Value
-3,276.8 .. 3,276.7 N/A
1
Float
Values Range
-3.40282E38
3.40282E38
Invalid Value
.. N/A
1
Float
Values Range
Invalid Value
-3,276.8 .. 3,276.7 N/A
1
Float
Values Range
Invalid Value
-3,276.8 .. 3,276.7 N/A
2
Float
zero
Values Range
Invalid Value
-163.840
.. N/A
163.835
span
Values Range
Invalid Value
0 .. 32.7675
N/A
FS-8700-21 LonWorks Manual
Appendix D.4. SNVT_Type by Number
SNVT Type Number
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
SNVT Type Name
SNVT_amp
SNVT_amp_mil
SNVT_angle
SNVT_angle_vel
SNVT_btu_kilo
SNVT_btu_mega
SNVT_char_ascii
SNVT_count
SNVT_count_inc
SNVT_date_cal
SNVT_date_day
SNVT_date_time
SNVT_elec_kwh
SNVT_elec_whr
SNVT_flow
SNVT_flow_mil
SNVT_length
SNVT_length_kilo
SNVT_length_micr
SNVT_length_mil
SNVT_lev_cont
SNVT_lev_disc
SNVT_mass
SNVT_mass_kilo
SNVT_mass_mega
SNVT_mass_mil
SNVT_power
SNVT_power_kilo
SNVT_ppm
SNVT_press
SNVT_res
SNVT_res_kilo
SNVT_sound_db
SNVT_speed
SNVT_speed_mil
SNVT_str_asc
SNVT_str_int
SNVT_telcom
SNVT_temp
SNVT_time_passed
SNVT_vol
SNVT_vol_kilo
SNVT_vol_mil
SNVT_volt
SNVT_volt_dbmv
SNVT_volt_kilo
SNVT_volt_mil
SNVT_amp_f
SNVT_angle_f
SNVT_angle_vel_f
SNVT Type Number
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
Page 79 of 82
SNVT Type Name
SNVT_state
SNVT_time_stamp
SNVT_zerospan
SNVT_magcard
SNVT_elapsed_tm
SNVT_alarm
SNVT_currency
SNVT_file_pos
SNVT_muldiv
SNVT_obj_request
SNVT_obj_status
SNVT_preset
SNVT_switch
SNVT_trans_table
SNVT_override
SNVT_pwr_fact
SNVT_pwr_fact_f
SNVT_density
SNVT_density_f
SNVT_rpm
SNVT_hvac_emerg
SNVT_angle_deg
SNVT_temp_p
SNVT_temp_setpt
SNVT_time_sec
SNVT_hvac_mode
SNVT_occupancy
SNVT_area
SNVT_hvac_overid
SNVT_hvac_status
SNVT_press_p
SNVT_address
SNVT_scene
SNVT_scene_cfg
SNVT_setting
SNVT_evap_state
SNVT_therm_mode
SNVT_defr_mode
SNVT_defr_term
SNVT_defr_state
SNVT_time_min
SNVT_time_hour
SNVT_ph
SNVT_ph_f
SNVT_chlr_status
SNVT_tod_event
SNVT_smo_obscur
SNVT_fire_test
SNVT_temp_ror
SNVT_fire_init
FS-8700-21 LonWorks Manual
SNVT Type Number
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
SNVT Type Name
SNVT_count_f
SNVT_count_inc_f
SNVT_flow_f
SNVT_length_f
SNVT_lev_cont_f
SNVT_mass_f
SNVT_power_f
SNVT_ppm_f
SNVT_press_f
SNVT_res_f
SNVT_sound_db_f
SNVT_speed_f
SNVT_temp_f
SNVT_time_f
SNVT_vol_f
SNVT_volt_f
SNVT_btu_f
SNVT_elec_whr_f
SNVT_config_src
SNVT_color
SNVT_grammage
SNVT_grammage_f
SNVT_file_req
SNVT_file_status
SNVT_freq_f
SNVT_freq_hz
SNVT_freq_kilohz
SNVT_freq_milhz
SNVT_lux
SNVT_ISO_7811
SNVT_lev_percent
SNVT_multiplier
SNVT Type Number
133
134
135
136
137
138
139
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
Page 80 of 82
SNVT Type Name
SNVT_fire_indcte
SNVT_time_zone
SNVT_earth_pos
SNVT_reg_val
SNVT_reg_val_ts
SNVT_volt_ac
SNVT_amp_ac
SNVT_turbidity
SNVT_turbidity_f
SNVT_hvac_type
SNVT_elec_kwh_l
SNVT_temp_diff_p
SNVT_ctrl_req
SNVT_ctrl_resp
SNVT_ptz
SNVT_privacyzone
SNVT_pos_ctrl
SNVT_enthalpy
SNVT_gfci_status
SNVT_motor_state
SNVT_pumpset_mn
SNVT_ex_control
SNVT_pumpset_sn
SNVT_pump_sensor
SNVT_abs_humid
SNVT_flow_p
SNVT_dev_c_mode
SNVT_valve_mode
SNVT_alarm_2
SNVT_state_64
SNVT_nv_type
FS-8700-21 LonWorks Manual
Appendix D.5. How to Interpret an XIF file
An XIF file can be viewed with a viewer program such as Notepad. The file contents start with a header section.
th
The first three lines are for informational purposes, followed by a 4 blank line:
File: fserver.xif generated by LonDriver Revision 1.30(e), XIF Version 4.0
Copyright (c) 2000-2012 by Sierra Monitor Corporation
All Rights Reserved. Run on Tue Jun 18 10:47:15 2013
The fifth line contains the program ID:
90:00:95:47:1E:02:04:D7
Lines 6-10 contain encoded information on the capabilities of the LonWorks device. Refer to the LonMark Device
Interface File Reference Guide for more information.
Line 11 contains a single asterisk indicating the end of the device information.
*
Line 12 contains the device self-documentation string, which is the same as the FieldServer title, specified in the
configuration file:
":D48:S01:DCC085 X30.CSV v4.10c
The next section contains the Network Variable definitions. We will only discuss the encoded information of
importance to the FieldServer. Refer to the LonMark Device Interface File Reference Guide for more information.
An example of a Standard Network Variable Type (SNVT) Definition:
Network Variable
Name from Map
Descriptor name.
Network Variable
Index from
SNVT_Index.
VAR SMD_AI_01 0 0 0 0
0 1 63 1 0 0 0 0 0 0 1 0 0
*
51 * 1
40400
LonMark Standard Network
Variable Number from SNVT_Type
e.g. 51 is SNVT_count_f.
This is the Network Variable’s entry in the configuration file:
Map_Descriptors
Map_Descriptor_Name
SMD_AI_01
, Node_Name
, Lon_srv_1
,Data_Array_Name
,DA_AI_01
, SNVT_Index
,0
,Data_Array_Offset
,0
,SNVT_Type
,SNVT_count_f
Page 81 of 82
,Lon_Function
,NVPO
,Function
,Server
FS-8700-21 LonWorks Manual
An example of a User Defined Network Variable Type (UNVT) Definition:
Network Variable Name
from Map Descriptor name.
VAR nviUNVT001 0 0 0 0
0 1 63 0 0 0 0 0 0 0 0 0 0
*
0*1
4 0 20 0 0
Always 0 to indicate
an UNVT.
UNVT size in bytes from
UNVT_Byte_Length.
This is the Network Variable’s entry in the configuration file:
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function , Node_Name ,SNVT_Type ,UNVT_Byte_Length
nviUNVT001
,DA_BYTE
,0
,NVUI
,SERVER ,Lon_1
,Not SNVT ,20
Page 82 of 82