31003688 2/2009

Advantys STB
Standard Ethernet Modbus TCP/IP
Network Interface Module
Applications Guide

31003688.06

2/2009

www.schneider-electric.com

 2009 Schneider Electric. All rights reserved.

31003688 2/2009

Table of Contents

Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is a Network Interface Module? . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is Advantys STB? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STB NIP 2212 Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Communications and Connectivity . . . . . . . . . . . . . . . . . . . . . . .

Chapter 2 The STB NIP 2212 NIM . . . . . . . . . . . . . . . . . . . . . . . . . . .

External Features of the STB NIP 2212 . . . . . . . . . . . . . . . . . . . . . . . . . .
STB NIP 2212 Network Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rotary Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LED Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CFG Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Power Supply Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logic Power. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting a Source Power Supply for the Islands Logic Power Bus. . . . .
Module Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 3 How to Configure the Island Bus . . . . . . . . . . . . . . . . . .

How Do Modules Automatically Get Island Bus Addresses? . . . . . . . . . .
How to Auto-Configure Default Parameters for Island Modules . . . . . . . .
How to Install the STB XMP 4440 Optional Removable Memory Card. . .
How to Configure the Island with the STB XMP 4440 Optional Removable
Memory Card. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is the RST Button?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Overwrite Flash Memory with the RST Button . . . . . . . . . . . . . . .

Chapter 4 IP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How the STB NIP 2212 Obtains IP Parameters . . . . . . . . . . . . . . . . . . . .
The IP Address Assignment Process . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31003688 2/2009

7
9
13
14
16
20
22

23
24
26
28
30
33
35
37
39
42

45
46
49
50
53
55
56

59
60
62

Chapter 5 STB NIP 2212 Services . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.1 Modbus Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Modbus Messaging Service Description . . . . . . . . . . . . . . . . . . . . . . . . .
Data Exchange with the STB NIP 2212 . . . . . . . . . . . . . . . . . . . . . . . . . .
Reading Diagnostic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modbus Commands Supported by the STB NIP 2212 . . . . . . . . . . . . . .
Modbus Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.2 IP Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dynamic Assignment of IP Addresses. . . . . . . . . . . . . . . . . . . . . . . . . . .
5.3 Faulty Device Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faulty Device Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faulty Device Replacement Preconditions . . . . . . . . . . . . . . . . . . . . . . .
Configuring Faulty Device Replacement . . . . . . . . . . . . . . . . . . . . . . . . .
Faulty Device Replacement Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . .
5.4 Embedded Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Embedded Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties Web Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Menu Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configured IP Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SNMP Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure Master Controller Web Page . . . . . . . . . . . . . . . . . . . . . . . . . .
Master Configurator Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Role Name Web Page / FDR Configuration Web Page. . . . . . . . . . . . . .
Reboot Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product Support Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security Menu Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web Access Password Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Password Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Diagnostics Menu Web Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STB NIP 2212 Registers Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . .
I/O Data Values Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Island Configuration Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Island Parameters Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faulty Device Replacement (FDR) Diagnostics Web Page. . . . . . . . . . .
Error Log Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.5 SNMP Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNMP Device Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the SNMP Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Schneider Private MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transparent Factory Ethernet (TFE) MIB Subtree. . . . . . . . . . . . . . . . . .
Port502 Messaging Subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web MIB Subtree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Equipment Profiles Subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66
67
72
81
89
91
92
92
93
94
96
98
100
101
102
104
105
106
110
112
115
118
124
125
126
127
130
134
135
136
138
140
141
142
146
148
149
151
152
154
155
156
157

31003688 2/2009

5.6 Other Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TFTP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 6 Connection Examples . . . . . . . . . . . . . . . . . . . . . . . . . . .

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modbus Functions Supported by the STB NIP 2212. . . . . . . . . . . . . . . . .

Chapter 7 Advanced Configuration Features . . . . . . . . . . . . . . . . .

159
159

161
162
163
165
169

173

STB NIP 2212 Configurable Parameters . . . . . . . . . . . . . . . . . . . . . . . . .

Configuring Mandatory Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prioritizing a Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is a Reflex Action? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Island Fallback Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Saving Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protecting Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A Modbus View of the Islands Data Image. . . . . . . . . . . . . . . . . . . . . . . .
The Islands Process Image Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The HMI Blocks in the Island Data Image . . . . . . . . . . . . . . . . . . . . . . . . .
Test Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Run-Time Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Virtual Placeholder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

174
177
179
180
184
186
187
188
191
193
195
197
202

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

205
229

31003688 2/2009

31003688 2/2009

Safety Information

Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with
the device before trying to install, operate, or maintain it. The following special
messages may appear throughout this documentation or on the equipment to warn
of potential hazards or to call attention to information that clarifies or simplifies a
procedure.

31003688 2/2009

PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by
qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.

31003688 2/2009

About the Book

At a Glance
Document Scope
This Guide describes the hardware and software features of the Advantys
STB NIP 2212, which enables an island of Advantys STB modules to function as a
node on an Ethernet LAN.
The Ethernet LAN on which an island resides uses Transport Control
Protocol/Internet Protocol as its transport layer. The Modbus protocol runs over the
TCP/IP layer. This way, an Ethernet host device can control an island with Modbus
commands. The Modbus protocol allows devices that can connect only to the RS232 port on other Advantys STB NIMs to connect to the STB NIP 2212s fieldbus
port, too.
The following information appears in this guide:
z the role of the standard NIM as the gateway between Ethernet TCP/IP and the
Advantys STB island
z the NIMs integrated power supply and its role in the distribution of logic power
across the island bus
z common external interfaces:
z the two-pin connector to an external SELV-rated power supply
z RS-232 interface to optional devices, including the Advantys configuration
software and an HMI panel
z
z
z
z
z
z
z

31003688 2/2009

the optional removable memory card

advanced configuration features, such as island fallback scenarios
STB NIP 2212 specific features, including its global connectivity capabilities
how to configure an STB NIP 2212 with IP parameters
how to connect the STB NIP 2212 to an Ethernet network
STB NIP 2212 web-based configuration and troubleshooting features
SNMP management services

Who Should Use This Manual?

This manual is intended to support the customer who has installed the
Advantys STB island bus on an Ethernet LAN and needs to understand the
STB NIP 2212s local and remote communications capabilities.
This manual assumes familiarity with the Modbus protocol.
Validity Note
The data and illustrations found in this book are not binding. We reserve the right to
modify our products in line with our policy of continuous product development. The
information in this document is subject to change without notice and should not be
construed as a commitment by Schneider Electric.
Related Documents
Title of Documentation

Reference Number

Advantys STB Analog I/O Modules Reference Guide

31007715 (E),
31007716 (F),
31007717 (G),
31007718 (S),
31007719 (I)

Advantys STB Discrete I/O Modules Reference Guide

31007720 (E),
31007721 (F),
31007722 (G),
31007723 (S),
31007724 (I)

Advantys STB Counter Modules Reference Guide

31007725 (E),
31007726 (F),
31007727 (G),
31007728 (S),
31007729 (I)

Advantys STB Special Modules Reference Guide

31007730 (E),
31007731 (F),
31007732 (G),
31007733 (S),
31007734 (I)

Advantys STB System Planning and Installation Guide

890 USE 171 0x

Advantys STB Configuration Software Quick Start User Guide

890 USE 180 0x

Advantys STB Reflex Actions Reference Guide

890 USE 183 0x

You can download these technical publications and other technical information from
our website at www.schneider-electric.com.

10

31003688 2/2009

Product Related Information

Schneider Electric assumes no responsibility for any errors that may appear in this
document. If you have any suggestions for improvements or amendments or have
found errors in this publication, please notify us.
No part of this document may be reproduced in any form or by any means, electronic
or mechanical, including photocopying, without express written permission of
Schneider Electric.
All pertinent state, regional, and local safety regulations must be observed when
installing and using this product. For reasons of safety and to assure compliance
with documented system data, only the manufacturer should perform repairs to
components.
When controllers are used for applications with technical safety requirements,
please follow the relevant instructions.
Failure to use Schneider Electric software or approved software with our hardware
products may result in injury, harm, or improper operating results.
Failure to observe this product related warning can result in injury or equipment
damage.
User Comments
We welcome your comments about this document. You can reach us by e-mail at
[email protected].

31003688 2/2009

11

12

31003688 2/2009

Introduction
31003688 2/2009

Introduction

1
Introduction
This chapter provides a general overview of the Advantys STB standard network
interface module and the Advantys STB island bus. The chapter concludes with an
introduction to the specific features of the STB NIP 2212 NIM.
What's in this Chapter?
This chapter contains the following topics:
Topic

31003688 2/2009

Page

What Is a Network Interface Module?

14

What Is Advantys STB?

16

STB NIP 2212 Product Overview

20

Ethernet Communications and Connectivity

22

13

Introduction

What Is a Network Interface Module?

Purpose
Every island requires a network interface module (NIM) in the leftmost location of the
primary segment. Physically, the NIM is the first (leftmost) module on the island bus.
Functionally, it is the gateway to the island busall communications to and from the
island bus pass through the NIM. The NIM also has an integrated power supply that
provides logic power to the island modules.
The Fieldbus Network
An island bus is a node of distributed I/O on an open fieldbus network, and the NIM
is the islands interface to that network. The NIM supports data transfers over the
fieldbus network between the island and the fieldbus master.
The physical design of the NIM makes it compatible with both an Advantys STB
island and your specific fieldbus master. Whereas the fieldbus connector on each
NIM type may differ, the location on the module front panel is essentially the same.
Communications Roles
Communications capabilities provided on a standard NIM include:
Function

Role

data exchange

The NIM manages the exchange of input and output data between the island and the
fieldbus master. Input data, stored in native island bus format, is converted to a fieldbusspecific format that can be read by the fieldbus master. Output data written to the NIM by
the master is sent across the island bus to update the output modules and is automatically
reformatted.

configuration services

Custom services can be performed by the Advantys configuration software. These services
include changing the operating parameters of the I/O modules, fine-tuning island bus
performance, and configuring reflex actions. The Advantys Configuration Software runs on
a computer attached to the NIMs CFG interface (see page 33). (For NIMs with Ethernet port
connectivity, you can also connect to the Ethernet port.)

human-machine
interface (HMI)
operations

A serial Modbus HMI panel can be configured as an input and/or output device on the island.
As an input device, it can write data that can be received by the fieldbus master; as an output
device, it can receive updated data from the fieldbus master. The HMI can also monitor
island status, data, and diagnostic information. The HMI panel must be attached to the NIMs
CFG port.

14

31003688 2/2009

Introduction

Integrated Power Supply

The NIMs built-in 24-to-5 VDC power supply provides logic power to the I/O
modules on the primary segment of the island bus. The power supply requires a
24 VDC external power source. It converts the 24 VDC to 5 V of logic power for the
island. Individual STB I/O modules in an island segment generally draw a logic bus
current of between 50 and 265 mA. (Consult the Advantys STB System Planning
and Installation Guide [890USE17100] for current limitations at various operating
temperatures.) If the logic bus current drawn by the I/O modules totals more than
1.2 A, additional STB power supplies need to be installed to support the load.
The NIM delivers the logic power signal to the primary segment only. Special
STB XBE 1300 beginning-of-segment (BOS) modules, located in the first slot of
each extension segment, have their own built-in power supplies, which will provide
logic power to the STB I/O modules in the extension segments. Each BOS module
that you install requires 24 VDC from an external power supply.
Structural Overview
The following figure illustrates the multiple roles of the NIM. The figure provides a
network view and a physical representation of the island bus:
1

4
2

6
P M
PDM

IO

IO

IO

IO

IO

1
2
3
4
5
6
7
8
31003688 2/2009

fieldbus master
external 24 VDC power supply, the source for logic power on the island
external device connecting to the CFG port: a computer running the Advantys
Configuration Software or an HMI panel
power distribution module (PDM): provides field power to the I/O modules
island node
island bus terminator plate
other nodes on the fieldbus network
fieldbus network terminator (if required)
15

Introduction

What Is Advantys STB?

Introduction
Advantys STB is an assembly of distributed I/O, power, and other modules that
function together as an island node on an open fieldbus network. Advantys STB
delivers a highly modular and versatile slice I/O solution for the manufacturing
industry, with a migration path to the process industry.
Advantys STB lets you design an island of distributed I/O where the I/O modules can
be installed as close as possible to the mechanical field devices that they control.
This integrated concept is known as mechatronics.
Island Bus I/O
An Advantys STB island can support as many as 32 I/O modules. These modules
may be Advantys STB I/O modules, preferred modules, and standard CANopen
devices.
The Primary Segment
STB I/O modules on an island may be interconnected in groups called segments.
Every island has at least one segment, called the primary segmentit is always the
first segment on the island bus. The NIM is the first module in the primary segment.
The primary segment must contain at least one Advantys STB I/O module and can
support a logic bus current of up to 1.2 A. The segment also contains one or more
power distribution modules (PDMs), which distribute field power to the I/O modules.
Extension Segments
When you are using a standard NIM, Advantys STB I/O modules that do not reside
in the primary segment can be installed in extension segments. Extension segments
are optional segments that enable an island to be a truly distributed I/O system. The
island bus can support as many as six extension segments.
Special extension modules and extension cables are used to connect segments in
a series. The extension modules are:
z
z

the STB XBE 1100 EOS module, which is the last module in a segment if the
island bus is extended
the STB XBE 1300 BOS module, which is the first module in an extension
segment

The BOS module has a built-in 24-to-5 VDC power supply similar to the NIM. The
BOS power supply also provides logic power to the STB I/O modules in an extension
segment.

16

31003688 2/2009

Introduction

Extension modules are connected by lengths of STB XCA 100x cable that extend
the island communication bus from the previous segment to the next BOS module:

1
2
3
4
5
6
7
8
9
10

primary segment
NIM
STB XBE 1100 EOS bus extension module(s)
1 m length STB XCA 1002 bus extension cable
first extension segment
STB XBE 1300 BOS bus extension module for the first extension segment
4.5 m length STB XCA 1003 bus extension cable
second extension segment
STB XBE 1300 BOS bus extension module for the second extension segment
STB XMP 1100 termination plate

Bus extension cables are available in various lengths, ranging from 0.3 m (1 ft) to
14.0 m (45.9 ft).
Preferred Modules
An island bus can also support those auto-addressable modules referred to as
preferred modules. Preferred modules do not mount in segments, but they do count
as part of the 32-module maximum system limit.
A preferred module can connect to an island bus segment via an STB XBE 1100
EOS module and a length of STB XCA 100x bus extension cable. Each preferred
module has two IEEE 1394-style cable connectors, one to receive the island bus
signals and the other to transmit them to the next module in the series. Preferred
modules are also equipped with termination, which must be enabled if a preferred
module is the last device on the island bus and must be disabled if other modules
follow the preferred device on the island bus.

31003688 2/2009

17

Introduction

Preferred modules can be chained to one another in a series, or they can connect
to Advantys STB segments. As shown in the following figure, a preferred module
passes the island bus communications signal from the primary segment to an
extension segment of Advantys STB I/O modules:

1
2
3
4
5
6
7
8
9

primary segment
NIM
STB XBE 1100 EOS bus extension module
1 m length STB XCA 1002 bus extension cable
preferred module
1 m length STB XCA 1002 bus extension cable
extension segment of Advantys STB I/O modules
STB XBE 1300 BOS bus extension module for the extension segment
STB XMP 1100 termination plate

Standard CANopen Devices

You may also install one or more standard CANopen devices on an island. These
devices are not auto-addressable, and they must be installed at the end of the island
bus. If you want to install standard CANopen devices on an island, you need to use
an STB XBE 2100 CANopen extension module as the last module in the last
segment.
NOTE: If you want to include standard CANopen devices in your island, you need
to configure the island using the Advantys Configuration Software, and you need to
configure the island to operate at 500 kbaud.

18

31003688 2/2009

Introduction

Because standard CANopen devices cannot be auto-addressed on the island bus,

they must be addressed using physical addressing mechanisms on the devices. The
standard CANopen devices together with the CANopen extension module form a
sub -network on the island bus that needs to be separately terminated at the
beginning and end. A terminator resistor is included in the STB XBE 2100 CANopen
extension module for one end of the extension sub-network; the last device on the
CANopen extension must also be terminated with a 120 resistor. The rest of the
island bus needs to be terminated after the CANopen extension module with an
STB XMP 1100 termination plate:

1
2
3
4
5
6
7
8
9

primary segment
NIM
STB XBE 1100 EOS bus extension module
1 m length STB XCA 1002 bus extension cable
extension segment
STB XBE 2100 CANopen extension module
STB XMP 1100 termination plate
typical CANopen cable
standard CANopen device with 120 termination

Length of the Island Bus

The maximum length of an island busthe maximum distance between the NIM and
the last device on the islandis 15 m (49.2 ft). This length must take into account
the extension cables between segments, extension cables between preferred
modules, and the space consumed by the devices themselves.

31003688 2/2009

19

Introduction

STB NIP 2212 Product Overview

Introduction
An Advantys STB island bus configured with an STB NIP 2212 standard NIM can
function transparently as a node on an Ethernet local area network (LAN), or on the
Internet. It can function, indirectly, as a node on a wide area network (WAN). The
STB NIP 2212 can be a slave device to an Ethernet host manager.
Ethernet and Internet Connectivity
TCP/IP is the transport layer for the Ethernet LAN on which the STB NIP 2212
Advantys STB island resides. This network architecture enables communications
with a wide range of Ethernet TCP/IP control products, such as Programmable Logic
Controllers (PLCs), industrial computers, motion controllers, host computers, and
operator control stations.
The STB NIP 2212 NIM has a Transparent Ready implementation classification of
B20.
Embedded Web Server
The STB NIP 2212 includes an embedded web server (see page 101), which is a
web browser-enabled application. It allows authorized users worldwide to view
configuration and diagnostic data for the STB NIP 2212 (see page 127). (Users with
additional authorization (see page 130) can write data to the STB NIP 2212.)
Internet Applications
The STB NIP 2212 is configured for the following Internet applications:
z

HTTP embedded web server

Port 80 service access point (SAP)
browser based IP configuration and troubleshooting
SNMPallows remote network management of the STB NIP 2212
Port 161 SAP
enables remote network management (NMT) of the STB NIP 2212

Open Modbus
An open implementation of the proprietary Modbus protocol runs over TCP/IP on the
Ethernet LAN on which the STB NIP 2212 resides. The fieldbus (Ethernet) port
(see page 26) on the STB NIP 2212 is configured for Port 502 SAP functionality.
Port 502 is the well-known port for Modbus over TCP that was assigned to
Schneider Electric by the Internet Authority (IANA).

20

31003688 2/2009

Introduction

Conformance to NIM Standards

The STB NIP 2212 is designed to support all of the standard Advantys STB NIM
features and functions (see page 14). Because an STB NIP 2212 runs Modbus as
its fieldbus protocol, a device running the Advantys configuration software or a
human-machine interface (HMI) can attach to either its fieldbus (Ethernet) port)
(see page 26) or its CFG port (see page 33).
Ethernet Host
PLCs and personal computers (PCs) configured with the Modbus protocol are
suitable upstream Ethernet hosts to islands using the STB NIP 2212 as their
gateway. The Ethernet host can be local or remote.

31003688 2/2009

21

Introduction

Ethernet Communications and Connectivity

Introduction
The STB NIP 2212 allows the Advantys STB island to function as a node on an
Ethernet local area network (LAN).
Ethernet is an open local (communications) network that enables the interconnectivity of all levels of manufacturing operations from the plants office to the sensors
and actuators on its floor.
Conformance
The STB NIP 2212 is located on a 10Base-T LAN. The 10Base-T standard is
defined by the IEEE 802.3 Ethernet specification. Contention for 10Base-T networks
is resolved by using Carrier Sense Multiple Access with Collision Detect
(CSMA/CD).
Transmission Rate
An STB NIP 2212 island node resides on a baseband network with a transmission
rate of 10 Mbit/s.
Frame Format
The STB NIP 2212 supports both Ethernet II and IEEE 802.3 frame formats;
Ethernet II is the default frame type.
Modbus over TCP/IP Connection Management
The STB NIP 2212 limits the number of Modbus client connections to 16. If a request
for a new connection is received and the number of existing connections is at the
limit, the oldest unused connection is closed.

22

31003688 2/2009

The STB NIP 2212 NIM

31003688 2/2009

The STB NIP 2212 NIM

2
Introduction
This chapter describes the external features of the STB NIP 2212, including its
Ethernet port, network cable requirements, and power requirements.
What's in this Chapter?
This chapter contains the following topics:
Topic
External Features of the STB NIP 2212

31003688 2/2009

Page
24

STB NIP 2212 Network Interface

26

Rotary Switches

28

LED Indicators

30

CFG Interface

33

The Power Supply Interface

35

Logic Power

37

Selecting a Source Power Supply for the Islands Logic Power Bus

39

Module Specifications

42

23

The STB NIP 2212 NIM

External Features of the STB NIP 2212

Summary of Features
The following figure indicates where the physical features critical to STB NIP 2212
NIM operations are located:

The physical features of the STB NIP 2212 are described briefly in the following
table:

24

Feature

Function

Ethernet interface

An RJ-45 (see page 26) connector is used to connect the

NIM and the island bus to an Ethernet LAN network.

MAC ID

48-bit, unique network ID hard-coded in the STB NIP 2212

when manufactured.

upper rotary switch

lower rotary switch

The rotary switches (see page 28) used together specify a

role name for the STB NIP 2212.
Alternatively, the lower rotary switch can be used to direct
the STB NIP 2212 to use its MAC-based default IP address
(see page 28) or to obtain its IP parameters from a BootP
server or from the STB NIP 2212 web site (see page 102).

space provided to record Write the IP address that you assign to this STB NIP 2212
IP address
here.
31003688 2/2009

The STB NIP 2212 NIM

31003688 2/2009

Feature

Function

power supply interface

A two-pin connector used to connect an external 24 VDC

power supply (see page 39) to the NIM.

LED array

Colored LEDs (see page 30) use various patterns to visually

indicate the operational status of the island bus, activity on
the NIM, and the status of communications to the island over
the Ethernet LAN.

removable memory card

drawer

A plastic drawer in which a removable memory card

(see page 50) can be seated and then inserted into the NIM.

CFG port cover

A hinged flap on the NIMs front panel that covers the CFG
interface (see page 33) and the RST button (see page 55).

25

The STB NIP 2212 NIM

STB NIP 2212 Network Interface

Introduction
The fieldbus interface on the STB NIP 2212 is the point of connection between an
Advantys STB island and the Ethernet LAN on which the island resides. This
fieldbus interface is also called the Ethernet port.
The fieldbus interface is a 10Base-T port with an RJ-45 female connector. Category
5 (CAT5) twisted pair electrical wiring, either shielded (STP) or unshielded (UTP), is
used to connect the STB NIP 2212 to the Ethernet baseband.
NOTE: Because the Ethernet port is configured for Modbus over TCP/IP services
(SAP 502), the Advantys configuration software can run over the fieldbus interface
on the STB NIP 2212.
Fieldbus (Ethernet) Port
The interface for 10Base-T connections is located on the front of the STB NIP 2212
NIM toward the top:

The RJ-45 connector is an eight-pin female connector. The eight pins connect
horizontally along the top. Pin 8 has the leftmost position, and pin 1 is the rightmost.
The pin-out for the RJ-45 complies with the information in the following table:

26

Pin

Description

tx+

tx-

rx+

reserved

reserved

31003688 2/2009

The STB NIP 2212 NIM

Pin

Description

rx-

reserved

reserved

Communications Cable and Connector

The required communications cable is either shielded (STP) or unshielded (UTP)
electrical, twisted pair CAT5 cable. The cable used with the STB NIP 2212 must
terminate with an eight-pin male connector.
The CAT5 cable recommended for connecting the STB NIP 2212 to an Ethernet
LAN has the following characteristics:
standard

description

max. length

application

data rate

connector to the
fieldbus interface

10Base-T

24-gauge, twisted pair

100 m (328 ft)

data transmission

10 Mbits/s

eight-pin male

Note: There are many 8-pin male connectors that are compatible with the RJ-45 fieldbus interface on the
STB NIP 2212. Refer to the Transparent Factory Network Design and Cabling Guide (490 USE 134 00) for a list of
approved connectors.

NOTE: For technical specifications of CAT5 cables, refer to FCC Part 68, EIA/TIA568, TIA.TSB-36, and TIA TSB-40.
About STP/UTP Cabling
Select STP or UTP cable according to the noise level in your environment:
z Use STP cabling in high electrical noise environments.
z UTP cabling is acceptable in low electrical noise environments.

31003688 2/2009

27

The STB NIP 2212 NIM

Rotary Switches
Introduction
The STB NIP 2212 is a single node on an Ethernet LAN and, in turn, the Internet.
An STB NIP 2212 must have a unique IP address. The two rotary switches on the
NIM provide a simple, easy way to assign an IP address to the STB NIP 2212.
Physical Description
The two rotary switches are positioned one above the other on the front of the
STB NIP 2212. The upper switch represents the tens digit, and the lower switch
represents the ones digit:

Summary of Valid IP Address Settings

Each rotary switch position that you can use to set a valid IP address is marked on
the STB NIP 2212 housing (see page 28). The following information summarizes
the valid address settings:
z For a switch-set role name, select a numeric value from 00 to 159. You can use
both switches:
z On the upper switch (tens digit), the available settings are 0 to 15.
z On the lower switch (ones digit), the available settings are 0 to 9.
The numeric setting is appended to the STB NIP 2212 part number, e.g.,
STBNIP2212_123, and a DHCP server assigns it an IP address.

28

31003688 2/2009

The STB NIP 2212 NIM

z
z

For a BootP-served IP address (see page 61), select either of the two BOOTP
positions on the bottom switch.
If you set the bottom switch to either of the two INTERNAL positions, the
IP address will be assigned by one of the following methods:
z if the STB NIP 2212 is direct from the factory, it has no software set
IP parameters and will use a MAC-based IP address (see page 60).
z a fixed IP address using the STB NIP 2212 web configuration pages
(see page 105)
z a web-configured role name (see page 118) in association with a
DHCP server

NOTE: The STB NIP 2212 requires a valid IP address to communicate on the
Ethernet network and with a host. You must power cycle the STB NIP 2212 to
configure the STB NIP 2212 with an IP address set with these rotary switches.
NOTE: Do not change the rotary switch settings except when you are installing or
configuring the NIM. If you change the switch settings at any other time, you will lose
Ethernet communications with the island.
For information about how the STB NIP 2212 prioritizes IP addressing options, refer
to the IP parameterization flow chart (see page 62).

31003688 2/2009

29

The STB NIP 2212 NIM

LED Indicators
Introduction
Six LEDs on the STB NIP 2212 NIM visually indicate the operational status of the
island bus on an Ethernet LAN. The LED array is located toward the top of the NIM
front bezel:
z LED 10T ACT (see page 30) indicates whether the Ethernet LAN and the
Ethernet port are healthy and alive.
z LED LAN ST (see page 30) indicates events on the Ethernet LAN.
z LEDs RUN, PWR, ERR, and TEST indicate activity on the island and/or events
on the NIM.
Description
The illustration shows the six LEDs used by the Advantys STB NIP 2212:

Ethernet Communications LEDs

The 10T ACT and the STATUS indicate the conditions described in the following
table:
Label
10T ACT (green)

30

Pattern

Meaning

on or blinking

The network is alive and healthy.

off

The network is not alive and not healthy.

31003688 2/2009

The STB NIP 2212 NIM

Label

LAN ST (green)

Pattern

Meaning

steady on

The Ethernet LAN is operational.

steady off

No MAC address found.

blinking

Initializing the Ethernet network.

blink: 3

No link pulse detected.

blink: 4

Duplicate IP address detected.

blink: 5

Obtaining IP address or using default IP address

for bootp/Role name switch setting (see page 62).

blink: 6

Using the default IP address.

Advantys STB Communications LEDs

The table that follows describes the island bus condition(s) communicated by the
LEDs, and the colors and blink patterns used to indicate each condition.
RUN
(green)

ERR (red) TEST

(yellow)

Meaning

blink: 2

blink: 2

The island is powering up (self test in progress).

off

off

off

The island is initializingit is not started.

blink: 1

off

off

The island has been put in the pre-operational state by

the RST buttonit is not started.

blink: 3

The NIM is reading the contents of the removable

memory card (see page 53).

on

The NIM is overwriting its Flash memory with the cards

configuration data. (See 1.)

off

blink: 8

off

The contents of the removable memory card is invalid.

blinking
(steady)

off

off

The NIM is configuring (see page 45) or autoconfiguring (see page 49) the island busthe bus is
not started.

blinking

off

on

Auto-configuration data is being written to Flash

memory. (See 1.)

off

blink: 6

off

The NIM detects no I/O modules on the island bus.

off

blink: 2

off

Configuration mismatch detected after power upat

least one mandatory module does not match; the island
bus is not started.

off

blink: 2

off

Assignment errorthe NIM has detected a module

