A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-21 LonWorks
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after April 2009
Driver Version:
Document Revision:
1.25
6
FS-8700-21 LonWorks Manual
Table of Contents
Nodes...................................................................................................................................................17
Driver Related Map Descriptor Parameters.........................................................................................18
Map Descriptor Example 2 – Polling UNVT’s .......................................................................................19
Nodes...................................................................................................................................................21
Driver Related Map Descriptor Parameters.........................................................................................22
Appendix A.1. Using UNVT’s....................................................................................................................................24
Appendix A.5. Configuration Properties..................................................................................................................25
Appendix A.9.1. SNVT_Option Field .................................................................................................................28
Appendix A.9.2. SNVT_Units Field ....................................................................................................................28
Appendix B.1.1. Using LonMaker to commission the FieldServer ....................................................................30
Appendix B.1.2. Removing Previous FieldServer Device Templates in LonMaker. ...........................................30
Appendix C.1. Debugging a LonWorks connection: Hints and tips.........................................................................33
Appendix C.2. Error Messages.................................................................................................................................33
Appendix C.2.1. Error Message Lonlive.c 121...................................................................................................33
Appendix C.4. “Illegal” Characters in Network Variable Names..............................................................................35
FS-8700-21 LonWorks Manual
Page 4 of 62
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-B4011 FieldServer is supplied with a LonWorks Card, while the FS-B2011 and FS-
B30 Series FieldServers have a built-in LonWorks Interface. A Fieldbus connection is available on the FieldServer. The FS-B30
and FS-B4011 can handle up to 4096 Network Variables and the FS-B2011 up to 1000 which can be of the Standard Network
Variable Types (SNVT) and/or User-defined Network Variable Types (UNVT).
2
DEFINITIONS
2.1 NV Updates/Polls
On LonWorks networks, information is transferred using Network Variable Updates and Network Variable Polls. The Client
requests Network Variables from the Server using Network Variable Polls and Network Variable Updates occur when a Client
sends Network Variables to a Server.
2.2 Network Management
The FieldServer is able to set its own Domain, Subnet and Node ID at start-up using the FieldServer configuration file.
Alternatively, the FieldServer is capable of being commissioned and bound by Network Management Tools such as
2.2.1 LonWorks - Program ID Calculation (SPID)
Network management tools use the Program ID to identify the different applications running on each device. Two devices on
a network may have the same Program ID only if they have identical application/configurations
The Program ID for the FieldServer consists of a fixed and a variable field (XX in the Program ID below)..
90:00:95:47:1E:02:04:XX
The fixed part does not change for different configuration files or for different LonWorks driver versions. The variable part
XX, which is also defined as the Model or Revision number, does however change.
The variable part is calculated at start-up when the configuration is loaded on the FieldServer. Certain critical fields in the
configuration file are used to calculate this variable part of the Program ID. Thus if the configuration file changes significantly
(critical fields) the Program ID will change. Also, as we add new features and capabilities to the LonWorks driver, this variable
part of the Program ID may be different between LonWorks driver versions (even though the configuration file is the same).
It is possible though very unlikely that through a change in LonWorks driver and/or configuration file, the program IDs
calculates out identical to another combination of driver and configuration. If this is the case with two FieldServers on the
same network that run different configurations, one of these devices may fail to commission properly.
The following configuration can be used to force the SPID.
Connections
Adapter
,Protocol
,SPID
Lonworks
,Lonworks ,80:00:95:48:50:02:04:01
FS-8700-21 LonWorks Manual
Page 5 of 62
2.3 Clients/Servers
The FieldServer functions as a Client when polling or sending updates on the LonWorks network and as a Server when being
polled or receiving updates. The FieldServer can be bound to a maximum number of 15 LonWorks Nodes. The FieldServer
recommended point limit is 1000 points for the FS-B2011 Series and 4096 points for the FS-B30 and FS-B4011.
2.4 Explicit/Implicit
Clients can address Servers using explicit or implicit addressing. Clients using explicit addressing obtain their data transfer
parameters directly from the FieldServer configuration file. Implicit addressing is used when a Network Management Tool
such as LonMaker® is used to connect a FieldServer to other LonWorks Nodes - the FieldServer is assigned its data transfer
(binding) parameters by the Network Management Tool.
2.5 XIF Files
At start-up the FieldServer creates an external interface file (XIF) called fserver.xif based on the configuration file. The
FieldServer differs from most other LonWorks drivers in that it is configurable and therefore its XIF is not fixed for all
applications. The list of points available to the network will vary depending on the other networks connected to the
FieldServer, and the requirements of the particular application. The recommended procedure for obtaining the XIF file for
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 5.1.3. Please note that due to the sophisticated nature of
LonWorks variables, it may not always be possible to typecast the full information supplied in a LonWorks variable to a simple
Data Type contained in another protocol. The FieldServer supports Move and Logic functions which would allow the
LonWorks variable to be split up and passed to separate simple data types, thus preventing information loss. The FieldServer
supports the sending and receiving of User-defined Network Variable Types (UNVTs) on the LonWorks Network. An UNVT is
simply implemented as an array of bytes of user-defined length.
2.7 NV 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.
FS-8700-21 LonWorks Manual
Page 6 of 62
3
DRIVER SCOPE OF SUPPLY
3.1 Supplied by FieldServer Technologies for this driver
FieldServer Technologies Part # Description
FS-8700-21
Driver Manual.
3.2 Provided by the Supplier of 3rd Party Equipment
Part # Description
N/A
N/A
N/A
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)
PCC10 PCCard LonWorks Adapter (Optional)
3.3 Additional files required for the Driver
Auto-Created "Always
Loaded
By Conditionally
Filename
Comments
by driver
FieldServer Technologies loaded
Template loaded if no custom configuration
ordered, otherwise Custom configuration
loaded.
Config.csv
X
Generated at power up. Changes if profile in
configuration changes.
Used for providing defaulted DSN. Refer to
Section 6.1.4
Maintains commissioning settings. If corrupted,
delete it, and reboot FieldServer to create new
one.
fserver.xif
lon.ini
X
X
X
lonvars.cfg
FS-8700-21 LonWorks Manual
Page 7 of 62
4
HARDWARE CONNECTIONS
LonWorks devices are available with several different physical interfaces. The screw plug supplied with the FieldServer
LonWorks interface will connect the FieldServer to the FTT-10 network. The 9 pin D-connector can also be used to connect to
the network (FS-B4011 only). The 2-wire twisted-pair connection to the network is polarity insensitive. The FTT-10 network is
a free topology network which supports star, loop and/or bus wiring connections. Please refer to the FTT-10A Free Topology
Transceiver User’s Guide from Echelon Corporation for recommended wiring practices if necessary. The connection diagram
below shows how the FieldServer FS-B2011, FS-B30 and FS-B4011 are connected to a LonWorks network:
To other
LonWorks
Nodes
FS-X20
or
FS-X30
FieldBus
Connector
To other
LonWorks
Nodes
To other
LonWorks
Nodes
Pin 1
DB 9 Connector
Pin 2
FS-X40
FieldBus
Connector
To other
LonWorks
Nodes
Configure the remote LonWorks devices according to manufacturer’s instructions.
4.1 Service Pin
The service pin is used to commission the FieldServer onto the network using a LonWorks Network Management tool. On FS-
B2011 and FS-B4011 FieldServers the node’s unique Neuron ID will be displayed on the Error Screen of the Ruinet utility with
every service pin press.
FS-8700-21 LonWorks Manual
Page 8 of 62
4.2 Neuron ID
The driver prints the Neuron ID on the Driver Message Screen as its starts. On FS-B2011 and FS-B4011 FieldServers it is
possible to print the Neuron ID on the Error Screen at any time by pushing the Service Button on the side of the FieldServer.
On all platforms, the driver can store the Neuron ID in a Data Array so that it can be read by a Client node – Refer also to
4.3 Lon LED’s
The location of the Lon LED varies between FieldServer’s. Please consult the Start-up guide for the FieldServer in question.
Lon LED is consistent with the table below for all FieldServers.
Explicit Implicit – Not Commissioned Implicit – Commissioned
Off
Flashing
Off
4.4 The LonWorks Adapter Card (FS-X40 only)
Lon LED
4.4.1 Port Address Switch
The LonWorks driver has been configured to access the LonWorks card at ISA port address 340 hex. This is the default setting
for the card, and the DIP switches must not be modified. The DIP switch setting on the card is as follows:
Switch
Setting
ON
ON
OFF
ON
OFF
OFF
OFF
OFF
1
2
3
4
5
6
7
8
FS-8700-21 LonWorks Manual
Page 9 of 62
5
IMPLICIT CONFIGURATIONS
5.1 Special considerations
Implicit addressing is used when a Network Management Tool such as LonMaker® is used to connect a FieldServer to other
LonWorks nodes - the FieldServer is assigned its data transfer (binding) parameters by the Network Management Tool.
5.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.
5.1.2 Implicit Lon functions
Implicit Map Descriptors are distinguished from Explicit Map Descriptors by the function used in the Lon_Function field of the
Map Descriptor. Depending on the nature and direction of Data Transfer needed, different implicit functions are available as
follows (NOTE: function field MUST pair up with the Lon_Function field as shown in the table):
Lon_Function Description
Function Field
PASSIVE
NVUI
Network Variable Update Input
NVPO
Network Variable Polled Output
NVPIIMC
NVUOIMC
NVUOIMX
NVUOIMT
CFG_NVUI
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
Configuration Network Variable Update Input PASSIVE
RDBC
WRBC
WRBX
5.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.
5.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).
FS-8700-21 LonWorks Manual
Page 10 of 62
5.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 that do this, see Appendix B
It is possible to set the FieldServer Online and Offline using the Network Management Tools. This is a LonWorks function, and
is different from the traditional Online and Offline Status discussed in other FieldServer documentation. When the
FieldServer is set offline using this LonWorks feature it will not communicate with other LonWorks devices.
5.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.
5.2 Client Side Mapping
5.2.1 Connection Parameters
Section Title
Connections
Column Title
Protocol
Function
Specify protocol used
Legal Values
LonWorks
Specify Network Management. Primarily used for Circon_SI, refer LonMaker,
LonWatcher,
Connection_Type*
Example
// Client Side Connections
Connections
Adapter
,Protocol
LonWorks
,LonWorks
FS-8700-21 LonWorks Manual
Page 11 of 62
5.2.2 Node Parameters
Section Title
Nodes
Column Title
Node_Name
Protocol
Function
Provide name for Node
Specify protocol used
Legal Values
Up to 32 alphanumeric characters
LonWorks
Example
// Client Side Nodes
Nodes
Node_Name ,Protocol
LON_1
,LonWorks
5.2.3 FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
Name of this Map Descriptor. (Network Variable
Name)
Map_Descriptor_Name
Up to 16 alphanumeric characters.
Name of Data Array where data is to be stored or One of the Data Array names from “Data
Data_Array_Name
Data_Array_Offset
Lon_Function
Function
fetched from in the FieldServer
Array” section above
0 to maximum specified in “Data Array”
section above
Starting location in Data Array
Implicit Connections.
based on the Lon_Function.
Detailed Function of Client Map Descriptor
Function of Client Map Descriptor
FS-8700-21 LonWorks Manual
Page 12 of 62
5.2.4 Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Client Node
Descriptors” above
See Appendix D
Name of Node to fetch data from or send data to. Needed for Explicit
Addressing.
Node_Name
SNVT_Type
Standard network variable type of the data
SNVT_Option*
SNVT_Units*
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
See Appendix A.9.1
See Appendix A.9.2
UNVT_Byte_Length* when SNVT_Type is set to UNVT, the parameter is not used in 1-255. See Appendix A.1
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
UNVT_ID
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.
NV_Min_Value*
NV_Max_Value*
See Appendix A.2
See Appendix A.2
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_Delta_Value*
NV_Selfdoc_Text*
See Appendix A.3
Normal Text up to
length of 40 characters
a
The Self-Documenting String for this Network Variable.
5.2.5 Timing Parameters
Column Title
Scan_Interval
Function
Seconds per scan
Legal Values
0-32000
FS-8700-21 LonWorks Manual
Page 13 of 62
5.2.6 Client Side Map Descriptor Example
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name ,SNVT_Type
,Nv_Delta_Value ,Min_Scan_Time ,Max_Scan_Time ,Scan_Interval
TempOut1
TempOut2
TempOut3
TempIn
,DA_FO_01
,DA_FO_01
,DA_FO_01
,DA_FI_01
,0
,1
,2
,0
,NVUOIMT
,NVUOIMX
,NVUOIMC
,NVPIIMT
,Wrbc
,Wrbc
,Wrbc
,Rdbc
,LON_1
,LON_1
,LON_1
,LON_1
,SNVT_Temp_f ,10
,SNVT_Temp_f ,-
,SNVT_Temp_f ,-
,SNVT_Temp_f ,-
,5
,-
,-
,-
,20
,-
,-
,-
,-
,20
,5
,-
The Data Array will be
This field
determines the
Map
Descriptor’s
function. See
Section 5.1.2
for more
For Non-Throttled
Client Map
Descriptors the
Scan_Interval
determines the
update rate.
sampled and evaluated for
delta change once every
Required for Throttling Mode: This field specifies the
minimum change needed for a Network Variable’s
value to invoke an NV Update.
If found during Min_Scan_Time
sampling (Throttling Mode) that
Max_Scan_Time has elapsed since the
last NV Update, a new NV Update will
be transmitted.
information.
FS-8700-21 LonWorks Manual
Page 14 of 62
6
EXPLICIT CONFIGURATIONS
6.1 Special considerations
With Explicit configuration, the FieldServer communicates directly with other devices by specifying the remote device address
in the FieldServer configuration.
All the Servers and their Clients need to be on the same domain to be able to communicate. If the LonWorks device’s Node
ID is not known, it may be read using a utility program e.g. NodeUtil or using a LonWorks Analyzer. All the Client Node CSV
files need to have their Subnet_ID and Node_ID parameters set to point to their respective Server Subnet and Node ID values.
Once the FieldServers are restarted the network should function correctly.
6.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.
6.1.2 Lon functions
Explicit Map Descriptors are distinguished from Implicit Map Descriptors by the function used in the Lon_Function field of the
Map Descriptor. Depending on the nature and direction of Data Transfer needed different explicit functions are available as
shown below
NOTE:
Function field MUST pair up with the Lon_Function field as shown in the table
NMFETCHC is the preferred Lon Function for most applications. See Section 6.1.5
Lon_Function Description
Function Field
SERVER
NVUI
Network Variable Update Input
NVPO
Network Variable Polled Output
NVPIEXC
NVUOEXC
NVUOEXX
NVUOEXT
NMFETCHC
CFG_NVUI
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) RDBC
Configuration Network Variable Update Input SERVER
RDBC
WRBC
WRBX
WRBC
6.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.
FS-8700-21 LonWorks Manual
Page 15 of 62
6.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:
FieldServer configuration file contents ( config.csv )
FieldServer
System_Station_Address ,Title
12
,Your title
FS-8700-21 LonWorks Manual
Page 16 of 62
Example 2: Setting the Domain and Subnet from 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 and enclosed by “:”. 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.
Once the domain table has been set, the “:Dxx:Sxx:” part of the Title field will be removed. Now the Title field will be left with
*Title continued…+ which may be the Node self-documentation string or any title
lon.ini file contents
The file may contain any values or be removed from the FieldServer.
FieldServer configuration file contents ( config.csv )
FieldServer
System_Station_Address ,Title
12
,":D48:S01:TESTING"
Specifying the Domain and Subnet in the configuration file will override the settings from the lon.ini file.
6.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.
FS-8700-21 LonWorks Manual
Page 17 of 62
6.2 Client Side Configuration
6.2.1 Connections
Section Title
Connections
Column Title Function
Legal Values
LonWorks
Adapter
Protocol
Adapter Name
Specify protocol used LonWorks
Example
// Client Side Connections
Connections
Adapter
,Protocol
LonWorks
,LonWorks
6.2.2 Nodes
Section Title
Nodes
Column Title Function
Legal Values
Up to
characters
32
alphanumeric
Node_Name Provide name for Node
Server (destination) Node’s Subnet ID of an explicitly addressed
message
Subnet_ID
1-255
Node_ID
Protocol
Adapter
Server (destination) Node’s Node ID of an explicitly addressed message
Specify protocol used
Specify port Adapter used
1-127
LonWorks
LonWorks
Example
// Client Side Nodes
Nodes
Node_Name ,Subnet_ID ,Node_ID ,Protocol
,Adapter
LON_1
,1
,1
,LonWorks ,LonWorks
FS-8700-21 LonWorks Manual
Page 18 of 62
6.2.3 Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Client Node
Descriptors” above
0-4095
Name of Node to fetch data from or send data to. Needed for Explicit
Addressing.
Node_Name
SNVT_Index
SNVT_Type
Server Network Variable Index
Standard network variable type of the data
See Appendix D
SNVT_Option*
Specifies which record out of a complex SNVT we are after.
Specifies the measurement units if something other than Metric is
required
See Appendix A.9.1
SNVT_Units*
See Appendix A.9.2
Specifies the length in bytes of an UNVT. This Parameter is compulsory
UNVT_Byte_Length* when SNVT_Type is set to UNVT, the parameter is not used on 1-255. See Appendix A.1
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
UNVT_ID
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.
NV_Min_Value*
NV_Max_Value*
See Appendix A.2
See Appendix A.2
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_Delta_Value*
NV_Selfdoc_Text*
See Appendix A.2
Normal Text up to
length of 40 characters
a
The Self-Documenting String for this Network Variable.
6.2.4 Timing Parameters
Column Title
Function
Legal Values
0-32000,
2s
Scan_Interval*
Seconds per scan
Min_Scan_Time*
Max_Scan_Time*
FS-8700-21 LonWorks Manual
Page 19 of 62
6.2.5 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 ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name
,SNVT_Index ,SNVT_Type
,Remote_Node ,0 ,SNVT_temp_p ,Deg_F
,Remote_Node ,1 ,SNVT_switch ,-
,SNVT_Units ,SNVT_Option ,Scan_Interval
pollTemp_p
pollSwitch
,DA_Explicit
,DA_Explicit
,1
,2
,NMFETCHC
,NMFETCHC
,Rdbc
,Rdbc
,-
,1.0s
,1.0s
,State
This field
determines the
Map
Explicitly Addressed Client Map Descriptors use
this field to point to their relevant Server Map
Descriptors.
For Non-Throttled
Client Map
Descriptors the
Scan_Interval
determines the
update rate.
Descriptor’s
function. See
Section 6.1.2
for more
information.
6.2.6 Map Descriptor Example 2 – Polling UNVT’s
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name
,SNVT_Index ,SNVT_Type ,UNVT_Byte_Length ,Scan_Interval
pollUNVT
,DA_Explicit
,101
,NMFETCHC
,Rdbc
,Remote_Node ,2 ,UNVT ,31 ,1.0s
UNVT Byte length must be specified for correct
operation.
FS-8700-21 LonWorks Manual
Page 20 of 62
6.2.7 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 6.1.4
Bridge
System_Station_Address ,Title
110
,":D01:S01:Neuron ID Example:"
On the Client side Nodes add a new field as shown below:
Nodes
Node_Name ,Node_ID ,Protocol
,Neuron_ID
Lon_Srv_11 ,11 ,Lonworks ,F912AB440100
Create a Map Descriptor as Follows:
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name ,SNVT_Index ,SNVT_Type ,Scan_Interval
1nviAmp1
,DA_001
,0
,NMFETCHC
,RDBC
,Lon_Srv_11 ,000
,SNVT_amp ,0s
FS-8700-21 LonWorks Manual
Page 21 of 62
6.3 Server Side Configuration
6.3.1 Connections
Section Title
Connections
Column Title Function
Legal Values
LonWorks
Adapter
Protocol
Adapter Name
Specify protocol used LonWorks
Example
// Server Side Connections
Connections
Adapter
,Protocol
LonWorks
,LonWorks
6.3.2 Nodes
Section Title
Nodes
Column Title Function
Legal Values
Node_Name Provide name for Node Up to 32 alphanumeric characters
Protocol
Specify protocol used
LonWorks
Example
// Server Side Nodes
Nodes
Node_Name ,Protocol
LON_1
,LonWorks
6.3.3 FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
Up to 16 alphanumeric characters.
Map_Descriptor_Name Name of this Map Descriptor
Name of Data Array where data is to be stored One of the Data Array names from
Data_Array_Name
Data_Array_Offset
Lon_Function
Function
or fetched from in the FieldServer
“Data Array” section above
0 to maximum specified in “Data
Array” section above
Starting location in Data Array
entries.
entries.
Detailed Function of Client Map Descriptor
Function of Client Map Descriptor
FS-8700-21 LonWorks Manual
Page 22 of 62
6.3.4 Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
Name of Node to fetch data from or send data to. Needed for specified in “Client
Node_Name
Explicit Addressing.
Node
Descriptors”
above
0-4095
See Appendix D
SNVT_Index
SNVT_Type
SNVT_Option
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 something other than
Metric is required
See Appendix A.9.1
SNVT_Units
See Appendix A.9.2
Specifies the length in bytes of an UNVT. This Parameter is
UNVT_Byte_Length* 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.
0, 146-255.
See
UNVT_ID
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.
NV_Min_Value*
NV_Max_Value*
See Appendix A.2
See Appendix A.2
Network Variable updates where the value’s delta change is
less than specified in this field will be ignored unless the
NV_Delta_Value*
NV_Selfdoc_Text
Throttling Lon Functions only. Not used on other Lon
Functions.
Normal Text up to a
length of 40 characters
The Self-Documenting String for this Network Variable.
6.3.5 Timing Parameters
Column Title
Function
Legal Values
0-32000,
2s
Scan_Interval*
Seconds per scan
Min_Scan_Time*
Max_Scan_Time*
FS-8700-21 LonWorks Manual
Page 23 of 62
6.3.6 Map Descriptor Example
// Server Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name
NviTemp
NviTemp
,Data_Array_Name
,DA_FI_01
,DA_FO_01
,-
,Data_Array_Offset
,Lon_Function
,NVUI
,NVPO
,Function
,Server
,Server
,Server
,Node_Name
,LON_1
,LON_1
,SNVT_Index
,Nv_Delta_Value
,10
,-
,SNVT_Type
,Nv_Min_Value
,Nv_Max_Value
,- “
,150 “
,150
,Nv_Selfdoc_text
,@0|1;WaterTemp”
,&200\x8023”
,0
,1
,-
,-
,-
,-
,SNVT_Temp_f
,SNVT_Temp_f
,SNVT_Temp_f
,0
,0
,-
NviTemp
,CFG_NVUI
,LON_1
,-
,“&200\x8020
Explicitly Addressed Client Map
Descriptors use this field to point
to their relevant Server Map
Descriptors.
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.
Server NVUI can be grouped with
Client NV Update types and
NMFETCHC. Server
NVPO can be grouped with Client
NV Poll types and NMFETCHC.
The Self-documenting String for a
Network Variable can be up to 40
characters wide.
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.
Required for Throttling Mode: This field specifies the
minimum change needed for a Network Variable’s
value to invoke an NV Update.
FS-8700-21 LonWorks Manual
Page 24 of 62
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
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
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
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
This functionality applies only to SNVT’s of either Floating point or Integer formats.
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 RuiNet utility.
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 . 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. Remember that this XIF file will change whenever the configuration file has been changed,
downloaded and the FieldServer restarted.
FS-8700-21 LonWorks Manual
Page 25 of 62
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.
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.
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”
Examples of configuration network variables are presented in Section 6.3.6
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 please consult the following documentation from the LonMark
Understanding LonMark Self-Documentation
LonMark Application Layer Interoperability Guidelines
The two examples given below will show how LonMark Objects can be assigned in FieldServer configuration files:
The first example uses the standard Open Loop Sensor Object (Type 1) to create a Water Temperature Sensor that will send
out its current status via Network Variable Updates.
A typical recipient of these updates is given by example #2 which uses the LonMark Open Loop Actuator Object (Type 3) to
create a Water Heating Element object that will interpret the Network Variable it receives and adjust power to its heating
element accordingly.
FS-8700-21 LonWorks Manual
Page 26 of 62
LonMark Config file Example #1 – Open Loop “Water Temperature” Sensor:
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name ,SNVT_Index ,SNVT_Type
,Nv_Min_Value ,Nv_Max_Value ,Nv_Selfdoc_text
nvoTemp
NviTempMin
NviTempMax
,DA_FI_01
,-
,-
,0
,-
,-
,NVUOIMC
,CFG_NVUI
,CFG_NVUI
,Wrbc
,Server
,Server
,LON_1
,LON_1
,LON_1
,-
,-
,-
,SNVT_Temp_f ,-
,SNVT_Temp_f ,10
,SNVT_Temp_f ,-
,-
,-
,300
,“@0|1;WaterTemp”
,“&200\x8023”
,“&200\x8020”
The Node Self-
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 CP’s. These defaults are loaded by the
FieldServer after a restart only when re-commissioning is required.
The object index is 0 and
this Map Descriptor
Documentation String
defines one LonMark
object of type 1 – Open
Loop Sensor.
defines the 1st Network
Variable of the object.
LonMark Config file Example #2 – “Water Heating Element” Actuator:
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Lon_Function ,Function ,Node_Name ,SNVT_Index ,SNVT_Type
,Nv_Min_Value ,Nv_Max_Value ,Nv_Selfdoc_text
nvoTemp
NviTempMin
NviTempMax
,DA_FI_01
,-
,-
,0
,-
,-
,NVUOIMC
,CFG_NVUI
,CFG_NVUI
,Wrbc
,Server
,Server
,LON_1
,LON_1
,LON_1
,-
,-
,-
,SNVT_Temp_f ,-
,SNVT_Temp_f ,10
,SNVT_Temp_f ,-
,-
,-
,300
,“@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 CP’s. These defaults are loaded by
the FieldServer after a restart only when re-
commissioning is required.
The Node Self-
Documentation String
defines one LonMark
object of type 3 – Open
Loop Actuator.
The object index is 0 and
this Map Descriptor
defines the 1st Network
Variable of the object.
FS-8700-21 LonWorks Manual
Page 27 of 62
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 Ruinet 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 Bridge 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.
FS-8700-21 LonWorks Manual
Page 28 of 62
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_press_f
SNVT_press_p
SNVT_Option
N/A
SNVT_UnitsLengthMeasurement Units
Inch_H20
Inch_H20
Raw
1
1
1
1
1
1
1
1
1
1
2
1
1
1
Inches of water
N/A
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 (%)
SNVT_temp
N/A
N/A
N/A
Deg_C
Deg_F
Deg_C
Deg_F
Raw
SNVT_temp_f
SNVT_temp_p
Deg_C
Deg_F
Raw
All
Raw
SNVT_switch1
Value
State
Percent
Raw
Raw, unadjusted data
FS-8700-21 LonWorks Manual
Page 29 of 62
SNVT_Type
SNVT_Option
All
SNVT_UnitsLengthMeasurement Units
Raw
12
6
6
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
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)
Deg_C
Deg_F
Raw
Occupied_cool Deg_C
Deg_F
Raw
Deg_C
Deg_F
Raw
Standby_cool
SNVT_temp_setpt
Unoccupied_cool Deg_C
Deg_F
Raw
Occupied_heat Deg_C
Deg_F
Raw
Standby_heat
Deg_C
Deg_F
Raw
Unoccupied_ heatDeg_C
Deg_F
FS-8700-21 LonWorks Manual
Page 30 of 62
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:
Network Interface: Choose Network Attached
Management Mode: Choose Onnet unless you are working offline
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
Enter Device Name: Choose commission device
Specify Device Template: Choose upload from device
Specify Device Channel: Choose Auto Detect
Specify Device Properties: Leave as is (Ping is optional)
Identify Device: Choose service pin
Device Application Image: Leave unchecked
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 variables you require (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 you have 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 your next FieldServer product as some parameters might transfer to
your new device.
To remove the device templates, open your LonMaker workspace as you would normally do. 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 your FieldServer product.
FS-8700-21 LonWorks Manual
Page 31 of 62
Appendix B.2. Neuron Systems
Newron Systems may produce the following Error message “bindings lost after power-cycle” The solution to this is
to place 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.3. Honeywell Care
This system uses unacknowledged service as default. This protocol driver requires acknowledged service to
operate correctly.
Appendix B.4. Tridium JACE
This system uses unacknowledged service as default. This protocol driver requires acknowledged service to
operate correctly.
Note that Tridium calls Acknowledged service “critical bindings”.
FS-8700-21 LonWorks Manual
Page 32 of 62
Appendix B.5. 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, you will be able to see the FieldServer 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.
FS-8700-21 LonWorks Manual
Page 33 of 62
Appendix C. Troubleshooting Tips
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.
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
Description
"LON:#03 FYI. Standard driver build. This is normal. 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.
FS-8700-21 LonWorks Manual
Page 34 of 62
Appendix C.3. 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 ,Data_Format ,Data_Array_Length
Lonworks-stats
,UINT32
,1000
Data Array
Offset
Description
1
2
3
4
5
6
7
8
9
Increments each time Neuron ID is read. Used for scripting
Overwritten each time Neuron ID is read. Contains 1st byte of Neuron ID
Overwritten each time Neuron ID is read. Contains 2nd byte of Neuron ID
Overwritten each time Neuron ID is read. Contains 3rd byte of Neuron ID
Overwritten each time Neuron ID is read. Contains 4th byte of Neuron ID
Overwritten each time Neuron ID is read. Contains 5th byte of Neuron ID
Overwritten each time Neuron ID is read. Contains 6th byte of Neuron ID
Not Used
Not Used
Overwritten each time 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 each time 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 each time Neuron ID is read. Contains 1st nibble of 2nd byte of Neuron ID as an ASCII
char
Overwritten each time Neuron ID is read. Contains 2nd nibble of 2nd byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 1st nibble of 3rd byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 2nd nibble of 3rd byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 1st nibble of 4th byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 2nd nibble of 4th byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 1st nibble of 5th byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 2nd nibble of 5th byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 1st nibble of 6th byte of Neuron ID as an ASCII
char.
Overwritten each time Neuron ID is read. Contains 2nd nibble of 6th byte of Neuron ID as an ASCII
char.
10
11
12
13
14
15
16
17
18
19
20
21
FS-8700-21 LonWorks Manual
Page 35 of 62
Appendix C.4. “Illegal” Characters in Network Variable Names
Spaces
Spaces may not be used in Network Variable Names. The driver automatically replaces all spaces with
underscores at start-up.
Brackets 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.5. Circon_SI Limitations
Circon_SI does not recognize whitespace; %; -
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
,Protocol
,Connection_Type
LonWorks
,LonWorks ,Circon_SI
Appendix C.6. Service types currently supported for network variable messages
Currently the service type for network variable update messages is fixed to acknowledged service. Request-
response service is used for network variable poll and network management fetch messages.
Appendix C.7. 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 Desciption
Min Typ Max Units
1
2
FieldServer startup time with 4096 network variables
-
-
6.5
-
-
40
Minutes
Minutes
Milli-
seconds
Milli-
seconds
Milli-
seconds
Time to commission FieldServer with 4096 network variables
Time to complete a network variable updFieldServersbetween two
FieldServers (acknowledged service)
3
4
5
-
-
-
40
-
-
-
Time to complete
a
networFieldServersoll message between two
125
125
FieldServers (request/response service)
Time to complete a network manageFieldServers variable fetch message
between two FieldServers (request/response service)
FS-8700-21 LonWorks Manual
Page 36 of 62
Appendix D. 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 Description
Values Range
0,1
BIT
1-bit
BYTE
8-bit Byte
0.. 255
SINT16
UINT16
SINT32
UINT32
FLOAT
16-bit Signed Integer
16-bit Unsigned Integer 0.. 65,535
32-bit Signed Integer
32-bit Unsigned Integer 0.. 4,294,967,295
-32,768... 32,767
-2,147,483,647... 2,147,483,647
32-bit Float
-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.
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.
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_abs_humid
SNVT_address
Measurement
Units
Values Range
0.. 655.34
Invalid Value
Raw:
Type: 655.35
1
Absolute humidity
gram/kilogram
65,535
(0xFFFF)
Data Length
Suggested Data Array Formats
Data Item 1
Uint16, Float
Measurement
Units
Values Range
Invalid Value
Neuron Chip Address
16-bit address value
16,384 .. 64,767 N/A
FS-8700-21 LonWorks Manual
Data Length
Page 37 of 62
25
Suggested Data Array Formats
Uint16, Float
Alm_Location00,
..Alm_Location05
Invalid Value
N/A
Data Item 1-6
Measurement
Units
Values Range
0 .. 255
Location array element 8-bit unsigned byte
Data Item 7
Object_ID
Measurement
Object ID
Units
object index
Values Range
0 .. 65,535
Invalid Value
N/A
Data Item 8
Alarm_type
Measurement
alarm_type_t
Data Item 9
Measurement
Priority_level_t
Data Item 10
Measurement
Units
N/A
Values Range
0 .. 254
Invalid Value
255 (0xFF)(AL_NUL)
Priority_level
Invalid Value
255 (0xFF)(PR_NUL)
Index_to_SNVT
Invalid Value
Units
N/A
Values Range
0 .. 11
Units
Values Range
index of NV causing
alarm
Index to NV
0 .. 65,535
N/A
Alm_Value00,
..Alm_Value03
Invalid Value
N/A
Year
Invalid Value
N/A
Data Item 11-14
Measurement
Value array element
Data Item 15
Measurement
Year
Units
specific to NVT
Values Range
0 .. 255
SNVT_alarm
Units
year
Values Range
0 .. 3000
Data Item 16
Measurement
Month
Month
Invalid Value
N/A
Units
month of year
Values Range
0 ..12
Data Item 17
Measurement
Day
Day
Invalid Value
N/A
Units
day of month
Values Range
0 ..31
Data Item 18
Measurement
Hour
Hour
Invalid Value
N/A
Units
Hour of day
Values Range
0 ..23
Data Item 19
Measurement
Minute
Minute
Invalid Value
N/A
Units
Minutes
Values Range
0 ..59
Data Item 20
Measurement
Second
Second
Invalid Value
N/A
Units
Seconds
Values Range
0 ..59
Data Item 21
Measurement
Millisecond
Data Item 22-25
Measurement
Millisecond
Invalid Value
N/A
Alm_limit00, ..Alm_limit03
Invalid Value
Units
Milliseconds
Values Range
0 ..999
Units
Values Range
Alarm
element
limit
array
specific to NVT
0 .. 255
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_amp
Measurement
Units
Values Range
-3,276.8...
3,276.7
Invalid Value
N/A
Electric current
Amperes
FS-8700-21 LonWorks Manual
Data Length
Page 38 of 62
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_amp_ac
Measurement
Alternating
current
Units
electric Amperes
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_amp_f
SNVT_angle
Measurement
Units
Values Range
Invalid Value
-3.40282E38 .. N/A
Electric current
Amperes
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
1
Uint16, Float
Measurement
Phase/Rotation
Data Length
Units
Radians
Values Range
0 .. 65.535
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_angle_deg
Measurement
Units
Values Range
Invalid Value
Angular distance
degrees
-359.98 .. 360.00 Type: 655.34 Raw: 32,767
(0x7FFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_angle_f
SNVT_angle_vel
SNVT_angle_vel_f
SNVT_area
Measurement
Units
Values Range
Invalid Value
-3.40282E38 .. N/A
Phase/Rotation
Radians
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Units
Values Range
-3,276.8
3,276.7
Invalid Value
.. N/A
Angular velocity
Radians/second
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Units
Values Range
Invalid Value
-3.40282E38 .. N/A
Angular Velocity
Radians/Second
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Units
Values Range
Invalid Value
Area
Square meters (m²)
0 .. 13.1068
Type: 13.107
0xFFFF (65,535)
Raw:
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_btu_f
Measurement
Thermal Energy
Data Length
Units
British Thermal Units
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_btu_kilo
Measurement
Units
Values Range
Invalid Value
Thermal Energy
Kilo-British
Units
Thermal 0 .. 65,535
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 39 of 62
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_btu_mega
Measurement
Units
Values Range
Invalid Value
Thermal Energy
Mega-British Thermal 0 .. 65,535
Units
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_char_ascii
Measurement
Character
Units
8-bit ASCII Character
Values Range
0 .. 255
Invalid Value
N/A
Data Length
3
Suggested Data Array Formats
Data Item 1
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
Measurement
Byte, Uint16, Float
Data Item 2
Units
8-bit ASCII Character
Values Range
0 .. 255
SNVT_chlr_status
Measurement
hvac_t
Units
N/A
Values Range
0 .. 17
Data Item 3
Measurement
Units
Values Range
0 .. 255
N/A
Data Length
3
Suggested Data Array Formats
Data Item 1
Float
L_star
Measurement
Lightness
Units
Lightness
Values Range
0.0 .. 100.0
Invalid Value
N/A
SNVT_color
Data Item 2
a_star
Measurement
Redness/Greenness
Data Item 3
Units
Redness/Greenness
Values Range
-200.0 .. 200.0
Invalid Value
N/A
b_star
Measurement
Yellowness/Blueness
Data Length
Units
Yellowness/Blueness
Values Range
-200.0 .. 200.0
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_config_src
SNVT_count
Measurement
Config_source_t
Data Length
Units
N/A
Values Range
0 .. 1
Invalid Value
255 (0xFF)(CFG_NUL)
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
Measurement
Event Count
Data Length
Units
Count
Values Range
0 .. 65,535
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_count_f
SNVT_count_inc
Measurement
Event Count
Data Length
Units
Count
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Sint16, Float
Measurement
Units
Values Range
Invalid Value
Incremental Count
Count
-32,768 .. 32,767 N/A
FS-8700-21 LonWorks Manual
Data Length
Page 40 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_count_inc
Measurement
Units
Values Range
Invalid Value
Incremental Count
Count
-3.40282E38 .. N/A
3.40282E38
Data Length
3
Suggested Data Array Formats
Data Item 1
Uint16, Float
ctl_req_rcvr_id
Invalid Value
0
Measurement
Receiver ID
Units
ID number
Values Range
1 .. 65,535
SNVT_color
Data Item 2
Measurement
Sender ID
Data Item 3
Measurement
Sender priority
Data Length
ctl_req_sndr_id
Invalid Value
65,535 (0xFFFF)
ctl_req_sndr_pri
Invalid Value
N/A
Units
ID number
Values Range
1 .. 65,534
Units
Priority value
Values Range
0 .. 200
5
Suggested Data Array Formats
Data Item 1
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
Invalid Value
65,535 (0xFFFF)
3
Measurement
control_resp_t
Data Item 2
Measurement
Sender ID
Units
N/A
Values Range
0 .. 5
Units
ID number
Values Range
1 .. 65,534
SNVT_ctrl_resp
Data Item 3
Measurement
Units
Values Range
1 .. 65,534
Sender Range Lower ID ID number
Data Item 4
Measurement
ctl_rsp_snd_rupper
Data Item 5
Units
ID number
Values Range
1 .. 65,534
Measurement
Controller ID
Units
ID number
Values Range
1 .. 65,534
Data Length
Suggested Data Array Formats
Data Item 1
Sint32
Currency
Measurement
Currency_t
Data Item 2
Measurement
Magnitude
Data Item 3
Measurement
Value
Units
N/A
Values Range
0 .. 56
Invalid Value
255 (0xFF)(CU_NUL)
Power_of_10
Invalid Value
N/A
SNVT_currency
Units
Power of 10
Values Range
-128 .. 127
Currency_Value
Invalid Value
Units
Currency Value
Values Range
-2,147,483,648 .. N/A
2,147,483,647
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_count_inc
SNVT_defr_mode
Measurement
days_of_week_t
Data Length
Units
N/A
Values Range
0 .. 6
Invalid Value
255 (0xFF)
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
Units
Values Range
0 .. 2
Invalid Value
255
defrost_t
N/A
(0xFF)(DFM_MODE_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 41 of 62
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_defr_state
Measurement
defrost_state_t
Data Length
Units
N/A
Values Range
0 .. 4
Invalid Value
255 (0xFF)(DFS_NUL)
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_defr_term
Measurement
defrost_term_t
Data Length
Units
N/A
Values Range
0 .. 100
Invalid Value
255 (0xFF)(DFT_NUL)
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_density
Measurement
Units
Values Range
Invalid Value
Density
Kg/m³: kilograms per 0 .. 32,767.5
cubic meter
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_density_f
Measurement
Units
Values Range
Invalid Value
Density
Kilograms per Cubic 0 .. 3.40282E38
Meter (kg/m³)
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_dev_c_mode
Measurement
device_c_mode_t
Data Length
Units
N/A
Values Range
0 .. 29
Invalid Value
255 (0xFF)(DCM_NUL)
6
Suggested Data Array Formats
Data Item 1
Float
epos_dir_bits
Invalid Value
N/A
epos_lat_degs
Invalid Value
255 (0xFF)
epos_lat_mins
Invalid Value
Raw:
Measurement
Latitude/Longitude
Data Item 2
Units
Direction
Values Range
0 .. 255
Measurement
Latitude degrees
Data Item 3
Units
Degrees
Values Range
1 .. 90
Measurement
Latitude Minutes
Units
Minutes
Values Range
1 .. 59.999
65,535
(0xFFFF)
(0xFFFF)
SNVT_earth_pos
Type: 65.535
epos_long_degs
Invalid Value
255 (0xFF)
epos_long_mins
Invalid Value
Data Item 4
Measurement
Longitude Degrees
Data Item 5
Measurement
Longitude Minutes
Units
Degrees
Values Range
1 ..180
Units
Minutes
Values Range
1 .. 59.999
Raw:
65,535
Type: 65.535
epos_htabv_sea
Invalid Value
Data Item 6
Measurement
Units
Values Range
Height Above Sea Level Meters (m)
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 42 of 62
5
Suggested Data Array Formats
Data Item 1
Uint16, Float
etm_day
Measurement
Days
Data Item 2
Measurement
Hours
Units
Days
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
etm_hour
Invalid Value
N/A
Units
Hours
Values Range
0 .. 23
SNVT_elapsed_tm
Data Item 3
Measurement
Minutes
etm_minute
Invalid Value
N/A
Units
Minutes
Values Range
0 .. 59
Data Item 4
Measurement
Seconds
etm_second
Invalid Value
N/A
Units
Seconds
Values Range
0 .. 59
Data Item 5
Measurement
Milliseconds
Data Length
etm_millisecond
Invalid Value
N/A
Units
Milliseconds
Values Range
0 .. 999
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_elec_kwh
Measurement
Electrical energy
Data Length
Units
Kilowatt-hours
Values Range
0 .. 65,535
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Sint32
SNVT_elec_kwh_l
Measurement
Units
Values Range
-214,748,364.8
..214,748,364.6
Invalid Value
-214,748,364.7
(0x7FFFFFFF)
1
Electricity
Kilowatt-hour
Data Length
Suggested Data Array Formats
Data Item 1
Float
SNVT_elec_whr
Measurement
Electric energy
Data Length
Units
Watt-hours
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_elec_whr_f
Measurement
Electric Energy
Data Length
Units
Watt-hour
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_enthalpy
Measurement
Units
Values Range
Invalid Value
Enthalpy
KiloJoules per Kilogram -327.68 .. 327.66 Raw:
32,767
(0x7FFF)
kJ/kg Type: 327.67
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_evap_state
Measurement
Units
Values Range
Invalid Value
evap_t
N/A
0 .. 2
255 (0xFF)(EVAP_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 43 of 62
10
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
ex_ctrl_status
Invalid Value
255
Measurement
Units
Values Range
0 .. 2
ex_control_t
N/A
(0xFF)(EX_CONTROL_NUL)
ex_ctrl_domid_0,
..ex_ctrl_domid_5
Invalid Value
N/A
Data Item 2-7
Measurement
Domain ID
Units
Byte
Values Range
0 .. 255
SNVT_ex_control
Data Item 8
Measurement
Domain length
Data Item 9
Measurement
Subnet
ex_ctrl_domid_len
Invalid Value
N/A
ex_ctrl_subnet
Invalid Value
N/A
Units
Number of bytes
Values Range
0 .. 6
Units
Subnet number
Values Range
1 .. 255
Data Item 10
Measurement
Node
ex_ctrl_node
Invalid Value
N/A
Units
Node number
Values Range
1 .. 127
Data Length
2
Suggested Data Array Formats
Data Item 1
Uint32
ops_rw_ptr
Invalid Value
Measurement
Units
Values Range
0 .. N/A
SNVT_file_pos
Read/Write Pointer
File Byte Address
2,147,483,647
Data Item 2
ops_rw_len
Measurement
Read/Write Length
Data Length
Suggested Data Array Formats
Data Length
Units
Number of Bytes
Values Range
0 .. 65,535
Invalid Value
N/A
12
Byte
27
Byte
1
SNVT_file_req (only
raw data supported)
SNVT_file_status (only
raw data supported)
Suggested Data Array Formats
Data Length
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_fire_test
SNVT_flow
Measurement
fire_test_t
Units
N/A
Values Range
0 .. 3
Invalid Value
255 (0xFF)(FT_NUL)
1
Data Length
Suggested Data Array Formats
Data Item 1
Uint16, Float
Measurement
Flow volume
Data Length
Units
Liters/Second
Values Range
0 .. 65,534
Invalid Value
65,535 (0xFFFF)
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_flow_f
Measurement
Units
Values Range
Invalid Value
Flow Volume
Liters/Second
-3.40282E38 .. N/A
3.40282E38
Data Length
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_flow_mil
Measurement
Units
Values Range
Invalid Value
Flow volume
Milliliters/Second
(ml/s)
0 .. 65,535
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 44 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_flow_p
Measurement
Units
Values Range
Invalid Value
Flow volume
Cubic metres per hour
0 .. 655.34
Raw:
Type: 655.35
65,535
(0xFFFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_freq_f
SNVT_freq_hz
Measurement
Frequency
Units
Hertz
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Frequency
Data Length
Units
Hertz
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_freq_kilohz
SNVT_freq_milhz
SNVT_fire_init
Measurement
Frequency
Units
Kilohertz
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Frequency
Units
Hertz
Values Range
0 .. 6.5535
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
fire_initiator_t
Data Length
Units
N/A
Values Range
0 .. 16
Invalid Value
255 (0xFF)(FI_NUL)
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_fire_indcte
SNVT_gfci_status
SNVT_grammage
SNVT_grammage_f
SNVT_hvac_emerg
Measurement
fire_indicator_t
Data Length
Units
N/A
Values Range
0 .. 8
Invalid Value
255 (0xFF)(FN_NUL)
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
gfci_status_t
Data Length
Units
N/A
Values Range
0 .. 5
Invalid Value
255 (0xFF)(GFCI_NUL)
1
Float
Suggested Data Array Formats
Data Item 1
Measurement
Grammage
Units
Grams/Square-meter
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Grammage
Units
Grams/Square-meter
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
Units
Values Range
Invalid Value
emerg_t
N/A
0 .. 5
255 (0xFF)(EMERG_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 45 of 62
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_hvac_mode
Measurement
Hvac_t
Data Length
Units
N/A
Values Range
0 .. 17
Invalid Value
255 (0xFF)(HVAC_NUL)
3
Suggested Data Array Formats
Data Item 1
Float
hvac_ord_state
Invalid Value
255 (0xFF)(HVO_NUL)
hvac_ord_percent
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_ord_flow
Invalid Value
65,535 (0xFFF)
7
Measurement
hvac_overid_t
Data Item 2
Measurement
Percent
Units
N/A
Values Range
0 .. 48
SNVT_hvac_overid
Units
Percent of Full Scale
Values Range
-163.840
163.830
Raw:
Data Item 3
Measurement
Flow
Units
Liters per Second
Values Range
0 .. 65,534
Data Length
Suggested Data Array Formats
Data Item 1
Float
hvac_sts_mode
Invalid Value
255 (0xFF)(HV_NUL)
hvac_heat_out_pri
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_heat_out_sec
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_cool_out
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_econ_out
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_fan_out
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
hvac_in_alarm
Invalid Value
N/A
Measurement
hvac_t
Units
N/A
Values Range
0 .. 17
Data Item 2
Measurement
Primary Heat Output
Units
Percent of Full Scale
Values Range
-163.840
163.830
Raw:
Raw:
Raw:
Raw:
Raw:
Data Item 3
Measurement
Units
Values Range
-163.840
163.830
Secondary
Heat Percent of Full Scale
Output
Data Item 4
Measurement
Cooling Output
SNVT_hvac_status
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 7
Measurement
In Alarm State
Data Length
Units
Alarm value
Values Range
0 .. 1
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_hvac_type
SNVT_length
Measurement
Hvac_hvt_t
Units
N/A
Values Range
0 .. 9
Invalid Value
255 (0xFF)(HVT_NUL)
1
Float
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Invalid Value
Length
Meters (m)
0 .. 6,553.5
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 46 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_length_f
SNVT_length_kilo
SNVT_length_micr
SNVT_length_mil
SNVT_length_cont
Measurement
Length
Units
Meters
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Length
Units
Kilometers (km)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Length
Units
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Micrometers, Microns
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Length
Units
Millimeters (mm)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Float
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Continuous Level
Data Length
Units
Percent of Full Level
Values Range
0 .. 100.0
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_length_cont_f
SNVT_length_disc
Measurement
Continuous Level
Data Length
Units
Percent of Full Scale
Values Range
0 .. 100
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
Discrete_levels_t
Data Length
Units
N/A
Values Range
0 .. 4
Invalid Value
255 (0xFF)(ST_NUL)
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_length_percent
Measurement
Units
Values Range
Invalid Value
.. Type: 163.835
32,767 (0x7FFF)
1
Percentage Level
Percent of Full Scale, or -163.840
Parts-per Million (ppm) 163.830
Raw:
Data Length
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_lux
Measurement
Illumination
Data Length
Suggested Data Array Formats
Data Length
Units
Lux
Values Range
0 .. 65,535
Invalid Value
N/A
20
Byte
1
SNVT_magcard (only
raw data supported)
Suggested Data Array Formats
Data Item 1
Float
SNVT_mass
Measurement
Units
Values Range
Invalid Value
Mass
Grams
0 .. 6,553.5
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 47 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_mass_f
SNVT_mass_kilo
SNVT_mass_mega
SNVT_mass_mil
SNVT_motor_state
Measurement
Mass
Units
Grams
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Mass
Units
Kilograms (kg)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Mass
Units
Metric Tons; Tonne
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Mass
Units
Milligrams (mg)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
motor_state_t
Data Length
Units
N/A
Values Range
0 .. 7
Invalid Value
255 (0xFF)(MOTOR_NUL)
2
Suggested Data Array Formats
Data Item 1
Uint16, Float
Multiplier
Invalid Value
N/A
Measurement
Multiplier
Units
N/A
Values Range
0 .. 65,535
SNVT_mul_div
Data Item 2
Measurement
Divisor
Divisor
Invalid Value
0
Units
N/A
Values Range
1 .. 65,535
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_multiplier
Measurement
Units
Values Range
Invalid Value
Multiplier
N/A
0 .. 32.7675
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 48 of 62
15
Suggested Data Array Formats
Byte, Uint16, Float
nv_type_pid0,
..nv_type_pid7
Invalid Value
N/A
Data Item 1-8
Measurement
Program ID
Units
N/A
Values Range
0 .. 255
Data Item 9
Measurement
Scope
nv_type_scope
Invalid Value
N/A
Units
N/A
Values Range
0 .. 6
Data Item 10
Measurement
Type index
nv_type_index
Invalid Value
0
Units
N/A
Values Range
1 .. 65,535
Data Item 11
Measurement
nv_type_category_t
Data Item 12
Measurement
Type length
nv_type_cat
Invalid Value
255 (0xFF)(NVT_CAT_NUL)
nv_type_length
Invalid Value
0
Units
N/A
Values Range
1 .. 14
SNVT_nv_type
Units
Bytes
Values Range
1 .. 31
Data Item 13
Measurement
Scaling multiplier
Data Item 14
Measurement
Scaling exponent
Data Item 15
Measurement
Scaling offset
Data Length
nv_type_scale_a
Invalid Value
Units
N/A
Values Range
-32,768 .. 32,766 32,767
nv_type_scale_b
Invalid Value
-32,768 .. 32,766 32,767
nv_type_scale_c
Values Range Invalid Value
Units
N/A
Values Range
Units
N/A
-32,768 .. 32,766 32,767
2
Suggested Data Array Formats
Data Item 1
Uint16, Float
obj_request_id
Measurement
Units
Values Range
Invalid Value
SNVT_obj_request
obj_request_id
File Byte Address
0 .. N/A
2,147,483,647
Data Item 2
obj_request
Invalid Value
255 (0xFF)(RQ_NUL)
2
Measurement
object_request_t
Data Length
Units
N/A
Values Range
0 .. 17
Suggested Data Array Formats
Data Item 1
Uint32
obj_status_id
Invalid Value
N/A
obj_status_bits
Invalid Value
Measurement
Functional Block ID
Data Item 2
Units
N/A
Values Range
0 .. 65,535
SNVT_obj_status
Measurement
object_status_bits
Units
Bits
Values Range
0
.. N/A
4,294,967,295
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_occupancy
SNVT_override
Measurement
Occup_t
Units
N/A
Values Range
0 .. 3
Invalid Value
255 (0xFF)(OC_NUL)
1
Data Length
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
Measurement
Units
Values Range
Invalid Value
override_t
N/A
0 .. 2
255 (0xFF)(OV_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 49 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_pH
Measurement
Acidity
Units
pH
Values Range
-32.768 .. 32.767 N/A
Invalid Value
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_pH_f
Measurement
Units
Values Range
Invalid Value
Acidity
pH
-3.40282E38 .. N/A
3.40282E38
Data Length
9
Suggested Data Array Formats
Data Item 1
Float
pos_ctrl_rcvr_id
Measurement
Receiver ID
Units
ID number
Values Range
1 .. 65,535
Invalid Value
0
Data Item 2
pos_ctrl_cntrl_id
Invalid Value
65,535 (0xFFFF)
pos_ctrl_cntrl_prio
Invalid Value
N/A
pos_ctrl_function
Invalid Value
255 (0xFF)(CMF_NUL)
pos_ctrl_action
Invalid Value
255 (0xFF)(CMA_NUL)
pos_ctrl_number
Invalid Value
0
Measurement
Controller ID
Data Item 3
Measurement
Controller priority
Data Item 4
Measurement
cam_func_t
Data Item 5
Measurement
cam_act_t
Data Item 6
Measurement
Action number
Data Item 7
Measurement
Pan position
Units
ID number
Values Range
1 .. 65,534
Units
Priority value
Values Range
0 .. 200
Units
N/A
Values Range
0 .. 2
Units
N/A
Values Range
0 .. 2
SNVT_pos_ctrl
Units
Action number
Values Range
1 .. 255
pos_ctrl_pan
Invalid Value
Units
Degrees
Values Range
-359.98 .. 360.00 Raw:
32,767
(0x7FFF)
(0x7FFF)
(0x7FFF)
Type: 655.34
pos_ctrl_tilt
Invalid Value
Data Item 8
Measurement
Tilt position
Units
Degrees
Values Range
-359.98 .. 360.00 Raw:
32,767
Type: 655.34
pos_ctrl_zoom
Invalid Value
Data Item 9
Measurement
Zoom position
Units
Values Range
Percent of full-scale or -163.840
ppm
.. Raw:
32,767
163.830
Type: 163.835
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_power
Measurement
Power
Data Length
Units
Watts (W)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_power_f
Measurement
Units
Values Range
Invalid Value
Power
Watts
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 50 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_power_kilo
Measurement
Power
Units
KiloWatts
Values Range
0 .. 6,553.5
Invalid Value
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_ppm
Measurement
Concentration
Data Length
Units
Values Range
Invalid Value
N/A
1
Parts per Million (ppm) 0 .. 65,535
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_ppm_f
Measurement
Concentration
Data Length
Units
Parts per Million
Values Range
0 .. 3.40282E38
Invalid Value
N/A
11
Suggested Data Array Formats
Data Item 1
Uint16, Float
preset_learn
Invalid Value
255 (0xFF)(LN_NUL)
preset_selector
Invalid Value
N/A
Measurement
learn_mode_t
Data Item 2
Measurement
Selector
Units
N/A
Values Range
0 .. 3
Units
N/A
Values Range
0 .. 65,535
preset_value00,
..preset_value03
Invalid Value
N/A
Data Item 3-6
Measurement
Value
Units
Specific to SNVT
Values Range
0 .. 255
Data Item 7
Measurement
Days
Data Item 8
Measurement
Hours
preset_day
Invalid Value
65,535 (0xFFFF)
preset_hour
Invalid Value
N/A
Units
Days
Values Range
0 .. 65,534
SNVT_preset
Units
Hour
Values Range
0 .. 23
Data Item 9
Measurement
Minutes
preset_minute
Invalid Value
N/A
Units
Minutes
Values Range
0 .. 59
Data Item 10
Measurement
Seconds
preset_second
Invalid Value
N/A
Units
Seconds
Values Range
0 .. 59
Data Item 11
Measurement
Milliseconds
Data Length
preset_millisec
Invalid Value
N/A
Units
Milliseconds
Values Range
0 .. 999
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_press
Measurement
Units
Values Range
-3,276.8
3,276.6
Invalid Value
.. Type: 3,276.7
32,767 (0x7FFF)
1
Pressure (gauge)
KiloPascals
Raw:
Data Length
Suggested Data Array Formats
Data Item 1
Float
SNVT_press_f
Measurement
Units
Values Range
Invalid Value
Pressure (gauge)
Pascals
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 51 of 62
1
Suggested Data Array Formats
Data Item 1
Sint16, Float
SNVT_press_p
Measurement
Pressure (gauge)
Data Length
Units
Pascals
Values Range
-32,768 .. 32,766 32,767 (0x7FFF)
Invalid Value
3
Suggested Data Array Formats
Data Item 1
Uint16, Float
priv_zn_action
Measurement
privacyzone_t
Data Item 2
Measurement
Zone number
Data Item 3
Measurement
Camera ID
Units
N/A
Values Range
0 .. 5
Invalid Value
255 (0xFF)(PZ_NUL)
priv_zn_number
Invalid Value
0
priv_zn_camera_id
Invalid Value
0
SNVT_privacyzone
Units
Privacy zone number
Values Range
1 .. 255
Units
ID number
Values Range
1 .. 65,535
Data Length
6
Suggested Data Array Formats
Data Item 1
Float
ptz_pan_dir
Invalid Value
N/A
ptz_pan_speed
Invalid Value
N/A
Measurement
ptz_pan_dir
Data Item 2
Measurement
Pan speed
Units
Direction
Values Range
0 .. 255
Units
Percent of full level
Values Range
0.0 .. 100.0
Data Item 3
Measurement
tilt_dir_t
Data Item 4
Measurement
Tilt speed
ptz_tilt_dir
Invalid Value
255 (0xFF)(TILT_NUL)
ptz_tilt_speed
Invalid Value
N/A
Units
N/A
Values Range
0 .. 2
SNVT_ptz
Units
Percent of full level
Values Range
0.0 .. 100.0
Data Item 5
Measurement
zoom_t
Data Item 6
Measurement
ptz_zoom_speed
ptz_zoom
Units
N/A
Values Range
0 .. 2
Invalid Value
255 (0xFF)(ZOOM_NUL)
ptz_zoom_speed
Invalid Value
Units
Meters (m)
Values Range
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 52 of 62
13
Suggested Data Array Formats
Data Item 1
Float
pump_sn_rot_speed
Invalid Value
N/A
Measurement
Frequency
Units
Hertz
Values Range
0 .. 6,553.4
Data Item 2
pump_sn_body_temp
Invalid Value
-274.0 .. 6,279.4 N/A
pump_sn_mot_ext_temp
Invalid Value
-274.0 .. 6,279.4 N/A
Measurement
Body temperature
Data Item 3
Measurement
Motor
Units
Degrees celcius
Values Range
Units
Values Range
external Degrees celcius
temperature
Data Item 4
Measurement
Motor
pump_sn_mot_int_temp
Invalid Value
-274.0 .. 6,279.4 N/A
Units
Values Range
internal Degrees celcius
temperature
Data Item 5
Measurement
Boolean
Data Item 6
Measurement
Boolean
Data Item 7
Measurement
Boolean
Data Item 8
Measurement
pump_sn_mot_overload
Invalid Value
Units
Bit
Values Range
0, 1
255 (0xFF)(BOOL_NUL)
pump_sn_oil_low
Invalid Value
255 (0xFF)(BOOL_NUL)
pump_sn_ph_imbal
Invalid Value
255 (0xFF)(BOOL_NUL)
pump_sn_curr_use
Invalid Value
Units
Bit
Values Range
0, 1
SNVT_pump_sensor
Units
Bit
Values Range
0, 1
Units
Ampere
Values Range
-3,276.8
Electric current usage
.. N/A
3,276.6
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
pump_sn_pwr_usage
Invalid Value
N/A
pump_sn_temp_ctrl
Invalid Value
255 (0xFF)(TEMP_NUL)
pump_sn_em_brake_act
Invalid Value
255 (0xFF)(BOOL_NUL)
pump_sn_fric_brk_act
Invalid Value
255 (0xFF)(BOOL_NUL)
pump_sn_gas_brk_act
Invalid Value
Units
Kilowatts
Values Range
0 .. 6,553.4
Units
N/A
Values Range
0 .. 3
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
255 (0xFF)(BOOL_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 53 of 62
8
Suggested Data Array Formats
Data Item 1
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
Measurement
motor_state_t
Data Item 2
Measurement
motor_state_t
Data Item 3
Measurement
priority_level_t
Data Item 4
Measurement
Boolean_t
Units
N/A
Values Range
0 .. 7
Units
N/A
Values Range
0 .. 7
Units
N/A
Values Range
0 .. 11
Units
Bit
Values Range
0, 1
SNVT_pumpset_mn
Data Item 5
Measurement
Boolean_t
Units
Bit
Values Range
0, 1
Data Item 6
Measurement
Boolean_t
Units
Bit
Values Range
0, 1
Data Item 7
Measurement
Boolean_t
Units
Bit
Values Range
0, 1
255 (0xFF)(BOOL_NUL)
pset_maint_req
Invalid Value
Data Item 8
Measurement
Boolean_t
Units
Bit
Values Range
0, 1
255 (0xFF)(BOOL_NUL)
FS-8700-21 LonWorks Manual
Data Length
Page 54 of 62
14
Suggested Data Array Formats
Data Item 1
Float
pset_sn_dil_flow
Invalid Value
N/A
Measurement
Units
Values Range
0 .. 65,534
Total Dilution Flow Milliliters per second
Volume
Data Item 2
pset_sn_exh_temp
Measurement
Exhaust Temperature
Data Item 3
Measurement
Exhaust Pressure
Units
Degrees Celcius
Values Range
Invalid Value
-274.0 .. 6,279.4 N/A
pset_sn_exh_press
Invalid Value
.. N/A
Units
Kilo-pascals
Values Range
-3,276.8
3,276.6
Data Item 4
pset_sn_seal_press
Measurement
Units
purge Kilo-pascals
Values Range
-3,276.8
Invalid Value
.. N/A
Shaft
seal
pressure
3,276.6
Data Item 5
pset_sn_inlet_vacuum
Measurement
Units
Values Range
Invalid Value
Inlet vacuum pressure Kilo-pascals
-3.40282E38 .. N/A
3.40282E38
Data Item 6
Measurement
Supply voltage
pset_sn_supply_volts
Invalid Value
.. N/A
Units
Volts
Values Range
-3,276.8
3,276.6
SNVT_pumpset_mn
Data Item 7
Measurement
Total coolant flow
Data Item 8
Measurement
Boolean
Data Item 9
Measurement
Boolean
Data Item 10
Measurement
Boolean
Data Item 11
Measurement
Boolean
Data Item 12
Measurement
Boolean
Data Item 13
Measurement
Boolean
Data Item 14
Measurement
Boolean
pset_sn_cool_flow
Invalid Value
N/A
pset_sn_cool_fl_low
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
Units
Milliliters per second
Values Range
0 .. 65,534
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
Units
Bit
Values Range
0, 1
255 (0xFF)(BOOL_NUL)
pset_sn_pwr_sup_on
Invalid Value
255 (0xFF)(BOOL_NUL)
1
Units
Bit
Values Range
0, 1
Data Length
Suggested Data Array Formats
Data Item 1
Float
SNVT_pwr_fact
Measurement
Units
Values Range
Invalid Value
Power Factor
Multiplier
-1.00000 .. N/A
1.00000
FS-8700-21 LonWorks Manual
Data Length
Page 55 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_pwr_fact_f
Measurement
Power Factor
Data Length
Units
N/A
Values Range
-1 .. 1
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_pwr_fact_f
Measurement
Power Factor
Data Length
Units
N/A
Values Range
-1 .. 1
Invalid Value
N/A
3
Suggested Data Array Formats
Data Item 1
Sint32
reg_val_value
Invalid Value
Measurement
Units
Values Range
Raw value
Defined by unit field
-2,147,483,638 .. N/A
2,147,483,647
SNVT_reg_val
Data Item 2
reg_val_unit
Measurement
reg_val_unit_t
Data Item 3
Measurement
Decimal Place
Units
N/A
Values Range
0 .. 43
Invalid Value
255 (0xFF)(RVU_NUL)
reg_val_decimals
Invalid Value
N/A
Units
Values Range
Digits to Right of 0 ..7
Decimal Point
Data Length
9
Suggested Data Array Formats
Data Item 1
Sint32
reg_val_ts_raw
Invalid Value
Measurement
Units
Values Range
Raw Value
-2,147,483,648 .. N/A
2,147,483,647
Data Item 2
Measurement
reg_val_unit_t
Data Item 3
Measurement
See SNVT tables
Data Item 4
Measurement
Year
reg_val_ts_unit
Units
N/A
Values Range
0 .. 43
Invalid Value
255 (0xFF)(RVU_NUL)
reg_val_ts_bits
Invalid Value
N/A
reg_val_ts_year
Invalid Value
N/A
Units
See SNVT tables
Values Range
0 .. 255
Units
Year
Values Range
0 .. 300
SNVT_reg_val_ts
Data Item 5
Measurement
Month
reg_val_ts_month
Invalid Value
N/A
Units
Month of Year
Values Range
0 .. 12
Data Item 6
Measurement
Day
reg_val_ts_day
Invalid Value
N/A
Units
Day of Month
Values Range
0 .. 31
Data Item 7
Measurement
Hour
reg_val_ts_hour
Invalid Value
N/A
Units
Hour of day
Values Range
0 .. 23
Data Item 8
Measurement
Minutes
reg_val_ts_min
Invalid Value
N/A
Units
Minute of Hour
Values Range
0 .. 59
Data Item 9
Measurement
Minutes
reg_val_ts_secs
Invalid Value
N/A
Units
Minute of Hour
Values Range
0 .. 59
FS-8700-21 LonWorks Manual
Data Length
Page 56 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_res
SNVT_res_f
SNVT_res_kilo
Measurement
Electrical Resistance
Data Length
Units
Ohms
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
Measurement
Electrical Resistance
Data Length
Units
Ohms
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
Measurement
Electrical Resistance
Data Length
Units
KiloOhms
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_rpm
Measurement
Units
Values Range
Invalid Value
Angular Velocity
Revolutions per Minute 0 .. 65,534
(RPM)
65,535 (0xFFFF)
Data Length
2
Suggested Data Array Formats
Byte, Uint16, Float
Data Item 1
Function
Measurement
Scene_t
Data Item 2
Measurement
Scene Number
Data Length
Units
N/A
Values Range
0 .. 23
Invalid Value
255 (0xFF)(SC_NUL)
Scene_Number
Invalid Value
N/A
SNVT_scene
Units
Scene Number
Values Range
1 .. 255
7
Suggested Data Array Formats
Data Item 1
Float
scn_cfg_func
Invalid Value
255 (0xFF)(SCF_NUL)
scn_cfg_scene
Invalid Value
N/A
scn_cfg_setting
Invalid Value
N/A
Measurement
scene_config_t
Data Item 2
Units
N/A
Values Range
0 .. 4
Measurement
Scene Number
Data Item 3
Units
Scene Number
Values Range
1 .. 255
Measurement
Scene Setting Level
Data Item 4
Units
Percent of Full Level
Values Range
0 .. 100.0
scn_cfg_rotation
Invalid Value
Measurement
Scene Rotation Angle
Units
Degrees
Values Range
SNVT_scene_cfg
-359.98 .. 360.00 Raw:
32,767
(0x7FFF)
(0xFFFF)
(0xFFFF)
Type: 655.34
scn_cfg_fade_tim
Invalid Value
Data Item 5
Measurement
Scene Fade Time
Units
Seconds
Values Range
0.0 to 6,553.4
Raw:
65,535
Type: 6553.5
scn_cfg_dly_tim
Invalid Value
Data Item 6
Measurement
Scene Delay Time
Units
Seconds
Values Range
0.0 to 6,553.4
Raw:
65,535
Type: 6553.5
scn_cfg_scn_proi
Invalid Value
N/A
Data Item 7
Measurement
Scene Priority
Units
Priority Value
Values Range
0 .. 255
FS-8700-21 LonWorks Manual
Data Length
Page 57 of 62
3
Suggested Data Array Formats
Data Item 1
Float
setting_function
Invalid Value
255 (0xFF)(SET_NUL)
setting_setting
Invalid Value
N/A
Measurement
setting_t
Units
N/A
Values Range
0 .. 5
Data Item 2
SNVT_setting
Measurement
Scene Setting Level
Data Item 3
Units
Percent of Full Level
Values Range
0 .. 100.0
setting_rotation
Invalid Value
Measurement
Rotation Angle
Units
Degrees
Values Range
-359.98 .. 360.00 Raw:
(0x7FFF)
32,767
Type: 655.34
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_smo_obscur
SNVT_sound_db
Measurement
Smoke Obscuration
Data Length
Units
Percent Obscuration
Values Range
0.000 .. 5.000
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
Measurement
Sound Level
Data Length
Units
Decibels
Values Range
-327.68 .. 327.67 N/A
Invalid Value
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_sound_db_f
SNVT_speed
Measurement
Units
Values Range
Invalid Value
Sound Level
Decibels from Sound -3.40282E38 .. N/A
Pressure Level
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Linear Velocity
Data Length
Units
Meters per Second
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_speed_f
Measurement
Units
Values Range
Invalid Value
Speed
Meters per Second
-3.40282E38 .. N/A
3.40282E38
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_speed_mil
SNVT_state
Measurement
Linear Velocity
Data Length
Units
Values Range
Invalid Value
N/A
1
Millimeters per Second 0 .. 65.535
Suggested Data Array Formats
Data Item 1
Uint16, Float
Measurement
Units
Values Range
Invalid Value
16 state bits
Bits
0 .. 65,535
N/A
FS-8700-21 LonWorks Manual
Data Length
Page 58 of 62
4
Suggested Data Array Formats
Data Item 1
Packed_Bit, Uint16, Float
state_64_word0
Measurement
Units
Values Range
Invalid Value
Boolean
Bit
0, 1 per bit ( 16 N/A
bits in word )
Data Item 2
Measurement
Boolean
state_64_word1
Invalid Value
0, 1 per bit ( 16 N/A
bits in word )
Units
Bit
Values Range
SNVT_state_64
Data Item 3
Measurement
Boolean
state_64_word2
Invalid Value
0, 1 per bit ( 16 N/A
bits in word )
Units
Bit
Values Range
Data Item 4
Measurement
Boolean
state_64_word3
Invalid Value
0, 1 per bit ( 16 N/A
Units
Bit
Values Range
bits in word )
Data Length
31
Suggested Data Array Formats
Data Item 1 - 31
Byte, Uint16, Float
SNVT_str_asc
SNVT_str_int
ascii00, ascii01, .. ascii30
Invalid Value
N/A
Measurement
Character String
Data Length
Units
N/A
Values Range
0 .. 255
16
Suggested Data Array Formats
Data Item 1
Uint16, Float
char_set
Invalid Value
N/A
wide_char00,
wide_char14
Invalid Value
N/A
Measurement
Locale Code
Units
N/A
Values Range
0 .. 255
Data Item 2 - 16
..
Measurement
Units
Values Range
0 .. 65,535
Wide-character string N/A
with NULL terminator
Data Length
2
Suggested Data Array Formats
Data Item 1
Float
Value
Measurement
Value
Units
Values Range
Invalid Value
N/A
SNVT_scene
Percentage of full scale 0 .. 100.0
Data Item 2
Measurement
State
State
Invalid Value
-1
Units
N/A
Values Range
0 .. 1
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_telcom
SNVT_temp
Measurement
telcom_states_t
Data Length
Units
N/A
Values Range
0 .. 20
Invalid Value
255 (0xFF)(TEL_NUL)
1
Float
Suggested Data Array Formats
Data Item 1
Measurement
Temperature
Data Length
Units
Degrees Celsius
Values Range
-274.0 .. 6,279.5 N/A
Invalid Value
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_temp_diff_p
Measurement
Temperature
difference
Units
Degrees Celcius
Values Range
Invalid Value
-327.68 .. 327.66 Raw:
32,767
(0x7FFF)
Type: 655.34
FS-8700-21 LonWorks Manual
Data Length
Page 59 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_temp_f
SNVT_temp_p
SNVT_temp_ror
Measurement
Units
Values Range
Invalid Value
-3.40282E38 .. N/A
Incremental Count
Degrees Celcius
3.40282E38
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Units
Values Range
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Temperature
Degrees celsius
(0x7FFF)
1
Float
Data Length
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Invalid Value
.. Raw: 32,767
Temperature Rate of Degrees Celsius per -16,384.0
(0x7FFF)
Change/Rise
Minute (˚C/min)
16,383.0
Type: 16,383.5
Data Length
6
Suggested Data Array Formats
Data Item 1
Float
Occupied_cool
Invalid Value
Measurement
Units
Values Range
Occupied
Cooling Degrees Celsius
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Setpoint
(0x7FFF)
Data Item 2
Measurement
Standby
Standby_cool
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Units
Values Range
Cooling Degrees Celsius
Setpoint
(0x7FFF)
Data Item 3
Measurement
Unoccupied
Setpoint
Unoccupied_cool
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Units
Values Range
Cooling Degrees Celsius
SNVT_temp_setpt
(0x7FFF)
Data Item 4
Measurement
Occupied
Occupied_heat
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Units
Values Range
Heating Degrees Celsius
Setpoint
(0x7FFF)
Data Item 5
Measurement
Standby
Standby_heat
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Units
Values Range
Heating Degrees Celsius
Setpoint
(0x7FFF)
Data Item 6
Measurement
Unoccupied
Setpoint
Unoccupied_heat
Invalid Value
-273.17 .. 327.66 Type: 327.67 Raw: 32,767
Units
Values Range
Heating Degrees Celsius
(0x7FFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_therm_mode
SNVT_time_f
Measurement
therm_mode_t
Data Length
Units
N/A
Values Range
0 .. 2
Invalid Value
255 (0xFF)(THERM_NUL)
1
Float
Suggested Data Array Formats
Data Item 1
Measurement
Units
Values Range
Invalid Value
Elapsed Time
Seconds
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 60 of 62
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_time_hour
SNVT_time_min
SNVT_time_sec
Measurement
Elapsed Time
Data Length
Units
Hours
Values Range
0 .. 65,535
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
Measurement
Elapsed Time
Data Length
Units
Minutes
Values Range
0 .. 65,535
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
Measurement
Elapsed time
Data Length
Units
Seconds
Values Range
0 .. 6,553.4
Invalid Value
65,535 (0xFFFF)
6
Suggested Data Array Formats
Data Item 1
Uint16, Float
ts_year
Measurement
Year
Data Item 2
Measurement
Month
Units
Year
Values Range
0 .. 3000
Invalid Value
65,535 (0xFFFF)
ts_month
Invalid Value
N/A
Units
Month of Year
Values Range
0 .. 12
Data Item 3
Measurement
Day
ts_day
Invalid Value
N/A
Units
Day of Month
Values Range
0 .. 31
SNVT_time_stamp
Data Item 4
Measurement
Hours
ts_hour
Invalid Value
N/A
Units
Hours of Day
Values Range
0 .. 23
Data Item 5
Measurement
Minutes
ts_minute
Invalid Value
N/A
Units
Minute of Hour
Values Range
0 .. 59
Data Item 6
Measurement
Second
ts_second
Invalid Value
N/A
Units
Second of Minute
Values Range
0 .. 59
Data Length
Suggested Data Array Formats
Data Length
15
Byte
3
SNVT_time_zone (only
raw data supported)
Suggested Data Array Formats
Data Item 1
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
Measurement
occup_t
Units
N/A
Values Range
0 .. 3
SNVT_tod_event
Data Item 2
Measurement
occup_t
Units
N/A
Values Range
0 .. 3
Data Item 3
Measurement
Time to Next State
Data Length
Units
Minute of Hour
Values Range
0 .. 65,535
8
Suggested Data Array Formats
Data Item 1-7
Float
tr_point00, ..tr_point06
Invalid Value
Measurement
Units
Values Range
SNVT_trans_table
Axis-points Array
N/A
-3.40282E38 .. N/A
3.40282E38
Data Item 8
Measurement
interp_t
interp_methods
Invalid Value
N/A
Units
N/A
Values Range
0 .. 65,535
FS-8700-21 LonWorks Manual
Data Length
Page 61 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_turbidity
Measurement
Units
Values Range
Invalid Value
Turbidity
Nephelometric
Turbidity Units (NTU)
0 .. 65.534
65,535 (0xFFFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_turbidity_f
Measurement
Units
Values Range
Invalid Value
Turbidity
Nephelometric
Turbidity Units (NTU)
0 .. 3.40282E38
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Byte, Uint16, Float
SNVT_valve_mode
SNVT_vol
Measurement
valve_mode_t
Data Length
Units
N/A
Values Range
0 .. 7
Invalid Value
255 (0xFF)(VALVE_NUL)
1
Float
Suggested Data Array Formats
Data Item 1
Measurement
Volume
Data Length
Units
Liters
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_vol_f
Measurement
Volume
Data Length
Units
Liters
Values Range
0 .. 3.40282E38
Invalid Value
N/A
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_vol_kilo
SNVT_vol_mil
Measurement
Volume
Units
Kiloliters (kl)
Values Range
0 .. 6,553.5
Invalid Value
N/A
1
Data Length
Suggested Data Array Formats
Data Item 1
Float
Measurement
Volume
Units
Milliliters
Values Range
0 .. 6,553.5
Invalid Value
N/A
Data Length
1
Suggested Data Array Formats
Data Item 1
Uint16, Float
SNVT_volt_ac
Measurement
Units
Values Range
Invalid Value
Electric Voltage
Volts,
Current (VAC)
Alternating 0 .. 65,534
65,535 (0xFFFF)
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_volt_dbmv
SNVT_volt_f
Measurement
Units
Values Range
-3,276.8
3,276.7
Invalid Value
.. N/A
Electric Voltage
Decibels-milliVolts,
Direct Current
Data Length
Suggested Data Array Formats
Data Item 1
1
Float
Measurement
Units
Values Range
Invalid Value
Electric Voltage
Volts
-3.40282E38 .. N/A
3.40282E38
FS-8700-21 LonWorks Manual
Data Length
Page 62 of 62
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_volt_kilo
Measurement
Units
Values Range
-3,276.8
Invalid Value
.. N/A
Electric Voltage
Kilovolts
3,276.7
Data Length
1
Suggested Data Array Formats
Data Item 1
Float
SNVT_volt_mil
Measurement
Units
Values Range
-3,276.8
Invalid Value
.. N/A
Electric Voltage
Millivolts
3,276.7
Data Length
2
Suggested Data Array Formats
Data Item 1
Float
zero
Measurement
Units
Values Range
Invalid Value
Zero-term
Percent (%) or Parts- -163.840
.. N/A
SNVT_zerospan
per-Million (ppm)
163.835
Data Item 2
Measurement
Span-factor
span
Invalid Value
N/A
Units
Values Range
Percent (%) or Parts- 0 .. 32.7675
per-Million (ppm)
|