3 Driver Scope of Supply ................................................................................................................................... 6
3.1Supplied by FieldServer Technologies for this driver ..................................................................................... 6
3.2Provided by the Supplier of 3rd Party Equipment .......................................................................................... 6
3.3Additional files required for the Driver .......................................................................................................... 6
4.2Neuron ID ....................................................................................................................................................... 8
5.1.6 Client vs Server Mapping ..................................................................................................................... 10
5.2Client Side Mapping ..................................................................................................................................... 10
6.2Client Side Configuration ............................................................................................................................. 17
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
6.2.5 Map Descriptor Example 1 - Explicit Configuration using Network Management Polls ...................... 19
6.2.6 Map Descriptor Example 2 – Polling UNVT’s ....................................................................................... 19
6.2.7 Using Neuron ID to Address Devices (Client Drivers only) .................................................................... 20
6.3Server Side Configuration ............................................................................................................................ 21
6.3.6 Map Descriptor Example ...................................................................................................................... 23
Appendix A. Useful Features ................................................................................................................................ 24
Appendix A.1. Using UNVT’s .................................................................................................................................... 24
Appendix A.2. Using NV_Min, NV_Max etc. ............................................................................................................ 24
Appendix A.7. Node Status Operation ..................................................................................................................... 27
Appendix A.8. Working with Binary Data ................................................................................................................ 27
Appendix A.9.1. SNVT_Option Field ................................................................................................................. 28
Appendix A.9.2. SNVT_Units Field .................................................................................................................... 28
Appendix B. Vendor Information ......................................................................................................................... 30
Appendix C.6. Service types currently supported for network variable messages ................................................. 35
Appendix C.7. Combining Explicit and Implicit ........................................................................................................ 35
Appendix D. SNVT_Type ...................................................................................................................................... 36
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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 FSB30 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
LonMaker® - see Appendix B.1.1 for further information.
2.2.1 LonWorks - Program ID Calculat ion (SPID)
Network management tools use the Program ID to identify the different applications running on each device. Two devices on
a network may have the same Program ID only if they have identical application/configurations
The Program ID for the FieldServer consists of a fixed and a variable field (XX in the Program ID below)..
90:00:95:47:1E:02:04:XX
The fixed part does not change for different configuration files or for different LonWorks driver versions. The variable part
XX, which is also defined as the Model or Revision number, does however change.
The variable part is calculated at start-up when the configuration is loaded on the FieldServer. Certain critical fields in the
configuration file are used to calculate this variable part of the Program ID. Thus if the configuration file changes significantly
(critical fields) the Program ID will change. Also, as we add new features and capabilities to the LonWorks driver, this variable
part of the Program ID may be different between LonWorks driver versions (even though the configuration file is the same).
It is possible though very unlikely that through a change in LonWorks driver and/or configuration file, the program IDs
calculates out identical to another combination of driver and configuration. If this is the case with two FieldServers on the
same network that run different configurations, one of these devices may fail to commission properly.
The following configuration can be used to force the SPID.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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
the FieldServer is to upload it. Refer to Appendix A.4 for details.
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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:
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 FSB2011 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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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
Appendix C.3.
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.
4.4 The LonWorks Adapter Card (FS-X40 only)
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:
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Network Variable Polled Input Implicitly addressed Continuously sent
RDBC
NVUOIMC
Network Variable Update Output Implicitly addressed Continuously sent
WRBC
NVUOIMX
Network Variable Update Output Implicitly addressed and sent on Change
WRBX
NVUOIMT
Network Variable Update Output Implicitly addressed sent in Throttling Mode
WRBC See Appendix A.3
CFG_NVUI
Configuration Network Variable Update Input
PASSIVE
5 IMPLICIT CONFIGURATI ONS
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.
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):
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).
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Specify Network Management. Primarily used for Circon_SI, refer
to Appendix C.5.
LonMaker, LonWatcher,
Circon_SI, None
// Client Side Connections
Connections
Adapter
,Protocol
LonWorks
,LonWorks
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 Mapp ing
5.2.1 Connection Parameters
Example
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Name of Node to fetch data from or send data to. Needed for Explicit
Addressing.
One of the node names
specified in “Client Node
Descriptors” above
SNVT_Type
Standard network variable type of the data
See Appendix D
SNVT_Option*
Specifies which record out of a complex SNVT we are after.
See Appendix A.9.1
SNVT_Units*
Specifies the measurement units (e.g. Metric or English)
See Appendix A.9.2
UNVT_Byte_Length*
Specifies the length in bytes of an UNVT. This Parameter is compulsory
when SNVT_Type is set to UNVT, the parameter is not used in
conjunction with SNVT’s
1-255. See Appendix A.1
UNVT_ID
Specifies the Type Number to apply to this particular UNVT. This
Parameter is optional when SNVT_Type is set to UNVT, the parameter
is not used on conjunction with SNVT’s
0, 146-255. See Appendix
A.1
NV_Min_Value*
Network Variable updates with values less than specified in this field
will be ignored.
See Appendix A.2
NV_Max_Value*
Network Variable updates with values higher than specified in this field
will be ignored.
See Appendix A.2
NV_Delta_Value*
Network Variable updates where the value’s delta change is less than
specified in this field will be ignored unless the Max_Scan_Time
Condition has been met. Compulsory for Throttling Lon Functions only.
Not used on other Lon Functions.
See Appendix A.3
NV_Selfdoc_Text*
The Self-Documenting String for this Network Variable.
Normal Text up to a
length of 40 characters
Column Title
Function
Legal Values
Scan_Interval
Seconds per scan
0-32000
Min_Scan_Time
Minimum Scan Time in seconds.
See Appendix A.3
Max_Scan_Time
Maximum Scan Time in seconds.
See Appendix A.3
5.2.4 Driver Related Map Descriptor Parameters
5.2.5 Timing Parameters
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Network Variable Polled Input Explicitly addressed Continuously sent
RDBC
NVUOEXC
Network Variable Update Output Explicitly addressed Continuously sent
WRBC
NVUOEXX
Network Variable Update Output Explicitly addressed and sent on Change
WRBX
NVUOEXT
Network Variable Update Output Explicitly addressed sent in Throttling Mode
WRBC
NMFETCHC
Network Management Network Variable Fetch Continuously sent (Explicit Addressing only)
RDBC
CFG_NVUI
Configuration Network Variable Update Input
SERVER
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.
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
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
Example 2: Setting the Domain and Subnet from the configuration file
The Title field must start with “:D”, followed by the Domain_ID in hexadecimal notation, followed by “:S”, followed by the
Subnet_ID in hexadecimal notation 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.
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 thi s 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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Name of Node to fetch data from or send data to. Needed for Explicit
Addressing.
One of the node names
specified in “Client Node
Descriptors” above
SNVT_Index
Server Network Variable Index
0-4095
SNVT_Type
Standard network variable type of the data
See Appendix D
SNVT_Option*
Specifies which record out of a complex SNVT we are after.
See Appendix A.9.1
SNVT_Units*
Specifies the measurement units if something other than Metric is
required
See Appendix A.9.2
UNVT_Byte_Length*
Specifies the length in bytes of an UNVT. This Parameter is compulsory
when SNVT_Type is set to UNVT, the parameter is not used on
conjunction with SNVT’s
1-255. See Appendix A.1
UNVT_ID
Specifies the Type Number to apply to this particular UNVT. This
Parameter is optional when SNVT_Type is set to UNVT, The parameter
is not used on conjunction with SNVT’s
0, 146-255. See Appendix
A.1.
NV_Min_Value*
Network Variable updates with values less than specified in this field
will be ignored.
See Appendix A.2
NV_Max_Value*
Network Variable updates with values higher than specified in this field
will be ignored.
See Appendix A.2
NV_Delta_Value*
Network Variable updates where the value’s delta change is less than
specified in this field will be ignored unless the Max_Scan_Time
Condition has been met. Compulsory for Throttling Lon Functions only.
Not used on other Lon Functions.
See Appendix A.2
NV_Selfdoc_Text*
The Self-Documenting String for this Network Variable.
Normal Text up to a
length of 40 characters
Column Title
Function
Legal Values
Scan_Interval*
Seconds per scan
0-32000,
2s
Min_Scan_Time*
Minimum Scan Time in seconds. Compulsory for Throttling Lon Functions only. Not
used on other Lon Functions.
See Appendix
A.3
Max_Scan_Time*
Maximum Scan Time in seconds. Compulsory for Throttling Lon Functions only. Not
used on other Lon Functions.
See Appendix
A.3
6.2.3 Driver Related Map Descriptor Parameters
6.2.4 Timing Parameters
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
This field
determines the
Map
Descriptor’s
function. See
Section 6.1.2
for more
information.
UNVT Byte length must be specified for correct
operation.
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
6.2.6 Map Descriptor Example 2 – Polling UNVT’s
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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
On the Client side Nodes add a new field as shown below:
Create a Map Descriptor as Follows:
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Name of Node to fetch data from or send data to. Needed for
Explicit Addressing.
One of the node names
specified in “Client
Node Descriptors”
above
SNVT_Index
Server Network Variable Index
0-4095
SNVT_Type
Standard network variable type of the data
See Appendix D
SNVT_Option
Specifies which record out of a complex SNVT we are after.
See Appendix A.9.1
SNVT_Units
Specifies the measurement units if something other than
Metric is required
See Appendix A.9.2
UNVT_Byte_Length*
Specifies the length in bytes of an UNVT. This Parameter is
compulsory when SNVT_Type is set to UNVT, the parameter is
not used on conjunction with SNVT’s
1-255. See Appendix
A.1
UNVT_ID
Specifies the Type Number to apply to this particular UNVT.
This Parameter is optional when SNVT_Type is set to UNVT, the
parameter is not used on conjunction with SNVT’s
0,146-255. See
Appendix A.1.
NV_Min_Value*
Network Variable updates with values less than specified in
this field will be ignored.
See Appendix A.2
NV_Max_Value*
Network Variable updates with values higher than specified in
this field will be ignored.
See Appendix A.2
NV_Delta_Value*
Network Variable updates where the value’s delta change is
less than specified in this field will be ignored unless the
Max_Scan_Time Condition has been met. Compulsory for
Throttling Lon Functions only. Not used on other Lon
Functions.
See Appendix A.2
NV_Selfdoc_Text
The Self-Documenting String for this Network Variable.
Normal Text up to a
length of 40 characters
Column Title
Function
Legal Values
Scan_Interval*
Seconds per scan
0-32000,
2s
Min_Scan_Time*
Minimum Scan Time in seconds. Compulsory for Throttling Lon Functions
only. Not used on other Lon Functions.
See Appendix
A.3
Max_Scan_Time*
Maximum Scan Time in seconds. Compulsory for Throttling Lon Functions
only. Not used on other Lon Functions.
See Appendix
A.3
6.3.4 Driver Related Map Descriptor Parameters
6.3.5 Timing Parameters
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
Server NVUI can be grouped with
Client NV Update types and
NMFETCHC. Server
NVPO can be grouped with Client
NV Poll types and NMFETCHC.
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.
Required for Throttling Mode: This field specifies the
minimum change needed for a Network Variable’s
value to invoke an NV Update.
Explicitly Addressed Client Map
Descriptors use this field to point
to their relevant Server Map
Descriptors.
6.3.6 Map Descriptor Example
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
UNVT’s are User-defined Network Variable Types and are defined in the configuration file by filling the SNVT_Type field with
“UNVT”. The UNVT’s size in bytes should also be added to the UNVT_Byte_Length field and the UNVT’s type number in the
UNVT_ID field. Valid UNVT_IDs are 0 and the range 146 to 255. The UNVT_ID value will be substituted with the default value
of 0 if the field is left empty. Refer to the example in Section 6.2.3
Appendix A.2. Using NV_Min, NV_Max etc.
The NV_Min_Value, NV_Max_Value functionality were added to stop the propagation of ‘out of bounds’ network variables
across a LonWorks network. NV values higher than assigned by the NV_Max_Value field or lower than assigned by
NV_Min_Value field will not be sent out on the network or copied to their relevant Data Arrays. If one or both of these fields
are not assigned values, limit checking will not be performed on that particular field. This functionality applies only to SNVT's
of either Floating point or Integer formats. Refer to the examples in Sections 5.2.6 and 6.3.6.
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
than or equal to the Max_Scan_Time field value. Refer to the examples in Sections 5.2.6 and 6.3.6.
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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:
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 SelfDocumentation Strings in order to create a LonMark Object please consult the following documentation from the LonMark
Interoperability Association at www.lonmark.org
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
The Node SelfDocumentation String
defines one LonMark
object of type 1 – Open
Loop Sensor.
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
defines the 1st Network
Variable of the object.
The Node SelfDocumentation String
defines one LonMark
object of type 3 – Open
Loop Actuator.
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 recommissioning is required.
The object index is 0 and
this Map Descriptor
defines the 1st Network
Variable of the object.
LonMark Config file Example #1 – Open Loop “Water Temperature” Sensor:
LonMark Config file Example #2 – “Water Heating Element” Actuator:
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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 offline (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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
1
See Also Appendix A.8
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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”.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
"LON:#03 FYI. Standard driver build. This is normal.
This message is informational and can be safely ignored.
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.
Declaring the Map Descriptor functions as WRBC, or WRBX can do this. See Section 5.1.2 for more
information.
If the domain and Subnet ID are defined in the configuration file of the FieldServer, these values will be
used when power is cycled to the FieldServer. If the values set here are different to what the Network
Manager has set up for the FieldServer for clients using implicit addressing, the FieldServer will stop
communicating. In this case, change these settings or remove them from the configuration file
completely and recommission the FieldServer.
Appendix C.2. Error Messages
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Increments each time Neuron ID is read. Used for scripting
2
Overwritten each time Neuron ID is read. Contains 1st byte of Neuron ID
3
Overwritten each time Neuron ID is read. Contains 2nd byte of Neuron ID
4
Overwritten each time Neuron ID is read. Contains 3rd byte of Neuron ID
5
Overwritten each time Neuron ID is read. Contains 4th byte of Neuron ID
6
Overwritten each time Neuron ID is read. Contains 5th byte of Neuron ID
7
Overwritten each time Neuron ID is read. Contains 6th byte of Neuron ID
8
Not Used
9
Not Used
10
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
11
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
12
Overwritten each time Neuron ID is read. Contains 1st nibble of 2nd byte of Neuron ID as an ASCII
char
13
Overwritten each time Neuron ID is read. Contains 2nd nibble of 2nd byte of Neuron ID as an ASCII
char.
14
Overwritten each time Neuron ID is read. Contains 1st nibble of 3rd byte of Neuron ID as an ASCII
char.
15
Overwritten each time Neuron ID is read. Contains 2nd nibble of 3rd byte of Neuron ID as an ASCII
char.
16
Overwritten each time Neuron ID is read. Contains 1st nibble of 4th byte of Neuron ID as an ASCII
char.
17
Overwritten each time Neuron ID is read. Contains 2nd nibble of 4th byte of Neuron ID as an ASCII
char.
18
Overwritten each time Neuron ID is read. Contains 1st nibble of 5th byte of Neuron ID as an ASCII
char.
19
Overwritten each time Neuron ID is read. Contains 2nd nibble of 5th byte of Neuron ID as an ASCII
char.
20
Overwritten each time Neuron ID is read. Contains 1st nibble of 6th byte of Neuron ID as an ASCII
char.
21
Overwritten each time Neuron ID is read. Contains 2nd nibble of 6th byte of Neuron ID as an ASCII
char.
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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.
// Client Side Connections
Connections
Adapter
,Protocol
,Connection_Type
LonWorks
,LonWorks
,Circon_SI
No
Desciption
Min
Typ
Max
Units
1
FieldServer startup time with 4096 network variables
-
6.5 - Minutes
2
Time to commission FieldServer with 4096 network variables
- - 40
Minutes
3
Time to complete a network variable updFieldServersbetween two
FieldServers (acknowledged service)
-
40
-
Milliseconds
4
Time to complete a networFieldServersoll message between two
FieldServers (request/response service)
-
125
-
Milliseconds
5
Time to complete a network manageFieldServers variable fetch message
between two FieldServers (request/response service)
-
125
-
Milliseconds
Appendix C.4. “Illegal” Characters 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
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. Requestresponse 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
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
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:
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com