assignment error; the island bus is not started.

blink: 5

31003688 2/2009

blink: 2

Internal triggering protocol error.

31

The STB NIP 2212 NIM

RUN
(green)

ERR (red) TEST

(yellow)

Meaning

off

blinking
(steady)

Fatal errorBecause of the severity of the error, no

further communications with the island bus are
possible and the NIM stops the island. The following
are fatal errors:
z significant internal error

off

z module ID error
z auto-addressing (see page 46) failure
z mandatory module (see page 177) configuration

error
z process image error
z auto-configuration/configuration (see page 49)

error
z island bus management error
z receive/transmit queue software overrun error

32

on

off

off

The island bus is operational.

on

blink 3

off

At least one standard module does not matchthe

island bus is operational with a configuration mismatch.

on

blink: 2

off

Serious configuration mismatch (when a module is

pulled from a running island)the island bus is now in
pre-operational mode because of one or more
mismatched mandatory modules.

blink: 4

off

off

The island bus is stopped (when a module is pulled

from a running island)no further communications
with the island are possible.

off

on

off

Fatal errorinternal failure.

[any]

[any]

on

Test mode is enabledthe configuration software or

an HMI panel can set outputs. (See 2.)

The TEST LED is on temporarily during the Flash overwrite process.

The TEST LED is on steadily while the device connected to the CFG port is in control.

31003688 2/2009

The STB NIP 2212 NIM

CFG Interface
Purpose
The CFG port is a connection point to the island for:
z a computer running the Advantys configuration software
z an HMI panel
Physical Description
The CFG port is an RS-232 interface. It is located under a hinged flap on the front
of the NIM:

The port uses a male 8-pin HE-13 connector.

Port Parameters
The CFG port supports the set of communication parameters listed in the following
table. If you want to apply any settings other than the factory default values, you
must use the Advantys Configuration Software:
Parameter

Valid Values

bit rate (baud)

2400 / 4800 / 9600 / 19200 / 9600

38400/ 57600

Factory Default Settings

data bits

7/8

stop bits

1/2

parity

none/odd/even

even

Modbus communications mode

RTU/ASCII

RTU

Modbus address

1...247

NOTE: To restore all of the CFG ports communication parameters to their factory
default settings, push the RST button (see page 55) on the NIM. Be aware,
however, that this action overwrites all of the islands current configuration values
with factory default values.
You can also password protect a configuration, thereby putting the island in
protected mode (see page 187). If you do this, however, the RST button is disabled
and you are not able to use it to reset port parameters.

31003688 2/2009

33

The STB NIP 2212 NIM

Connections
An STB XCA 4002 programming cable must be used to connect the computer
running the Advantys Configuration Software or a Modbus-capable HMI panel to the
NIM via the CFG port.
The programming cable follows these specifications:
Parameter

Description

model

STB XCA 4002

function

connection to a device running Advantys Configuration

Software
connection to HMI panel

34

communications protocol

Modbus (either RTU or ASCII mode)

cable length

2 m (6.23 ft)

cable connectors

8-receptacle HE-13 (female)

9-receptacle SUB-D (female)

cable type

multiconductor

31003688 2/2009

The STB NIP 2212 NIM

The Power Supply Interface

Introduction
The NIMs built-in power supply requires 24 VDC from an external SELV-rated
power source. The connection between the 24 VDC source and the island is the
male two-pin connector illustrated below.
Physical Description
Power from the external 24 VDC supply comes in to the NIM via a two-pin connector
located at the bottom left of the module:

1
2

connector 124 VDC

connector 2common voltage

Connectors
Use either:
z a screw type power connector, available in a kit of 10 (model STB XTS 1120)
z a spring clamp power connector, available in a kit of 10 (model STB XTS 2120)

31003688 2/2009

35

The STB NIP 2212 NIM

The following illustrations show two views of each power connector type. A front and
back view of the STB XTS 1120 screw type connector is shown on the left, and a
front and back view of the STB XTS 2120 spring clamp connector is shown on the
right:

1
2
3
4
5

STB XTS 1120 screw-type power connector

STB XTS 2120 spring clamp power connector
wire entry slot
screw clamp access
spring clamp actuation button

Each entry slot accepts a wire in the range 0.14 to 1.5 mm2 (28 to 16 AWG).
Each connector has a 3.8 mm (0.15 in) pitch between the entry slots.

36

31003688 2/2009

The STB NIP 2212 NIM

Logic Power
Introduction
Logic power is a 5 VDC power signal on the island bus that the I/O modules require
for internal processing. The NIM has a built-in power supply that provides logic
power. The NIM sends the 5 V logic power signal across the island bus to support
the modules in the primary segment.
External Source Power

CAUTION
IMPROPER GALVANIC ISOLATION
The power components are not galvanically isolated. They are intended for use
only in systems designed to provide SELV isolation between the supply inputs or
outputs and the load devices or system power bus. You must use SELV-rated
supplies to provide 24 VDC source power to the NIM.
Failure to follow these instructions can result in injury or equipment damage.
Input from an external 24 VDC power supply (see page 39) is needed as the source
power for the NIMs built-in power supply. The NIMs built-in power supply converts
the incoming 24 V to 5 V of logic power. The external supply must be rated safety
extra low voltage (SELV-rated).
Logic Power Flow
The figure below shows how the NIMs integrated power supply generates logic
power and sends it across the primary segment:

31003688 2/2009

37

The STB NIP 2212 NIM

The figure below shows how the 24 VDC signal is distributed to an extension
segment across the island:

The logic power signal is terminated in the STB XBE 1100 module at the end of the
segment (EOS).
Island Bus Loads
The built-in power supply provides logic bus current to the island. If the logic bus
current drawn by the I/O modules exceeds the available current, install additional
STB power supplies to support the load. Consult the Advantys STB System
Planning and Installation Guide for the current provided and consumed by
Advantys STB modules at various operating temperatures and voltages.

38

31003688 2/2009

The STB NIP 2212 NIM

Selecting a Source Power Supply for the Islands Logic Power Bus
Logic Power Requirements
An external 24 VDC power supply is needed as the source for logic power to the
island bus. The external power supply connects to the islands NIM. This external
supply provides the 24 V input to the built-in 5 V power supply in the NIM.
The NIM delivers the logic power signal to the primary segment only. Special
STB XBE 1300 beginning-of-segment (BOS) modules, located in the first slot of
each extension segment, have their own built-in power supplies, which will provide
logic power to the STB I/O modules in the extension segments. Each BOS module
that you install requires 24 VDC from an external power supply.
Characteristics of the External Power Supply

CAUTION
IMPROPER GALVANIC ISOLATION
The power components are not galvanically isolated. They are intended for use
only in systems designed to provide SELV isolation between the supply inputs or
outputs and the load devices or system power bus. You must use SELV-rated
supplies to provide 24 VDC source power to the NIM.
Failure to follow these instructions can result in injury or equipment damage.
The external power supply needs to deliver 24 VDC source power to the island. The
supply that you select can have a low range limit of 19.2 VDC and a high range limit
of 30 VDC. The external supply must be rated safety extra low voltage (SELV-rated).
The SELV-rating means that SELV isolation is provided between the power supplys
inputs and outputs, the power bus, and the devices connected to the island bus.
Under normal or single-fault conditions the voltage between any two accessible
parts, or between an accessible part and the protective earth (PE) terminal for Class
1 equipment, will not exceed a safe value (60 VDC max.).
Calculating the Wattage Requirement
The amount of power (see page 37) that the external power supply must deliver is
a function of the number of modules and the number of built-in power supplies
installed on the island.
The external supply needs to provide 13 W of power for the NIM and 13 W for each
additional STB power supply (like an STB XBE 1300 BOS module). For example, a
system with one NIM in the primary segment and one BOS module in an extension
segment would require 26 W of power.

31003688 2/2009

39

The STB NIP 2212 NIM

Here is an example of an extended island:

1
2
3
4
5
6
7
8

40

24 VDC source power supply

NIM
PDM
primary segment I/O modules
BOS module
first extension segment I/O modules
second extension segment I/O modules
island bus terminator plate

31003688 2/2009

The STB NIP 2212 NIM

The extended island bus contains three built-in power supplies:

z the supply built into the NIM, which resides in the leftmost location of the primary
segment
z a power supply built into each of the STB XBE 1300 BOS extension modules,
which reside in the leftmost location of the two extension segments
In the figure, the external supply would provide 13 W of power for the NIM plus 13 W
for each of the two BOS modules in the extension segments (for a total of 39 W).
NOTE: If the 24 VDC source power supply also supplies field voltage to a power
distribution module (PDM), you must add the field load to your wattage calculation.
For 24 VDC loads, the calculation is simply amps x volts = watts.
Suggested Devices
The external power supply is generally enclosed in the same cabinet as the island.
Usually the external power supply is a DIN rail-mountable unit.
We recommend using ABL8 Phaseo power supplies.

31003688 2/2009

41

The STB NIP 2212 NIM

Module Specifications
Specifications Detail
The general specifications for the STB NIP 2212, which is the Ethernet network
interface module (NIM) for an Advantys STB island bus, appear in the following
table:
General Specifications
dimensions

interface and connectors

width

40.5 mm (1.594 in)

height

130 mm (4.941 in)

depth

70 mm (2.756 in)

to the Ethernet LAN

RJ-45 female connector

CAT5 STP/UTP twisted-pair, electrical
cable(s)

built-in power supply

RS-232 (see page 33) port for device

running the Advantys configuration
software or an HMI panel (see page 193)

eight-pin connector HE-13

to the external 24 VDC power supply

two-pin connector (see page 35)

input voltage

24 VDC nominal

input power range

19.2 ... 30 VDC

internal current supply

400 mA@ 24 VDC, consumptive

output voltage to the island bus

5 VDC nominal
2% variation due to temperature drift,
intolerance, or line regulation
1% load regulation
< 50 m output impedance up to
100 kHz

output current rating

1.2 A @ 5 VDC

isolation

no internal isolation
Isolation must be provided by an
external 24 VDC source power supply,
which must be SELV-rated.

addressable modules
supported

per segment

16 maximum

per island

32 maximum

segments supported

primary (required)

one

extension (optional)

six maximum

42

31003688 2/2009

The STB NIP 2212 NIM

General Specifications
standards

Ethernet conformance

IEEE 802.3

Transparent Ready implementation

classification

B20

HTTP

Port 80 SAP

SNMP

Port 161 SAP

Modbus over TCP/IP

Port 502 SAP

MTBF

200,000 hours GB (ground benign)

electromagnetic compatibility (EMC)

storage temperature

EN 61131-2
-40 to 85 C

operating temperature range*

0 to 60 C

agency certifications

refer to the Advantys STB System

Planning and Installation Guide, 890
USE 171 00

*This product supports operation at normal and extended temperature ranges. Refer to the Advantys STB System
Planning and Installation Guide, 890 USE 171 00 for a complete summary of cabalities and limitations.

31003688 2/2009

43

The STB NIP 2212 NIM

44

31003688 2/2009

How to Configure the Island Bus

31003688 2/2009

How to Configure the Island Bus

3
Introduction
The information in this chapter describes the auto-addressing and autoconfiguration processes. An Advantys STB system has an auto-configuration
capability in which the actual configuration of I/O modules on the island is read and
saved to Flash.
The removable memory card is discussed in this chapter. The card is an
Advantys STB option for storing configuration data offline. Factory default settings
can be restored to the island bus I/O modules and the CFG port by engaging the
RST button.
The NIM is the physical and logical location of all island bus configuration data and
functionality.
What's in this Chapter?
This chapter contains the following topics:
Topic
How Do Modules Automatically Get Island Bus Addresses?

31003688 2/2009

Page
46

How to Auto-Configure Default Parameters for Island Modules

49

How to Install the STB XMP 4440 Optional Removable Memory Card

50

How to Configure the Island with the STB XMP 4440 Optional Removable
Memory Card

53

What is the RST Button?

55

How to Overwrite Flash Memory with the RST Button

56

45

How to Configure the Island Bus

How Do Modules Automatically Get Island Bus Addresses?

Introduction
Each time that the island is powered up or reset, the NIM automatically assigns a
unique island bus address to each module on the island that engages in data
exchange. All Advantys STB I/O modules and preferred devices engage in data
exchange and require island bus addresses.
About the Island Bus Address
An island bus address is a unique integer value in the range 1 through 127 that
identifies the physical location of each addressable module on the island. The NIM's
address is always 127. Addresses 1 through 32 are available for I/O modules and
other island devices.
During initialization, the NIM detects the order in which modules are installed and
addresses them sequentially from left to right, starting with the first addressable
module after the NIM. No user action is required to address these modules.
Addressable Modules
Advantys STB I/O modules and preferred devices are auto-addressable. Enhanced
CANopen modules are not auto-addressable. They require manual address
settings.
Because they do not exchange data on the island bus, the following are not
addressed:
z bus extension modules
z PDMs such as the STB PDT 3100 and STB PDT 2100
z auxiliary power supplies, such as the STB CPS 2111
z termination plate

46

31003688 2/2009

How to Configure the Island Bus

An Example
For example, if you have an island bus with eight I/O modules:

1
2
3
4
5
6
7
8
9
10
11

NIM
STB PDT 3100 (24 VDC power distribution module)
STB DDI 3230 24 VDC (2-channel digital input module)
STB DDO 3200 24 VDC (2-channel digital output module)
STB DDI 3420 24 VDC (4-channel digital input module)
STB DDO 3410 24 VDC (4-channel digital output module)
STB DDI 3610 24 VDC (6-channel digital input module)
STB DDO 3600 24 VDC (6-channel digital output module)
STB AVI 1270 +/-10 VDC (2-channel analog input module)
STB AVO 1250 +/-10 VDC (2-channel analog output module)
STB XMP 1100 (island bus termination plate)

The NIM would auto-address it as follows. Note that the PDM and the termination
plate do not consume island bus addresses:
Module

31003688 2/2009

Physical
Location

Island Bus Address

NIM

127

STB PDT 3100 PDM

not addressed: does not exchange data

STB DDI 3230 input

STB DDO 3200 output

STB DDI 3420 input

STB DDO 3410 output

STB DDI 3610 input

STB DDO 3600 output

STB AVI 1270 input

STB AVO 1250 output

10

STB XMP 1100 termination plate

11

not applicable

47

How to Configure the Island Bus

Associating the Module Type with the Island Bus Location

As a result of the configuration process, the NIM automatically identifies physical
locations on the island bus with specific I/O module types. This feature enables you
to hot swap a failed module with a new module of the same type.

48

31003688 2/2009

How to Configure the Island Bus

How to Auto-Configure Default Parameters for Island Modules

Introduction
All Advantys STB I/O modules are shipped with a set of predefined parameters that
allow an island to be operational as soon as it is initialized. This ability of island
modules to operate with default parameters is known as auto-configuration. Once
an island bus has been installed, assembled, and successfully parameterized and
configured for your fieldbus network, you can begin using it as a node on that
network.
NOTE: A valid island configuration does not require the intervention of the optional
Advantys Configuration Software.
About Auto-Configuration
Auto-configuration occurs under these circumstances:
z The island is powered up with a factory default NIM configuration. (If this NIM is
subsequently used to create a new island, auto-configuration will not occur when
that new island is powered).
z You push the RST button (see page 55).
z You force an auto-configuration using the Advantys Configuration Software.
As part of the auto-configuration process, the NIM checks each module and
confirms that it has been properly connected to the island bus. The NIM stores the
default operating parameters for each module in Flash memory.
Customizing a Configuration
In a custom configuration, you can:
customize the operating parameters of I/O modules
z create reflex actions
z add enhanced CANopen standard devices to the island bus
z customize other island capabilities
z

31003688 2/2009

49

How to Configure the Island Bus

How to Install the STB XMP 4440 Optional Removable Memory Card
Introduction

CAUTION
LOSS OF CONFIGURATIONMEMORY CARD DAMAGE OR CONTAMINATION
The cards performance can be degraded by dirt or grease on its circuitry.
Contamination or damage may create an invalid configuration.
z
z
z

Use care when handling the card.

Inspect for contamination, physical damage, and scratches before installing the
card in the NIM drawer.
If the card does get dirty, clean it with a soft dry cloth.

Failure to follow these instructions can result in injury or equipment damage.

The STB XMP 4440 removable memory card is a 32-kbyte subscriber identification
module (SIM) that lets you store (see page 186), distribute, and reuse custom island
bus configurations. If the island is in unprotected (edit) mode (see page 187) and a
removable memory card containing a valid island bus configuration is inserted in the
NIM, the configuration data on the card overwrites the configuration data in Flash
memory, and is adopted when the island starts up. If the island is in protected mode,
the island ignores the presence of a removable memory card.
The removable memory card is an optional Advantys STB feature.
Remember:
Network configuration data, such as the fieldbus baud setting cannot be saved to
the card.
z Keep the card free of contaminants and dirt.
z

50

31003688 2/2009

How to Configure the Island Bus

Installing the Card

Use the following procedure to install the memory card:
Step
1

Action
Punch out the removable memory card from the plastic card on which it is
shipped.

Make sure that the edges of the card are smooth after you punch it out.

31003688 2/2009

Open the card drawer on the front of the NIM. If it makes it easier for you to work,
you may pull the drawer completely out from the NIM housing.

Align the chamfered edge (the 45 corner) of the removable memory card with
the one in the mounting slot in the card drawer. Hold the card so that the chamfer
is in the upper left corner.

Seat the card in the mounting slot, applying slight pressure to the card until it
snaps into place. The back edge of the card must be flush with the back of the
drawer.

Close the drawer.

51

How to Configure the Island Bus

Removing the Card

Use the following procedure to remove the memory card from the NIM. As a
handling precaution, avoid touching the circuitry on the card.
Step

52

Action

Open the card drawer.

Push the removable memory card out of the drawer through the round opening
at the back. Use a soft but firm object like a pencil eraser.

31003688 2/2009

How to Configure the Island Bus

How to Configure the Island with the STB XMP 4440 Optional Removable
Memory Card
Introduction
A removable memory card is read when an island is powered on. If the configuration
data on the card is valid, the current configuration data in Flash memory is
overwritten.
A removable memory card can be active only if an island is in edit mode. If an island
is in protected mode (see page 187), the card and its data are ignored.
Configuration Scenarios
The following discussion describes several island configuration scenarios that use
the removable memory card. The scenarios assume that a removable memory card
is already installed in the NIM:
z initial island configuration
z replace the current configuration data in Flash memory in order to:
z apply custom configuration data to your island
z temporarily implement an alternative configuration; for example, to replace an
island configuration used daily with one used to fulfill a special order
z
z

copying configuration data from one NIM to another, including from a failed NIM
to its replacement; the NIMs must run the same fieldbus protocol
configuring multiple islands with the same configuration data

NOTE: Whereas writing configuration data from the removable memory card to the
NIM does not require use of the optional Advantys configuration software, you must
use this software to save (write) configuration data to the removable memory card
in the first place.
Edit Mode
Your island must be in edit mode to be configured. In edit mode, the island can be
written to as well as monitored.
Edit mode is the default operational mode for the Advantys STB island:
z A new island is in edit mode.
z Edit mode is the default mode for a configuration downloaded from the Advantys
configuration software to the configuration memory area in the NIM.

31003688 2/2009

53

How to Configure the Island Bus

Initial Configuration and Reconfiguration Scenarios

Use the following procedure to set up an island with configuration data that was
previously saved (see page 186) to a removable memory card. You can use this
procedure to configure a new island or to overwrite an existing configuration. Note:
The execution of this procedure destroys your existing configuration data.
Step

Action

Result

Install (see page 50) the

removable memory card in its
drawer in the NIM.

Power on the new island.

The configuration data on the card is checked. If the data is valid, it is

written to Flash memory. The system restarts automatically, and the
island is configured with this data. If the configuration data is invalid, it is
not used and the island will stop.
If the configuration data was unprotected, the island remains in edit mode.
If the configuration data on the card was password-protected
(see page 187), your island enters protected mode at the end of the
configuration process.
Note: If you are using this procedure to reconfigure an island and your
island is in protected mode, you can use the configuration software to
change the islands operational mode to edit.

Configuring Multiple Islands with the Same Data

You can use a removable memory card to make a copy of your configuration data;
then use the card to configure multiple islands. This capability is particularly
advantageous in a distributed manufacturing environment or for an OEM (original
equipment manufacturer).
NOTE: The islands may be either new or previously configured, but the NIMs must
all run the same fieldbus protocol.

54

31003688 2/2009

How to Configure the Island Bus

What is the RST Button?

Summary
The RST function is basically a Flash memory overwriting operation. This means
that RST is functional only after the island has been successfully configured at least
once. All RST functionality is performed with the RST button, which is enabled only
in edit mode (see page 53).
Physical Description

CAUTION
UNINTENDED EQUIPMENT OPERATION/CONFIGURATION OVERWRITTENRST BUTTON
Do not attempt to restart the island with the RST button. Pushing the RST button
reconfigures the island with default settings (no custom parameters).
Failure to follow these instructions can result in injury or equipment damage.
The RST button is located immediately above the CFG port (see page 33), and
behind the same hinged cover:

Holding down the RST button for 2 seconds or longer causes Flash memory to be
overwritten, resulting in a new configuration for the island.
If the island is already auto-configured, there is no consequence other than the
island stops during the configuration process. However, island parameters that you
previously customized with the Advantys Configuration Software are overwritten by
default parameters during the configuration process.
Engaging the RST Button
To engage the RST button, it is recommended that you use a small screwdriver with
a flat blade no wider than 2.5 mm (.10 in). Do not use a sharp object that might
damage the RST button, nor a soft item like a pencil that might break off and jam the
button.

31003688 2/2009

55

How to Configure the Island Bus

How to Overwrite Flash Memory with the RST Button

Introduction

CAUTION
UNINTENDED EQUIPMENT OPERATION/CONFIGURATION DATA OVERWRITTENRST BUTTON
Do not attempt to restart the island by pushing the RST button. Pushing the RST
button (see page 55) causes the island bus to reconfigure itself with factory default
operating parameters.
Failure to follow these instructions can result in injury or equipment damage.
The RST function allows you to reconfigure the operating parameters and values of
an island by overwriting the current configuration in Flash memory. RST functionality
affects the configuration values associated with the I/O modules on the island, the
operational mode of the island, and the CFG port parameters.
The RST function is performed by holding down the RST button (see page 55) for at
least two seconds. The RST button is enabled only in edit mode. In protected mode
(see page 187), the RST button is disabled; pressing it has no effect.
NOTE: Network settings, such as the fieldbus baud and the fieldbus node ID, remain
unaffected.
RST Configuration Scenarios
The following scenarios describe some of the ways that you can use the RST
function to configure your island:
z Restore factory-default parameters and values to an island, including to the I/O
modules and the CFG port (see page 33).
z Add a new I/O module to a previously auto-configured (see page 49) island.
If a new I/O module is added to the island, pressing the RST button forces the
auto-configuration process. The updated island configuration data is
automatically written to Flash memory.

56

31003688 2/2009

How to Configure the Island Bus

Overwriting Flash Memory with Factory Default Values

The following procedure describes how to use the RST function to write default
configuration data to Flash memory. Follow this procedure if you want to restore
default settings to an island. This is also the procedure to use to update the
configuration data in Flash memory after you add an I/O module to a previously
auto-configured island bus. Because this procedure overwrites the configuration
data, you may want to save your existing island configuration data to a removable
memory card before pushing the RST button.
Step

Action

If you have a removable memory card installed, remove it (see page 52).

Ensure that your island is in edit mode (see page 53).

Hold the RST button (see page 55) down for at least two seconds.

The Role of the NIM in this Process

The NIM reconfigures the island bus with default parameters as follows:
Stage

31003688 2/2009

Description

The NIM auto-addresses (see page 46) the I/O modules on the island and
derives their factory-default configuration values.

The NIM overwrites the current configuration in Flash memory with configuration
data that uses the factory-default values for the I/O modules.

It resets the communication parameters on its CFG port to their factory-default

values (see page 33).

It re-initializes the island bus and brings it into operational mode.

57

How to Configure the Island Bus

58

31003688 2/2009

IP Parameters
31003688 2/2009

IP Parameters

4
Introduction
The information in this chapter describes how IP parameters are assigned to the
STB NIP 2212.
What's in this Chapter?
This chapter contains the following topics:
Topic

31003688 2/2009

Page

How the STB NIP 2212 Obtains IP Parameters

60

The IP Address Assignment Process

62

59

IP Parameters

How the STB NIP 2212 Obtains IP Parameters

Summary
As a node on a TCP/IP network, the STB NIP 2212 requires a valid 32-bit IP
address. The IP address can be:
z
z

the MAC-based default IP address

assigned by an network server, including:
z BootP server (see page 92)
z DHCP server (see page 92)
customer-configured using the STB NIP 2212 web pages (see page 102)

NOTE: Refer to the IP parameters flow chart (see page 62) for information about
how the STB NIP 2212 prioritizes IP address assignment options.
Deriving an IP Address from a Media Access Control (MAC) Address
The 32-bit default IP address for the STB NIP 2212 is composed of the last four
octets of its 48-bit Media Access Control (MAC) address. The MAC address, or
Institute of Electrical and Electronics Engineers, Inc. (IEEE) global address is
assigned at the factory. The MAC address for an STB NIP 2212 is located on the
front bezel under the Ethernet port (see page 24).
A MAC address is stored in hexadecimal format. The numbers in the MAC address
must be converted from hexadecimal to decimal notation to derive the default
IP address. Use the following steps:
Step

Action

A MAC address comprises six pairs of hex values, e.g., 00 00 54 10 01 02.

Ignore the first two pairs: 00 00.

Identify a pair, e.g., 54.

Multiply the first number, 5 by 16. (5 x 16 = 80).

Add the second number, 4 (80 + 4 = 84).

NOTE: There are many resources for converting hex numbers to decimal numbers.
We recommend using the Windows calculator in scientific mode.
NOTE: An IP address is derived from the MAC address only when the IP address is
not otherwise provided by:
z
z
z

a BootP server
a DHCP server
a user configured IP setting

For more information about how the STB NIP 2212 prioritizes IP address
assignment options, refer to the IP parameters flowchart (see page 62) and fallback
IP addressing (see page 63).

60

31003688 2/2009

IP Parameters

MAC-Based IP Address Example

In the following example, the hex pairs in the example IEEE global address
(MAC address) 54.10.2D.11 are converted into a decimal number in the derived
IP address. The derived IP address is 84.16.45.17, so this becomes the default
IP address for the example STB NIP 2212:

Server-Assigned IP Addresses
A server-assigned IP address may be obtained from either a BootP or a DHCP
server. A BootP server must be invoked using either BOOTP position on the lower
rotary switch (see page 28). A DHCP-served IP address is associated with a
role name.
Role Name
A role name is a combination of the Ethernet NIM part number STBNIP2212 and a
numeric value, e.g., STBNIP2212_123.
A role name may be assigned in one of two ways:
z
z

using the numeric settings (00 to 159) on the rotary switches (see page 28)
setting the lower rotary switch to an INTERNAL position, powering on the
STB NIP 2212, and completing the Role Name setting (see page 122).

Customer-Configured IP Address
If your STB NIP 2212 does not have a role name, you can configure an IP address
directly on the Configured IP web page (see page 106). Set the lower rotary switch
to an INTERNAL position, power on the STB NIP 2212, and complete the web page.

31003688 2/2009

61

IP Parameters

The IP Address Assignment Process

Determining the IP Address
As shown in the following flow chart, the STB NIP 2212 performs a sequence of
checks to determine an IP address:

62

31003688 2/2009

IP Parameters

Assigning a Fallback IP Address

If the STB NIP 2212 cannotor is not configured toobtain an IP address from either
a BootP or DHCP server, it will assign itself a fallbackor defaultIP address. If a
BootP or DHCP server later assigns an IP address, the BootP or DHCP assigned IP
address replaces the fallback IP address.
The following diagram depicts the "Assign fallback IP address" process, referenced
above:

Frame Format Priorities

The STB NIP 2212 supports communications in the Ethernet II and 802.3 frame
formats. Ethernet II is the default.
When communicating with a BootP server, the STB NIP 2212 first makes a request
using the Ethernet II frame format followed by a request using the 802.3 frame
format, repeating this cycle 6 times. If the STB NIP 2212 completes this cycle of 6
BootP requests before it receives an IP address from the BootP server:
z

31003688 2/2009

for executable versions 2.2.4 or higher, it simultaneously:

z assigns a fallback IP address, and
z continues to make BootP requests until the BootP server assigns an IP
address

63

IP Parameters
z

for executable versions earlier than version 2.2.4, it:

z continues to make BootP requests until the BootP server assigns an IP
address

When communicating with a DHCP server, the STB NIP 2212 makes four requests
using the Ethernet II frame format, then makes four requests using the 802.3 frame
format. If the STB NIP 2212 completes making this cycle of requests before it
receives an IP address from the DHCP server:

64

