Echelon LonPoint Application and Plug-In User Manual
LonPoint Application
and Plug-in Guide
9HUVLRQ
&RUSRUDWLRQ
$
(FKHORQ/21/21:25.6/RQ7DON1HXURQ/210$5.
/RQ3RLQW6FKHGXOH0DNHU6FKHGXOH.HHSHUWKH/RQ8VHUVORJRWKH
(FKHORQORJRDQGWKH/210$5.ORJRDUHUHJLVWHUHGWUDGHPDUNVRI
(FKHORQ&RUSRUDWLRQ/RQ3RLQWWKH/RQ3RLQW6FKHGXOH0DNHU/RQ0DNHU
DQG/RQ6XSSRUWDUHWUDGHPDUNVRI(FKHORQ&RUSRUDWLRQ
2WKHUEUDQGDQGSURGXFWQDPHVDUHWUDGHPDUNVRUUHJLVWHUHGWUDGHPDUNV
RIWKHLUUHVSHFWLYHKROGHUV
1HXURQ
&KLSV/RQ3RLQW0RGXOHVDQGRWKHU2(03URGXFWVZHUHQRW
GHVLJQHGIRUXVHLQHTXLSPHQWRUV\VWHPVZKLFKLQYROYHGDQJHUWRKXPDQ
KHDOWKRUVDIHW\RUDULVNRISURSHUW\GDPDJHDQG(FKHORQDVVXPHVQR
UHVSRQVLELOLW\RUOLDELOLW\IRUXVHRIWKH1HXURQ
&KLSVRU/RQ3RLQW0RGXOHVLQ
VXFKDSSOLFDWLRQV
3DUWVPDQXIDFWXUHGE\YHQGRUVRWKHUWKDQ(FKHORQDQGUHIHUHQFHGLQWKLV
GRFXPHQWKDYHEHHQGHVFULEHGIRULOOXVW U DWLYHSXUSRVHVRQO\DQGPD\QRW
KDYHEHHQWHVW H GE\(FKHORQ,WLVWKHUHVSRQVLELOLW\RIWKHFXVWRPHUWR
GHWHUPLQHWKHVXLWDELOLW\RIWKHVHSDUWVIRUHDFKDSSOLFDWLRQ
(&+(/210$.(6$1'<285(&(,9(12:$55$17,(625&21',7,216
(;35(66,03/,('67$78725<25,1$1<&20081,&$7,21:,7+<28$1'
(&+(/2163(&,),&$//<',6&/$,06$1<,03/,(':$55$17<2)
0(5&+$17$%,/,7<25),71(66)25$3$57,&8/$5385326(
1RSDUWRIWKLVSXEOLFDWLRQPD\EHUHSURGXFHGVWRUHGLQDUHWULHYDOV\VWHP
RUWUDQVPLWWHGLQDQ\IRUPRUE\DQ\PHDQVHOHFWURQLFPHFKDQLFDO
SKRWRFRS\LQJUHFRUGLQJRURWKHUZLVHZLWKRXWWKHSULRUZULWWHQSHUPLVVLRQ
RI(FKHORQ&RUSRUDWLRQ
3ULQWHGLQWKH8QLWHG6WDWHVRI$PHULFD
&RS\ULJKWE\(FKHORQ&RUSRUDWLRQ
(FKHORQ&RUSRUDWLRQ
0LUDQGD$YHQXH
3DOR$OWR&$86$
iii
Contents
1 LonPoint System Overview 1-1
Introduction to the LonPoint System 1-2
Getting Started 1-4
LonPoint Applications 1-4
Terminology Used in this Manual 1-6
Upstream and Downstream 1-6
Heartbeats 1-6
Throttle 1-7
Default Values 1-7
Override Values 1-7
Network Variables 1-8
Changing Network Variable Types 1-9
Network Variable Formats 1-10
Changing Network Variable Formats 1-10
2 The Digital Input Functional Block 2-1
The Digital Input Functional Block 2-2
Configuring the Digital Input with the LonPoint Plug-in 2-2
Digital Input 2-3
Status 2-6
3 The Digital Input/Counter Functional Block 3-1
The Digital Input/Counter Functional Block 3-2
Configuring the Digital Input/Counter with the LonPoint Plug-in 3-2
Digital Input/Counter 3-3
Processing Options 3-4
Using The Control Network Variable 3-8
Processing Parameters 3-9
Translation 3-10
Output Parameters 3-11
Status 3-12
4 The Digital Output Functional Block 4-1
The Digital Output Functional Block 4-2
Configuring a Digital Output with the LonPoint Plug-in 4-2
Digital Output 4-3
Input Defaults 4-6
Presets 4-7
Output Parameters 4-8
Heartbeats 4-9
Status 4-10
5 The Digital Encoder Functional Block 5-1
The Digital Encoder Functional Block 5-2
Configuring the Digital Encoder with the LonPoint Plug-in 5-2
Digital Encoder 5-3
The LonPoint Application and Plug-in Guide
iv
Lookup Tables 5-4
Heartbeats 5-7
Status 5-8
6 The Analog Input Functional Block 6-1
The Analog Input Functional Block 6-2
Configuring an Analog Input with the LonPoint Plug-in 6-2
Analog Input 6-3
Translation 6-5
Output Parameters 6-6
Status 6-7
Analog Input Gain and Current Settings 6-7
Amps Measurement Type (2WIR and 4WIR Jumper Settings) 6-7
Ohms Measurement Type (RES Jumper Setting) 6-7
Volts Measurement Type (VOLT Jumper Setting) 6-8
7 The Analog Output Functional Block 7-1
The Analog Output Functional Block 7-2
Configuring an Analog Output 7-2
Analog Output 7-3
Defaults 7-4
Presets 7-5
Heartbeats 7-6
Status 7-6
8 The Analog Function Block (AFB) Functional Block 8-1
The Analog Function Block (AFB) Functional Block 8-2
Configuring the AFB Functional Block using the LonPoint Plug-in 8-2
Analog Function Block 8-3
Inputs 8-4
Function 8-6
Outputs 8-8
Heartbeats 8-10
Status 8-11
9 The PID Controller Functional Block 9-1
The PID Controller Functional Block 9-2
Configuring a PID Controller with the LonPoint Plug-in 9-3
PID 9-4
Input Defaults 9-5
Presets 9-6
PID Coefficients 9-7
Output Parameters 9-9
Heartbeats 9-11
Status 9-12
LonPoint PID Controller Tuning 9-12
Table of Contents
v
10 The Scheduler Functional Block 10-1
Using the SCH-10 Scheduler Module 10-2
SCH-10 Functional Blocks 10-2
LonPoint Schedule Maker 10-4
Types of Schedules 10-5
Overview of the Supervisory Application Development Process 10-5
Creating an Event Schedule Design 10-6
Defining Daily Schedules 10-6
Assigning Default Daily Schedules 10-7
Assigning Override Daily Schedules 10-8
Creating a State Machine Design 10-9
Defining Inputs and Outputs 10-9
Drawing a State Machine Bubble Diagram 10-13
Defining State Transitions 10-15
Defining Exit Conditions 10-18
Starting and Exiting the LonPoint Schedule Maker Utility 10-19
Configuring the Real Time Clock Functional Block 10-20
Configuring the Event Scheduler Functional Block 10-21
Configuring Daily Schedules 10-22
Configuring Default Daily Schedules 10-23
Configuring Override Daily Schedules 10-24
Configuring the State Machine Functional Block 10-25
Configuring a Digital Output Schedule 10-25
Configuring a State Machine 10-26
Assigning Input/Output Names 10-26
Defining the State Machine 10-29
Defining Exit Conditions 10-31
Setting Scheduler Options 10-33
Saving and Loading a Supervisory Application Design File 10-34
Simulating a Supervisory Application Design 10-35
Resetting the Simulator 10-37
Using Debug Mode 10-37
Simulating Inputs 10-38
Running to the Next Event 10-38
Manually Entering Time and Date 10-39
Overriding the Event Schedule 10-39
Adding the Scheduler Functional Blocks 10-40
Downloading a Supervisory Application Design 10-41
Setting the SCH-10 Time 10-42
Changing the Mode and Mode_Out Types 10-42
Testing a Schedule Design 10-43
The LonPoint Application and Plug-in Guide
vi
11 The Schedule Keeper Utility 11-1
The Schedule Keeper Utility 11-2
Starting the Schedule Keeper Utility 11-2
Modifying the Daily Schedules 11-3
Modifying the Daily Default Schedule 11-5
Modifying Schedule Overrides 11-6
Modifying System Parameters 11-7
Adding Schedule Constraints 11-8
Schedule Constraint Equations 11-9
The Schedule Constraint Language 11-10
Adding Parameter Constraints 11-11
System Parameter Constraint Equations 11-12
System Parameter Constraint Language 11-12
Saving and Exiting 11-13
Converting to US Units 11-13
12 The Type Translator Functional Block 12-1
The Type Translator Functional Block 12-2
Configuring a Type Translator Using the LonPoint Plug-in 12-2
Type Translator 12-3
Status 12-5
13 The Data Logger Functional Block 13-1
The Data Logger Functional Block 13-2
Configuring the Data Logger with the LonPoint Plug-in 13-3
Data Logger 13-3
Input Options 13-4
Input Limits 13-5
Log Options 13-6
Status 13-9
The LonPoint Data Logger Utility 13-9
Menu Commands 13-11
Formatting Preferences 13-12
Monitoring Preferences 13-13
Log Preferences 13-14
CSV Text File Format 13-16
Tagname Line 13-16
Data Lines 13-17
Data Point Formats 13-18
Command Line Switches 13-18
Setting the DL-10’s Real Time Clock 13-19
14 The Node Object Functional Block 14-1
The Node Object Functional Block 14-2
Configuring a Node Object with the LonPoint Plug-in 14-2
Node Object Window: Node Object 14-3
Status 14-4
Table of Contents
1
LonPoint System Overview
This chapter introduces the LonPoint System, applications, plug-in,
and utilities.
The LonPoint Application and Plug-in Guide 1-1
Introduction to the LonPoint System
Chapter
The LonPoint System is a family of LONMARK® products used to integrate new and
legacy devices, as well as other L
systems. The LonPoint system product family includes the following:
• LonPoint Interface, Scheduler, Data Logger, and Router Modules. LONMARK
devices that provide I/O processing, application resources, scheduling,
sequencing, data logging, and routing for a LonPoint system. The LonPoint
interface, scheduler, and data logger modules are certified to meet the L
Interoperability Guidelines.
• LonMaker for Windows Integration Tool. An LNS installation tool with a
Visio™ user interface that supports LonPoint devices, other L
and other L
ONWORKS devices. You can use the LonMaker tool to design,
configure, commission, and maintain a distributed control network. The
LonPoint Plug-in is included with the LonMaker tool to simplify LonPoint device
configuration.
• LonPoint Plug-In. An LNS application that provides an easy-to-use interface for
configuring LonPoint devices. The plug-in can be called from any LNS tool that
follows the LNS plug-in standard, including the LonMaker tool.
• LNS Server. The service provider for the LNS network operating system.
Provides a central database that can be used by multiple LonMaker tools,
LonPoint Plug-ins, and other LNS applications simultaneously. The LNS Server
may run on the same PC with the LonMaker tool and LonPoint Plug-in, or may
run on a different PC. A remote LNS Server may be accessed over a LonWorks
network, a local area network, or the Internet.
• LNS Network Interface Hardware. Hardware that allows you to connect a PC
running the LNS Server, the LonMaker tool, and the LonPoint Plug-in to a
ONWORKS network. This hardware is not necessary for network design, but
L
must be installed to commission, test, or manage devices. The LNS network
interfaces include the PCLTA-10 ISA card, the PCC-10 PC Card (PCMCIA
compatible), the SLTA-10 Serial LonTalk Adapter, and the PCNSI ISA card.
ONMARK devices, to create interoperable control
ONMARK
ONMARK devices,
Each LonPoint device comes pre-loaded with application software that implements a
number of functional blocks. These functional blocks are listed in Table 1.1. They
are installed and interconnected using the LonMaker tool as described in the
LonMaker for Windows User’s Guide. The functional blocks are then configured as
described in this user’s guide.
Table 1.1 LonPoint Functional Blocks
Name Description Examples
2 Digital Input
(DI)
3 Digital
Input/Counter
(DC)
4 Digital Output
(DO)
5 Digital
Encoder (DE)
Senses digital inputs Contact closure, push
button input, logic input
Senses, counts, and times
digital inputs
Turnstyle counting,
frequency measurement,
flow meter interface.
Drives digital outputs Control relays, logic
outputs
Performs logic functions
on up to four digital
inputs
Relay logic, interlocks,
Boolean logic, device
enables
1-2 LonPoint System Overview
6 Analog Input
Scheduler (ES)
LonPoint Device
Quantity per Device
(AI)
7 Analog Output
(AO)
8 Analog
Function
Block (AFB)
9 PID Controller
(PID)
10/11 Real Time
Clock (RTC)
10/11 Event
10/11 State Machine
(SM)
12 Type
Translator
13 Data Logger Logs periodic data based
14 Node Object Management commands
The LonPoint functional blocks are loaded into the LonPoint devices as listed below.
Senses current, voltage,
or resistance inputs
Drives current, voltage,
or resistance analog
outputs
Performs functions on
two analog values and a
digital value such as add,
subtract, multiply, divide,
greater than, less than,
enthalpy, and comparison
Performs closed-loop
control
Maintains date, day of
week, and time of day
Schedules system events Scheduler with occupied
Controls system state Sequence of operations
Converts network
variable data types
on exceptional data
values or large changes in
data value.
for a device
Measure temperature,
pressure, humidity,
velocity, level
Variable speed drive
control; valve control;
damper control
Deadband thermostat,
heating/cooling
optimization
Pressure, temperature, or
position loops
Non-volatile system time
source
and unoccupied periods,
daily, weekly, holiday
schedules
controller
Interface between
incompatible devices
Logging periods of
extreme
temperature/rapid
fluctuations.
Putting devices into
Override. Getting device
status.
The LonPoint Application and Plug-in Guide 1-3
Table 1.2 Assignment of LonPoint Functional Blocks to LonPoint Devices
Functional Block
DI-10 Node Object
Digital Input
Digital Encoder
Analog Function Block
Type Translator
DO-10 Node Object
Digital Output
Digital Encoder
Analog Function Block
Type Translator
DIO-10 Node Object
Digital Input/Counter
Digital Output
Digital Encoder
Analog Function Block
1
4
2
4
6
1
4
2
2
6
1
2
2
2
2
Type Translator 6
AI-10 Node Object
Analog Input
Digital Encoder
Analog Function Block
Type Translator
AO-10 Node Object
Analog Output
PID Controller
Digital Encoder
Analog Function Block
Type Translator
SCH-10 (with
SCH-10
application)
SCH-10 (with DL10 application)
Each functional block has a number of network variables, through which data is
passed to or from the functional block, and configuration properties, which are used
to configure the functional block and define its behavior. The functional blocks are
implemented as L
the LonMaker tool using the LonPoint Plug-in and utilities.
Node Object
Real Time Clock
Event Generator
State Machine
Node Object
Data Logger
Real Time Clock
ONMARK objects on the LonPoint devices, and are configured from
1
2
2
4
4
1
2
2
1
2
2
1
1
1
1
1
1
1
Note:
The SCH-10 device ships with the SCH-10 application pre-loaded. The DL-10
application can be downloaded into the SCH-10 device with a network
integration tool such as the LonMaker tool for Windows.
Getting Started
Install the LonPoint Plug-in software as described in the LonMaker for Windows
User’s Guide. Create a network design that includes LonPoint devices and
functional blocks.
To start the LonPoint Plug-in, right-click a LonPoint functional block and select
Configure from the shortcut menu. The LonPoint Plug-in window associated with
the selected functional block opens.
LonPoint Applications
Each LonPoint device has a LonPoint Application. This is the application firmware
in the device. All LonPoint devices are shipped with applications already loaded. The
version of the application which shipped in the device is printed on the LonPoint
device label. Newer versions of applications may become available and may be
loaded into the LonPoint device at any time using an LNS tool such as the
LonMaker tool (see Loading a New Application into a Device in Chapter 5 of the
LonMaker for Windows User’s Guide).
1-4 LonPoint System Overview
The LonPoint AI-10, AO-10, DI-10, and DO-10 applications have been upgraded to
version 3, but many of the devices currently available still have the version 2
applications loaded into them. The version 3 applications have been certified to meet
ONMARK Interoperability Guidelines. The program ID for all four applications
the L
has been changed to indicate a L
ONMARK. The Digital Output, AFB, and PID
functional blocks have been enhanced in the version 3 applications as described in
the LonPoint Read Me First document in the LonPoint program folder. Each
functional block has an independent version number that is displayed on its
Status
tab.
When you first install a LonPoint device in a network, you should upgrade it to
version 3 if it has a version 2 application. You do not have to upgrade devices that
have already been installed.
Each application contains a program ID that identifies the class, subclass, model
number, and application version. If an attempt is made to load an application into a
device that currently contains an application with a different class or subclass, the
LonMaker tool will issue an application load warning. The following table
summarizes the program ID information for all version 2 and version 3 LonPoint
applications:
Device
Version 2 Version 3
Application
DI-10 Device Class: 0532
Device Subclass: 8A04
Model Number: 02
ONMARK Certified: No
L
DO-10 Device Class: 0533
Device Subclass: 8A04
Model Number: 02
ONMARK Certified: No
L
AI-10 Device Class: 0518
Device Subclass: 8A04
Model Number: 02
ONMARK Certified: No
L
AO-10 Device Class: 0519
Device Subclass: 8A04
Model Number: 02
ONMARK Certified: No
L
SCH-10 Device Class: 0114
Device Subclass: 8A04
Model Number: 02
ONMARK Certified: No
L
DIO-10 No version 2 DIO-10
application available.
DL-10 No version 2 DL-10
application available.
Device Class: 052A
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0533
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0518
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0519
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0114
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0528
Device Subclass: 8A04
Model Number: 03
LONMARK Certified: Yes
Device Class: 0104
Device Subclass: 8A04
Model Number: 03
The LonPoint Application and Plug-in Guide 1-5
The DI-10 device’s version 2 and version 3 applications have different Device Class
values, so the LonMaker tool will issue a warning when an attempt is made to load a
version 3 DI-10 application into a device which currently contains a version 2 DI-10
application. This warning may be safely ignored.
The SCH-10 device supports two applications, the SCH-10 application and the DL-10
application. Attempting to load the DL-10 application into a SCH-10 device which
currently contains the SCH-10 application or vice versa will cause a warning in the
LonMaker tool that an attempt is being made to load an application with a different
Device Class or Device Subclass into a device already containing an application. In
this case, this warning may be safely ignored.
Terminology Used in this Manual
The following sections contain definitions for several concepts presented in this
manual in conjunction with the LonPoint functional blocks.
Upstream and Downstream
The terms upstream and downstream represent the flow of information. If
functional block A sends information to functional block B, B is said to be
downstream of A, and A is said to be upstream of B. For example, in the following
figure, the DO- 1 Valve Actuator is downstream of the DI- 1 Limit Switch.
LONMARK Certified: Yes
Heartbeats
A heartbeat is a network variable update that is automatically sent if the network
variable has not otherwise been updated for a configurable length of time.
Most LonPoint output network variables can be configured to send heartbeat
updates. Most LonPoint input network variables can monitor heartbeats from
upstream functional blocks to detect device failures using heartbeat receive
checking. If a heartbeat is not received within the specified amount of time, the
functional block will go into heartbeat failure and cease propagating output network
variables, and if the functional block is associated with a hardware output it will
cause that output to go to its configured default value. The functional block will
return to normal operation once the heartbeat is restored.
The heartbeat send time should be approximately 4 times as frequent as the
corresponding expected heartbeat receive time to allow for lost messages.
Heartbeat failure propagates downstream in a LonPoint system. Once a LonPoint
functional block receives a heartbeat failure, it will stop sending heartbeats, causing
1-6 LonPoint System Overview
any downstream functional blocks that check heartbeats to go into heartbeat failure
as well. Functional blocks which go into heartbeat failure will output their default
values (see Defaults, below)
You can disable heartbeat receive checking on downstream functional blocks. This
may be desirable in situations where it makes sense for the application to continue
to use the last known valid data rather than change to the configured default
network variable or hardware output.
Throttle
The throttle option limits the rate of updates on an output network variable. Use
throttling to reduce network traffic. In order to minimize network traffic, set the
throttle value to the longest interval between updates on the output network
variable that is compatible with correct system operation. Turn off throttling by
setting the value to 0. The AI and PID functional blocks produce data at their
configured scan interval, and do not have a throttle configuration property.
Default Values
Default values are values that apply to hardware outputs and both input and output
network variables.
A functional block will use its default hardware or network variable output value
when any of the following conditions occur:
• The functional block has just come out of reset and has not yet received any
network variable updates.
• The functional block has an enable input network variable which is turned off.
• The functional block senses a heartbeat failure.
Default values for input network variables are used when any of the following
conditions occur:
• The network variable has not yet received any updates since its last reset.
• The network variable is not connected. There are often situations where one or
more inputs on a functional block will not be connected. The network variable
should be configured with an appropriate default input value. This also allows
you to manually set the value of an input network variable for debugging and
testing.
Override Values
Override values are values that apply to output network variables and hardware
outputs. LonPoint functional blocks can be forced into an override state with the
LonMaker tool or the LonPoint Plug-in. When a functional block is in the override
state, the output network variables and hardware outputs, if any, will be set to their
override values. Override values and the override state are preserved across power
cycles and resets.
While override values are stored in both the device and in the LNS database, the
override state of a device is stored only in the device, not in the LNS database. If you
replace a device with the LonMaker tool, the old device’s override values are
The LonPoint Application and Plug-in Guide 1-7
transferred to the new device. The new device will not necessarily be in the
same override state as the old device.
Network Variables
On the first tab of the LonPoint Plug-in window for each LonPoint functional block
(except for the Node Object) there is a network variable shape for each network
variable which looks like this:
To get information about a network variable, click on the network variable shape.
The following
Network Variable Information dialog appears:
This dialog contains the following information:
Network Variable Name The name of the network variable. You can change this
name using the LonMaker tool.
Type Name The network variable type. If the type is a standard
network variable type, the network variable may only be
connected to network variables with the same type. If
the network variable has a changeable type, the
Type button will be enabled.
Format Name The network variable format. The format determines
how data from the network variable will be formatted
when it is displayed or input by an LNS tool such as the
LonMaker tool. If the format is changeable, the
Format button will be enabled.
Units The type of units the network variable uses. If the
network variable does not use a specific type of unit, this
field will be empty.
To change a network variable type, click the
network variable format, click the
Change Format button.
Change Type button. To change a
Change
Change
1-8 LonPoint System Overview
Changing Network Variable Types
You can change the types of some network variables in LonPoint functional blocks.
Most changeable types are either floating-point or enumerated network variables, as
well as the network variables in the Type Translator functional block.
Changing the type of a network variable will reset its format to the default for that
type. This affects the display of related fields in the LonPoint Plug-in. See Network
Variable Formats for more information.
To change the type of a network variable, click the network variable shape in the
LonPoint Plug-in window, then click the
Variable Information dialog. The following Change Network Variable Type
dialog appears:
Change Type button in the Network
This dialog contains the following fields:
Network Variable Name The name of the network variable. This field is read-only.
You can change the name of a network variable using the
LonMaker tool.
Previous Type Name The current network variable type. This field is read-
only.
Standard Network
Variable Type
Type Files Lists all available type files from the device resource file
Specifies whether the new network variable type is a
standard type or a user defined type. Enable this option
if you want to use a SNVT. (See the SNVT Master list in
the LNS Utilities and L
Disable this option if you want to select a user-defined
type.
catalog. If the Standard Network Variable Type option is
selected, only the standard type file is listed. Select the
ONMARK Reference help file.)
The LonPoint Application and Plug-in Guide 1-9
type file containing the new network variable type from
this list.
Type List Lists all network variable types in the selected file that
are compatible with the selected network variable. Select
the new network variable type from this list.
Compatible Types Indicates how compatibility is decided. For all functional
blocks except the Type Translator, this is by
(e.g., floating-point or enumeration). The Type Translator
uses the
equal to four bytes long. You cannot change this option.
Length <= option, listing all types less than or
Base Type
Network Variable Formats
Many floating-point network variable types have at least two standard formats: one
for SI units (i.e. the metric system, which are the default units of most SNVTs), and
one for comparable U.S. units. There may also be more than one format for either of
these two basic systems (e.g. SNVT_flow has U.S. formats for both gallons per
second and cubic feet per minute). If there is more than one format, one of them is
considered the default. The LonMaker and LonPoint Plug-in installation programs
allow installing format files that have either all SI units as the default, or all U.S.
units as the default.
Selecting a format does not affect the actual network variable data on the network
or configuration property data in the device. This data is always in the native units
of the network variable or configuration property. The format only affects how the
data is displayed (or interpreted when doing data entry). Any format that does not
use the native configuration property or network variable units will convert the data
to or from the native units using conversion values associated with that format. For
example, if U.S. units are being used, data being entered is converted internally to
SI units, and converted back to U.S. units for display. Due to floating-point
rounding, values displayed may not always be exactly what was entered.
Changing Network Variable Formats
You can change the format of most LonPoint floating-point network variables, as
well as the network variables in the Type Translator functional block.
Note:
Changing the format of a network variable affects the display of related fields in
the LonPoint Plug-in, the LonMaker tool, and other third-party LNS
applications. The format change will be immediately visible in the LonPoint
plug-in. However, other applications may not reflect the format change until
some action causes the format to be refreshed; this can be accomplished by
restarting the application or by some explicit command, such as the LonMaker
Browser's
To change a network variable format, click the network variable shape in the LonPoint
Plug-in window, then click the
Information dialog. The following Change Network Variable Format dialog
appears:
1-10 LonPoint System Overview
Refresh All command.
Change Format button in the Network Variable
This dialog contains the following fields:
Network Variable Name The name of the network variable. This field is read-only.
You can change the name of a network variable using the
LonMaker tool.
Previous Format The current format of the selected network variable. This
field is read-only.
Format Lists the available formats for the selected network
variable type. Select a format from this list to explicitly
determine the type of units used in the selected network
variable and its associated configuration properties.
Use Default Automatically selects the default format from the Format
field. Use this option to reset a network variable to use its
default format.
When you select a new format for a network variable, the units of that format will
be indicated in the LonPoint Plug-in anywhere there is a field which contains data
that matches the network variable type (e.g. an override value). Data in these fields
is entered and displayed in those units.
The LonPoint Application and Plug-in Guide 1-11
1-12 LonPoint System Overview
2
The Digital Input Functional
Block: Application and Plug-in
This chapter describes how to configure a Digital Input
functional block using the LonPoint Plug-in.
The LonPoint Application and Plug-in Guide 2-1
The Digital Input Functional Block
The Digital Input functional block reads the state of a digital signal. This value
is then processed, and the resulting digital value is sent to the output network
variable. The following figure and table summarize the inputs and outputs of
the Digital Input functional block:
Output Network Variables
Default name Default type Description
Digital SNVT_switch The Digital output network
variable driven by the sensor.
Configuring the Digital Input with the LonPoint Plug-in
Right-click a Digital Input functional block and select Configure from the
shortcut menu to open the Digital Input window of the LonPoint Plug-in. You
can also choose Plug-ins from the shortcut menu and then select
LonPoint Object from the dialog box. The Digital Input functional block
window has two tabs,
Digital Input and Status.
Configure
2-2 Digital Input Functional Block
Digital Input
The Digital Input tab, pictured below, provides a graphical interface to the
LonPoint Digital Input (DI) functional block. It allows you to determine how
data from a physical digital input is interpreted and what value is sent over the
network on the DI functional block’s output network variable.
The data flow in this tab is left to right. The raw digital input signal can be
modified by the debounce configuration property, then passed to the
configurable inversion function, then that data is passed to the remaining
processing steps.
Use the plug-in to set the following configuration properties:
Debounce The debounce time for the digital input. This is the
amount of time, in milliseconds, that the input must
remain constant for the value to be passed on to the
rest of the functional block. Set this value to 0 to
turn off the debounce function.
Invert Specifies whether or not the data from the digital
input is inverted before further processing is done.
Location The location string for this digital input. This
property can be used to document the associated
sensor’s location within the plant so it can be easily
The LonPoint Application and Plug-in Guide 2-3
found. This field may contain up to 30 characters.
This value is separate from the device’s location
property.
Processing Affects the translation of incoming data to the value
passed to the output network variable. There are five
processing options:
Pulsed, and One-Shot.
Direct option causes data to be output directly
The
after the debounce and invert functions have
executed.
Delayed option specifies a delay from a change
The
on the input to an update on the output network
variable. A change from Off to On is delayed by the
time indicated in the
change from On to Off is delayed by the time
indicated in the
Toggled option causes the output data to toggle,
The
or change state, every time the input data changes
from Off to On. For example, if a Digital Input
functional block is attached to a push button and the
functional block is configured with the
option, the network variable output value will change
every time the button is pushed.
Direct, Delayed, Toggled,
On Delay Time field. A
Off Delay Time field.
Toggled
Pulsed option generates a pulse on the output
The
network variable every time the input data changes
from Off to On. The pulse is generated after a delay
specified on the
of the pulse is specified on the
does not matter how long the input data remains on,
the output will always send a pulse of the specified
length after waiting the configured delay. If a delayed
pulse is re-triggered during a pulse, the delay will be
ignored. If a pulse is re-triggered during a delay, the
trigger will be ignored.
One-Shot option generates a pulse on the output
The
network variable every time the input data changes
from Off to On. The pulse is generated after a delay
specified on the
of the pulse is specified in the
the input data changes from Off to On while the
pulse is being sent, the pulse timer will be reset (i.e.,
if a two second pulse was retriggered after one
second, the output would be on for two more seconds,
or three seconds total).
On Delay Time Use this field with the
Shot Processing options. This value determines the
length of the delay in the change from the off state to
the on state. To change the value, click the
to the right of the time value to be changed and enter
On Delay Time field. The duration
On Delay Time field. The duration
Pulse Time field. It
Pulse Time field. If
Delayed, Pulsed, and One-
button
2-4 Digital Input Functional Block
the new values to be used for the delay. The valid
range for this value is from zero to 48 days, 23 hours,
59 minutes, 59 seconds, and 999 milliseconds.
Off Delay Time Use this field with the
This value determines the length of the delay in the
change from the on state to the off state. To change
the value, click the
value to be changed and enter the new values to be
used for the delay. The valid range for this value is
from zero to 48 days, 23 hours, 59 minutes, 59
seconds, and 999 milliseconds.
Pulse Time If you select either the
Processing options, the Pulse Time field appears
in place of
the length of time the on state remains active. To
change the value, click the
the time value to be changed and enter the new
values to be used for the pulse. The valid range for
this value is from zero to 48 days, 23 hours, 59
minutes, 59 seconds, and 999 milliseconds.
Override Value Determines the value sent to the network via the
output network variable if the functional block is put
into override mode as described in the next section.
Heartbeat Determines how often the functional block sends a
heartbeat over the network. The behavior of the
system in case of a missed heartbeat is determined by
the functional blocks which fail to receive the
heartbeat. Setting this property to 0 disables the
heartbeat for this functional block. Disabling the
heartbeat causes the output network variable to only
be transmitted in response to a changed input value.
Off Delay Time. This value determines
Delayed Processing option.
button to the right of the time
Pulsed or the One-Shot
button to the right of
Throttle Limits how often data is sent over the network.
Setting this property to 0 disables throttling.
The LonPoint Application and Plug-in Guide 2-5
Status
This tab allows you to view and change the status of a Digital Input functional
block. This tab appears as follows:
This tab contains the following fields and buttons:
Device Version The version number of the application in this device.
The minor version number (after the decimal point) is
always read from the device itself. If the network is
unattached or Offnet, the minor version number will
XX (e.g. 2.XX).
read
Error Log The most recently logged error on the device. This
error may not apply to the functional block you are
configuring.
Error Description A description of the most recently logged error.
Clear (Device Status) Clears the status of the device, including the Error
Log. This also clears other device communication
statistics information that is not displayed here (e.g.,
Lost Messages). If you wish to examine the other
information before clearing it, use the Test command
described under Managing Devices, Functional
2-6 Digital Input Functional Block
Blocks, and Routers in the LonMaker for Windows
User’s Guide.
Object Version The version number of this functional block. The
minor version number (after the decimal point) is
always read from the device itself. If the network is
unattached or Offnet, the minor version number will
XX (e.g. 2.XX).
read
Disabled Indicates
it is enabled, and
communication with the device. If you can
communicate with the device, you can change the
state of the functional block by clicking the
and Disable buttons. See Managing Devices,
Functional Blocks, and Routers in the LonMaker for
Windows User’s Guide for more information.
Override Indicates
No if it is not in override, and ? if the plug-in is not in
communication with the device. If you can
communicate with the device, you can change the
mode of the functional block by clicking the
Override Off and Override On buttons. See
Managing Devices, Functional Blocks, and Routers in
the LonMaker for Windows User’s Guide for more
information.
Other Status Displays other information relating to the functional
block status (e.g. communication error, range error).
Clear (Object Status) Clears the status of the functional block.
Refresh Refreshes the information in this tab. Any changes to
the data displayed in this tab since the plug-in was
started (by using the LonMaker tool’s Manage
command, for example) will not be updated until this
button is pressed. Some LonPoint plug-ins can
experience a temporary lock-out. This can be cleared
by clicking this button.
Yes if this functional block is disabled, No if
? if the plug-in is not in
Enable
Yes if this functional block is in override,
The LonPoint Application and Plug-in Guide 2-7
2-8 Digital Input Functional Block
3
The Digital Input/Counter
Functional Block: Application
and Plug-in
This chapter describes how to configure a Digital Input/Counter
functional block using the LonPoint Plug-in.
The LonPoint Application and Plug-in Guide 3-1
The Digital Input/Counter Functional Block
The Digital Input/Counter functional block reads the state of a digital signal.
This value is then processed, and the resulting value is sent to the digital output
network variable. The Digital Input/Counter is a superset of the Digital Input; it
contains all the functionality of the Digital Input plus additional capabilities.
The following figure and tables summarize the inputs and outputs of the Digital
Input/Counter functional block:
Input Network Variables
Default name Default type Description
Control
Default name Default type Description
Digital
Analog
This functional block contains an analog output network variable which is used
for several different purposes depending on the processing option, and a control
input network variable which may be used to clear, hold, pause, or preset the
analog output. The digital output network variable type is always
The analog output network variable type is changeable. See Chapter 1 for a
discussion of network variables.
UNVT_
count_control
(changeable)
Output Network Variables
SNVT_switch
SNVT_temp_f
(changeable)
The Control network variable is an
enumerated type that controls
counting functions.
The Digital output network
variable. The meaning varies
according to the processing option.
See the Processing Options, later in
this chapter, for more information.
The Analog output network
variable. The meaning varies
according to the processing option.
See the Processing Options, later in
this chapter, for more information.
SNVT_switch.
Configuring the Digital Input/Counter with the LonPoint
Plug-in
Right-click a Digital Input/Counter functional block and select Configure from
the shortcut menu to open the Digital Input/Counter window of the LonPoint
Plug-in. The Digital Input/Counter functional block window contains the
3-2 Digital Input/Counter Functional Block
following tabs, Digital Input/Counter, Processing Parameters,
Translation, Output Parameters, and Status.
Digital Input/Counter
The Digital Input/Counter tab, pictured below, provides a graphical
interface to the LonPoint Digital Input/Counter (DC) functional block. It allows
the user to determine how data from a hardware digital input is interpreted and
what value is sent over the network on the Digital Input/Counter functional
block’s output network variables.
The data flow in this tab is left to right. The raw digital input signal is checked
against the input voltage threshold in order to determine the logical state of the
input (on or off) and then can be modified by the debounce configuration
property, then passed to the configurable inversion function, then passed to the
remaining processing steps. Click the
variable buttons to change the types of these network variables.
Use the plug-in to set the following configuration properties:
Input Type Determines the voltage threshold levels which trigger
a state change. The value may of Dry Contact, 5V,
12V, 24V, or 31V. Use Dry Contact to determine if a
relay or switch has been closed.
Debounce The debounce time for the digital input. This is the
amount of time, in milliseconds, that the input must
Control and Analog Output network
The LonPoint Application and Plug-in Guide 3-3
remain constant for the value to be passed on to the
rest of the functional block. Set this value to 0 to turn
off the debounce function.
Inversion Specifies whether or not the data from the digital
input is inverted before further processing is done.
Determines whether a high voltage level is
interpreted as an On state (not inverted) or an Off
state (inverted).
Processing Affects the translation of incoming data to the value
passed to one of the output network variables. There
are nine processing options:
Toggled, Pulsed, One-Shot, Count, Repeating
Count, On Time, and Frequency. The Direct,
Delayed, Toggled, Pulsed, and One-Shot options
cause the Digital input/Counter functional block to
behave identically to the Digital Input functional
block, and the Control and Analog output network
variables will not be used. See Processing Options in
the next section for a description of the processing
options.
Location The location string for this digital input/counter. This
property can be used to document the associated
hardware’s location within an installation so it can be
easily found. This field may contain up to 30
characters. This value is separate from the device’s
location property.
Direct, Delayed,
Processing Options
The following sections describe the processing options selected in the Digital
Input/Counter tab.
Direct
Causes data to be output directly to the digital output network variable after the
debounce and invert functions have executed.
Delayed
Specifies a delay from a change on the input to an update on the digital output
network variable. A change from Off to On is delayed by the time indicated in
On Delay Time field. A change from On to Off is delayed by the time
the
indicated in the
Off Delay Time field.
Toggled
Causes the digital output network variable value to toggle, or change state, every
time the input data changes from Off to On. For example, if a Digital
Input/Counter functional block is attached to a push button and the functional
3-4 Digital Input/Counter Functional Block
Loading...