for executable versions 2.2.4 or higher, it simultaneously:

z assigns a fallback IP address, and
z continues to make DHCP requests until the DHACP server assigns an IP
address

for executable versions earlier than version 2.2.4, it:

z assigns a fallback IP address, and ceases making further DHCP requests

31003688 2/2009

Services
31003688 2/2009

STB NIP 2212 Services

5
Introduction
This chapter describes the services provided by the STB NIP 2212 network
interface module.
What's in this Chapter?
This chapter contains the following sections:
Section

31003688 2/2009

Topic

Page

5.1

Modbus Messaging

5.2

IP Addressing

92

5.3

Faulty Device Replacement

93

5.4

Embedded Web Server

101

5.5

SNMP Services

148

5.6

Other Services

159

66

65

Services

5.1

Modbus Messaging

Introduction
The STB NIP 2212 implements the Modbus Messaging server service.
This section describes how data stored in the process image is exchanged between
the STB NIP 2212 and the Ethernet network, via Modbus over TCP/IP.
What's in this Section?
This section contains the following topics:
Topic
Modbus Messaging Service Description

66

Page
67

Data Exchange with the STB NIP 2212

72

Reading Diagnostic Data

81

Modbus Commands Supported by the STB NIP 2212

89

Modbus Error Codes

91

31003688 2/2009

Services

Modbus Messaging Service Description

The Modbus Messaging Services
The Modbus messaging service handles the transfer of data or commands between
two devices. One device is the client and the other is the server. The client initiates
the request and the server responds to the request. These services use the Modbus
protocol (or Modbus over TCP/IP in Ethernet applications) to support the data
transfer between devices.

1
2
3

SCADA and HMI data requests

PLC data transfer
device data gathering

Modbus Communication Standard

Modbus has been the industrial communication standard since 1979. It is now
combined with Ethernet TCP/IP to support Transparent Ready solutions.
Modbus over TCP/IP is a completely open Ethernet protocol. The development of a
connection to Modbus TCP/IP requires no proprietary component or license
purchase. The protocol may be easily combined with any device that supports a
standard TCP/IP communication stack. Specifications can be obtained free of
charge from www.modbus.org.

31003688 2/2009

67

Services

Modbus TCP Device Implementation

The Modbus application layer is very simple and universally recognized. Thousands
of manufacturers are already implementing this protocol. Many have already
developed Modbus TCP/IP connections, and many products are currently available.
The simplicity of Modbus TCP/IP enables any small field device, such as an I/O
module, to communicate over Ethernet without a powerful microprocessor or a large
amount of internal memory.
Modbus TCP/IP
The same application protocol is used for Modbus serial link, Modbus Plus, and
Modbus TCP. This interface routes messages from one network to another without
changing the protocol. Because Modbus is implemented above the TCP/IP layer,
you can also benefit from the IP routing, which enables devices located anywhere
in the world to communicate regardless of the distance between them.
Schneider offers an entire range of gateways for interconnecting a Modbus TCP/IP
network to already existing Modbus Plus or Modbus serial link networks. For further
details, consult a Schneider Electric regional sales office. The IANA institute has
assigned to Schneider port TCP 502, which is reserved for the Modbus protocol.
Modbus Messaging Summary
The transfer of information between a Modbus client and server is initiated when the
client sends a request to the server to transfer information, to execute a command,
or to perform one of many other possible functions.
After the server receives the request, it executes the command or retrieves the
required data from its memory. The server then responds to the client by either
acknowledging that the command is complete or providing the requested data.
The system response time is limited by two main factors, the time required for the
client to send the request/receive the response and the ability of the server to
answer within a specific amount of time.

1
2
3
4

68

retrieved data
client request
server response
data retrieval

31003688 2/2009

Services

A device may implement a Modbus client service, a Modbus server service, or both,
depending on the requirements of the device. A client is able to initiate Modbus
messaging requests to one or more servers. The server responds to requests
received from one or more clients.
A typical HMI or SCADA application implements a client service to initiate
communications with PLCs and other devices for information gathering. An I/O
device implements a server service so that other devices can read and write its I/O
values. Because the device does not need to initiate communications, it does not
implement a client service.
A PLC implements both client and server services so that it can initiate
communications to other PLCs and I/O devices and respond to requests from other
PLCs, SCADA, HMIs and other devices.

What a Modbus Client Service Provides

A device that implements the Modbus client service can initiate Modbus messaging
requests to another device that implements a Modbus server. These requests allow
the client to retrieve data from or send commands to the remote device.

31003688 2/2009

69

Services

What a Modbus Server Service Provides

A device that implements the Modbus server servicefor example, the
STB NIP 2212 Network Interface Modulecan respond to requests from any
Modbus client. The Modbus server service allows a device to make all its internal
and I/O data available to remote devices for both reading and control.
Modbus Function Codes
The Modbus protocol is a collection of function codes, where each code defines a
specific action for the server to perform. The ability of a device to perform read and
write functions is determined by the Modbus function codes that are implemented by
the server.
The Modbus protocol is based on five memory areas inside the device.
Memory Area

Description

0x or %M

Memory bits or output bits

1x or %I

Input bits

3x or %IW

Input words

4x or %MW

Memory words or output words

6x

Extended memory area

In addition to the function codes for reading and writing data within these areas,
there are codes for statistics, programming, device identification, and exception
responses. The Modbus server can make data available based on the following
limits:
z
z

Read: 125 words or registers

Write: 100 words or registers

When to Use the Client

A Modbus client should be used when data needs to be exchanged between two
devices at irregular or infrequent intervals such as when an event occurs. The client
allows a request to be triggered by the application code (in the case of a PLC or
SCADA) or by an internal timer (for a SCADA or an HMI). This allows you to initiate
communications only when required and provides a more efficient use of resources.
If the data must be exchanged at a short fixed rate, the I/O scanner service should
be used instead (if that service is supported by the client).

70

31003688 2/2009

Services

When to Use the Server

The Modbus server is accessed by either a Modbus client or an I/O scanner service
and should be used to transfer plant information, commands, or other required data.
The Modbus server provides real-time data transfer or access to data reports that
are stored in its memory. The Modbus server answers any Modbus requests it
receives. No additional configuration is necessary.
Any device that needs to exchange plant status, commands or data with other
devices should implement a Modbus server. A device that implements the server
can respond to requests sent from Modbus clients and make its internal I/O and data
available to remote devices for reading and control. The device may be an I/O
module, a drive, a power meter, a circuit breaker, a motor starter, or a PLC.
I/O modules are good examples of devices that implement a Modbus server service.
As servers, input modules let other control devices read values from them, and
output modules let control devices write values to them.
A PLC system implements both client and server services. The client service
enables the PLC to communicate with other PLCs and I/O modules; the server
service enables it to respond to requests from other PLCs, SCADA, HMIs and other
devices. Devices that do not need to respond to data transfer requests should not
need to implement a server service.

31003688 2/2009

71

Services

Data Exchange with the STB NIP 2212

Introduction
Data exchange between a Modbus over TCP/IP host or the HTTP embedded web
server and the Advantys STB island bus is conducted over the Ethernet port on the
STB NIP 2212.
Master Devices
The input and output data image areas (see page 191) can be accessed and
monitored over the Ethernet LAN by a Modbus over TCP/IP fieldbus master or the
STB NIP 2212 HTTP embedded web server.
The Ethernet port on the STB NIP 2212 is configured as follows:
z
z
z

Port 502 SAPModbus over TCP/IP

Port 80 SAPHTTP
Port 161 SAPSNMP

NOTE: An HMI panel or a device running the Advantys configuration software can
also exchange data with an island via the CFG port (see page 33) on the
STB NIP 2212.
Modbus over TCP/IP Communications
Master devices use Modbus messaging (see page 89) to read and write data to
specific registers in the process image. The Modbus protocol is understood
regardless of the network type.
The Modbus protocol uses a 16-bit word data format.
Data Exchange Process
Data stored in the process image is exchanged between the STB NIP 2212 and the
Ethernet network via Modbus over TCP/IP. First, data from the Ethernet host is
written to the output data image area (see page 74) in the NIMs process image.
Then, status, echo output, and input data information from the I/O modules on the
island are placed in the input data image area (see page 76). In this location, the
Modbus master can access them over the TCP/IP network, or over the CFG port.
Data within the output and the input areas of the process image is organized in the
order that the I/O modules are assembled (see page 73) on the island bus.

72

31003688 2/2009

Services

Data and Status Objects

Data exchange between the island and the fieldbus master involves three object
types:
z
z
z

data objects, which are operating values that the master either reads from the
input modules or writes to the output modules
status objects, which are module health records sent to the input area of the
process image by all of the I/O modules and read by the master
echo output data objects, which the digital output modules send to the input
process image; these objects are usually a copy of the data objects, but they can
contain useful information if a digital output channel is configured to handle the
result of a reflex action.

A Data Exchange Example

The example uses the sample island bus assembly, as illustrated in the following
figure. The sample island comprises the STB NIP 2212 NIM, eight Advantys STB
I/O modules, a 24 VDC PDM, and an STB XMP 1100 termination plate:

1
2
3
4
5
6
7
8
9
10
11

31003688 2/2009

STB NIP 2212 network interface module

24 VDC power distribution module
STB DDI 3230 24 VDC two-channel digital input module
STB DDO 3200 24 VDC two-channel digital output module
STB DDI 3420 24 VDC four-channel digital input module
STB DDO 3410 24 VDC four-channel digital output module
STB DDI 3610 24 VDC six-channel digital input module
STB DDO 3600 24 VDC six-channel digital output module
STB AVI 1270 +/-10 VDC two-channel analog input module
STB AVO 1250 +/-10 VDC two-channel analog output module
STB XMP 1100 island bus termination plate

73

Services

The I/O modules have the following island bus addresses:

I/O Model

Module Type

Modules Island Bus Address

STB DDI 3230

two-channel digital input

N1

STB DDO 3200

two-channel digital output

N2

STB DDI 3420

four-channel digital input

N3

STB DDO 3410

four-channel digital output

N4

STB DDI 3610

six-channel digital input

N5

STB DDO 3600

six-channel digital output

N6

STB AVI 1270

two-channel analog input

N7

STB AVO 1250

two-channel analog output

N8

The PDM and the termination plate are not addressable (see page 46), so they
exchange neither data objects nor status objects with the fieldbus master.
The Output Data Process Image
The output data process image contains the data written to the island from the
Modbus over TCP/IP host. This data is used to update the output modules on the
island bus. In the sample island bus assembly, there are four output modulesthree
digital output modules and one analog output module.

74

31003688 2/2009

Services

Each digital output module uses one Modbus register for its data. The analog output
module requires two registers, one for each output channel. Therefore, a total of five
registers (registers 40001 through 40005) are needed to accommodate the four
output modules in the sample island bus assembly.

1
2

The value represented in register 40004 is in the range +10 to -10 V, with 11-bit resolution
plus a sign bit in bit 15.
The value represented in register 40005 is in the range +10 to -10 V, with 11-bit resolution
plus a sign bit in bit 15.

The digital modules use the LSBs to hold and display their output data. The analog
module uses the MSBs to hold and display its output data.

31003688 2/2009

75

Services

The Input Data and I/O Status Process Image

Input data and I/O status information from the I/O modules are sent to the input
process image area. The fieldbus master or another monitoring device, e.g., an HMI
panel (see page 193), can view data in the input data image area.
All eight I/O modules are represented in the input process image area. Their
assigned registers start at register 45392 and continue in the order of their island
bus addresses.
A digital I/O module uses two contiguous registers:
z
z

Digital input modules use one register to report data and the next to report status.
Digital output modules use one register to report echo output data and the next
to report status.

NOTE: The value in an echo output data register is basically a copy of the value
written to the corresponding register in the output data process image area
(see page 74). Generally, the fieldbus master writes this value to the NIM, and the
echo is of not much interest. If an output channel is configured to perform a reflex
action (see page 180), however, the echo register provides a location where the
fieldbus master can view the current value of the output.
The analog input module uses four contiguous registers:
z
z
z
z

the first register to report the data for channel 1

the second register to report status for channel 1
the third register to report the data for channel 2
the fourth register to report status for channel 2

The analog output module uses two contiguous registers:

z the first register to report status for channel 1
z the second register to report status for channel 2

76

31003688 2/2009

Services

In total, the Modbus over TCP/IP sample island bus requires 18 registers (registers
45392 through 45409) to support our configuration:

31003688 2/2009

77

Services

78

31003688 2/2009

Services

31003688 2/2009

79

Services

80

31003688 2/2009

Services

Reading Diagnostic Data

Summary
Thirty-five contiguous registers (45357 through 45391) in the island bus data image
(see page 189) are reserved for diagnostic data about the Advantys STB system.
The diagnostic registers have pre-defined meanings, which are described below.
Master Devices
The diagnostic registers can be monitored by a Modbus over TCP/IP host or the
STB NIP 2212 embedded web server. The master devices use Modbus messaging
(see page 89) to read and write diagnostic data to specific registers in the diagnostic
block of the process image.
NOTE: An HMI panel or a device running the Advantys configuration software can
also exchange data with an island via the (CFG) port (see page 33) on the
STB NIP 2212.
Island Communications Status
Status information about the state of communications across the island bus is stored
in register 45357. The bits in the low byte (bits 7 through 0) use fifteen different
patterns to indicate the islands current communications state. Each bit in the high
byte (bits 15 through 8) indicates the presence or absence of a specific error
condition:

31003688 2/2009

81

Services
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

82

The island is initializing.

The island has been set to pre-operational mode, for example, by the reset function.
The STB NIP 2212 is configuring or auto-configuringcommunication to all modules is
reset.
The STB NIP 2212 is configuring or auto-configuringchecking for any modules that are
not auto-addressed.
The STB NIP 2212 is configuring or auto-configuringAdvantys STB and preferred
modules are being auto-addressed.
The STB NIP 2212 is configuring or auto-configuringboot-up is in progress.
The process image is being set up.
Initialization is complete, the island bus is configured, the configuration matches, and the
island bus is not started.
Configuration mismatchnon-mandatory or unexpected modules in the configuration do
not match, and the island bus is not started.
Configuration mismatchat least one mandatory module does not match, and the island
bus is not started.
Serious configuration mismatchthe island bus has been set to pre-operational mode,
and initialization is aborted.
The configuration matches, and the island bus is operational.
The island is operational with a configuration mismatch. At least one standard module
does not match, but all the mandatory modules are present and operating.
Serious configuration mismatchthe island bus was started but is now in pre-operational
mode because of one or more mismatched mandatory module(s).
The island has been set to pre-operational mode, for example, by the stop function.
A value of 1 in bit 8 is a fatal error. It indicates a low-priority receive queue software overrun
error.
A value of 1 in bit 9 is a fatal error. It indicates a NIM overrun error.
A value of 1 in bit 10 indicates an island bus-off error.
A value of 1 in bit 11 is a fatal error. It indicates that the error counter in the NIM has
reached the warning level and the error status bit has been set.
A value of 1 in bit 12 indicates that the NIMs error status bit has been reset.
A value of 1 in bit 13 is a fatal error. It indicates a low-priority transfer queue software
overrun error.
A value of 1 in bit 14 is a fatal error. It indicates a high-priority receive queue software
overrun error.
A value of 1 in bit 15 is a fatal error. It indicates a high-priority transfer queue software
overrun error.

31003688 2/2009

Services

Error Reporting
Each bit in register 45358 indicates a specific global error condition. A value of 1
indicates an error:

Fatal error. Because of the severity of the error, no further communications are possible
on the island bus.
2 Module ID errorA standard CANopen device is using a module ID reserved for the
Advantys STB modules.
3 Auto-addressing has failed.
4 Mandatory module configuration error.
5 Process image erroreither the process image configuration is inconsistent or it could not
be set up during auto-configuration.
6 Auto-configuration errora module is not in its configured location, and the NIM cannot
complete auto-configuration.
7 An island bus management error was detected by the NIM.
8 Assignment errorthe initialization process in the NIM has detected a module assignment
error.
9 Internal triggering protocol error.
10 Module data length error.
11 Module configuration error.

Node Configuration
The next eight contiguous registers (registers 45359 through 45366) display
locations where modules have been configured on the island bus. This information
is stored in Flash memory. At start up, the actual locations of the modules on the
island are validated by comparing them to the configured locations stored in
memory. Each bit represents one configured location:
z
z

31003688 2/2009

A value of 1 in a bit indicates that a module has been configured for the
associated location.
A value of 0 in a bit indicates that a module has not been configured for the
associated location.

83

Services

The first two registers, shown below, provide the 32 bits that represent the module
locations available in a typical island configuration. The remaining six registers
(45361 through 45366), are available to support the islands expansion capabilities:

Node Assembly
The next eight contiguous registers (registers 45367 through 45374) indicate the
presence or absence of configured modules in locations on the island bus. This
information is stored in Flash memory. At start up, the actual locations of the
modules on the island are validated by comparing them to the configured locations
stored in memory. Each bit represents a module:
z
z

84

A value of 1 in a given bit indicates that the configured module is not present.
A value of 0 indicates that the correct module is present in its configured location,
or that the location has not been configured.

31003688 2/2009

Services

The first two registers, shown below, provide the 32 bits that represent the module
locations available in a typical island configuration. The remaining six registers
(45369 through 45374) are available to support the islands expansion capabilities:

Emergency Messages
The next eight contiguous registers (registers 45375 through 45382) indicate the
presence or absence of newly received emergency messages for individual
modules on the island. Each bit represents a module:
z
z

31003688 2/2009

A value of 1 in a given bit indicates that a new emergency message has been
queued for the associated module.
A value of 0 in a given bit indicates that no new emergency messages have been
received for the associated module since the last time the diagnostic buffer was
read.

85

Services

The first two registers, shown below, provide the 32 bits that represent the module
locations available in a typical island configuration. The remaining six registers
(45377 through 45382) are available to support the islands expansion capabilities:

Fault Detection
The next eight contiguous registers (registers 45383 through 45390) indicate the
presence or absence of operational faults detected on the island bus modules. Each
bit represents a module:
z
z

86

A value of 1 in a bit indicates that the associated module is operating and that no
faults were detected.
A value of 0 in a bit indicates that the associated module is not operating either
because it has a fault or because it has not been configured.

31003688 2/2009

Services

The first two registers, shown below, provide the 32 bits that represent the module
locations available in a typical island configuration. The remaining six registers
(45385 through 45390) are available to support the islands expansion capabilities:

31003688 2/2009

87

Services

STB NIP 2212 Status Register

Register 45391 contains a word of diagnostic data that is allocated to the status of
the STB NIP 2212. The bits in the high byte have predefined meanings that are
common to all of the NIMs used with the Advantys STB island. The low byte displays
faulty device replacement status (see page 94):

1
2
3

4
5

6
7
8
9

10
11
12
13

88

FDR server 1 statusa value of 1 in bit 0 indicates that server 1 is not available
FDR server 2 statusa value of 1 in bit 1 indicates that server 2 is not available
FDR error a value of 1 in bit 2 indicates that either the NIM has received an invalid or 0length parameter file from a server or (the NIM has corrupted data or a length mismatch,
two examples of an invalid file).
Ethernet traffic overload errorthe NIM has experienced at least one Ethernet traffic
overload condition. This bit will not be reset until the next power cycle.
Ethernet traffic overload statusthe NIM has recently experienced an Ethernet traffic
overload condition. This bit will clear automatically, 15 seconds after the register is first
read following an overload condition.
Module failurebit 8 is set to 1 if any module on the island bus fails.
A value of 1 in bit 9 indicates an internal failureat least one global bit was set.
A bit value of 1 in bit 10 indicates an external failurethe problem is on the fieldbus.
A value of 1 in bit 11 indicates that the configuration is protectedthe RST button is
disabled, and the island configuration requires a password to write to it; a bit value of 0
indicates that the island configuration is unprotectedthe RST button is enabled, and the
configuration is not password-protected.
A value of 1 in bit 12 indicates that the configuration on the removable memory card is
invalid.
A value of 1 in bit 13 indicates that reflex action functionality has been configured. (For
NIMs with firmware version 2.0 or greater.)
A value of 1 in bit 14 indicates that one or more island modules have been hot-swapped.
(For NIMs with firmware version 2.0 or greater.)
Island bus output data mastera value of 0 in bit 15 indicates that the fieldbus master
device is controlling the output data of the islands process image; a bit value of 1 indicates
that the Advantys configuration software or an HMI panel is controlling the output data of
the islands process image.

31003688 2/2009

Services

Modbus Commands Supported by the STB NIP 2212

Introduction
Modbus is the protocol used by Modicon PLCs. Modbus defines the message
structure that the PLCs understand and use, regardless of network type. The
Modbus protocol describes the process that a controller uses to access another
device, how that device responds, and how errors are detected and reported.
Modbus Message Data Frame
Modbus messages are embedded within the frame or packet structure of the
network in use. A Modbus over TCP/IP network uses both the Ethernet II and
IEEE 802.3 data formats. For communications with the STB NIP 2212, Modbus
messages can be embedded in either frame type. Ethernet II is the default data
format.
Modbus Message Structure
The Modbus protocol uses a 16-bit word. A Modbus message begins with a header.
A Modbus message uses a Modbus function code (see page 89) as the first byte.
Following is a description of the structure of a Modbus message header:
Invoke Identifier

Protocol Type

Command Length

two-byte field that

associates a request
with a response

two-byte field
value for Modbus is
always 0

two-byte field
one-byte
value is the size of the
rest of the message

Destination ID

Modbus Message
n-byte field
first byte is the Modbus
function code

List of Supported Commands

The following table lists the Modbus commands that the STB NIP 2212 supports:
Modbus
Subfunction
Function Code or Subindex

Command

Valid Range

Max. No. of Words per

Message

read holding registers (4x)

19999

125

read input registers (3x)

14697

125

write single register (4x)

15120 and
94889999

get/clear Ethernet statistics

(see page 90)

053

N/A

16

write multiple registers (4x)

15120 and
94889999

100

22

mask write registers (4x)

15120 and
94889999

31003688 2/2009

21

89

Services

Modbus
Subfunction
Function Code or Subindex

Command

Valid Range

Max. No. of Words per

Message

23

read/write multiple registers

(4x)

15120 and
94889999

100 (write)

19999 (read)

125 (read)

Ethernet Statistics
Ethernet statistics comprise status information and errors related to data
transmissions to and from the STB NIP 2212 over the Ethernet LAN.
Ethernet statistics are held in a buffer until the get Ethernet statistics command is
issued, and the statistics are retrieved.
The clear Ethernet statistics command clears all of the statistics currently held in
the buffer except the MAC address and the IP address.
The following table lists the Ethernet statistics used by the Advantys STB system:
Word No.
in Buffer

Description

Comment

0002

MAC address

cannot be cleared

03

board status

0405

rx interrupt

0607

tx interrupt

08

jabber failure count

09

total collisions

1011

rx missed packet errors

1213

memory errors in state RAM

1415

chip restart count

1617

framing errors

1819

overflow errors

2021

CRC errors

2425

rx buffer errors

2627

tx buffer errors

2829

silo underflow

3031

late collision

3233

lost carrier

3435

collision tx failure

3637

IP address

cannot be cleared

3853

reserved

always 0

90

31003688 2/2009

Services

Modbus Error Codes

Introduction
During operations, you may encounter Modbus error codes that are returned by the
STB NIP 2212 NIM to the Advantys configuration software. These error codes are
displayed as byte codes in hexadecimal format.
General Error Codes

31003688 2/2009

Error Code

Error Type

Description

0x01

Illegal function

This error code is returned when the Advantys

configuration software attempts to modify the
configuration of the STB NIP 2212 when the software
does not have control.

0x03

Illegal Modbus
data value

This error code may indicate any of the following

conditions:
z the function code contains incorrect data
z a request is being issued while the NIM is in the
wrong operating modefor example, COMM state
protected
z you have entered the wrong password

91

Services

5.2

IP Addressing

Dynamic Assignment of IP Addresses

Introduction
The STB NIP 2212 network interface module can receive an IP address using either
the DHCP or BOOTP service.
For information on how these services are implemented in the STB NIP 2212
including the specific IP assignment sequencerefer to the chapter on IP
Parameters (see page 59).
DHCP
DHCP (Dynamic Host Configuration Protocol) manages network addressing
parameters for networked devices, in compliance with RFC 1531.
A DHCP server stores a list of role names and associated IP parameter settings for
every client device on the network. It dynamically assigns IP addressing settings in
response to client requests A DHCP server responds to both DHCP and BootP (a
subset of DHCP) requests.
The STB NIP 2212 network interface module implements DHCP as a client. Its IP
address can be dynamically assigned by a DHCP IP address server.
BOOTP
The Bootstrap Protocol (BootP) assigns IP addresses to nodes on an Ethernet
network, in compliance with RFC 951. Clients on the network issue BootP requests
during their initialization sequence.
A BootP server stores a list of MAC addresses and associated IP parameter settings
for every client device on the network. After receiving a request, the server responds
by assigning to the BootP client its IP parameter settings.
The STB NIP 2212 network interface module implements BootP as a client. A BootP
client transmits requests on the network every second during initialization until it
receives a reply from an IP address server.

92

31003688 2/2009

Services

5.3

Faulty Device Replacement

Introduction
The STB NIP 2212 network interface module supports the faulty device
replacement service. This service simplifies the process of replacing a failed or
failing STB NIP 2212, by automatically configuring the replacement devices IP
address and parameter settings.
What's in this Section?
This section contains the following topics:
Topic

31003688 2/2009

Page

Faulty Device Replacement

94

Faulty Device Replacement Preconditions

96

Configuring Faulty Device Replacement

98

Faulty Device Replacement Diagnostics

100

93

Services

Faulty Device Replacement

Summary
The FDR service uses a central FDR server to store network parameters
(see page 98) of certain devices on the network. If a device fails, the server
automatically configures the replacement device with the identical parameters as
the failed device. The FDR service removes the need for service personnel to keep
configuration records on hand and reduces the possibility of human error in entering
the new configuration.

1
2
3
4
5

94

FDR server
server configuration
operating parameter file transferred to the FDR client
FDR client (replacement device)
rolename assignment

31003688 2/2009

Services

FDR Components
As implemented in the STB NIP 2212 network interface module, the FDR service
comprises 1 or 2 FDR servers and 1 or more STB NIP 2212 clients. Each server is
a passive device; it simply stores the network parameters for the devices on the
network. To configure the server, create a list of the devices connected to the
network (each identified by a role name) and their IP parameters. After the FDR
service is enabled, the server responds to requests from the FDR clients.
The STB NIP 2212 FDR client is a network device that stores its parameters on the
FDR server to facilitate replacement of the device. Each client is assigned a role
name that uniquely identifies it from other devices on the network. After the device
is connected to the network, it sends a copy of its operating parameters to the
server. These parameters should always be sufficient to enable a replacement
STB NIP 2212 client to be configured to operate exactly as the original
STB NIP 2212 client. An update can be senteither manually or automaticallyto the
server when there is a change in the clients operating parameters.
If a STB NIP 2212 client device fails, the following occurs:

31003688 2/2009

Sequence

Event

Your service personnel must assign the same role name to the replacement
device.

Your service personnel places the new device on the network.

The device automatically issues a request to the server for a set of IP

parameters that is used by a device with this role name.

The device receives the IP parameters and then connects to the FDR server
and downloads a copy of its network parameters.

After the parameters are downloaded, the device implements the parameters
and operation resumes.

95

Services

Faulty Device Replacement Preconditions

Overview
Before your STB NIP 2212 network interface module can use the faulty device
replacement service, certain preconditions must be met. These preconditions relate
to:
z
z
z
z
z

software versioning
removable memory (SIM) card
server model types
role name settings
configuration sequence

Software Versions
The faulty device replacement service requires the installation of the following
software on your STB NIP 2212:
z
z

executable version 2.2.4 or higher

web site version 1.19.1 or higher

To check the software versions installed on your STB NIP 2212, check the
Properties page of your STB NIP 2212s embedded web server. To do this:
Step

Action

Use your internet browser to access your STB NIP 2212s web server
(see page 103). A username and password dialog opens.

Enter your web server username and password (see page 127) and click OK.
The Properties web page opens.

SIM Card
You may need to equip the Advantys island, of which the STB NIP 2212 is a part,
with an STB XMP 4400 removable memory (SIM) card. This SIM card retains the
island operating parameters.
NOTE: If you need to save only the network parametersand not the settings of
other island operating parametersthe FDR server (see page 119) stores that data
without the requirement of a SIM card.

96

31003688 2/2009

Services

Server Types
Only servers that support the faulty device replacement service can be installed as
FDR servers on your network. These include:
z
z

a 140 NOE 771 network communications module installed on a Modicon

Quantum PLC station
a TSX ETY network communications module installed on a Modicon Premium
PLC station

NOTE: If your network is configured to use dual FDR servers, both servers must be
of the same type: both Quantum NOE, or both Premium ETY.
Role Name Setting
The faulty device replacement service requires that the:
z
z

IP Address be assigned by a DHCP (and not BootP) server, and

role name be set using the rotary switches on face of the STB NIP 2212.

Configuration Sequence
Before powering up your STB NIP 2212, be sure to first configure your FDR server
(or servers) with a list containing the role name and associated IP address for each
STB NIP 2212 on the network.
NOTE: If your network is configured to use dual FDR servers, both FDR servers
must be configured with the same list of role names and associated IP addresses.

31003688 2/2009

97

Services

Configuring Faulty Device Replacement

Configurable Settings
Use the FDR Configuration page (see page 119) on the STB NIP 2212s embedded
web server to configure faulty device replacement client settings. The following
settings can be made:
Identifying 1 or 2 FDR servers If you do not identify any FDR servers on the FDR
Configuration page and a Quantum or Premium PLC is the fieldbus master, the
DHCP server acts as the FDR server. If a different type of fieldbus master is used,
you must fill in at least one of the FDR Server IP Address fields on the FDR
Configuration page or you will not have an FDR server.
Configuring the NIM to synchronize its operating parameters The
STB NIP 2212 can automatically synchronize its operating parameters with the
copy of those settings stored in the FDR server by periodically
z backing up (uploading) operating parameters from the STB NIP 2212 to the
FDR server, or
z restoring (downloading) the copied operating parameters from the FDR server
to the STB NIP 2212
Manually synchronizing the NIMs operating parameters You can synchronize
the STB NIP 2212 operating parameters by either backing up (uploading) or
restoring (downloading) these settings between the STB NIP 2212 and the FDR
server.
Turning off the automatic retrieval of operating parameters from the server
You can the automatic retrieval parameters (but not IP addressing parameters)
so that they must be manually input when a faulty device is replaced.
NOTE: The new STB NIP 2212 you are using to replace a faulty NIM must be in
factory-fresh condition when you are using the FDR service. A factory-fresh NIM is
one that has either just been removed from the box for the first time or one that has
been restored to a factory-default state.
A free utility program to restore a used NIM to its factory-default state is available on
Telemecanique.com.
Operating Parameters
The STB NIP 2212s operating parameters that the faulty device replacement
service can upload to or download from an FDR server are those settings configured
in the following embedded web server pages:
z
z
z

98

Configured IP page (see page 106)

Configure SNMP page (see page 110)
Configure Master Controller page (see page 112)

31003688 2/2009

Services
z
z
z
z

Master Configurator page (see page 115)

FDR Configuration page (see page 118)
Web Access Password Protection page (see page 127)
Configuration Password Protection page (see page 130)

Additionallyl, the configuration port parameters (see page 141) are also saved.

31003688 2/2009

99

Services

Faulty Device Replacement Diagnostics

Overview
Use the FDR Diagnostics pagein the STB NIP 2212s embedded web serverto
view information relating to the faulty device replacement service for your
STB NIP 2212 network interface module. This information describes:
z

status of the:
z FDR service
z IP address assignment process
z operating parameters file backup and restore process

how the STB NIP 2212 role name was assigned

the address of the IP address server
the file containing operating parameters received by the STB NIP 2212 from the
FDR server
synchronization status of the operating parameters file in the STB NIP 2212
the numbersince the last system rebootof:
z manual backups (uploads) of the operating parameters
z manual restores (downloads) of the operating parameters
z automatic backups (uploads) of the operating parameters
z automatic restores (downloads) of the operating parameters
z times the operating parameter file, downloaded from the FDR server, could not
be read by the STB NIP 2212
z times a connection could not be made between the STB NIP 2212 and the
FDR server

z
z
z
z

Refer to the FDR Diagnostics page (see page 142) for more detailed information
about the contents of this embedded web server page.

100

31003688 2/2009

Services

5.4

Embedded Web Server

Introduction
The STB NIP 2212 NIM provides an embedded web server that can be used to
configure and diagnose the device.
What's in this Section?
This section contains the following topics:
Topic
About the Embedded Web Server

31003688 2/2009

Page
102

Properties Web Page

104

Configuration Menu Web Page

105

Configured IP Web Page

106

Configure SNMP Web Page

110

Configure Master Controller Web Page

112

Master Configurator Web Page

115

Role Name Web Page / FDR Configuration Web Page

118

Reboot Web Page

124

Product Support Web Page

125

Security Menu Web Page

126

Web Access Password Protection

127

Configuration Password Protection

130

Diagnostics Menu Web Page

134

Ethernet Statistics

135

STB NIP 2212 Registers Web Page

136

I/O Data Values Web Page

138

Island Configuration Web Page

140

Island Parameters Web Page

141

Faulty Device Replacement (FDR) Diagnostics Web Page

142

Error Log Web Page

146

101

Services

About the Embedded Web Server

Introduction
The STB NIP 2212 includes a Hypertext Transfer Protocol (HTTP) based
embedded web server. Using a web browser (see page 102), you can view and edit
configuration and diagnostic data about the island node.
Initialization of the HTTP Server
At the end of the IP parameterization process (see page 62), the STB NIP 2212 is
initialized as an HTTP server, and its web pages are available for viewing and
editing.
Browser Requirements
You can use either of the following web browsers to access the STB NIP 2212 web
pages:
z
z

Internet Explorer browser, version 4.0 or greater

Netscape Navigator browser, version 4.0 or greater

Security
The STB NIP 2212 web site provides two levels of security:
z

A required web access username and password combination (see page 127),
whichdepending upon your configuration password selection (below)provides
either read-only or read/write web site access.
An optional configuration password (see page 130); if the configuration password
is:
z enabled, the web access username/password combination provides read-only
access, and the configuration password provides write access to the
STB NIP 2212 web site
z disabled, the web access username/password combination alone provides
both read and write access to the STB NIP 2212 web site

Getting Help
Page-level help is available for every STB NIP 2212 web page. To display the help
text for a page, click on the word Help. It is located at the top of the web page and
to the right of the STB NIP 2212 banner.

102

31003688 2/2009

Services

Accessing the STB NIP 2212 Web Site

Use the following steps to access the STB NIP 2212 web site:
Step

Action

Result

Go to your url: http://configured IP address

The STB NIP 2212 home page is displayed.

The web access password dialog box is displayed.

Enter your language preference. English is the
default language.
z If your language preference is English, click on
the Enter button.
z To select a different language, click on its name,
e.g., Deutsche. Then click on the Enter button.

Type the user name and the web access password

for your STB NIP 2212 site. Then click on the OK
button to proceed.
Note: The default user name and password are
USER. Both are case-sensitive. They should be
changed (see page 127) for your STB NIP 2212
web site.

The STB NIP 2212 Properties (see page 104) page

is displayed.

To navigate to a different web page, click on its tab.

For example, for information about how to contact
the STB NIP 2212 product support team, click on
the Support tab.

The Support web page (see page 103) is displayed.

Product Support
For information on how to contact Schneider-Electric for customer assistance for
your STB NIP 2212 NIM, select the Support menu command to open the Support
web page (see page 125).

31003688 2/2009

103

Services

Properties Web Page

Introduction
The Properties web page displays STB NIP 2212 statistics, such as the version of
the kernel and the executive, as well as the communications protocols for which the
STB NIP 2212 is configured.
Sample Properties Web Page
The Properties page is displayed automatically after the HTTP server authenticates
the user name and web access password. A sample Properties page is shown in the
following figure:

1
2
3
4

5
6

104

STB NIP 2212 banner. The role name (if configured) and the IP address in current use
display in the web banner.
Click on the word Home to return to the STB NIP 2212 home page.
Click on the word Help to display the help text for this web page.
The network activity icon indicates which communications protocols are active. The top
light represents HTTP, the middle light Modbus, and the bottom light FTP. If a protocol is
active, the light representing it is lit. For more information, drag the mouse over the light.
Navigation tabs.
Schneider Electric copyright information.

31003688 2/2009

Services

Configuration Menu Web Page

Introduction
The web-based resources that are available for configuring the STB NIP 2212 are
listed as options on the Configuration menu. The specific web page for each feature
is linked to a menu option.
Web-Based Configuration Options
The Configuration menu contains the following options:
z
z
z
z
z
z

Configured IP
Configure SNMP
Master Controller
Master Configurator
FDR ConfigurationorRole Name (see Note, below)
Reboot

Click on an option to open the associated embedded web server configuration page.
NOTE: Web server versions 1.19.1 and later display an FDR Configuration page;
earlier versions of the web server display a Role Name page.

31003688 2/2009

105

Services

Configured IP Web Page

Introduction
To communicate as a node on an Ethernet network, the fieldbus (Ethernet) port on
the STB NIP 2212 must be configured with a valid IP address. The IP address must
be unique on the Ethernet LAN on which the STB NIP 2212 resides.
One of the available IP address assignment methods (see page 60) is to configure
an IP address yourself, in the Configured IP web page.
NOTE: The configured IP address is used in the fallback IP assignment process
(see page 63). The configured IP address is applied only if the STB NIP 2212 is not
configured to obtainor cannot obtainan IP address from either a BootP or DHCP
server.
Sample Configured IP Web Page
A sample Configured IP web page appears in the following figure:

106

31003688 2/2009

Services

IP Parameters
The IP address for the STB NIP 2212 has the four parameters, which are described
in the following table:
Parameter

Description

IP address

Unique 32-bit address assigned to every node on the Internet.

subnet mask

The subnet mask is 32 bits assigned with the IP address of a

host. The contiguous 1s of the mask are used to separate the
network portion from the host portion of the address. When the
subnet mask is applied to the source and destination addresses,
it determines if the target host is on the local subnet or on a
remote network.

gateway

The default gateway, typically a router, is where the host sends

frames that are bound for remote networks. This is an optional
feature provided for networks containing a default gateway.

frame type

Ethernet format used by the STP NIP 2212. For example, the
STB NIP 2212 can use either the Ethernet II or the IEEE 802.3
frame format. Ethernet II is the default.

Note: The IP address for the STB NIP 2212 is written in dotted decimal format.

Using the Command Buttons

The following table describes how to use the command buttons on the Configured IP
web page:
To ...

Click on ...

Display the IP address stored in Flash memory

Reset

Display the MAC-based, derived default IP address.

Default

Save the IP address displayed on the Configured IP web

page.

Save

Assigning a Configured IP Address to the STB NIP 2212

Use the following procedure to configure an IP address for the STB NIP 2212. Note:
Your STB NIP 2212 cannot have a role name.
Step

Action

Comment

Set the lower rotary switch to an INTERNAL position

(see page 28), and power cycle the STB NIP 2212.

If your STB NIP 2212 has a role name, you must remove
it by deleting the Role Name setting (see page 118).

If no role name is assigned, skip step 2.

Open the STB NIP 2212 web site.

Click on the Configuration tab to display the Configuration

menu.

31003688 2/2009

107

Services

Step

Action

Comment

Select the Configured IP option.

In the IP address field, type the IP address that you want

to use in dotted decimal format.

Click on the Save button to save the address to Flash

memory and in RAM.

If the address is valid, it will appear in the

banner at the top of each STB NIP 2212
web page.
Note: The LAN ST LED (see page 30) on
the NIM blinks four times if the IP address is
a duplicate.

Click on the Configuration tab to return to the

Configuration menu.

Select Reboot (see page 124).

10

At the Reboot now? prompt, click on the OK button.

11

Click on the OK button at the confirmation prompt, "Are

you sure?"

Your STB NIP 2212 restarts. The

IP address that you set up on the web is the
active IP address for the island.

Restoring Default Parameters from the Web

Use the following procedure to reconfigure the STB NIP 2212 with its default
IP parameters (see page 60) from the embedded web werver. Note: If your
STB NIP 2212 has a Role Name, you must remove it before proceeding with the
following steps.
Step

108

Action

Comment

Open the STB NIP 2212 web site.

Click on the Configuration tab to display the

Configuration menu.

Select the Configured IP option.

The Configured IP web page (see page 106)

opens.

Click on the Default button.

The IP address parameters are restored to their

default values.
The address is based on the 48-bit MAC address
that was programmed into the STB NIP 2212
when it was manufactured.

Click on the Save button to save the address to

Flash memory and in RAM.

Note: The LAN ST LED (see page 30) on the NIM

blinks six times if the STB NIP 2212 default
address is in use. If the address is a duplicate, the
LAN ST LED blinks four times.

Click on the Configuration tab to return to the

Configuration menu.

31003688 2/2009

Services

Step

Action

Comment

Select Reboot (see page 124).

At the Reboot now? prompt, click on the OK button.

Click on the OK button at the confirmation prompt,

"Are you sure?"

31003688 2/2009

109

Services

Configure SNMP Web Page

Introduction
The Configure SNMP web page provides access to the parameters used by the
SNMP agent contained in the STB NIP 2212.
Fields on the Configure SNMP Web Page
The settings for the SNMP agent are described in the table below.
NOTE: The Manager and Trap SNMP features are not supported by the
STB NIP 2212.
Purpose

Field Name

Description

Agent

Location

96-character, case-sensitive alphanumeric string describing the

location of this STB NIP 2212 (agent device).

Contact

96-character, case-sensitive alphanumeric string identifying the

contact person for this STB NIP 2212.

Set

100-character, case-sensitive alphanumeric community string used

to wite the value of a point of information. A SetRequest is used by
an SNMP manager to write to the STB NIP 2212.
The default community name for the STB NIP 2212 is public.
Note: If you enable an Authentication Failure Trap, assign a private
community string for SetRequest.

Get

100-character, case-sensitive alphanumeric community string,

assigned by the user and used by the master to read the value of a
point of information provided by the STB NIP 2212.
The default community name for the STB NIP 2212 is public.

Community

110

31003688 2/2009

Services

Sample Configure SNMP Web Page

A sample Configure SNMP web page is shown in the following figure:

31003688 2/2009

111

Services

Configure Master Controller Web Page

Introduction
Any controller on the Ethernet network has the potential to control an island on that
network. Control can be obtained on a first-come/first-serve basis. The
STB NIP 2212 allows you to pre-assign priority control (masters) to as many as
three specific controllers on the network. If one of these assigned controllers is
connected, it will take priority over any unassigned controllers, even if an
unassigned controller has connected to the island first. To assign one or more
priority control (masters), use the Master Controller web page.
Understanding Processing Control and Priority
A controller that has control over an island has the ability to write to the islands
output process image and to change operating parameters on the island nodes.
Typically, the first controller to request write access is granted control. If another
controller attempts to write to the island while the first controller has control, the NIM
sends an error message and access is denied.
If a Web page configured master controller has been configured on the Master
Controller Web page (see page 114), a write request from it will preempt processing
control from any other non-Web page configured controller during its reservation
time.
Fields on the Master Controller Web Page
To pre-assign one or more (up to three) priority controllers for the STB NIP 2212,
identify them by their IP addresses:

112

Field Name

Description

Master x ID*

The unique IP address (see page 60) for a master controller.

Reservation Time

The amount of time in ms allocated to a priority controller for writing to

the STB NIP 2212. Other non-Web page configured controllers
attempting to write to the STB NIP 2212 while the non-Web page
configured controller is connected will receive an error message.
The default reservation time is 60,000 (1 min). Each time the non-Web
page configured controller writes to the NIM, the reservation time is
reset to 60,000.
Note: There is no reservation time applied for control from a Web page
configured controller.

31003688 2/2009

Services

Field Name

Description

Holdup Time

The amount of time in ms that output modules will hold their current state
without an update by a Modbus write command (see page 89). When
the module hold-up time out expires, the outputs will be driven to their
defined fallback states (see page 184).
Note: The holdup time must be defined via the Master Controller web
page. Holdup time out parameters and values are stored in nonvolatile
Flash memory.
Note: When write commands to an Ethernet NIM are stopped, an output
module located on the NIMs island maintains its output states from that
time until any pre-programmed timeout value expires. After that, the
predefined fallback states are set.

Link Failure Mode

The state the STB NIP 2212 enters upon the failure of the Ethernet
communication link, either:
z Fallback: the outputs immediately assume their defined fallback
states on link failure. This is the default setting.
z Holdup: the outputs hold their current state for the holdup time set
in this page, before assuming their defined fallback states.

* If you do not enter an IP address, then write access to the NIM will be obtained by the first
non-Web page configured controller that writes to it.

Setting Up Master Controllers for the Island

Use the following procedure to configure a master controller for the STB NIP 2212:
Step

Action

Click the Configuration tab to display the Configuration menu.

Select the Master Controller option.

Type the IP address for each master controller (up to three) that you want to set
up.

Type a value for the reservation time (0 ... 120000 ms). This is the amount of time
allocated to any non-Web page configured controller. The default setting is
60000 ms (1 min).

Type a value in ms for the holdup time. The default setting is 1000 ms. (1 sec).
The valid values are:
z values in the range 300 ... 120,000 ms.
z a value of 0 ms signifying indefinite hold up time
Note: You must enter the holdup value via the web page.

31003688 2/2009

113

Services

Step

Action

Select a link failure mode, which determines the STB NIP 2212s behavior when
the Ethernet communications link fails:
z Holdup: the STB NIP 2212 waits the holdup time before assuming its fallback
state, or
z Fallback: the STB NIP 2212 immediately assumes its fallback state

Click the Save button to store information to the STB NIP 2212s Flash memory
and in RAM.

Sample Master Controller Web Page

A sample Master Controller web page is shown in the following figure:

114

31003688 2/2009

Services

Master Configurator Web Page

What Is a Master Configurator?
The master configurator of an Advantys STB island controls the configuration data
for all of the I/O modules during its reservation time (see page 116). The
configuration master must run the Advantys configuration software. The
configuration master can connect to either the fieldbus (Ethernet) interface
(see page 26) or the CFG port (see page 33) on the STB NIP 2212.
NOTE: The master configurator of an Advantys STB island must be set up on the
Master Configurator web page.
The configuration master of an Advantys STB island can be a:
z
z
z

local host that resides on the same Ethernet LAN as the island
remote host that communicates with the Ethernet LAN on which the island
resides
device connecting to the STB NIP 2212, serially, via the CFG port

The master configurator is identified on the Master Configurator web page as

follows:
z
z

A master configurator running over the network is identified by its IP address.

A configuration master connecting to the CFG port is specified as serial
(see page 116).

A master configurator will pre-empt configuration mastery for the Advantys STB
island from any other configurator during its reservation time.

31003688 2/2009

115

Services

Fields on the Master Configurator Web Page

The fields on the Master Configurator web page are described in the following table:
Field

Legal Values

Description

protocol

IP

The IP address (see page 60) of the master

configurator on the Ethernet LAN.

Serial

The master configurator is attached to the CFG

port on the STB NIP 2212.

Disabled

Disabled is the default setting for this feature.

If selected, the master configurator feature is
disabled. However, devices normally capable of
configuring the island will perform as designed.

Reservation Time

0 ... 120000 ms, with a 1 ms resolution time The amount of time in ms allocated to a master
for writing configuration data to the
STB NIP 2212. Other masters attempting to
configure the island during this time will receive
an error message.
The default reservation time is 60,000 ms (1 min).
Reservation time is self-renewing.

Configuring a Master Configurator for the Island

Use the following procedure to configure a master configurator for an Advantys STB
island:
Step

Action

Click on the Configuration tab to display the Configuration menu.

Select the Master Configurator option.

To identify the master configurator, do one of the following:

z Click on the radio button next to the IP option and type in the IP address for

the master configurator communicating via the fieldbus (Ethernet) port

(see page 26), e.g., 139.158.2.38 (see page 117).
z For a master configurator attached to the STB NIP 2212s CFG port
(see page 33), click on the radio button next to the Serial option.
z To disable this feature, click on the radio button next to the Disabled
(default) option.

116

Type a value for the reservation time (0 ... 120000 ms). This is the amount of
time allocated to the master configurator for writing configuration data to the
island. The default setting is 60000 ms (1 min).

Click on the Save button to store the information about the master configurator
in the STB NIP 2212s Flash memory and in RAM.

31003688 2/2009

Services

Sample Master Configurator Web Page

A sample Master Configurator web page is shown in the following figure:

31003688 2/2009

117

Services

Role Name Web Page / FDR Configuration Web Page

Introduction
The STB NIP 2212 provides the following alternate configurable web pages,
depending upon the installed version of its embedded web server software:
If embedded web server software is...

The STB_NIP_2212 displays the...

version 1.19.1 or later (with executable

version 2.2.4 or higher also installed)

FDR Configuration web page

earlier than version 1.19.1

Role Name configuration web page

The FDR Configuration web page contains the settings, including role name, for the
STB NIP 2212s faulty device replacement service. When you replace a faulty
STB NIP 2212, the FDR service saves you the task of manually reconfiguring the
replacement device by automatically:
z
z
z

obtaining an IP address from a DHCP server

retrieving stored operating parameters from up to 2 specified FDR servers
assigning these operating parameters to the replacement STB NIP 2212 device

The Role Name configuration web page contains the role name assigned to the
STB NIP 2212. This role name is used by the STB NIP 2212 to request an IP
address from a DHCP server.
Both configuration pages are described, below.
Role Name
You can assign, edit, or delete a role name for an STB NIP 2212 in both the FDR
Configuration and the Role Name web pages. A role name is a concatenation of the
STBNIP2212 part number, an underscore character (_), and three numeric
characters, e.g., STBNIP2212_002.
A role name is the priority IP address assignment method used by the
STB NIP 2212 (see page 62). If a role name is assigned, the IP address for the
STB NIP 2212 is always associated with it.
NOTE: You will not be able to assign a configured IP (see page 61) or the default
IP address (see page 60), unless you first remove the role name.

118

31003688 2/2009

Services

Sample FDR Configuration Web Page

A sample FDR Configuration web page is displayed below:

FDR Settings
FDR web page settings include:
Setting

Description

Role Name

The concatenation of the ethernet NIMs model number

(STBNIP2212), an underscore character ( _ ), and a 3-digit number
(000...159) that uniquely identifies the NIM on the Ethernet LAN.

Server 1 IP Address1 The IP address of the first FDR server that stores the STB NIP 2212
operating parameters.
Server 2 IP Address1 The IP address of the second FDR server that stores the
STB NIP 2212 operating parameters.
Check Time
(minutes)
1

31003688 2/2009

The time period for the performance of either Auto Restore or Auto
Backup functions, as described in the Auto Sync Mode field, below.
Values range from 2...1500 minutes, with a default of 30 minutes.

When multiple FDR servers are active on the network, at least one of server IP address
settings is required. If only 1 FDR server is active on the network, no server IP address
settings are required.

119

Services

Setting

Description

Auto Sync Mode

The presently selected synchronization functionfor the configuration

files stored in both the FDR server and the STB NIP 2212to be
automatically performed within the Check Time period, above:
z Disabled: No file synchronization is scheduled
z Auto Backup: The configuration file in the STB NIP 2212 will be
uploaded to the FDR server(s)
z Auto Restore: The configuration file in the FDR server(s) will be
downloaded to the STB NIP 2212

Use Local
Configuration

Select this to turn off the automatic retrieval and assignment of

operating parameters. This selection necessitates the manual
configuration of a replacement STB NIP 2212.
Notes: - You must reboot the STB NIP 2212 for changes to this
setting to take effect. - This selection does not stop the STB NIP 2212
from sending DHCP requests for acquiring an IP address.

When multiple FDR servers are active on the network, at least one of server IP address
settings is required. If only 1 FDR server is active on the network, no server IP address
settings are required.

FDR Commands
Use the 4 command buttons at the bottom of the FDR Configuration web page to
execute the following functions:

120

Command

Description

Save

Saves edits made to the FDR Configuration values to the STB NIP 2212
flash memory, overwriting the previously stored values.

Reset

Discards non-saved FDR configuration edits, reverting settings to the

values stored in STB NIP 2212 flash memory.

Restore

Manually downloads stored operating parameters from an FDR server and

saves them to STB NIP 2212 flash memory.

Backup

Manually uploads saved operating parameters from STB NIP 2212 flash
memory to an FDR server.

31003688 2/2009

Services

Configuring FDR Settings

Use the following procedure to configure FDR settings for the STB NIP 2212:
Step

Action

Comment

Use the upper and/or lower rotary switches to set

the role name to a numerical address (from 0 to
159) (see page 28).

When you open the embedded web servers FDR

Configuration page, the value you set here will be
displayed in the Role Name field.

Open the STB NIP 2212 web site.

Click on the Configuration tab to display the

Configuration menu.

Select FDR Configuration.

Type in, or select, settings for the following fields:

z Server1/2 IP Address: If your Ethernet LAN

An FDR server can be either a:

has:
z Quantum NOE module, or
z multiple FDR servers, type the IP address for z Premium ETY module
1 or 2 FDR servers
Note: If you are using 2 FDR servers, both must be
z only 1 FDR server, leave these fields blank
the same type, i.e. both Quantum NOE, or both
Premium ETY modules.

z Check Time: Type in the time periodfrom

Default value is 30 minutes.

2 to 1500 minutesfor the performance of either

Auto Restore or Auto Backup functions, if
selected in the Auto Sync Mode field.
z Auto Sync Mode: Select if and how

Default value is Disabled.

STB NIP 2212 operating parameters will be

synchronized with an FDR server(s):
z Disabled: No synchronization
z Auto Backup: Settings to be uploaded from
the STB NIP 2212 to the FDR server(s)
z Auto Restore: Settings to be downloaded
from the FDR server(s) to the STB NIP 2212
z Use Local Configuration: Select this if you

want to turn off the automatic retrieval and

assignment of operating parameters, and
manually configure a replacement
STB NIP 2212.
6

31003688 2/2009

If you select this option, you must also reboot the

STB NIP 2212 for this change to take effect.

Click on the Save button to save your settings to the Notes:

Flash memory and in RAM.
z If you changed the Role Name of the
STB NIP 2212, you must reboot the
STB NIP 2212 to have a DHCP server assign
an IP address (see page 61).
z You should click the Backup command button
to upload your settings to the FDR server(s).

121

Services

Sample Role Name Web Page

A sample Role Name web page is shown below:

Configuring a Role Name

You can configure an internally set role name in either of the following web server
pages:
z
z

the Role Name page (for embedded web site versions earlier than 1.19.1) or
the FDR Configuration page (for embedded web site versions 1.19.1 and later)

In either case, to configure a role name:

Step

Action

Comment

Set the lower rotary switch to an INTERNAL position

(see page 28), and power cycle the STB NIP 2212.

Open the STB NIP 2212 web site.

Click on the Configuration tab to display the

Configuration menu.

Depending upon the version of your web server, select

the:
z Role Name page, or
z FDR Configuration page

Type or overtype the address portion (i.e. the last 3

The default role name is STBNIP2212_000.
digits) of the role name with 3 numeric values. You can
use any numbers in the range 000 to 159 that are not
already in use on the same Ethernet LAN.

122

31003688 2/2009

Services

Step

Action

Comment

Click on the Save button to save your role name to the The role name appears in the banner at the top
Flash memory and in RAM.
of each STB NIP 2212 web page.
Note: Saving the role name, however, does not
configure the STB NIP 2212 with it. You must
reboot the STB NIP 2212 (see step 8) to
configure it with a role name and to have a
DHCP server assign an IP address
(see page 61).

Click on the Configuration tab to return to the

Configuration menu.

Select Reboot (see page 124).

At the Reboot now? prompt, click OK.

10

At the Are you sure? confirmation prompt, click OK.

Your STB NIP 2212 restarts. It is configured

with the role name and an IP address.

Deleting a Role Name

You must delete a role name before you can assign a configured IP address or the
default IP parameters. Use the following steps:
Step

Action

1 Set the lower rotary switch to an INTERNAL position (see page 28), and power cycle
the STB NIP 2212.
2 Open the STB NIP 2212 web site.
3 Click on the Configuration tab to display the Configuration menu.
4 Select either:
z FDR Configuration if your web server version is 1.19.1 or higher, or
z Role Name, if your web server version is earlier than 1.19.1.
5 Highlight the role name to select it. Then press the Delete key on your keyboard.
6 Click Save.
Note: The role name is deleted from Flash memory.

31003688 2/2009

123

Services

Reboot Web Page

Reboot
The reboot operation temporarily disables the STB NIP 2212. it does not read the
rotary switches. Instead it:
z
z

applies the island operating parameters, that were stored in flash memory, to
island devicesincluding the STB NIP 2212 network interface module, and
clears the history in the STB NIP 2212s FDR Diagnostics (see page 142) web
page

The Reboot page looks like this:

124

31003688 2/2009

Services

Product Support Web Page

Product Support
Information about how to contact Schneider Electric about your STB NIP 2212
product is available from the Support web page. A sample Support page appears in
the following figure:

31003688 2/2009

125

Services

Security Menu Web Page

Introduction
The screens for changing the default web access username and password
combination, and setting a configuration password for the STB NIP 2212 are listed
as options on the Security menu.
Security Menu
The Security menu contains the following options:
z
z

Change Web Access Password

Change Configuration Password

Click on an option to open the related embedded web server page.

126

31003688 2/2009

Services

Web Access Password Protection

Summary
The STB NIP 2212 web site is password-protected. Initially, security for the
STB NIP 2212 web site is provided by a default web access user name and
password. Any visitor to your STB NIP 2212 site can view all of your information
using the default user name and password.
You will want to set up your own user name and password to protect your
STB NIP 2212 web site. To do this, in the Security menu, select the Change Web
Access Password (see page 128) option.
Default User Name and Password
The default name and password for the STB NIP 2212 web site are:
z
z

default user nameUSER

default passwordUSER

The user name and password are case-sensitive.

Correct entry of the default user name and password authorizes read-only access
to your STB NIP 2212 web site. The default (HTTP password) screen is shown in
the following figure:

31003688 2/2009

127

Services

What Is the Web Access Password?

The web access password is an eight-character, case-sensitive user name and
password that you assign. Your values will replace the default protection for your
STB NIP 2212 web site. All visitors to your site must correctly complete the web
access password dialog box, which is shown in the following figure. The web access
dialog box displays immediately after the STB NIP 2212 home page.

Setting Up the Web Access Login

Use the following procedure to set up your web access user name and password:
Step

128

Action

Result

Navigate to your url: http://configured IP address. The STB NIP 2212 home page is displayed.

The web access password dialog box is displayed.

Enter your language preference. English is the
default language.
z If your language preference is English, click on
the Enter button.
z To select a different language, click on its
name, e.g., Deutsche. Then click on the Enter
button.

Type USER, using all uppercase letters, in the user

name field and then, again, in the password field.

31003688 2/2009

Services

Step

Action

Result

Click on the OK button.

The STB NIP 2212 Properties web page

(see page 104) is displayed.

Click on the Security tab.

The Security menu is displayed.

Select the Change Web Access Password option. The Change Web Access Password page is
displayed.

Type the new user name.

The user name can have a maximum of eight
alphanumeric characters. You can also use an
underscore (_).
The characters are case-sensitive.

Type the user name again as the value for the

Confirm New User Name field.

In the New Password field, type your web access

password.
The password can have a maximum of eight
alphanumeric characters. You can also use an
underscore (_).
The characters are case-sensitive.

10

Type the password again in the Confirm New

Password field.

11

Click on the Save button.

The web access user name and password take effect

immediately.

31003688 2/2009

129

Services

Configuration Password Protection

Introduction
The configuration password controls read/write access from the STB NIP 2212 web
site to the physical modules Flash memory. There is no default configuration
password. Until a configuration password is set, only the web access username and
password (see page 127) combination is required to access and edit embedded
web server parameters.
Set the configuration password in the Change Configuration Password web page:

Set Configuration Password Procedure

Use the following procedure to set up a configuration password for your
STB NIP 2212 web site:
Step

130

Action

Result

Click on the Security tab.

The Security menu is displayed.

In the Security menu, click Change

Configuration Password.

The Change Configuration Password page is

displayed.

31003688 2/2009

Services

Step

Action

Result

In the New Password field, type your

configuration password.
Note: The password...
z ...must consist of 6 alphanumeric characters
z ...is case-sensitive

In the Confirm New Password field, re-type the

new password

Click Save.

The configuration password takes effect immediately.

Synchronizing the Web and Advantys Software Configuration Passwords

The same configuration password is used to:
z
z

authorize write privileges on the STB NIP 2212 embedded web server pages,
and
configure an Advantys STB island bus using the Advantys configuration software
(see page 187)

If your island already has a configuration password that was set using the Advantys
configuration software, you must use that password as the configuration password
for your STB NIP 2212 embedded web server pages, and vice versa.

31003688 2/2009

131

Services

Sample Login Prompt

When active, the login prompt is displayed in the web banner (as shown in the
following figure). The six-character configuration password must be entered to
proceed:

1
2

configuration password text box

Login / Log Out command button

Logging In and Out

If you set up a configuration password, the following login procedure takes effect:
Step

132

Action

Result

Type the configuration password in the text box

site next to the Login button.
Note: The password is case-sensitive.

The Login button toggles to Logout.

Your entire STB NIP 2212 web session is now write
enabled.

Click Login.

The web server tests the validity of the configuration

password.

31003688 2/2009

Services

Step

Action

Result

After a successful login:

z the web server pages are accessible for write
operations, and
z the Login button toggles to a Log Out button.

After completing your web server edits, click on

the Logout button to end write privileges on your
web site.

Write protection for your web site is restored.

31003688 2/2009

133

Services

Diagnostics Menu Web Page

Introduction
The web-based resources that are available for troubleshooting the STB NIP 2212
are listed as options on the Diagnostics menu. The web page for each feature is
linked to a menu option.
Diagnostics Menu
The Diagnostics menu contains the following options:
z
z
z
z
z
z
z

Ethernet Statistics
Network Interface Module Registers
I/O Data Values
Island Configuration
Island parameters
FDR Diagnostics (only for embedded web server versions 1.19.1 or higher)
Error Log

Click on an option to open the related embedded web server diagnostics page.

134

31003688 2/2009

Services

Ethernet Statistics
Introduction
The Ethernet Statistics web page reports status information and errors that are
related to data transmissions to and from the STB NIP 2212 over the Ethernet LAN.
Refresh Rate
The statistics on this page are updated at the rate of one per second.
Sample Ethernet Statistics Web Page
A sample Ethernet Statistics web page appears in the following figure:

1
2
3
4
5

31003688 2/2009

unique role name for this STB NIP 2212.

unique IP address for this STB NIP 2212.
unique MAC address for this STB NIP 2212.
Ethernet statisticsclick on the Help button to display a description for each Ethernet
statistic.
Reset buttonclicking on this button returns all of the counters to 0.

135

Services

STB NIP 2212 Registers Web Page

Summary
The NIM Registers web page will display information about specific Modbus
registers in the STB NIP 2212 process image. The registers to display are identified
by their Modbus register addresses.
Page Design
The NIM Registers web page is designed to provide a shared view of the specified
Modbus registers (see page 189). There is no limit to the number of registers that
can be displayed on this web page.
Customized and Common Views
The NIM Registers web page is designed to provide a customized but common view
of the STB NIP 2212 process image to everyone viewing the web page.
z

Custom viewBy supplying a personal variable name (maximum 10

characters) and an actual Modbus register location (see page 189), you can
customize this page to show the data that is most important to you.
Common viewHowever, only one view of the NIM Registers can be saved to
Flash memory.
After the display on the NIM Registers web page is written to Flash memory (by
clicking on the Save button on the page), the display on this web page is fixed,
providing a common view.

Using the Command Buttons

The following table describes how to use the command buttons on the NIM
Registers web page:

136

To ...

Click on the ...

add a row to the display.

Add button.

delete one or more row(s) from the display.

checkbox in front of each row that you

want to delete; then, click on the Delete
button.

save the NIM registers information from the web

page to Flash memory.
Note: This operation will overwrite the "save"
space in Flash memory with the NIM registers
data displayed on the web page.

Save button.

31003688 2/2009

Services

Format Feature
The format feature allows you to select whether the content of the NIM registers is
displayed in decimal or hexadecimal notation.
Sample NIM Registers Web Page
A sample NIM Registers web page appears in the following figure:

1
2
3
4
5
6
7
8

31003688 2/2009

10-character variable name

Modbus register number
current value for Modbus register 40090 is 0
checkbox for selecting variables to be deleted
Add button
Delete button
format preferencedecimal, hexadecimal or binary
Clicking on the Save button overwrites the designated (single) space in Flash memory with
the content of this web page.

137

Services

I/O Data Values Web Page

Summary
The I/O Data Values web page will display the values stored in the process image
output data area (see page 74) and input data area (see page 76) for the I/O
modules currently assembled on the island bus. The order of information on this web
page is the order of the I/O module assembly, as determined by the auto-addressing
(see page 46) and auto-configuration (see page 49) processes.
Page Design
The I/O Data Values web page is designed to accommodate up to 32 Advantys STB
I/O modules (or up to 256 Modbus registers (see page 189)). The number of
modules that can be accommodated will vary according to actual I/O modules
assembled on the island. For example, if there are multiple six-channel digital I/O
modules (STB DDI 3610s and/or STB DDO 3600s), STB AVI 1270s,
STB AVO 1250s, and a specialty module like the STB ART 0200, fewer than 32
modules can be represented on the I/O Data Values web page.

138

31003688 2/2009

Services

Sample I/O Data Values Web Page

A sample I/O Data Values web page appears in the following figure:

1
2
3
4
5
6
7
8

31003688 2/2009

modules island bus node address

Advantys STB part number
Modbus register location(s) for input and status data
input values
format preferencedecimal, hexadecimal, or binary
Modbus register location(s) for output data
output values
middle light is lit indicating Modbus activity

139

Services

Island Configuration Web Page

Introduction
The Island Configuration web page describes the configuration and operational
status (see page 86) of every module currently assembled on the island bus. The
modules are listed in order of their assembly starting with the STB NIP 2212.
Sample Island Configuration Web Page
A sample Island Configuration web page appears in the following figure:

140

31003688 2/2009

Services

Island Parameters Web Page

Sample Island Parameters Web Page
The Island Parameters web page displays a read-only list of the islands parameters
and their current values. A sample web page appears in the following figure:

31003688 2/2009

141

Services

Faulty Device Replacement (FDR) Diagnostics Web Page

Introduction
Use the Faulty Device Replacement (FDR) Diagnostics web page to monitor the
current state of FDR parameters.
Sample FDR Diagnostics Web Page
The FDR Diagnostics web page looks like this:

The FDR Diagnostics parameters are described, below:

Parameter
FDR Status

Description
The availability of FDR services:
z Operational: FDR service available
z Not Operational: FDR service unavailable

Naming Scheme

142

How the Role Name was assigned:

z Rotary Switches
z User Provisioned (via the web server page (see page 118))

31003688 2/2009

Services

31003688 2/2009

Parameter

Description

IP Status

Status of the IP address acquisition process:

z Offer Applied: an IP address was received via DHCP and applied
z Fallback NoOffer: no IP address was received via DHCPthe
STB NIP 2212 auto-assigned a fallback IP address (see page 63)
(from either a configured IP setting (see page 106) or its MAC ID)
z Fallback Invalid: an invalid IP address was received via DHCP and
not applied; STB NIP 2212 auto-assigned a fallback IP address
z Fallback Duplicate: a duplicate IP addressthat is, an IP address
already assigned to another device on the LANwas received via
DHCP and this IP address replaced the fallback IP address

File Status

The status of a parameter configuration filecontaining settings for the

Master Controller (see page 112) and Master Configurator
(see page 115) web pagesthat was sent to the STB NIP 2212 by the
FDR server:
z File Applied: the configuration file settings have been applied
z File Empty: the configuration file contained no settings, and was not
applied
z File Incompatible: the configuration file contained settings
incompatible with the STB NIP 2212, and was not applied
z File Corrupted: the configuration file was corrupted, and was not
applied
z No Server: no server could be found to send a configuration file
z File Uploaded: a configuration file has been uploaded from the
STB NIP 2212 to the FDR server
z File Downloaded: a configuration file has been downloaded from the
FDR server to the STB NIP 2212

DHCP Attempts

The number of DHCP requests that were made before the

STB NIP 2212 received a DHCP offer.

Address Server

The IP address of the server that provided an IP address to the

STB NIP 2212.

File Server

The IP address of the server that provided an FDR configuration file to

the STB NIP 2212.

File Name

The name of the FDR configuration file.

File Header

The header of the FDR configuration file.

File Checksum

The hexadecimal checksum of the FDR configuration file.

File Size

The size, in bytes, of the FDR configuration file.

File Updated

The synchronization status of the FDR configuration file, between the

STB NIP 2212 and the FDR server:
z True: synchronized
z False: not synchronized

Manual Backup

The number of manual backups, performed in the FDR Configuration

web page (see page 119), since the last system reboot. Resets to 1 after
65520 is reached.
143

Services

144

Parameter

Description

IP Status

Status of the IP address acquisition process:

z Offer Applied: an IP address was received via DHCP and applied
z Fallback NoOffer: no IP address was received via DHCPthe
STB NIP 2212 auto-assigned a fallback IP address (see page 63)
(from either a configured IP setting (see page 106) or its MAC ID)
z Fallback Invalid: an invalid IP address was received via DHCP and
not applied; STB NIP 2212 auto-assigned a fallback IP address
z Fallback Duplicate: a duplicate IP addressthat is, an IP address
already assigned to another device on the LANwas received via
DHCP and this IP address replaced the fallback IP address

File Status

The status of a parameter configuration filecontaining settings for the

Master Controller (see page 112) and Master Configurator
(see page 115) web pagesthat was sent to the STB NIP 2212 by the
FDR server:
z File Applied: the configuration file settings have been applied
z File Empty: the configuration file contained no settings, and was not
applied
z File Incompatible: the configuration file contained settings
incompatible with the STB NIP 2212, and was not applied
z File Corrupted: the configuration file was corrupted, and was not
applied
z No Server: no server could be found to send a configuration file
z File Uploaded: a configuration file has been uploaded from the
STB NIP 2212 to the FDR server
z File Downloaded: a configuration file has been downloaded from the
FDR server to the STB NIP 2212

DHCP Attempts

The number of DHCP requests that were made before the

STB NIP 2212 received a DHCP offer.

Address Server

The IP address of the server that provided an IP address to the

STB NIP 2212.

File Server

The IP address of the server that provided an FDR configuration file to

the STB NIP 2212.

File Name

The name of the FDR configuration file.

File Header

The header of the FDR configuration file.

File Checksum

The hexadecimal checksum of the FDR configuration file.

File Size

The size, in bytes, of the FDR configuration file.

File Updated

The synchronization status of the FDR configuration file, between the

STB NIP 2212 and the FDR server:
z True: synchronized
z False: not synchronized

Manual Backup

The number of manual backups, performed in the FDR Configuration

web page (see page 119), since the last system reboot. Resets to 1 after
65520 is reached.
31003688 2/2009

Services

31003688 2/2009

Parameter

Description

Auto Backup

The number of auto backups since the last system reboot. Resets to 1
after 65520 is reached.
Note: The auto backup procedure is configured in the FDR Configuration
web page.

Manual Restore

The number of manual restore procedures, performed in the FDR

Configuration web page, since the last system reboot. Resets to 1 after
65520 is reached.

Auto Restore

The number of auto restore procedures since the last system reboot.
Resets to 1 after 65520 is reached.
Note: The auto restore procedure is configured in the FDR Configuration
web page.

FTP Errors

The number times the STB NIP 2212 encountered an error while
attempting to read a configuration file downloaded from the FDR server,
since the last system reboot. Resets to 1 after 65520 is reached.

Sync Errors

The number of times the STB NIP 2212 tried and failed to connect to the
FDR server, since the last system reboot. Resets to 1 after 65520 is
reached.

145

Services

Error Log Web Page

Introduction
System-wide information collected while the Advantys STB island is operational is
reported on the Error Log web page.
Sample Error Log Web Page
A sample Error Log web page appears in the following figure:

Error Log Operations

The operations associated with the Error Log web page are described in the
following table:
To ...

Do ...

Display the Error Log web page.

Click on the Diagnostics tab to display

the Diagnostics menu (see page 134).
Then select the Error Log option.

146

Comment

31003688 2/2009

Services

To ...

Do ...

Comment

Update the display.

Click on the Refresh button.

The error log is not updated

automatically. It can only be updated
manually.

Delete the log.

Caution: Deleting the error log on
the web page removes it from
Flash memory.

Click on the Delete button.

You must have read/write

authorization (see page 130) to
delete the error log.

31003688 2/2009

147

Services

5.5

SNMP Services

Introduction
The STB NIP 2212 supports the simple network management protocol (SNMP).
What's in this Section?
This section contains the following topics:
Topic

148

Page

SNMP Device Management

149

Configuring the SNMP Agent

151

About the Schneider Private MIBs

152

Transparent Factory Ethernet (TFE) MIB Subtree

154

Port502 Messaging Subtree

155

Web MIB Subtree

156

Equipment Profiles Subtree

157

31003688 2/2009

Services

SNMP Device Management

Introduction
The STB NIP 2212 contains a Simple Network Management Protocol (SNMP)
Version 1.0 agent that is capable of supporting up to three concurrent SNMP
connections.
User Datagram Protocol (UDP)
On the STB NIP 2212, SNMP services are delivered via the UDP/IP stack. UDP is
the transport protocol used by the SNMP application in its communications with the
STB NIP 2212.
NOTE: BootP and the DHCP applications also use UDP as their transport layer
when communicating with the STB NIP 2212.
SNMP Agents and Managers
The SNMP network management model uses the following terminology and
definitions:
z
z

managerthe client application program running on the master

agentthe server application running on a network device, in this case, the
STB NIP 2212

The SNMP manager initiates communications with the agent. An SNMP manager
can query, read data from and write data to other host devices. An SNMP manager
uses UDP to establish communications with an agent device via an "open" Ethernet
interface.
When the STB NIP 2212 is successfully configured with SNMP, the STB NIP 2212
agent and the SNMP manager devices can recognize one another on the network.
The SNMP manager can then transmit data to and retrieve data from the
STB NIP 2212.
Network Management Application
SNMP software allows an SNMP manager (remote PC) to monitor and control the
STB NIP 2212. Specifically, SNMP services are used to monitor and manage:
z
z
z
z

performance
faults
configuration
security

SNMP Protocol Data Units (PDUs)

Protocol Data Units (PDUs) within SNMP carry requests and responses between the
manager and the STB NIP 2212 agent. The following PDUs are used:
31003688 2/2009

149

Services
z

GetRequestAn SNMP manager uses the "Get" PDU to read the value of one
or more management information base (MIB) (see page 152) objects from the
STB NIP 2212 agent.
SetRequestAn SNMP manager uses the "Set" PDU to write a value to one or
more objects resident on the STB NIP 2212 agent.

These PDUs are used in conjunction with MIB objects to get and set information
contained in an Object Identifier (OID).
SNMP PDU Structure
An SNMP message is the innermost part of a typical network transmission frame, as
shown in the following illustration:

Version & Community Identifiers

The STB NIP 2212 is configured with SNMP, Version 1.0. When setting up the
SNMP agent function for your STB NIP 2212 (see page 110), you should configure
private community name(s) for GetRequest and SetRequest.
NOTE: If you do not configure private community names for GetRequest and
SetRequest, any SNMP manager can read the MIB objects for your STB NIP 2212.
The community name is an identifier that you assign to your SNMP network when
you set up the SNMP manager. Community names for the SNMP manager and
agent must agree before SNMP processing can occur.

150

31003688 2/2009

Services

Configuring the SNMP Agent

The SNMP agent is configured using the STB NIP 2212s embedded web server.
Refer to the Configure SNMP Web Page (see page 110) topic for instructions on
how to configure SNMP settings.

31003688 2/2009

151

Services

About the Schneider Private MIBs

Introduction
The following information describes the Schneider Electric private MIB, and the
Transparent Factory Ethernet (TFE) and other subtrees that apply to the
STB NIP 2212.
The STB NIP 2212 uses the MIB II standard.
Management Information Base (MIB)
The Management Information Base (MIB) is an international communications
database in which each object that SNMP accesses is listed with a unique name and
its definition. Both SNMP manager and agent applications access the MIB.
Each MIB contains a finite number of objects. A management station (PC) running
an SNMP application uses sets (see page 110) and gets (see page 110) to set
system variables and to retrieve system information.
Schneider Private MIB
Schneider Electric has a private MIB, Groupe_Schneider (3833). 3833 is a private
enterprise number (PEN) assigned to Groupe_Schneider by the Internet Assigned
Numbers Authority (IANA). The number represents a unique object identifier (OID)
for Groupe_Schneider.
The OID for the root of the Groupe_Schneider subtree is 1.3.6.1.4.1.3833. This
OID represents a path to the TFE subtree as follows:

152

31003688 2/2009

Services

Transparent Factory Ethernet (TFE) Subtree

Under the Groupe_Schneider MIB is a Transparent_Factory_Ethernet (TFE) private
MIB that is controlled by the TFE SNMP embedded component. All SNMP
managers that communicate with an Advantys STB island via an SNMP agent use
the object names and definitions exactly as they appear in the TFE private MIB:

31003688 2/2009

153

Services

Transparent Factory Ethernet (TFE) MIB Subtree

Introduction
The Transparent Factory Ethernet (TFE) private is a subtree of the
Groupe_Schneider private MIB. The TFE SNMP component controls
Groupe_Schneiders private MIB function. Via its associated network
communications services, the Groupe_Schneider private MIB manages and
monitors all of the Advantys STB system components.
The TFE MIB provides data to manage the main TFE communications services for
the communication components that are part of the TFE architecture. The TFE MIB
does not define specific management applications and policies.
Transparent Factory Ethernet (TFE) MIB Subtree
The Transparent_Factory_Ethernet(1) defines groups that support TFE services
and devices:
Service

Description

Port 502_Messaging(2)

subtree that defines objects for managing explicit client/server

communications

web(5)

subtree that defines objects for managing embedded web

server activity

equipment_profiles(7)

subtree that identifies objects for each type of device in the TFE
product portfolio

Note: Numbers such as 1, 2, 5, and 7 are OIDs.

154

31003688 2/2009

Services

Port502 Messaging Subtree

Introduction
Port502 services support TFE services. Port502 services manage explicit
client/server communications that support applications, e.g., HMI data
communications. Every Port502 SAP is associated with a unique object in the
Port502 MIB subtree.
Port502 MIB Subtree
The Port502_Messaging subtree (OID 5) provides connection management and
data flow services to the STB NIP 2212. The following table includes the port502
objects and OIDs used by a TFE service:
Service

Indication for Port 502

Available Values

port502Status(1)

status of the service

idle

port502 SupportedProtocol(2)

supported protocols

port502IPSecurity(3)

status of IP security

disableddefault

operational

enabled
port502MaxConn(4)

max. no. of TCP connections supported

33

port502LocalConn(5)

no. of local TCP connections currently active

always 0

port502RemConn(6)

no of rport502 connections that are currently active

0 ... 32

port502 IPSecurityTable(7)

table containing the total no. of unsuccessful TCP

connection attempts by a remote device

port502ConnTable(8)

table containing Port 502-specific information

port502MsgIn(9)

total number of Port 502 messages received from the

network

port502MsgOut(10)

total number of Port 502 messages sent to the

network

port502MsgOutErr(11)

total number of error messages sent to the network

from Port 502

port502AddStackStat(12)

support of additional stack statistics

port502AddStackStatTable(13)

additional stack statistics (optional)

MsgIn
MsgOut

disabled
enabled

31003688 2/2009

155

Services

Web MIB Subtree

Introduction
The Web MIB subtree, OID 5, defines objects for managing embedded web server
activity.
Web MIB Subtree
The following table describes the objects in the Web subtree that support Ethernet
services used by the Advantys STB system:
Service

Indication

Available Values

webStatus(1)

global status of the web service

1idle

webPassword(2)

switch to enable/disable use of web 1disabled (see table note)

passwords
2enabled

2operational

webSuccessfulAccess(3) total number of successful

accesses to the STB NIP 2212
web site
webFailedAttempts(4)

total number of unsuccessful

attempts to access the
STB NIP 2212 web site

Note: Disabling the webPassword service will disable the default HTTP password
(see page 127) for the STB NIP 2212 embedded web server.

156

31003688 2/2009

Services

Equipment Profiles Subtree

Introduction
The Equipment_Profiles subtree (OID 7) identifies objects for every device type in
the TFE product portfolio.
Equipment Profiles MIB Subtree
The following table describes the objects contained in the Equipment Profiles MIB
subtree (group) that are common to all TFE products:
Service

Description

Comment

profile Product Name(1)

displays the commercial name of the

communication product as a string

e.g., STB NIP 2212

profileVersion(2)

displays software version of STB NIP 2212 e.g., Vx.y or V1.1

profileCommunicationServices
(3)

displays list of communication services

supported by the profile

profileGlobalStatus(4)

indicates global_status of the

STB NIP 2212

e.g., Port502Messging, Web

available values
z 1nok
z 2ok

profileConfigMode(5)

indicates the IP configuration mode of the

STB NIP 2212

available values
z 1local: the IP configuration is
created locally
z 2DHCP-served: the IP
configuration is created remotely
by a DHCP server

profileRoleName(6)

indicates role name for IP address

management

if none, value is no role name

profileBandwidthMgt(7)

indicates the status of bandwidth

management

value is always disabled

profileBandwidthDistTable(8)
profileLEDDisplayTable(9)

not available
displays a table giving the name and state
of each modules LEDs

refer to the STB NIP 2212 LEDs

discussion (see page 30)

profileSlot(10)

value=127

profileCPUType(11)

Advantys STB

profileTrapTableEntries
Max(12)

managers not required; value is 0

profileTrapTable(13)

not used

profileSpecified(14)

255

profileIPAddress(15)

IP address in use

31003688 2/2009

157

Services

Service

Description

profileNetMask(16)

subnet mask associated with SNMP

agents IP address

profileIPGateway(17)

default gateway IP address for the SNMP

agent

profileMacAddress(18)

Ethernet media dependent address of the

SNMP agent

158

Comment

31003688 2/2009

Services

5.6

Other Services

TFTP Service
Description
Trivial File Transfer Protocol (TFTP) is a simple client/server protocol that may be
used instead of FTP to transfer files. It uses UDP port number 69 and is
implemented on top of the UDP transport layer.
With TFTP most of the features of a regular FTP are removed. It can perform only
read and write operations from/to a remote server; it cannot list directories, and it
has no provisions for user authentication or security. TFTP can be implemented in
simple devices.
During a TFTP connection, files are transferred between the client and the
server.The recipient of the file issues a confirmation that the file was received
without errors.The protocol does not permit retransmission of only part of a file that
contains an error; the entire file must be retransmitted. This can represent a delay
in the transmission time. However, the probability of errors in the file due to
transmission or transmission loss is not very high.
The STB NIP 2212 implements the TFTP client service, as part of the faulty device
replacement (FDR) service (see page 93), where TFTP is used to transfer operating
parameters between the STB NIP 2212 and the FDR server.

31003688 2/2009

159

Services

160

31003688 2/2009

Connection Examples
31003688 2/2009

Connection Examples

6
Introduction
The information in this chapter provides two examples showing how to connect and
commission an Advantys STB island with an STB NIP 2212 gateway on a Modbus
TCP/IP network. The first example uses PL7; the second example uses Unity Pro.
What's in this Chapter?
This chapter contains the following topics:
Topic
Introduction

31003688 2/2009

Page
162

Network Architecture

163

Sample Configuration

165

Modbus Functions Supported by the STB NIP 2212

169

161

Connection Examples

Introduction
Overview
The connection example that follows describes how to connect and commission an
Advantys STB island with an STB NIP 2212 Ethernet gateway module. The
connection example does not use a specific Ethernet host because Modbus over
TCP/IP is an open protocol.
Assumptions
The connection example is based on the following assumptions:
z
z
z

162

You have read the rest of this Guide.

You have configured your STB NIP 2212 with an IP address that you either know
or can locate (see page 24).
You have a basic knowledge of Modbus (see page 89) over TCP/IP.

31003688 2/2009

Connection Examples

Network Architecture
Architectural Diagram
The physical network shown in the following figure is representative of how
Advantys STB islands can have various Ethernet hosts and how the islands can be
configured as nodes on the Ethernet:

1
2
3
4

31003688 2/2009

PC Ethernet host
switches
PLC Ethernet host
Advantys STB islands with STB NIP 2212 gateways

163

Connection Examples

The following table describes the cabling guidelines for the network shown in the
figure above:
Type of Connection

Cabling Guidelines

direct connection between a PC

host (with an Ethernet card) and
the STB NIP 2212

crossover cable

through a switch as recommended shielded (STP) or unshielded (UTP) electrical, twisted pair Category (CAT5)
by Schneider Electric
cabling (see page 26)
Note: Compatible switch, hub, connector, and cable selections are described in the Transparent Factory Network
Design and Cabling Guide (490 USE 134 00).

164

31003688 2/2009

Connection Examples

Sample Configuration
Example
A representative island bus assembly with an STB NIP 2212 gateway is shown in
the following figure:

1
2
3
4

STB NIP 2212 network interface module

24 VDC power distribution module
STB DDI 3230 24 VDC two-channel digital input module (2 bits data, 2 bits status)
STB DDO 3200 24 VDC two-channel digital output module (2 bits data, 2 bits of echo
output data, 2 bits status)
5 STB DDI 3420 24 VDC four-channel digital input module (4 bits data, 4 bits status)
6 STB DDO 3410 24 VDC four-channel digital output module (4 bits data, 4 bits of echo
output data, 4 bits status)
7 STB DDI 3610 24 VDC six-channel digital input module (6 bits data, 6 bits status)
8 STB DDO 3600 24 VDC six-channel digital output module (6 bits data, 6 bits of echo
output data, 6 bits status)
9 STB AVI 1270 +/-10 VDC two-channel analog input module (16 bits datachannel 1,
16 bits datachannel 2, 8 bits statuschannel 1, 8 bits statuschannel 2)
10 STB AVO 1250 +/-10 VDC two-channel analog output module (16 bits datachannel 1,
16 bits datachannel 2, 8 bits statuschannel 1, 8 bits statuschannel 2)
11 STB XMP 1100 island bus termination plate

The I/O modules in the sample assembly have the following island bus addresses:

31003688 2/2009

I/O Model

Module Type

Modules Island
Bus Address

Modules Island
Bus Address

STB DDI 3230

two-channel digital input

N1

STB DDO 3200

two-channel digital output

N2

STB DDI 3420

four-channel digital input

N3

STB DDO 3410

four-channel digital output

N4

STB DDI 3610

six-channel digital input

N5

165

Connection Examples

I/O Model

Module Type

Modules Island
Bus Address

Modules Island
Bus Address

STB DDO 3600

six-channel digital output

N6

STB AVI 1270

two-channel analog input

N7

STB AVO 1250

two-channel analog output

N8

The PDM and the termination plate are not addressable (see page 46).
Modbus over TCP/IP View of the Sample Island Configuration
The order in which the Advantys STB I/O modules in the sample island
(see page 165) are physically assembled determines the order in which data will
appear in the input and output data image areas (see page 191) of the process
image.
z
z

input data includes all of the I/O modules on an Advantys STB island bus that
contain status, data, and/or echo output data
output data contains only data

No bit-packing is used.
Standard Modbus 4x and 3x message formats are the addressing mechanism.
Input Process Image
The I/O modules in the sample island (see page 165) require 18 Modbus registers
in the input data image area (see page 76). The following table shows how these
registers are organized:
Modbus 15
Register
45392

14

13

12

11

10

emptyset to 0

N1 data

STB DDI 3230 data

45393

emptyset to 0

N1 status

STB DDI 3230 status

45394

emptyset to 0

N2 echo

STB DD0 3200 feedback

45395

emptyset to 0

N2 status

STB DD0 3200 status

45396

emptyset to 0

N3 data

STB DDI 3420 data

45397

emptyset to 0

N3 status

STB DDI 3420 status

166

31003688 2/2009

Connection Examples

Modbus 15
Register

14

13

12

11

10

45398

N4 echo
STB DDO 3410 feedback

45399

N4 status
STB DDO 3410 status

45400

N5 data
STB DDI 3610 data

45401

N5 status
STB DDI 3610 status

45402

N6 echo
STB DDI 3600 feedback

45403

N6 status
STB DDI 3600 status

45404

N7channel 1 data
AVI 1270 channel 1data

45405

N7 channel 1 status
AVI 1270 channel 1 status

45406

N7channel 2 data
AVI 1270 channel 2 data

45407

N7 channel 2 status
AVI 1270 channel 2 status

45408

N8 channel 1 status
AVI 1250 channel 1 status

45409

N8 channel 2 status
AVI 1250 channel 2 status

31003688 2/2009

167

Connection Examples

Output Process Image

The I/O modules in the sample island bus assembly require five Modbus registers
in the output data image area (see page 74). The following table shows how these
registers are organized:
Modbus 15
Register

14

13

40001

emptyset to 0

40002

emptyset to 0

40003

emptyset to 0

40004

N8 channel 1 data

40005

N8 channel 2 data

12

11

10

N2 data

STB DDI 3230 data

N4 data

STB DDO 3420 data

N6 data

STB DDO 3600 data

STB AVO 1250, channel 1 data

STB AVO 1250, channel 2 data

168

31003688 2/2009

Connection Examples

Modbus Functions Supported by the STB NIP 2212

Introduction
The STB NIP 2212 supports the Modbus functionality that is described below.
NOTE: The procedures required by your specific Modbus master and
Modbus over TCP/IP application may differ from those described here. Be sure to
read the documentation specific to your Modbus master and/or application.
Operations Summary
A Modbus over TCP/IP fieldbus master can read and write to the Modbus registers
in the STB NIP 2212. Communications from the Modbus master to the
STB NIP 2212 include:
z
z
z

Modbus function code

the size of the data being transmitted in words
number of first Modbus register to be used

Request and Response Example

The following example uses the data from channel 1 and channel 2 in the
STB AVO 1250 module (node 8 in the sample Advantys STB island bus)
(see page 165). In the example, Modbus register 40004 corresponds to channel 1
and Modbus register 40005 corresponds to channel 2.
NOTE: The examples use hexadecimal notation (0x000) for their numerical format.
Addressing begins in the output process image at register 40001. The format and
addressing may vary according to your particular software and controls.
Request: The request determines the starting address and the number of registers
to be read. In this case, two registers40004 and 40005should be read:
Description

Field

Example

command

Modbus function code

0x003

register count

word count

0x002

starting point

starting register

0x40004

Response: The response is the reply from the device. It contains the contents of the
registers in which the requested data is located. In this case, register 40004 contains
data 1234, and register 40005 contains data 6789:

31003688 2/2009

Description

Field

Example

command

Modbus function code

0x003

register count

word count

0x002

returned value

value of register 40004

0x1234

returned value

value of register 40005

0x6789
169

Connection Examples

Reference Descriptions
The xs following the leading character (3/4) represent a four-digit Modbus register
address:
z

3xxxx
Read input registers. A 3x reference register contains a 16-bit number received
from an external source, e.g., an analog signal.
4xxxx
Read/write output or holding registers. A 4x reference register is used to store 16bits of numerical data (binary or decimal), or to send the data from the CPU to an
output channel.

List of Supported Function Codes and Their Descriptions

The following table lists the function codes that can be used by Modbus over TCP/IP
masters that communicate with the STB NIP 2212:
Modbus
Function
Code

Subfunction
or Subindex

Hexadecimal

Description

0x03

read output holding registers (4x)

0x04

read input registers (3x)

0x06

write single register (4x)

0x08

get/clear Ethernet statistics (see page 90)

16

0x10

write multiple (output) registers (4x)

22

0x16

mask write registers (4x)

23

0x17

read/write multiple registers (4x)

6
8

sub index 21

Modbus over TCP/IP Data Exchange

The following table describes the general process used by Modbus over TCP/IP
masters to exchange data with the STB NIP 2212.
Stage
1
2

Action
Execute a function, specify the function code and the register address of the
selected input or output channel.
The Modbus master (i.e., PC, PLC) sends a request to the STB NIP 2212.
z If no exception is returned, the STB NIP 2212 responds to the master by

sending the data that was requested.

z If a request contains an error, the STB NIP 2212 returns an exception code

to the master.

170

31003688 2/2009

Connection Examples

List of Exception Codes

The following table describes the exception codes that Modbus over TCP/IP uses to
indicate an error condition:

31003688 2/2009

Code in
Hexadecimal

Description

0x01

illegal function

0x02

illegal data address

0x03

illegal data value

0x04

slave device failure

171

Connection Examples

172

31003688 2/2009

Advanced Configuration Features

31003688 2/2009

Advanced Configuration Features

7
Introduction
This chapter describes the advanced and/or optional configuration features that you
can add to an Advantys STB island.
What's in this Chapter?
This chapter contains the following topics:
Topic
STB NIP 2212 Configurable Parameters

31003688 2/2009

Page
174

Configuring Mandatory Modules

177

Prioritizing a Module

179

What Is a Reflex Action?

180

Island Fallback Scenarios

184

Saving Configuration Data

186

Protecting Configuration Data

187

A Modbus View of the Islands Data Image

188

The Islands Process Image Blocks

191

The HMI Blocks in the Island Data Image

193

Test Mode

195

Run-Time Parameters

197

Virtual Placeholder

202

173

Advanced Configuration Features

STB NIP 2212 Configurable Parameters

Introduction
The following information describes how to the configure parameters for the
STB NIP 2212 using the Advantys configuration software.
The following operating parameters are user configurable:
data size (in words) of PLC output data transmitted to the HMI panel and HMI
input data sent to the PLC
z maximum node ID for the last module assembled on the island bus, including
CANopen devices
z

General Information
For general information about the NIM module (model name, version number,
vendor code, etc.), do the following:
Step

Action

Comment

Open your island configuration with the The STB NIP 2212 is the leftmost module
Advantys configuration software.
in your island bus assembly.

Double-click on the NIM in the island

editor.

The module editor window appears.

Select the General tab.

General information about the

STB NIP 2212 is available from this tab.

Accessing Configurable Parameters

To access the configurable parameters for the STB NIP 2212:
Step

174

Action

Comment

Double-click on the STB NIP 2212 in

the island editor.

The module editor window appears.

Select the Parameters tab.

Configurable parameters are located

under this tab.

The configurable parameters are

In the Parameter name column,
expand the Additional Info Store List by displayed.
clicking on the plus (+) sign.

31003688 2/2009

Advanced Configuration Features

Selecting the Display Format

By default, the values for the configurable NIM parameters use decimal notation.
You can change the display format to hexadecimal notation, and vice-versa:
Step

Action

Comment

Double-click the NIM in the island

editor.

The module editor window appears.

Select the Parameters tab.

Click on the checkbox in front of

Hexadecimal at the top right of the
module editor window.
Note: To use decimal notation, again,
click on this checkbox to disable
hexadecimal notation.

The values for the configurable

parameters will display in hexadecimal
notation.

Reserved Sizes (HMI to PLC)

The network interprets data from the HMI as input and reads it from the input data
table in the process image. This table is shared with data from all input modules on
the island bus. When the reserved size (HMI to PLC) is selected, the range of
available data sizes (in words) is displayed. Space that you reserve for HMI to PLC
data must not exceed the maximum value shown (512 words).
Reserved Sizes (PLC to HMI)
The network transmits data to the HMI as output by writing it to the output data table
in the process image. This table is shared with data for all output modules on the
island bus. When the reserved size (PLC to HMI) is selected, the range of available
data sizes (in words) is displayed. Space that you reserve for the PLC to HMI data
must not exceed the maximum value shown (512 words).
Reserving Data Sizes
To transfer data to the PLC from a Modbus HMI panel attached to the CFG port, you
must reserve space for that data. To reserve data sizes:
Step

Action

Result

1 In the module editor window, select the

Parameters tab.
2 In the Parameter name column, expand
the Additional Info Store List by clicking
on the plus (+) sign.

The configurable NIM parameters are

displayed.

3 Double-click in the Value column next to The value is highlighted.

the Reserved Size (Words) of HMI to PLC
table.

31003688 2/2009

175

Advanced Configuration Features

Step

Action

Result

4 Type a value for the data size to be

The value plus the data size of your island
reserved for data sent from the HMI panel cannot exceed the maximum value. If you
to the PLC.
accept the default value (0), no space will
be reserved in the HMI table in the
process image.
5 Repeat steps 2-4 to select a value for the
Reserved Size (Words) of PLC to HMI
table row.
6 Click on the OK button to save your work.
7 Click on the Apply button to configure the
NIM with these values.

CANopen Device Node IDs

From the Parameters tab, you can set the maximum node ID of the last module on
the island bus. The last module may be a standard CANopen device. Standard
CANopen devices follow the last segment of STB I/O modules. CANopen modules
are addressed by counting backwards from the value that you specify here. The
ideal node ID sequence is sequential.
For example, if you have an island with five STB I/O modules and three CANopen
devices, a maximum node ID of at least 8 (5 + 3) is required. This will result in node
IDs of 1 through 5 for STB I/O modules and 6 through 8 for standard CANopen
devices. Using the default ID of 32 (the maximum number of modules the island can
support) will result in node IDs of 1 through 5 for STB I/O modules and 30 through
32 for standard CANopen devices. Unless required, high addresses are not
desirable if any of your standard CANopen devices has a limited address range.
Assigning the Max. Node ID (CANopen Devices)
To assign the highest node ID used by a CANopen device on the island bus:
Step

176

Action

Comment

In the module editor window, select the

Parameters tab.

Configurable parameters are located

under this tab.

In the box next to Max. node ID on the

CANopen extension, enter a node ID.

This node ID represents the last

CANopen module on the island bus.

31003688 2/2009

Advanced Configuration Features

Configuring Mandatory Modules

Summary
As part of a custom configuration, you can assign mandatory status to any I/O
module or preferred device on an island. The mandatory designation indicates that
you consider the module or device critical to your application. If the NIM does not
detect a healthy mandatory module at its assigned address during normal
operations, the NIM stops the entire island.
NOTE: The Advantys configuration software is required if you want to designate an
I/O module or a preferred device as a mandatory module.
Specifying Mandatory Modules
By default, the Advantys STB I/O modules are in a non-mandatory (standard) state.
Mandatory status is enabled by clicking on the mandatory checkbox on a module or
preferred devices Options tab. Depending on your application, any number of
modules that your island will support can be designated as mandatory modules.
Effects on Island Bus Operations
The following table describes the conditions under which mandatory modules affect
island bus operations and the NIMs response:

31003688 2/2009

Condition

Response

A mandatory module fails during

normal island bus operations.

The NIM stops the island bus. The island enters fallback
mode (see page 184). I/O modules and preferred
devices assume their fallback values.

You attempt to hot swap a

mandatory module.

The NIM stops the island bus. The island enters fallback
mode. I/O modules and preferred devices assume their
fallback values.

You are hot swapping a standard

I/O module that resides to the left
of a mandatory module on the
island bus, and the island loses
power.

When power is restored, the NIM attempts to address the

island modules but must stop at the empty slot where the
standard module used to reside. Because the NIM is now
unable to address the mandatory module, it generates a
mandatory mismatch error and the island fails to restart.

177

Advanced Configuration Features

Recovering from a Mandatory Stop

WARNING
UNINTENDED EQUIPMENT OPERATION/LOSS OF CONFIGURATIONRST
BUTTON WHILE RECOVERING FROM MANDATORY STOP
Pushing the RST button (see page 55) causes the island bus to reconfigure itself
with factory-default operating parameters, which do not support mandatory I/O
status.
z
z

Do not attempt to restart the island by pushing the RST button.

If a module is unhealthy, replace it with the same module type.

Failure to follow these instructions can result in death, serious injury, or

equipment damage.
Pushing the RST button (see page 55) while recovering from a mandatory stop will
load the islands default configuration data.
Hot Swapping a Mandatory Module
If the NIM has stopped island bus operations because it cannot detect a healthy
mandatory module, you can recover island bus operations by installing a healthy
module of the same type. The NIM automatically configures the replacement module
to match the removed module. Assuming that other modules and devices on the
island bus are correctly configured and conform to their configuration data as written
to Flash memory, the NIM will start/restart normal island bus operations.
NOTE: When hot swapping a mandatory module with a Fipio NIM present, the
hardware configuration fault bit (x5) in the standard channel status is set. Replacing
the module does not clear the bit. To restore normal operations in accordance with
Fipio standards, reset the NIM with a reset command from the fieldbus or cycle NIM
power.

178

31003688 2/2009

Advanced Configuration Features

Prioritizing a Module
Summary
Using the Advantys configuration software, you can assign priority to digital input
modules in your island assembly. Prioritization is a method of fine tuning the NIMs
I/O scan of the island bus. The NIM will scan modules with priority more frequently
than other island modules.
Limitations
You can prioritize only modules with digital inputs. You cannot prioritize output
modules or analog modules. You can prioritize only 10 modules for a given island.

31003688 2/2009

179

Advanced Configuration Features

What Is a Reflex Action?

Summary
Reflex actions are small routines that perform dedicated logical functions directly on
the Advantys island bus. They allow output modules on the island to act on data and
drive field actuators directly, without requiring the intervention of the fieldbus master.
A typical reflex action comprises one or two function blocks that perform:
z
z
z
z
z
z

Boolean AND or exclusive-OR operations

comparisons of an analog input value to user-specified threshold values
up- or down-counter operations
timer operations
the triggering of a latch to hold a digital value high or low
the triggering of a latch to hold an analog value at a specific value

The island bus optimizes reflex response time by assigning the highest transmission
priority to its reflex actions. Reflex actions take some of the processing workload off
the fieldbus master, and they offer a faster, more efficient use of system bandwidth.
How Reflex Actions Behave

WARNING
UNEXPECTED OUTPUT OPERATION
For outputs that are configured to respond to reflex actions, the output state
represented in the islands network interface module (NIM) may not represent the
actual states of the outputs.
z
z
z

Turn off field power before you service any equipment connected to the island.
For digital outputs, view the echo register for the module in the process image
to see the actual output state.
For analog outputs, there is no echo register in the process image. To view an
actual analog output value, connect the analog output channel to an analog
input channel.

Failure to follow these instructions can result in death, serious injury, or

equipment damage.
Reflex actions are designed to control outputs independently of the fieldbus master
controller. They may continue to turn outputs on and off even when power is
removed from the fieldbus master. Use prudent design practices when you use
reflex actions in your application.

180

31003688 2/2009

Advanced Configuration Features

Configuring a Reflex Action

Each block in a reflex action must be configured using the Advantys configuration
software.
Each block must be assigned a set of inputs and a result. Some blocks also require
that you specify one or more user-preset valuesa compare block, for example,
requires that you preset threshold values and a delta value for hysteresis.
Inputs to a Reflex Action
The inputs to a reflex block include an enable input and one or more operational
inputs. The inputs may be constants or they may come from other I/O modules on
the island, from virtual modules or outputs from another reflex block. For example,
an XOR block requires three inputsthe enable and two digital inputs that contain
the Boolean values to be XORed:

Some blocks, such as the timers, require reset and/or trigger inputs to control the
reflex action. The following example shows a timer block with three inputs:

The trigger input starts the timer at 0 and accumulates time units of 1, 10, 100 or
1000 ms for a specified number of counts. The reset input causes the timer
accumulator to be reset.
An input to a block may be a Boolean value, a word value, or a constant, depending
on the type of reflex action it is performing. The enable input is either a Boolean or
a constant always enabled value. The operational input to an block such as a digital
latch must always be a Boolean, whereas the operational input to an analog latch
must always be a 16-bit word.
You will need to configure a source for the blocks input values. An input value may
come from an I/O module on the island or from the fieldbus master via a virtual
module in the NIM.
NOTE: All inputs to a reflex block are sent on a change-of-state basis. After a
change-of-state event has occurred, the system imposes a 10 ms delay before it
accepts another change of state (input update). This feature is provided to minimize
jitter in the system.

31003688 2/2009

181

Advanced Configuration Features

Result of a Reflex Block

Depending on the type of reflex block that you use, it will output either a Boolean or
a word as its result. Generally, the result is mapped to an action module, as shown
in the following table:
Reflex Action

Result

Action Module Type

Boolean logic

Boolean value

digital output

integer compare

Boolean value

digital output

counter

16-bit word

first block in a nested reflex action

timer

Boolean value

digital output

digital latch

Boolean value

digital output

analog latch

16-bit word

analog output

The result from a block is usually mapped to an individual channel on an output

module. Depending on the type of result that the block produces, this action module
may be an analog channel or a digital channel.
When the result is mapped to a digital or analog output channel, that channel
becomes dedicated to the reflex action and can no longer use data from the fieldbus
master to update its field device.
The exception is when a reflex block is the first of two actions in a nested reflex
action.
Nesting
The Advantys configuration software allows you to create nested reflex actions. One
level of nesting is supportedi.e., two reflex blocks, where the result of the first
block is an operational input to the second block.
When you nest a pair of blocks, you need to map the results of both to the same
action module. Choose the action module type that is appropriate for the result of
the second block. This may mean that in some cases you will need to choose an
action module for the first result that does not seem to be appropriate according to
the table above.

182

31003688 2/2009

Advanced Configuration Features

For example, say you want to combine a counter block and a compare block in a
nested reflex action. You want the result of the counter to be the operational input to
the compare block. The compare block will then produce a Boolean as its result:

Result 2 (from the compare block) is the result that the nested reflex action will send
to an actual output. Because the result of a compare block needs to be mapped to
a digital action module, result 2 is mapped to channel 4 on an STB DDO 3410 digital
output module.
Result 1 is used only inside the moduleit provides the 16-bit operational input to
the compare block. It is mapped to the same STB DDO 3410 digital output module
that is the action module for the compare block.
Instead of specifying a physical channel on the action module for result 1, the
channel is set to none. In effect, you are sending result 1 to an internal reflex buffer
where it is stored temporarily until it is used as the operational input to the second
block. You are not really sending an analog value to a digital output channel.
Number of Reflex Blocks on an Island
An island can support up to 10 reflex blocks. A nested reflex action consumes two
blocks.
An individual output module can support up to two reflex blocks. Supporting more
than one block requires that you manage your processing resources efficiently. If
you are not careful with your resources, you may be able to support only one block
on an action module.
Processing resources are consumed quickly when a reflex block receives its inputs
from multiple sources (different I/O modules on the island and/or virtual modules in
the NIM). The best way to preserve processing resources is to:
z
z

31003688 2/2009

use the always enabled constant as the enable input whenever possible
use the same module to send multiple inputs to a block whenever possible

183

Advanced Configuration Features

Island Fallback Scenarios

Introduction
In the event of a communications failure on the island or between the island and the
fieldbus, output data is put into a safe fallback state. In this state, output data is
replaced with pre-configured fallback values, ensuring that a modules output data
values are known when the system recovers from a communications failure.
Fallback Scenarios
There are several scenarios in which Advantys STB output modules go into their
fallback states:
z loss of fieldbus communicationsCommunications with the PLC are lost.
z

z
z

loss of island bus communicationsThere is an internal island bus

communications error, indicated by a missing heartbeat message from either the
NIM or a module.
change of operating stateThe NIM may command the island I/O modules to
switch from a running to a non-running (stopped or reset) state.
missing or failed mandatory moduleThe NIM detects the absence or failure of
a mandatory island module.

NOTE: If a mandatory (or any other) module fails, it needs to be replaced. The
module itself does not go into its fallback state.
In all of these fallback scenarios, the NIM disables the heartbeat message.
Heartbeat Message
The Advantys STB system relies on a heartbeat message to ensure the integrity and
continuity of communications between the NIM and the island modules. The health
of island modules and the overall integrity of the Advantys STB system are
monitored through the transmission and reception of these periodic island bus
messages.
Because island I/O modules are configured to monitor the NIMs heartbeat
message, output modules will go into their fallback states if they do not receive a
heartbeat message from the NIM within the defined interval.
Fallback States for Reflex Functions
Only an output module channel to which the result of a reflex action (see page 180)
has been mapped can operate in the absence of the NIMs heartbeat message.
When modules that provide input for reflex functionality fail or are removed from the
island, the channels that hold the result of those reflex actions go into their fallback
states.

184

31003688 2/2009

Advanced Configuration Features

In most cases, an output module that has one of its channels dedicated to a reflex
action will go to its configured fallback state if the module loses communication with
the fieldbus master. The only exception is a two-channel digital output module that
has both of its channels dedicated to reflex actions. In this case, the module may
continue to solve logic after a loss of fieldbus communication. For more information
about reflex actions, refer to the Reflex Actions Reference Guide (890 USE 183).
Configured Fallback
To define a customized fallback strategy for individual modules, you are required to
use the Advantys configuration software. Configuration is done channel by channel.
You can configure a single modules multiple channels with different fallback
parameters. Configured fallback parametersimplemented only during a
communications failureare part of the configuration file stored in the NIMs nonvolatile Flash memory.
Fallback Parameters
You can select either of two fallback modes when configuring output channels with
the Advantys configuration software:
z
z

hold last valueIn this mode, outputs retain the last values they were assigned
before the failure.
predefined valueIn this (default) mode, you can select either of two fallback
values:
z 0 (default)
z

some value in acceptable range

The permissible values for fallback parameters in the predefined value mode for
discrete and analog modules and reflex functions appear in the following table:
Module Type

Fallback Parameter Values

discrete

0/off (default)

analog

0 (default)

1/on

not 0 (in range of acceptable analog values)

NOTE: In an auto-configured system, default fallback parameters and values are

always used.

31003688 2/2009

185

Advanced Configuration Features

Saving Configuration Data

Introduction
The Advantys configuration software allows you to save configuration data created
or modified with this software to the NIMs Flash memory and/or to the removable
memory card (see page 50). Subsequently, this data can be read from Flash
memory and used to configure your physical island.
NOTE: If your configuration data is too large, you will receive a message when you
attempt to save it.
How to Save a Configuration
The following procedure describes the steps you use to save a configuration data
file to Flash memory directly and to a removable memory card. For more detailed
procedural information, use the configuration softwares online help feature:
Step

186

Action

Comment

For NIM modules that support Ethernet

Connect the device running the
Advantys Configuration Software to the communications, you can connect the
device directly to the Ethernet port.
CFG port (see page 33) on the NIM.

Launch the configuration software.

Download the configuration data that

A successful download saves the
you want to save from the configuration configuration data to the NIM's flash
software to the NIM.
memory.

Install the card (see page 51) in the host Saving the configuration data to the
NIM, then use the Store to SIM card
removable memory card is optional.
command.
This operation overwrites old data on
the SIM card.

31003688 2/2009

Advanced Configuration Features

Protecting Configuration Data

Introduction
As part of a custom configuration, you can password-protect an Advantys STB
island. This protection restricts write privileges to authorized personnel and prevents
unauthorized users from overwriting the configuration data currently stored in Flash
memory:
z Use the Advantys Configuration Software to password-protect an islands
configuration.
z For some modules, it is possible to password-protect the island configuration
through an embedded web site.
Protection Feature
If a configuration is protected, access to it is restricted in the following ways:
An unauthorized user is unable to overwrite the current configuration data in
Flash memory.
z The presence of a removable memory card (see page 50) is ignored. The
configuration data currently stored in Flash cannot be overwritten by data on the
card.
z The RST button (see page 55) is disabled, and pushing it has no effect on island
bus operations.
The island runs normally when it is in protected mode. All users have the ability
to monitor (read) the activity on the island bus.
z

Password Characteristics
A password must meet the following criteria:
It must be between 0 and 6 characters in length.
z Only alphanumeric ASCII characters are permitted.
z The password is case-sensitive.
z

If password protection is enabled, your password is saved to Flash memory (or to a

removable memory card) when you save the configuration data.
NOTE: A protected configuration is inaccessible to anyone who does not know the
password. Your system administrator is responsible for keeping track of the
password and the list of authorized users. If the assigned password is lost or
forgotten, you will be unable to change the islands configuration.
If the password is lost and you need to reconfigure the island, you will need to
perform a destructive reflash of the NIM. This procedure is described on the
Advantys STB product Web site at www.schneiderautomation.com.

31003688 2/2009

187

Advanced Configuration Features

A Modbus View of the Islands Data Image

Summary
A block of Modbus registers is reserved in the NIM to hold and maintain the islands
data image. Overall, the data image holds 9999 registers. The registers are divided
into contiguous groups (or blocks), each dedicated to a specific purpose.
Modbus Registers and Their Bit Structure
Registers are16-bit constructs. The most significant bit (MSB) is bit 15, which is
displayed as the leftmost bit in the register. The least significant bit (LSB) is bit 0,
displayed as the rightmost bit in the register:

The bits can be used to display operating data or device/system status.

Each register has a unique reference number, starting at 40001. The content of each
register, represented by its 0/1 bit pattern, may be dynamic, but the register
reference and its assignment in the control logic program remain constant.

188

31003688 2/2009

Advanced Configuration Features

The Data Image

The 9999 contiguous registers in the Modbus data image start at register 40001.
This figure shows the subdivision of data into sequential blocks:

Block 1 output data process image (4096 registers available)

Block 2 fieldbus master-to-HMI output table (512 registers available)
Block 3 reserved (512 registers available)
Block 4 9-register block reserved for future read/write use
Block 5 5-register RTP Request Block
Block 6 114-register block reserved for future read/write use
Block 7 54-register block reserved for future read/write use
Block 8 4-register RTP Response Block
Block 9 50-register block reserved for future read-only use
Block 10 35 predefined island bus status registers
Block 11 input data/status process image (4096 registers available)
Block 12 HMI-to-fieldbus master input table (512 registers available)

Each block has a fixed number of registers reserved for its use. Whether or not all
the registers reserved for that block are used in an application, the number of
registers allocated to that block remains constant. This permits you to know at all
times where to begin looking for the type of data of interest to you.
31003688 2/2009

189

Advanced Configuration Features

For example, to monitor the status of the I/O modules in the process image, look at
the data in block 11 beginning at register 45392.
Reading Register Data
All the registers in the data image can be read by an HMI panel connected to the
island at the NIMs CFG port (see page 33). The Advantys configuration software
reads all this data, and displays blocks 1, 2, 5, 8, 10, 11, and 12 in the Modbus Image
screen in its I/O Image Overview.
Writing Register Data
Some registers, usually configured number of registers in block 12 (registers
49488 through 49999) of the data image, may be written to by an HMI panel
(see page 193).
The Advantys configuration software or an HMI panel may also be used to write data
to the registers in block 1 (registers 40001 through 44096). The configuration
software or the HMI panel must be the island bus master in order for it to write to the
data imagei.e., the island must be in test mode.

190

31003688 2/2009

Advanced Configuration Features

The Islands Process Image Blocks

Summary
Two blocks of registers in the islands data image (see page 189) are the focus for
this discussion. The first block is the output data process image, which starts at
register 40001 and goes to register 44096. The other block is the input data and I/O
status process image, which also consumes 4096 registers (45392 through 49487).
The registers in each block are used to report island bus device status and to
dynamically exchange input or output data between the fieldbus master and the
islands I/O modules.
Output Data Process Image
The output data block (registers 40001 through 44096) handles the output data
process image. This process image is a Modbus representation of the control data
that has just been written from the fieldbus master to the NIM. Only data for the
islands output modules is written to this block.
Output data is organized in 16-bit register format. One or more registers are
dedicated to the data for each output module on the island bus.
For example, say you are using a two-channel digital output module as the first
output module on your island bus. Output 1 is on and output 2 is off. This information
would be reported in the first register in the output data process image, and it would
look like this:

where:
z
z
z

Normally, a value of 1 in bit 0 indicates that output 1 is on.

Normally, a value of 0 in bit 1 indicates that output 2 is off.
The remaining bits in the register are not used.

Some output modules, such as the one in the example above, utilize a single data
register. Others may require multiple registers. An analog output module, for
example, would use separate registers to represent the values for each channel,
and might use the 11 or 12 most significant bits to display analog values in
IEC format.
Registers are allocated to output modules in the output data block according to their
addresses on the island bus. Register 40001 always contains the data for the first
output module on the islandthe output module closest to the NIM.
31003688 2/2009

191

Advanced Configuration Features

NOTE: The requirements of each output module in the Advantys STB family are
described in the Advantys STB Hardware Components Reference Guide
(890 USE 172).
A detailed view of how the registers are implemented in the output data block is
shown in the process image example.
Output Data Read/Write Capabilities
The registers in the output data process image are read/write-capable.
You can read (i.e., monitor) the process image using an HMI panel or the Advantys
configuration software. The data content that you see when you monitor the output
data image registers is updated in near-real time.
The islands fieldbus master also writes updated control data to the output data
process image.
Input Data and I/O Status Process Image
The input data and I/O status block (registers 45392 through 49487) handles the
input data and I/O status process image. Every I/O module on the island bus has
information that needs to be stored in this block.
z

Each digital input module reports data (the on/off status of its input channels) in
one register of input data and I/O status block, then reports its status (e.g., the
presence or absence of errors) in the next register.
Each analog input module uses four registers in the input data and I/O status
block. It represents the analog data for each channel in separate registers and
the status of each channel in separate registers. Analog data is usually
represented with 11- or 12-bit resolution in the IEC format; status in an analog
input channel is usually represented by a series of status bits that report the
presence or absence of an out-of-range value in a channel.
Each digital output module reports an echo of its output data to a register in the
input data and I/O status block. Echo output data registers are essentially copies
of the register values that appear in the output data process image. This data is
usually not of much interest, but it can be useful in the event that a digital output
channel has been configured for a reflex action. In this case, the fieldbus master
can see the bit value in the echo output data register even though the output
channel is being updated inside the island bus.
Each analog output module uses two registers in the input data and I/O status
block to report status. Status in an analog output channel is usually represented
by a series of status bits that report the presence or absence of an out-of-range
value in a channel. Analog output modules do not report data in this block.

A detailed view of how the registers in the input data and I/O status block are
implemented is shown in the process image example.

192

31003688 2/2009

Advanced Configuration Features

The HMI Blocks in the Island Data Image

Summary
An HMI panel that communicates using the Modbus protocol can be connected to
the CFG port (see page 33) on the NIM. Using the Advantys configuration software,
you can reserve one or two blocks of registers in the data image (see page 188) to
support HMI data exchange. When an HMI panel writes to one of these blocks, that
data is accessible to the fieldbus master (as inputs). Data written by the fieldbus
master (as outputs) is stored in a different reserved block of registers that the HMI
panel can read.
HMI Panel Configuration
Advantys STB supports the ability of an HMI panel to act as:
z an input device, which writes data to the islands data image that is read by the
fieldbus master
z an output device, which can read data written by the fieldbus master to the
islands data image
z a combined I/O device
HMI Input Data Exchange
Input data to the fieldbus master can be generated by the HMI panel. Input controls
on an HMI panel might be elements such as:
z
z
z

push buttons
switches
a data entry keypad

To use an HMI panel as an input device on the island, you need to enable the HMIto-fieldbus master block in the islands data image (see page 189) and specify the
number of registers in this block that you want to use for HMI-to-fieldbus master data
transfers. You must use the Advantys configuration software to make these
configuration adjustments.
The HMI-to-fieldbus master block can comprise up to 512 registers, ranging from
register 49488 to 49999. (Your actual register limit will be dictated by your fieldbus.)
This block follows immediately after the standard input data and I/O status process
image (see page 192) block (registers 45392 through 49487) in the islands data
image.
The HMI panel writes the input data to a specified number of registers in the HMIto-fieldbus master block. The NIM manages the transfer of the HMI data in these
registers as part of the overall input data transferit converts the 16-bit register data
to a fieldbus-specific data format and transfers it together with the standard input
data and I/O status process image to the fieldbus. The fieldbus master sees and
responds to HMI data as if it were standard input data.

31003688 2/2009

193

Advanced Configuration Features

HMI Output Data Exchange

In turn, output data written by the fieldbus master can be used to update enunciator
elements on the HMI panel. Enunciator elements might be:
z
z
z

display indicators
buttons or screen images that change color or shape
data display screens (for example, temperature read-outs)

To use the HMI panel as an output device, you need to enable the fieldbus-to-HMI
block in the islands data image (see page 189) and specify the number of registers
in this block that you want to use. You need to use the Advantys configuration
software to make these adjustments to your configuration.
The fieldbus master-to-HMI block can comprise up to 512 registers, ranging from
register 44097 to 44608. This block follows immediately after the standard output
data process image (see page 191) block (registers 40001 through 44096) in the
islands data image.
The fieldbus master writes output update data in native fieldbus format to the HMI
data block concurrent with writing this data to the output data process image area.
The output data is placed in the fieldbus master-to-HMI block. Upon request by the
HMI via a Modbus read command, the role of the NIM is to receive this output data,
convert it to16-bit Modbus format, and send it over the Modbus connection at the
CFG port to the HMI panel.
NOTE: The read command enables all Modbus registers to be read, not just those
in the block reserved for fieldbus master-to-HMI data exchange.

194

31003688 2/2009

Advanced Configuration Features

Test Mode
Summary
Test Mode indicates that the output data of the STB islands process image is not
controlled by a fieldbus master device, but is instead controlled by either the
Advantys STB configuration software or an HMI. When the STB island is operating
in Test Mode, the fieldbus master cannot write the STB islands outputs, but can
continue to read its inputs and diagnostic data.
Test Mode is configured off-line, downloaded with the island configuration, then
activated online.
Select Test Mode Settings in the Online menu to open the Test Mode configuration
window, where you can select a test mode setting. Test Mode settings are stored
with other STB island configuration settings both in the NIMs flash memory and in
a SIM card, if one is attached to the NIM.
When Test Mode is activated, the NIMs TEST LED is lit, and bit #15 of the NIM
Status word in register 45391 is set to 1.
NOTE: Loss of Modbus communications will not affect Test Mode.
There are three Test Mode settings:
z
z
z

Temporary Test Mode

Persistent Test Mode
Password Test Mode

The following sections describe the process and effect of activating Test Mode.
Temporary Test Mode
When operating online, use the Advantys STB configuration software - and not an
HMI - to activate Temporary Test Mode, by selecting Test Mode in the Online menu.
Once activated, Temporary Test Mode will be deactivated by:
z
z
z
z
z

de-selecting Test Mode in the Online menu

cycling power to the NIM
selecting Reset in the Online menu
performing Autoconfiguration
downloading a new island configuration to the NIM (or inserting a SIM card with
a new island configuration into the NIM and cycling power to the NIM).

Temporary Test Mode is the default Test Mode configuration setting.

31003688 2/2009

195

Advanced Configuration Features

Persistent Test Mode

Use the Advantys STB configuration software to configure the STB island for
Persistent Test Mode. When the download of this configuration is complete,
Persistent Test Mode is activated. Thereafter, the STB island will operate in Test
Mode each time power is cycled to the island. When Persistent Test Mode is
activated, the STB islands process image output data is controlled exclusively by
either the HMI or the configuration software. The fieldbus master will no longer
control these outputs.
Persistent Test Mode will be deactivated by:
z
z

downloading a new island configuration to the NIM (or inserting a SIM card with
a new island configuration into the NIM and cycling power to the NIM)
performing Autoconfiguration.

Password Test Mode

Use the Advantys STB configuration software to enter a password to the STB
islands configuration settings. The password you input must have an integer value
from 1 to 65535 (FFFF hex).
After the changed configuration - including the password - has been downloaded,
you can activate Password Test Mode only by using an HMI to issue a single
Modbus Register write command to send the password value to Modbus Register
45120.
After Password Test Mode is activated, the STB islands process image output data
will be controlled by either the HMI or the configuration software. The fieldbus
master will no longer control these outputs.
Once the Password Test Mode is activated, deactivate it by:
z
z
z
z
z

cycling power to the NIM

selecting Reset in the Online menu
performing Autoconfiguration
downloading a new island configuration to the NIM (or inserting a SIM card with
a new island configuration into the NIM and cycling power to the NIM.)
using an HMI to issue a single Modbus register write command to send the
password value to Modbus Register 45121 (STB NIC 2212 NIM only).

NOTE: Password Test Mode must be activated only by using the NIMs
configuration port. For security reasons, all attempts to enter Password Test Mode
using the fieldbus (via NIM models NIC2212, NIP2212, or NMP2212) fail.

196

31003688 2/2009

Advanced Configuration Features

Run-Time Parameters
Introduction
For STB modules, the Advantys Configuration Software provides the run-time
parameters feature (RTP). It can be used for monitoring and modifying selected I/O
parameters and Island bus status registers of the NIM while the Island is running.
This feature is available only in standard STB NIMs with firmware version 2.0 or
later.
RTP must be configured using the Advantys Configuration Software before it can be
used. RTP is not configured by default. Configure RTP by selecting Configure runtime Parameters in the Options tab of the NIM Module Editor. This will allocate
necessary registers within the NIMs data process image that support this feature.
Request and Response Blocks
Once configured, use the RTP feature by writing up to 5 reserved words in the NIMs
output data process image (the RTP request block) and by reading the value of 4
reserved words in the NIMs input data process image (the RTP response block).
The Advantys Configuration Software displays both blocks of reserved RTP words
in the Islands I/O Image Overview dialog box, both in the Modbus Image tab and
- for NIMs with a separate fieldbus image - in the Fieldbus Image tab. In each tab,
the blocks of reserved RTP words appear after the block of process I/O data and
before the block of HMI data (if any).
NOTE: The Modbus address values of the RTP request and response blocks are
the same in all standard NIMs. The fieldbus address values of the RTP request and
response blocks depend upon the network type. Use the Fieldbus Image tab of the
I/O Image Overview dialog box to obtain the location of the RTP registers. For
Modbus Plus and Ethernet networks, use the Modbus register numbers.
Exceptions
Any parameter you modify using the RTP feature will not retain its modified value if
1 of the following events occurs:
z Power is cycled to the NIM.
z A Reset command is issued to the NIM using the Advantys Configuration
Software.
z A Store to SIM Card command is issued using the Advantys Configuration
Software.
z The module whose parameter has been modified is hot-swapped.
If a module is hot-swapped, as indicated by the HOT_SWAP indicator bit, you can
use the RTP feature to detect which module has been hot-swapped and to
restore the parameters to their previous values.

31003688 2/2009

197

Advanced Configuration Features

Test Mode
When the NIM is operating in test mode, the NIMs output data process image including the RTP request block - can be controlled either by the Advantys
Configuration Software or by an HMI (depending upon the test mode configured).
Standard Modbus commands can be used to access the RTP words. If the NIM is
in test mode, the fieldbus master cannot write to the RTP request block in the NIMs
output data process image.
RTP Request Block Words Definitions
The following table lists RTP request block words:
Modbus
Address

Upper Byte

Lower Byte

Data Type

Attribute

45130

sub-index

toggle + length

unsigned 16

RW

45131

index (high data byte)

index (low data byte)

unsigned 16

RW

45132

data byte 2

data byte 1 (LSB)

unsigned 16

RW

45133

data byte 4 (MSB)

data byte 3

unsigned 16

RW

45134

toggle + CMD

Node ID

unsigned 16

RW

NOTE: The RTP request block is also presented in the manufacturer specific area of the
CANopen fieldbus as an object with a dedicated index of 0x4101 and sub-index 1 to 5
(data type = unsigned 16, attribute = RW).

The NIM performs range checking on the above bytes as follows:

index (high / low byte): 0x2000 to 0xFFFF for write; 0x1000 to 0xFFFF for read
z toggle + length: length = 1 to 4 bytes; the most significant bit contains the
toggle bit
z toggle + CMD: CMD = 1 to 0x0A (see the table Valid Commands, below); most
significant bit contains toggle bit
z Node ID: 1 to 32 and 127 (the NIM itself)
z

The toggle+CMD and toggle+length bytes are located at the ends of the
register range to let the NIM validate the consistency of the data wrapped within
these bytes (in case RTP request block words are not updated in a single scan). To
form a complete and valid RTP request, both toggle bits must be identical, and they
must differ from their previous valid value.
NOTE: Make sure that either toggle+CMD or toggle+length is the last byte you
write when sending a request. Your request will be executed when the toggle bits in
both of these bytes are set equal to each other (and different from their previous
valid value). If you have not yet set values for all other bytes in the RTP request
block, you may perform unintended operations.

198

31003688 2/2009

Advanced Configuration Features

RTP Response Block Words Definitions

The following list shows RTP response block words:
Modbus
Address

Upper Byte

Lower Byte

Data Type

Attribute

45303

status (the most

significant bit is used
to indicate whether
RTP service is
enabled: MSB=1
means enabled)

toggle + CMD echo unsigned 16

RO

45304

data byte 2

data byte 1 (LSB)

unsigned 16

RO

45305

data byte 4 (MSB)

data byte 3

unsigned 16

RO

45306

toggle + CMD echo unsigned 16

RO

NOTE: The RTP response block is also presented in the manufacturer specific area of the
CANopen fieldbus as an object with a dedicated index of 0x4100 and sub-index 1 to 4
(data type = unsigned 16, attribute = RO).

toggle+CMD echo bytes are located at the end of the register range to let you
validate the consistency of the data wrapped within these bytes (in case RTP
response block words are not updated in a single scan). The NIM updates the status
byte and the 4 data bytes (if applicable) before updating the toggle+CMD echo
bytes in Modbus register 45303 and 45306 to equal the value of the toggle+CMD
byte of the corresponding RTP request. You must first check that both toggle+CMD
bytes match the toggle+CMD byte in the RTP request block before making use of
the data inside the RTP response block.
Valid RTP Commands
The following list shows valid commands (CMDs):
Command (CMD) Code
(Except
the msb)

31003688 2/2009

Valid Node IDs

Allowed State
of the
Addressed
Node

Data Bytes

Enable RTP (Only

After RTP Has
Been Configured
Using the
Advantys
Configuration
Software)

0x08

127

N/A

Disable RTP

0x09

127

N/A

199

Advanced Configuration Features

Command (CMD) Code

(Except
the msb)

Valid Node IDs

Allowed State
of the
Addressed
Node

Data Bytes

Reset Hot-Swap
Bit

0x0A

1-32

N/A

Read Parameter

0x01

1-32, 127

pre-operational
operational

data bytes in
response,
length to be
given

Write Parameter

0x02

1-32

operational

data bytes in
request, length
to be given

The most significant bit of an RTP request blocks toggle+CMD byte is the toggle
bit. A new command is identified when the value of this bit changes and matches the
value of the toggle bit in the toggle+length byte.
A new RTP request is processed only if the preceding RTP request has finished.
Overlapping RTP requests are not allowed. A new RTP request made before the
completion of a preceding request will be ignored.
To determine when an RTP command has been processed and its response is
complete, check the values of the toggle+CMD echo bytes in the RTP response
block. Continue to check both toggle+CMD bytes in the RTP response block until
they match the RTP request blocks toggle+CMD byte. Once they match, the
contents of the RTP response block is valid.
Valid RTP Status Messages
The following list shows valid status messages:

200

Status Byte

Code

Comment

Success

0x00 or 0x80

0x00 for successful completion of

a Disable RTP command

Command not Processed due to

Disabled RTP

0x01

Illegal CMD

0x82

Illegal Data Length

0x83

Illegal Node ID

0x84

Illegal Node State

0x85

RTP request error - access to a

node that is absent or not started

Illegal Index

0x86

31003688 2/2009

Advanced Configuration Features

Status Byte

Code

Comment

RTP Response Has More Than 4

Bytes

0x87

No Communication Possible on the

Island Bus

0x88

Illegal Write to Node 127

0x89

SDO Aborted

0x90

If an SDO protocol error occurs,

the data bytes in response will
contain the SDO abort code
according to DS301.

General Failure

0xFF

error not covered by other

implemented status messages

The most significant bit of the status byte in the RTP response block indicates
whether RTP is enabled (1) or disabled (0).

31003688 2/2009

201

Advanced Configuration Features

Virtual Placeholder
Summary
The virtual placeholder feature lets you create a standard island configuration and
depopulated variations of that configuration that share the same fieldbus process
image, thereby letting you maintain a consistent PLC or fieldbus master program for
various island configurations. The depopulated islands are physically built using
only those modules that are not marked as not present, thus saving cost and space.
As part of an Advantys STB island custom configuration, you can set Virtual
Placeholder status for any STB I/O or preferred third-party module whose node
address is assigned by the NIM during auto-addressing.
After a module has been assigned Virtual Placeholder status, you can physically
remove it from its Advantys STB island base, while retaining the islands process
image. All modules that physically remain in the Advantys STB island configuration
will retain their previous node addresses. This lets you physically alter the design of
your island, without having to edit your PLC program.
NOTE: Advantys configuration software is required to set Virtual Placeholder status.
Setting Virtual Placeholder Status
To set Virtual Placeholder status:

202

Step

Action

Open the STB I/O or preferred third-party modules property window.

In the Options tab, select Not Present.

Click OK to save your settings. The Advantys STB configuration software

marks the virtual placeholder module with a red "X" (as shown below).

31003688 2/2009

Advanced Configuration Features

For example, the following island configuration contains a NIM, a PDM, 2 digital
Input modules, 2 digital output modules, a digital relay output module, an analog
input module, and an analog output module:

After you assign Virtual Placeholder status to the DRC 3210 digital relay output
module (by selecting Not Present in its Options tab), the Advantys STB
configuration software marks the virtual placeholder module with a red "X" as shown
below:

For example, when you physically construct the above configuration, you would
build the island without the DRC-3210 and its base.
NOTE: Any reflex output, that is configured to use a virtual placeholder module as
an input, will constantly be in fallback.

31003688 2/2009

203

Advanced Configuration Features

204

31003688 2/2009

Glossary
31003688 2/2009

Glossary

0-9
100Base-T
An adaptation of the IEEE 802.3u (Ethernet) standard, the 100Base-T standard
uses twisted-pair wiring with a maximum segment length of 100 m (328 ft) and
terminates with an RJ-45 connector. A 100Base-T network is a baseband network
capable of transmitting data at a maximum speed of 100 Mbit/s. "Fast Ethernet" is
another name for 100Base-T, because it is ten times faster than 10Base-T.

10Base-T
An adaptation of the IEEE 802.3 (Ethernet) standard, the 10Base-T standard uses
twisted-pair wiring with a maximum segment length of 100 m (328 ft) and terminates
with an RJ-45 connector. A 10Base-T network is a baseband network capable of
transmitting data at a maximum speed of 10 Mbit/s.

802.3 frame
A frame format, specified in the IEEE 802.3 (Ethernet) standard, in which the header
specifies the data packet length.

A
agent
1. SNMP the SNMP application that runs on a network device.
2. Fipio a slave device on a network.

31003688 2/2009

205

Glossary

analog input
A module that contains circuits that convert analog DC input signals to digital values
that can be manipulated by the processor. By implication, these analog inputs are
usually direct. That means a data table value directly reflects the analog signal
value.

analog output
A module that contains circuits that transmit an analog DC signal proportional to a
digital value input to the module from the processor. By implication, these analog
outputs are usually direct. That means a data table value directly controls the analog
signal value.

application object
In CAN-based networks, application objects represent device-specific functionality,
such as the state of input or output data.

ARP
The ARP (address resolution protocol) is the IP network layer protocol, which uses
ARP to map an IP address to a MAC (hardware) address.

auto baud
The automatic assignment and detection of a common baud rate as well as the
ability of a device on a network to adapt to that rate.

auto-addressing
The assignment of an address to each Island bus I/O module and preferred device.

auto-configuration
The ability of Island modules to operate with predefined default parameters. A
configuration of the Island bus based completely on the actual assembly of I/O
modules.

B
basic I/O
Low-cost Advantys STB input/output modules that use a fixed set of operating
parameters. A basic I/O module cannot be reconfigured with the Advantys
Configuration Software and cannot be used in reflex actions.
206

31003688 2/2009

Glossary

basic network interface

A low-cost Advantys STB network interface module that supports up to 12 Advantys
STB I/O modules. A basic NIM does not support the Advantys Configuration
Software, reflex actions, nor the use of an HMI panel.

basic power distribution module

A low-cost Advantys STB PDM that distributes sensor power and actuator power
over a single field power bus on the Island. The bus provides a maximum of 4 A total
power. A basic PDM requires a 5 A fuse to protect the I/O.

BootP
BootP (bootstrap protocol) is an UDP/IP protocol that allows an internet node to
obtain its IP parameters based on its MAC address.

BOS
BOS stands for beginning of segment. When more than 1 segment of I/O modules
is used in an Island, an STB XBE 1200 or an STB XBE 1300 BOS module is
installed in the first position in each extension segment. Its job is to carry Island bus
communications to and generate logic power for the modules in the extension
segment. Which BOS module must be selected depends on the module types that
shall follow.

bus arbitrator
A master on a Fipio network.

C
CAN
The CAN (controller area network) protocol (ISO 11898) for serial bus networks is
designed for the interconnection of smart devices (from multiple manufacturers) in
smart systems for real-time industrial applications. CAN multi-master systems
ensure high data integrity through the implementation of broadcast messaging and
advanced error mechanisms. Originally developed for use in automobiles, CAN is
now used in a variety of industrial automation control environments.

CANopen protocol
An open industry standard protocol used on the internal communication bus. The
protocol allows the connection of any enhanced CANopen device to the Island bus.

31003688 2/2009

207

Glossary

CI
This abbreviation stands for command interface.

CiA
CiA (CAN in Automation) is a non-profit group of manufacturers and users dedicated
to developing and supporting CAN-based higher layer protocols.

CIP
Common Industrial Protocol. Networks that include CIP in the application layer can
communicate seamlessly with other CIP-based networks. For example, the
implementation of CIP in the application layer of an Ethernet TCP/IP network
creates an EtherNet/IP environment. Similarly, CIP in the application layer of a CAN
network creates a DeviceNet environment. Devices on an EtherNet/IP network can
therefore communicate with devices on a DeviceNet network via CIP bridges or
routers.

COB
A COB (communication object) is a unit of transportation (a message) in a CANbased network. Communication objects indicate a particular functionality in a
device. They are specified in the CANopen communication profile.

configuration
The arrangement and interconnection of hardware components within a system and
the hardware and software selections that determine the operating characteristics of
the system.

CRC
cyclic redundancy check. Messages that implement this error checking mechanism
have a CRC field that is calculated by the transmitter according to the messages
content. Receiving nodes recalculate the field. Disagreement in the two codes
indicates a difference between the transmitted message and the one received.

D
DDXML
Device Description eXtensible Markup Language

208

31003688 2/2009

Glossary

device name
A customer-driven, unique logical personal identifier for an Ethernet NIM. A device
name (or role name) is created when you:
z combine the numeric rotary switch setting with the NIM (for example,
STBNIP2212_010), or . . .
z edit the Device Name setting in the NIM's embedded web server pages
After the NIM is configured with a valid device name, the DHCP server uses it to
identify the island at power up.

DeviceNet protocol
DeviceNet is a low-level, connection-based network that is based on CAN, a serial
bus system without a defined application layer. DeviceNet, therefore, defines a layer
for the industrial application of CAN.

DHCP
dynamic host configuration protocol. A TCP/IP protocol that allows a server to
assign an IP address based on a device name (host name) to a network node.

differential input
A type of input design where two wires (+ and -) are run from each signal source to
the data acquisition interface. The voltage between the input and the interface
ground are measured by two high-impedance amplifiers, and the outputs from the
two amplifiers are subtracted by a third amplifier to yield the difference between the
+ and - inputs. Voltage common to both wires is thereby removed. Differential design
solves the problem of ground differences found in single-ended connections, and it
also reduces the cross-channel noise problem.

digital I/O
An input or output that has an individual circuit connection at the module
corresponding directly to a data table bit or word that stores the value of the signal
at that I/O circuit. It allows the control logic to have discrete access to the I/O values.

DIN
Deutsche industrial norms. A German agency that sets engineering and
dimensional standards and now has worldwide recognition.

Drivecom Profile
The Drivecom profile is part of CiA DSP 402 (profile), which defines the behavior of
drives and motion control devices on CANopen networks.

31003688 2/2009

209

Glossary

E
economy segment
A special type of STB I/O segment created when an STB NCO 1113 economy
CANopen NIM is used in the first location. In this implementation, the NIM acts as a
simple gateway between the I/O modules in the segment and a CANopen master.
Each I/O module in an economy segment acts as a independent node on the
CANopen network. An economy segment cannot be extended to other STB I/O
segments, preferred modules or enhanced CANopen devices.

EDS
electronic data sheet. The EDS is a standardized ASCII file that contains information
about a network devices communications functionality and the contents of its object
dictionary. The EDS also defines device-specific and manufacturer-specific objects.

EIA
Electronic Industries Association. An organization that establishes
electrical/electronic and data communication standards.

EMC
electromagnetic compatibility. Devices that meet EMC requirements can operate
within a systems expected electromagnetic limits without error.

EMI
electromagnetic interference. EMI can cause an interruption, malfunction, or
disturbance in the performance of electronic equipment. It occurs when a source
electronically transmits a signal that interferes with other equipment.

EOS
This abbreviation stands for end of segment. When more than 1 segment of I/O
modules is used in an Island, an STB XBE 1000 or an STB XBE 1100 EOS module
is installed in the last position in every segment that has an extension following it.
The EOS module extends Island bus communications to the next segment. Which
EOS module must be selected depends on the module types that shall follow.

Ethernet
A LAN cabling and signaling specification used to connect devices within a defined
area, e.g., a building. Ethernet uses a bus or a star topology to connect different
nodes on a network.
210

31003688 2/2009

Glossary

Ethernet II
A frame format in which the header specifies the packet type, Ethernet II is the
default frame format for NIM communications.

EtherNet/IP
EtherNet/IP (the Ethernet Industrial Protocol) is especially suited to factory
applications in which there is a need to control, configure, and monitor events within
an industrial system. The ODVA-specified protocol runs CIP (the Common Industrial
Protocol) on top of standard Internet protocols, like TCP/IP and UDP. It is an open
local (communications) network that enables the interconnectivity of all levels of
manufacturing operations from the plants office to the sensors and actuators on its
floor.

F
fallback state
A known state to which an Advantys STB I/O module can return in the event that its
communication connection fails.

fallback value
The value that a device assumes during fallback. Typically, the fallback value is
either configurable or the last stored value for the device.

FED_P
Fipio extended device profile. On a Fipio network, the standard device profile type
for agents whose data length is more than 8 words and equal to or less than 32
words.

Fipio
Fieldbus Interface Protocol (FIP). An open fieldbus standard and protocol that
conforms to the FIP/World FIP standard. Fipio is designed to provide low-level
configuration, parameterization, data exchange, and diagnostic services.

Flash memory
Flash memory is nonvolatile memory that can be overwritten. It is stored on a special
EEPROM that can be erased and reprogrammed.

31003688 2/2009

211

Glossary

FRD_P
Fipio reduced device profile. On a Fipio network, the standard device profile type for
agents whose data length is two words or less.

FSD_P
Fipio standard device profile. On a Fipio network, the standard device profile type
for agents whose data length is more than two words and equal to or less than 8
words.

full scale
The maximum level in a specific rangee.g., in an analog input circuit the maximum
allowable voltage or current level is at full scale when any increase beyond that level
is over-range.

function block
A function block performs a specific automation function, such as speed control. A
function block comprises configuration data and a set of operating parameters.

function code
A function code is an instruction set commanding 1 or more slave devices at a
specified address(es) to perform a type of action, e.g., read a set of data registers
and respond with the content.

G
gateway
A program or hardware that passes data between networks.

global_ID
global_identifier. A 16-bit integer that uniquely identifies a devices location on a
network. A global_ID is a symbolic address that is universally recognized by all other
devices on the network.

GSD
generic slave data (file). A device description file, supplied by the devices
manufacturer, that defines a devices functionality on a Profibus DP network.

212

31003688 2/2009

Glossary

H
HMI
human-machine interface. An operator interface, usually graphical, for industrial
equipment.

hot swapping
Replacing a component with a like component while the system remains
operational. When the replacement component is installed, it begins to function
automatically.

HTTP
hypertext transfer protocol. The protocol that a web server and a client browser use
to communicate with one another.

I
I/O base
A mounting device, designed to seat an Advantys STB I/O module, hang it on a DIN
rail, and connect it to the Island bus. It provides the connection point where the
module can receive either 24 VDC or 115/230 VAC from the input or output power
bus distributed by a PDM.

I/O module
In a programmable controller system, an I/O module interfaces directly to the
sensors and actuators of the machine/process. This module is the component that
mounts in an I/O base and provides electrical connections between the controller
and the field devices. Normal I/O module capacities are offered in a variety of signal
levels and capacities.

I/O scanning
The continuous polling of the Advantys STB I/O modules performed by the COMS
to collect data bits, status, error, and diagnostics information.

31003688 2/2009

213

Glossary

IEC
International Electrotechnical Commission Carrier. Founded in 1884 to focus on
advancing the theory and practice of electrical, electronics, and computer
engineering, and computer science. EN 61131-2 is the specification that deals with
industrial automation equipment.

IEC type 1 input

Type 1 digital inputs support sensor signals from mechanical switching devices such
as relay contacts and push buttons operating in normal environmental conditions.

IEC type 2 input

Type 2 digital inputs support sensor signals from solid state devices or mechanical
contact switching devices such as relay contacts, push buttons (in normal or harsh
environmental conditions), and 2- or 3-wire proximity switches.

IEC type 3 input

Type 3 digital inputs support sensor signals from mechanical switching devices such
as relay contacts, push buttons (in normal-to-moderate environmental conditions),
3-wire proximity switches and 2-wire proximity switches that have:
z a voltage drop of no more than 8 V
z a minimum operating current capability less than or equal to 2.5 mA
z a maximum off-state current less than or equal to 1.5 mA

IEEE
Institute of Electrical and Electronics Engineers, Inc. The international standards
and conformity assessment body for all fields of electrotechnology, including
electricity and electronics.

industrial I/O
An Advantys STB I/O module designed at a moderate cost for typical continuous,
high-duty-cycle applications. Modules of this type often feature standard IEC
threshold ratings, usually providing user-configurable parameter options, on-board
protection, good resolution, and field wiring options. They are designed to operate
in moderate-to-high temperature ranges.

input filtering
The amount of time that a sensor must hold its signal on or off before the input
module detects the change of state.

214

31003688 2/2009

Glossary

input polarity
An input channels polarity determines when the input module sends a 1 and when
it sends a 0 to the master controller. If the polarity is normal, an input channel will
send a 1 to the controller when its field sensor turns on. If the polarity is reverse, an
input channel will send a 0 to the controller when its field sensor turns on.

input response time

The time it takes for an input channel to receive a signal from the field sensor and
put it on the Island bus.

INTERBUS protocol
The INTERBUS fieldbus protocol observes a master/slave network model with an
active ring topology, having all devices integrated in a closed transmission path.

IOC object
Island operation control object. A special object that appears in the CANopen object
dictionary when the remote virtual placeholder option is enabled in a CANopen NIM.
It is a 16-bit word that provides the fieldbus master with a mechanism for issuing
reconfiguration and start requests.

IOS object
Island operation status object. A special object that appears in the CANopen object
dictionary when the remote virtual placeholder option is enabled in a CANopen NIM.
It is a 16-bit word that reports the success of reconfiguration and start requests or
records errors in the event that a request fails.

IP
internet protocol. That part of the TCP/IP protocol family that tracks the internet
addresses of nodes, routes outgoing messages, and recognizes incoming
messages.

IP Rating
Ingress Protection rating according to IEC 60529.
IP20 modules are protected against ingress and contact of objects larger than
12.5 mm. The module is not protected against harmful ingress of water.
IP67 modules are completely protected against ingress of dust and contact. Ingress
of water in harmful quantity is not possible when the enclosure is immersed in water
up to 1 m.

31003688 2/2009

215

Glossary

L
LAN
local area network. A short-distance data communications network.

light industrial I/O

An Advantys STB I/O module designed at a low cost for less rigorous (e.g.,
intermittent, low-duty-cycle) operating environments. Modules of this type operate in
lower temperature ranges with lower qualification and agency requirements and
limited on-board protection; they usually have limited or no user-configuration
options.

linearity
A measure of how closely a characteristic follows a straight-line function.

LSB
least significant bit, least significant byte. The part of a number, address, or field that
is written as the rightmost single value in conventional hexadecimal or binary
notation.

M
MAC address
media access control address. A 48-bit number, unique on a network, that is
programmed into each network card or device when it is manufactured.

mandatory module
When an Advantys STB I/O module is configured to be mandatory, it must be
present and healthy in the Island configuration for the Island to be operational. If a
mandatory module fails or is removed from its location on the Island bus, the Island
will go into a pre-operational state. By default, all I/O modules are not mandatory.
You must use the Advantys Configuration Software to set this parameter.

master/slave model
The direction of control in a network that implements the master/slave model is
always from the master to the slave devices.

216

31003688 2/2009

Glossary

Modbus
Modbus is an application layer messaging protocol. Modbus provides client and
server communications between devices connected on different types of buses or
networks. Modbus offers many services specified by function codes.

MOV
metal oxide varistor. A 2-electrode semiconductor device with a voltage-dependant
nonlinear resistance that drops markedly as the applied voltage is increased. It is
used to suppress transient voltage surges.

MSB
most significant bit, most significant byte. The part of a number, address, or field that
is written as the leftmost single value in conventional hexadecimal or binary notation.

N
N.C. contact
normally closed contact. A relay contact pair that is closed when the relay coil is deenergized and open when the coil is energized.

N.O. contact
normally open contact. A relay contact pair that is open when the relay coil is deenergized and closed when the coil is energized.

NEMA
National Electrical Manufacturers Association

network cycle time

The time that a master requires to complete a single scan of all of the configured I/O
modules on a network device; typically expressed in microseconds.

NIM
network interface module. This module is the interface between an Island bus and
the fieldbus network of which the Island is a part. A NIM enables all the I/O on the
Island to be treated as a single node on the fieldbus. The NIM also provides 5 V of
logic power to the Advantys STB I/O modules in the same segment as the NIM.

31003688 2/2009

217

Glossary

NMT
network management. NMT protocols provide services for network initialization,
error control, and device status control.

O
object dictionary
Part of the CANopen device model that provides a map to the internal structure of
CANopen devices (according to CANopen profile DS-401). A devices object
dictionary (also called the object directory) is a lookup table that describes the data
types, communications objects, and application objects the device uses. By
accessing a particular devices object dictionary through the CANopen fieldbus, you
can predict its network behavior and build a distributed application.

ODVA
Open Devicenet Vendors Association. The ODVA supports the family of network
technologies that are built on the Common Industrial Protocol (EtherNet/IP,
DeviceNet, and CompoNet).

open industrial communication network

A distributed communication network for industrial environments based on open
standards (EN 50235, EN50254, and EN50170, and others) that allows the
exchange of data between devices from different manufacturers.

output filtering
The amount that it takes an output channel to send change-of-state information to
an actuator after the output module has received updated data from the NIM.

output polarity
An output channels polarity determines when the output module turns its field
actuator on and when it turns the actuator off. If the polarity is normal, an output
channel will turn its actuator on when the master controller sends it a 1. If the polarity
is reverse, an output channel will turn its actuator on when the master controller
sends it a 0.

output response time

The time it takes for an output module to take an output signal from the Island bus
and send it to its field actuator.

218

31003688 2/2009

Glossary

P
parameterize
To supply the required value for an attribute of a device at run-time.

PDM
power distribution module. A module that distributes either AC or DC field power to
a cluster of I/O modules directly to its right on the Island bus. A PDM delivers field
power to the input modules and the output modules. It is important that all the I/O
clustered directly to the right of a PDM be in the same voltage groupeither
24 VDC, 115 VAC, or 230 VAC.

PDO
process data object. In CAN-based networks, PDOs are transmitted as unconfirmed
broadcast messages or sent from a producer device to a consumer device. The
transmit PDO from the producer device has a specific identifier that corresponds to
the receive PDO of the consumer devices.

PE
protective earth. A return line across the bus for fault currents generated at a sensor
or actuator device in the control system.

peer-to-peer communications
In peer-to-peer communications, there is no master/slave or client/server
relationship. Messages are exchanged between entities of comparable or
equivalent levels of functionality, without having to go through a third party (like a
master device).

PLC
programmable logic controller. The PLC is the brain of an industrial manufacturing
process. It automates a process as opposed to relay control systems. PLCs are
computers suited to survive the harsh conditions of the industrial environment.

PowerSuite Software
PowerSuite Software is a tool for configuring and monitoring control devices for
electric motors, including ATV31, ATV71, and TeSys U.

31003688 2/2009

219

Glossary

preferred module
An I/O module that functions as an auto-addressable device on an Advantys STB
Island but is not in the same form factor as a standard Advantys STB I/O module
and therefore does not fit in an I/O base. A preferred device connects to the Island
bus via an EOS module and a length of a preferred module extension cable. It can
be extended to another preferred module or back into a BOS module. If it is the last
device on the Island, it must be terminated with a 120 terminator.
premium network interface
A premium NIM has advanced features over a standard or basic NIM.

prioritization
An optional feature on a standard NIM that allows you to selectively identify digital
input modules to be scanned more frequently during a the NIMs logic scan.

process I/O
An Advantys STB I/O module designed for operation at extended temperature
ranges in conformance with IEC type 2 thresholds. Modules of this type often feature
high levels of on-board diagnostics, high resolution, user-configurable parameter
options, and higher levels of agency approval.

process image
A part of the NIM firmware that serves as a real-time data area for the data exchange
process. The process image includes an input buffer that contains current data and
status information from the Island bus and an output buffer that contains the current
outputs for the Island bus, from the fieldbus master.

producer/consumer model
In networks that observe the producer/consumer model, data packets are identified
according to their data content rather than by their node address. All nodes listen on
the network and consume those data packets that have appropriate identifiers.

Profibus DP
Profibus Decentralized Peripheral. An open bus system that uses an electrical
network based on a shielded 2-wire line or an optical network based on a fiber-optic
cable. DP transmission allows for high-speed, cyclic exchange of data between the
controller CPU and the distributed I/O devices.

220

31003688 2/2009

Glossary

R
reflex action
A simple, logical command function configured locally on an Island bus I/O module.
Reflex actions are executed by Island bus modules on data from various Island
locations, like input and output modules or the NIM. Examples of reflex actions
include compare and copy operations.

repeater
An interconnection device that extends the permissible length of a bus.

reverse polarity protection

Use of a diode in a circuit to protect against damage and unintended operation in the
event that the polarity of the applied power is accidentally reversed.

rms
root mean square. The effective value of an alternating current, corresponding to the
DC value that produces the same heating effect. The rms value is computed as the
square root of the average of the squares of the instantaneous amplitude for 1
complete cycle. For a sine wave, the rms value is 0.707 times the peak value.

role name
A customer-driven, unique logical personal identifier for an Ethernet NIM. A role
name (or device name) is created when you:
z
z

combine the numeric rotary switch setting with the NIM (for example,
STBNIP2212_010), or . . .
edit the Device Name setting in the NIM's embedded web server pages

After the NIM is configured with a valid role name, the DHCP server uses it to identify
the island at power up.

RTD
resistive temperature detect. An RTD device is a temperature transducer composed
of conductive wire elements typically made of platinum, nickel, copper, or nickeliron. An RTD device provides a variable resistance across a specified temperature
range.

31003688 2/2009

221

Glossary

RTP
run-time parameters. RTP lets you monitor and modify selected I/O parameters and
Island bus status registers of the NIM while the Advantys STB Island is running. The
RTP feature uses 5 reserved output words in the NIMs process image (the RTP
request block) to send requests, and 4 reserved input words in the NIMs process
image (the RTP response block) to receive responses. Available only in standard
NIMs running firmware version 2.0 or higher.

Rx
reception. For example, in a CAN-based network, a PDO is described as an RxPDO
of the device that receives it.

S
SAP
service access point. The point at which the services of 1 communications layer, as
defined by the ISO OSI reference model, is made available to the next layer.

SCADA
supervisory control and data acquisition. Typically accomplished in industrial
settings by means of microcomputers.

SDO
service data object. In CAN-based networks, SDO messages are used by the
fieldbus master to access (read/write) the object directories of network nodes.

segment
A group of interconnected I/O and power modules on an Island bus. An Island must
have at least 1 segment and, depending on the type of NIM used, may have as many
as 7 segments. The first (leftmost) module in a segment needs to provide logic
power and Island bus communications to the I/O modules on its right. In the primary
or basic segment, that function is filled by a NIM. In an extension segment, that
function is filled by an STB XBE 1200 or an STB XBE 1300 BOS module.

SELV
safety extra low voltage. A secondary circuit designed and protected so that the
voltage between any 2 accessible parts (or between 1 accessible part and the PE
terminal for Class 1 equipment) does not exceed a specified value under normal
conditions or under single-fault conditions.
222

31003688 2/2009

Glossary

SIM
subscriber identification module. Originally intended for authenticating users of
mobile communications, SIMs now have multiple applications. In Advantys STB,
configuration data created or modified with the Advantys Configuration Software can
be stored on a SIM and then written to the NIMs Flash memory.

single-ended inputs
An analog input design technique whereby a wire from each signal source is
connected to the data acquisition interface, and the difference between the signal
and ground is measured. For the success of this design technique, 2 conditions are
imperative: the signal source must be grounded, and the signal ground and data
acquisition interface ground (the PDM lead) must have the same potential.

sink load
An output that, when turned on, receives DC current from its load.

size 1 base
A mounting device, designed to seat an STB module, hang it on a DIN rail, and
connect it to the Island bus. It is 13.9 mm (0.55 in.) wide and 128.25 mm (5.05 in.)
high.

size 2 base
A mounting device, designed to seat an STB module, hang it on a DIN rail, and
connect it to the Island bus. It is 18.4 mm (0.73 in.) wide and 128.25 mm (5.05 in.)
high.

size 3 base
A mounting device, designed to seat an STB module, hang it on a DIN rail, and
connect it to the Island bus. It is 28.1 mm (1.11 in.) wide and 128.25 mm (5.05 in.)
high.

slice I/O
An I/O module design that combines a small number of channels (usually between
2 and 6) in a small package. The idea is to allow a system developer to purchase
just the right amount of I/O and to be able to distribute it around the machine in an
efficient, mechatronics way.

31003688 2/2009

223

Glossary

SM_MPS
state management_message periodic services. The applications and network
management services used for process control, data exchange, error reporting, and
device status notification on a Fipio network.

SNMP
simple network management protocol. The UDP/IP standard protocol used to
manage nodes on an IP network.

snubber
A circuit generally used to suppress inductive loadsit consists of a resistor in
series with a capacitor (in the case of an RC snubber) and/or a metal-oxide varistor
placed across the AC load.

source load
A load with a current directed into its input; must be driven by a current source.

standard I/O
Any of a subset of Advantys STB input/output modules designed at a moderate cost
to operate with user-configurable parameters. A standard I/O module may be
reconfigured with the Advantys Configuration Software and, in most cases, may be
used in reflex actions.

standard network interface

An Advantys STB network interface module designed at moderate cost to support
the configuration capabilities, multi-segment design and throughput capacity
suitable for most standard applications on the Island bus. An Island run by a
standard NIM can support up to 32 addressable Advantys STB and/or preferred I/O
modules, up to 12 of which may be standard CANopen devices.

standard power distribution module

An Advantys STB module that distributes sensor power to the input modules and
actuator power to the output modules over two separate power buses on the Island.
The bus provides a maximum of 4 A to the input modules and 8 A to the output
modules. A standard PDM requires a 5 A fuse to protect the input modules and an
8 A fuse to protect the outputs.

224

31003688 2/2009

Glossary

STD_P
standard profile. On a Fipio network, a standard profile is a fixed set of configuration
and operating parameters for an agent device, based on the number of modules that
the device contains and the devices total data length. There are 3 types of standard
profiles: Fipio reduced device profile (FRD_P), Fipio standard device profile
(FSD_P), and the Fipio extended device profile (FED_P).

stepper motor
A specialized DC motor that allows discrete positioning without feedback.

subnet
A part of a network that shares a network address with the other parts of a network.
A subnet may be physically and/or logically independent of the rest of the network.
A part of an internet address called a subnet number, which is ignored in IP routing,
distinguishes the subnet.

surge suppression
The process of absorbing and clipping voltage transients on an incoming AC line or
control circuit. Metal-oxide varistors and specially designed RC networks are
frequently used as surge suppression mechanisms.

T
TC
thermocouple. A TC device is a bimetallic temperature transducer that provides a
temperature value by measuring the voltage differential caused by joining together
two different metals at different temperatures.

TCP
transmission control protocol. A connection-oriented transport layer protocol that
provides reliable full-duplex data transmission. TCP is part of the TCP/IP suite of
protocols.

telegram
A data packet used in serial communication.

31003688 2/2009

225

Glossary

TFE
transparent factory Ethernet. Schneider Electrics open automation framework
based on TCP/IP.

Tx
transmission. For example, in a CAN-based network, a PDO is described as a
TxPDO of the device that transmits it.

U
UDP
user datagram protocol. A connectionless mode protocol in which messages are
delivered in a datagram to a destination computer. The UDP protocol is typically
bundled with the Internet Protocol (UPD/IP).

V
varistor
A 2-electrode semiconductor device with a voltage-dependant nonlinear resistance
that drops markedly as the applied voltage is increased. It is used to suppress
transient voltage surges.

voltage group
A grouping of Advantys STB I/O modules, all with the same voltage requirement,
installed directly to the right of the appropriate power distribution module (PDM) and
separated from modules with different voltage requirements. Never mix modules
with different voltage requirements in the same voltage group.

VPCR object
virtual placeholder configuration read object. A special object that appears in the
CANopen object dictionary when the remote virtual placeholder option is enabled in
a CANopen NIM. It provides a 32-bit subindex that represents the actual module
configuration used in a physical Island.

226

31003688 2/2009

Glossary

VPCW object
virtual placeholder configuration write object. A special object that appears in the
CANopen object dictionary when the remote virtual placeholder option is enabled in
a CANopen NIM. It provides a 32-bit subindex where the fieldbus master can write
a module reconfiguration. After the fieldbus writes to the VPCW subindex, it can
issue a reconfiguration request to the NIM that begins the remote virtual placeholder
operation.

W
watchdog timer
A timer that monitors a cyclical process and is cleared at the conclusion of each
cycle. If the watchdog runs past its programmed time period, it generates a fault.

31003688 2/2009

227

Glossary

228

31003688 2/2009

Index
31003688 2/2009

B
AC

Index

0-9
10Base-T, 26
802.3 standard, 22, 27, 42

A
ABL8 Phaseo power supply, 41
action module, 182
addressable module, 17, 46, 47, 74, 165
Advantys configuration software, 21, 33, 72,
89, 115, 131, 170, 171, 174, 177, 179, 181,
182, 186, 187, 190, 190, 192
auto-addressing, 17, 46, 57
auto-configuration
and reset, 49, 56, 57
defined, 49
initial configuration, 49

B
baud
CFG port, 33, 56
fieldbus interface, 56
BootP, 92
BootP server, 28, 60, 61, 63

C
Category 5 (CAT5) cabling, 27, 27, 42

31003688 2/2009

CFG port
devices connecting to, 14, 33, 34
master configurator, 115
parameters, 33, 57
physical description, 33
client
in a faulty device replacement operation,
95
community names, 150
configurable parameters, 174, 174
configuration data
restoring default settings, 33, 53, 57
saving, 53, 57
Configuration menu, 105
configuration password, 102, 130, 132, 132
connection management
for Modbus clients, 22
custom configuration, 49, 50, 53, 56, 177,
186, 187
customer support, 125

D
data exchange, 14, 31, 46, 72, 73, 135, 170,
193, 194
data image, 73, 189, 191, 193
data size, 175
default IP address, 60, 61, 63, 107, 108
DHCP, 92
DHCP server, 28, 60, 61, 63

229

Index

diagnostics block
in the process image, 81
island communications, 81
Diagnostics menu, 134

E
edit mode, 50, 53, 53, 54, 56
embedded web server
access, 103
help, 102
managing, 156
navigation, 103
overview, 20
process image, 72
product support, 125
security, 102, 127
troubleshooting, 81
Ethernet
host, 20, 21, 72, 162
port, 21, 26, 30, 72, 107, 115
specification, 27
statistics, 90, 135
Ethernet
specification, 22
Ethernet LAN, 20, 22, 26, 28, 30, 72, 90,
106, 115
extension cable, 17, 38
extension module, 15, 16, 37, 38, 39, 40, 46
extension segment, 15, 16, 37, 38, 39, 40

F
factory default settings, 33, 49, 53, 57
fallback state, 177, 184
fallback value, 177, 185
faulty device replacement
client, 95
configuration, 119
configuring, 98
diagnostics, 100
preconditions, 96
server, 95

230

fieldbus master
and the output data image, 192
communicating the islands status to, 88
configuring, 112
fieldbus-to-HMI block, 194
HMI-to-fieldbus block, 193
setting up communications with the island bus, 112
flash memory, 96
Flash memory
Advantys configuration software, 186
and reset, 55, 57
overwriting, 53, 57, 187
saving configuration data, 49
frame type
default, 22
Ethernet II, 22, 63, 89, 107
IEEE 802.3, 22, 63, 89, 107
function codes
Modbus, 70

H
HE-13 connector, 34
heartbeat message, 184
HMI panel
data exchange, 14, 21, 174, 175, 190,
190, 193, 194
functionality, 193
process image blocks, 193
hot-swapping
mandatory modules, 178
hot-swapping modules, 48, 177
HTTP server, 20, 72, 102, 103, 104, 127

I
initial configuration, 53, 54
inputs
to a reflex block, 181
Internet, 20, 20, 28, 60
Internet browser, 102

31003688 2/2009

Index

IP address
BootP, 28
change, 107, 123, 136
default, 60, 61, 63, 107, 108
MAC address, 60, 61, 63, 108
setting, 28, 60, 62, 107
software priorities, 63
IP address field, 106, 107
IP parameters, 62, 106, 107, 108
island
configuration data, 53
operational mode, 53
island bus
communications, 14
configuration data, 50, 57, 115, 140, 187
extending, 16, 17, 38
fallback, 184
IP address, 60, 105, 106, 122
LEDs, 31
maximum length, 19
operational mode, 31, 56
overview, 15, 16
status, 30, 81
termination, 15, 17
island bus example, 47, 73, 165
island bus node address
address range, 28
setting, 60, 106, 108
valid and invalid addresses, 28
island bus password, 187

L
LEDs
10T ACT, 30
and COMS states, 31
and reset, 31
ERR, 31
island bus, 31
LAN ST, 30
overview, 30
RUN, 31
TEST, 31

31003688 2/2009

logic power
considerations, 15, 17, 37, 37, 38, 39
integrated power supply, 14, 15, 37, 39,
39
signal, 37
source power supply, 15, 39

M
MAC address, 60, 61, 63, 108
mandatory I/O modules, 177, 177
mandatory module hot swapping, 178
MIB II, 152, 154
Modbus
function codes, 70
Modbus client, 69, 70
Modbus communication standard, 67
Modbus function codes, 89, 170, 171
Modbus messaging, 68
client services, 69, 70
Modbus TCP device implementation, 68
server services, 70, 71
Modbus over TCP/IP
and master controllers, 112
connection example, 162, 169
data formats, 63, 89, 166
fieldbus interface, 26
fieldbus master, 72, 73
input data image, 76
output data image, 75
Port 502 SAP, 20, 42
protocol, 21
troubleshooting, 81
Modbus protocol, 33, 34, 72, 89, 166, 188,
191, 193
Modbus server, 70, 71

N
nested reflex actions, 182
network architecture, 163
network considerations, 14, 20, 26, 28, 30,
54, 60
number of reflex blocks on an island, 183

231

Index

O
outputs
from a reflex block, 182

P
parameterization, 49
PDM, 37, 41, 46, 47, 74, 166
PLC, 20, 21, 89, 175
preferred module, 17
Premium ETY, 97
primary segment, 15, 16, 37, 39
prioritization, 179
private MIB, 152, 153, 154, 155, 157
process image
analog input and output module data, 76,
192
and reflex actions, 76
connection example, 169
custom view, 137
diagnostic block, 81
digital input and output module data, 76,
192
echo output data, 76
embedded web server, 72
fieldbus-to-HMI block, 194
graphical representation, 189
HMI blocks, 193
HMI-to-fieldbus block, 193
I/O status image, 76, 188, 192, 193
input data image, 76, 138, 192, 193
output data image, 74, 138, 191, 194
overview, 188
protected mode, 33, 50, 53, 54, 56, 102, 127,
131, 187

Q
Quantum NOE, 97

reflex action
and fallback, 184
and the echo output data image area, 73,
76, 192
overview, 180
reflex block types, 180
removable memory card, 50, 52, 53, 186
RJ-45 connector, 26, 27
role name, 61, 62, 63, 118
rotary switches, 28, 61, 61
RST button
and auto-configuration, 57
and Flash memory, 55, 57
caution, 55, 56
disabled, 33, 187
functionality, 49, 55, 56, 56
LED indications, 31
physical description, 55
run-time parameters, 197

S
security
configuration password, 130, 132
private community strings, 150
web access password, 128
web site, 127, 130, 132
Security menu, 126
server
in a faulty device replacement operation,
95
services, 65
faulty device replacement, 94
Modbus messaging, 67
Simple Network Management Protocol (SNMP), 20, 149, 150, 152, 154
SNMP
configuring, 151
SNMP agent, 149
SNMP manager, 149

R
reboot operation, 124

232

31003688 2/2009

Index

source power supply

considerations, 39
logic power, 15, 39
recommendations, 41
SELV-rated, 35, 37, 39, 39
two-receptacle wiring connector, 35
specifications
CFG port, 33
Ethernet transmission, 22, 27
MIB II, 152, 154
STB NIP 2212, 22, 42
STB XCA 4002 programming cable, 34
standard I/O modules, 177
STB NIP 2212
and the Internet, 20
configuration mastery of, 116
configuration password, 126
configuring for IP, 28, 60, 62, 105, 106,
107
Ethernet LAN, 22
fieldbus (Ethernet) port, 26, 27
LEDs, 30
limitations, 42
master controller(s), 113
physical features, 24
specifications, 22, 42
troubleshooting, 88, 134, 135, 146
web access password, 126
STB NIP 2212 diagnostics, 152
STB NIP 2212 web site, 102, 104, 128, 131
STB XCA 4002 programming cable, 34
STB XMP 4400, 96
STB XMP 4440 removable memory card
and reset, 33
installing, 51
removing, 52
storing configuration data, 53
STB XTS 1120 screw type power connector,
35
STB XTS 2120 spring clamp field wiring connector, 35
storing configuration data
and reset, 57
in Flash memory, 49, 177, 186
to a removable memory card, 50, 53,
31003688 2/2009

177, 186
STP (shielded twisted pair) cable, 27, 42

T
termination plate, 15, 47, 74, 166
test mode, 31
TFTP, 159
troubleshooting
emergency messages, 85
error log, 146
global bits errors, 83
island bus, 83, 84, 86, 138
Modbus registers, 136
STB NIP 2212, 88, 134, 135, 146, 152,
154
using the Advantys STB LEDs, 31
using the Ethernet LAN LEDs, 30
web-based, 134, 135, 136, 138, 146
with the Advantys configuration software,
81
with the HMI panel, 81

U
user datagram protocol (UDP), 149, 149
UTP (unshielded twisted pair) cable, 27, 42

V
virtual placeholder, 202

W
web access password, 102, 128

233

Index

web pages
Change Configuration Password, 130
Change Web Access Password, 128
Configure SNMP, 110, 111
Configured IP, 61, 106, 106, 107
Error Log, 146, 146
Ethernet Statistics, 135
FDR Configuration, 118, 119
FDR Diagnostics, 142
I/O Data Values, 139
Island Configuration, 140
Island Parameters, 141
login, 132, 132
Master Configurator, 116, 117
Master Controller, 112, 114
NIM Registers, 137
Properties, 104
Reboot, 124
Role Name, 61, 118, 122

234

31003688 2/2009

Index

31003688 2/2009

235

Index

236

31003688 2/2009