0% found this document useful (0 votes)
139 views69 pages

Manual Modbus Info

fdf
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
139 views69 pages

Manual Modbus Info

fdf
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 69

Modbus Communication

4.1 Description

Modbus Communication Network Connections


Modbus™ network communication is shown below.

0RGEXV0DVWHU
1RWH8VHWZLVWHGSDLUZLULQJLIVKLHOGHGFRQQHFWRQO\DWRQHHQG
A

1RWH7KHJURXQGLVORFDWHGRQ3LQRIHDFKGULYH

B A B A B A

0D[FRQQHFWLRQV

1;*&RQWUROV 0RGEXVVODYHV

= 7HUPLQDWLRQ 1RWH$%GHILQLWLRQVDUHQRWVWDQGDUG,IWKHXQLWGRHVQRWZRUN
\RXPD\QHHGWRVZDS$DQG%

Figure 4-1 Typical 2-wire Modbus Communication Connection

4.1.2 Siemens Modbus Module

Description
The Siemens Modbus™ module supports Modbus™ communication. The module plugs into
the Anybus 1 (ABUS1) connector or the Anybus 2 (ABUS2) connector on the fiber optic board,
as shown in Figure NXGpro Control in the Introduction Chapter.
The following figure shows the connector and status indicators on the Siemens Modbus™
module.

NXGpro Communication
32 Function Manual, AD, A5E33486415A
Modbus Communication
4.1 Description

Figure 4-2 Siemens Modbus Module

Connector
The module has fixed pin assignments for Data A and Data B. The following figure shows the
output pin configuration for RS485.

1 Pin 2: Data A
2 Pin 3: Data B
3 Pin 5: Ground
Figure 4-3 RS485 Pin Assignments

NXGpro Communication
Function Manual, AD, A5E33486415A 33
Modbus Communication
4.2 Software Programming

Status Indicators
The following table explains the status indicators as shown in Figure Siemens Modbus Module.

Table 4-1 Status Indicator Descriptions

Status Indicator LED Indication


Red Module is sending data to the Modbus network
Green Module is receiving data from the Modbus network

Note
The green LED does not indicate that network traffic is present for this specific device; it only
means that network traffic is present.

Termination Resistor
The module incorporates a jumper (JP5), which can be used to terminate the network line as
listed in the following table.

Table 4-2 Jumper to enable/disable Termination Resistor

Jumper Setting
JP5 = 1-2 Termination resistor disabled
JP5 = 2-3 Termination resistor enabled

4.2 Software Programming


This section provides details for user programming through the SOP.
The fixed register bits are defined by the drive's software by default. To reprogram the definition
of the bits, complete these steps:
1. Set parameters using the procedure Fast Setup: control the drive using user-defined bits
controlled by the SOP in Section Planning/Configuring.
2. Refer to the procedures detailed in this section to complete setup:
– programmable inputs to the drive
– programmable outputs from the drive

NXGpro Communication
34 Function Manual, AD, A5E33486415A
Modbus Communication
4.2 Software Programming

The following table shows how the fixed register bits correspond with programmable bits
available for use in the SOP (drctry.pro bits).

Table 4-3 Network 1 and 2: Fixed Register Bits

Pick list variable in 'Data to Drive Reg nn' menus Corresponding Drctry.pro bits Modbus Address
Fixed Reg Bits (network 1) Network1FixedRegBit0_I ~ Network1FixedReg‐ 40065
Bit15_I
Fixed Reg Bits (network 2) Network2FixedRegBit0_I ~ Network2FixedReg‐ 40065
Bit15_I

4.2.1 Programmable Inputs to the Drive

Description
There are 64 input bits available for user programming through the SOP file. These bits can be
programmed to set or reset any other bits used within the SOP.

Programming Procedure
1. Locate the first data to drive register that is programmable using Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
You will see that the first programmable data to drive register for network 1 is register 'Data
to Drive 03', which corresponds to parameter ID (9603).
2. Enter parameter ID (9603).
3. The pick list of data to drive variables will appear. Refer to Table Data to Drive Pick List
Variables and Scaling in Section Parameter Assignment/Addressing for a list of data to drive
pick list variables.
4. Scroll through the pick list until you come to 'Net Input Flag 1' and press [ENTER]. This
setting uses the first 16 bits of the possible 64 bits.
Now the corresponding bits from the drctry.pro file can be used in the SOP, as shown below:
;Network1Flag0_I Use bit 0 for Stop bit
;Network1Flag1_I Use bit 1 for Run Forward bit
RunRequest_O = /Network1Flag0_I * Network1Flag1_I;Run drive using
bit 1,stop using bit 0
5. Select 'Net Input Flag 2' to use the second set of 16 bits, and so on.
Note
By choosing 'Data to Drive 03' as the write register, the PLC must now send 0x02 in register
'Data to Drive 03' to run the drive.
To stop the drive, the PLC must send 0x01 in register 'Data to Drive 03'.

NXGpro Communication
Function Manual, AD, A5E33486415A 35
Modbus Communication
4.2 Software Programming

The pick list variables and the corresponding programmable input bits are found in the following
tables for network 1 and 2, respectively.

Table 4-4 Network 1: Programmable input bits (parameter ID 9603-9664)

Pick list variable in 'Data to Drive Reg nn' menus Related Drctry.pro bits
Net Input Flag 1 Network1Flag0_I ~ Network1Flag15_I
Net Input Flag 2 Network1Flag16_I ~ Network1Flag31_I
Net Input Flag 3 Network1Flag32_I ~ Network1Flag47_I
Net Input Flag 4 Network1Flag48_I ~ Network1Flag63_I

Table 4-5 Network 2: Programmable input bits (parameter ID 9703-9764)

Pick list variable in 'Data to Drive Reg nn' menus Related Drctry.pro bits
Net Input Flag 1 Network2Flag0_I ~ Network2Flag15_I
Net Input Flag 2 Network2Flag16_I ~ Network2Flag31_I
Net Input Flag 3 Network2Flag32_I ~ Network2Flag47_I
Net Input Flag 4 Network2Flag48_I ~ Network2Flag63_I

Example
The following example shows how the network can be programmed to trip the input medium
voltage:
● The PLC writes to register 'Data to Drive 03' which is programmed to 'Net Input Flag 1' using
the procedure above.
● The SOP sets a flag bit that uses a digital output to trip input medium voltage, using the
following SOP source code:

;ExternalDigitalOutput01h_O Use digital output to trip input medium voltage


ExternalDigitalOutput01h_O = Network1FixedRegBit9_I;

● The PLC writes the contents of 'Net Input Flag 1', bit 9 (Network1Flag9_I) to create an input
medium voltage trip.

4.2.2 Programmable Outputs from the Drive

Description
There are 64 output bits available for user programming through the SOP file. These bits can
be programmed to set or reset any other bits used within the SOP.

NXGpro Communication
36 Function Manual, AD, A5E33486415A
Modbus Communication
4.2 Software Programming

Programming Procedure
1. Locate the first data from drive register that is programmable using Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
You will see that the first programmable data from drive register for network 1 is register
'Data from Drive 03', which corresponds to parameter ID (9403).
2. Enter parameter ID (9403).
3. The pick list of data from drive variables will appear. Refer to Table Data from Drive Pick List
Variables in Section Parameter Assignment/Addressing for a list of data from drive pick list
variables.
4. Scroll through the pick list until you come to 'Net1 Out Reg 1' and press [ENTER]. This
setting uses the first 16 bits of the possible 64 bits.
5. Select 'Net1 Out Reg 2' to use the second set of 16 bits, and so on.
The pick list variables and the corresponding programmable output bits are found in the
following tables for network 1 and 2, respectively.

Table 4-6 Network 1: Programmable output bits (parameter ID 9403-9464)

Pick list variable in 'Data from Drive Reg nn' menus Related Drctry.pro bits
Net1 Out Reg 1 Network1Flag0_O ~ Network1Flag15_O
Net1 Out Reg 2 Network1Flag16_O ~ Network1Flag31_O
Net1 Out Reg 3 Network1Flag32_O ~ Network1Flag47_O
Net1 Out Reg 4 Network1Flag48_O ~ Network1Flag63_O

Table 4-7 Network 2: Programmable output bits (parameter ID 9503-9564)

Pick list variable in 'Data from Drive Reg nn' menus Related Drctry.pro bits
Net2 Out Reg 1 Network2Flag0_O ~ Network2Flag15_O
Net2 Out Reg 2 Network2Flag16_O ~ Network2Flag31_O
Net2 Out Reg 3 Network2Flag32_O ~ Network2Flag47_O
Net2 Out Reg 4 Network2Flag48_O ~ Network2Flag63_O

Example
The following example shows how the network can be programmed to detect a trip on the input
medium voltage:
● The PLC reads register 'Data from Drive 03', which is programmed to 'Net1 Out Reg 1' using
the procedure above.
● The SOP sets a flag bit that corresponds to a medium voltage low fault, using the following
SOP source code:

; Monitor medium voltage fault on the Modbus network


Network1Flag9_O = MediumVoltageLowFault_I;

NXGpro Communication
Function Manual, AD, A5E33486415A 37
Modbus Communication
4.3 Parameter Assignment/Addressing

● This example uses bit 9 of 'Net1 Out Reg 1', which is Network1Flag9_O, to set the network
flag true if the medium voltage low fault is active.
● The PLC reads the contents of 'Net1 Out Reg 1', bit 9 (Network1Flag9_O) to determine if a
medium voltage fault occured.

4.3 Parameter Assignment/Addressing


This section provides the following information for communication configuration and
programming:
● Drive parameter ID and corresponding communication protocol address
● Parameter tables:
– Network configuration parameters
– Network 1 configuration parameters
– Network 2 configuration parameters
● Pick list variable tables:
– Data from Drive variables
– Data to Drive variables

4.3.1 Correspondence between Drive Parameter ID and Communication Protocol


Address
The following table provides drive parameter IDs and the corresponding Modbus™ addresses.
The following data is provided:
● Parameter ID
The drive parameter ID number to enter via the keypad or the ToolSuite.
● Modbus™ Address
A digital location provided by the Modbus™ Protocol, which stores values for use by the
master (PLC) and slave (Siemens drive) devices. To establish functional communication
between the PLC and the drive via the drive's Modbus™ connection, the control software in
the drive must be configured to know what certain addresses are used for.
● Data From Drive
Data that the PLC will receive from the drive to determine how the drive is functioning.
Each register contains a 16-bit digital representation of the status of a particular aspect of
drive functionality.
Some registers are fixed to track certain drive functions; others are programmable to track
any of a number of drive status choices.
● Data To Drive
Data that the PLC will send to the drive to control it.
Each register contains a 16-bit digital representation of the PLC's command for a particular
aspect of drive functionality.
Some registers are fixed to control certain functions; others are programmable to control
any of a number of drive function choices.

NXGpro Communication
38 Function Manual, AD, A5E33486415A
Modbus Communication
4.3 Parameter Assignment/Addressing

Table 4-8 Correspondence between Drive Parameter ID and Modbus Address

Network Parameter ID Description Default Contents Modbus Address


1 9401 Data From Drive 01 General Status (not changea‐ 40001
ble)
1 9402 Data From Drive 02 Motor Speed (not changeable) 40002
1 9403 to 9464 Data From Drive 03 to 64 None 40003 to 40064
1 9601 Data To Drive 01 Fixed Register Bits (not 40065
changeable)
1 9602 Data To Drive 02 Velocity Demand (not change‐ 40066
able)
1 9603 to 9664 Data To Drive 03 to 64 None 40067 to 40128
2 9501 Data From Drive 01 General Status (not changea‐ 40001
ble)
2 9502 Data From Drive 02 Motor Speed (not changeable) 40002
2 9503 to 9564 Data From Drive 03 to 64 None 40003 to 40064
2 9701 Data To Drive 01 Fixed Register Bits (not 40065
changeable)
2 9702 Data To Drive 02 Velocity Demand (not change‐ 40066
able)
2 9703 to 9764 Data To Drive 03 to 64 None 40067 to 40128

4.3.2 Parameter Tables

Network Parameters

Table 4-9 Network Control Menu (9943)

Parameter ID Unit Default Min Max Description


Net Control Type 9944 Sop Set bit definition:
● SOP
● Fixed
Start Stop Control 9945 Maintained Set Start/Stop bit inputs:
● Maintained
● Momentary

Table 4-10 Network 1 to 2 Register Copy (9946)

Parameter ID Unit Default Min Max Description


Net 1 to 2 reg. copy 9946 Function Copy Network 1 registers to Network 2
registers.

NXGpro Communication
Function Manual, AD, A5E33486415A 39
Modbus Communication
4.3 Parameter Assignment/Addressing

Network 1 Parameters

Table 4-11 Network 1: Configure Menu (9900)

Parameter ID Unit Default Min Max Description


Network 1 Type 9901 None Designate the type of external network connected to
the drive:
● None
● Modbus
● DeviceNet
● Profibus
● Ethernet Modbus
● ControlNet
● Ethernet I/P

Table 4-12 Network 1: Configure Parameters Menu (9902)

Parameter ID Unit Default Min Max Description


Modbus Baud Rate 9060 19200 Set the Modbus network baud rate:
● 1200
● 2400
● 4800
● 9600
● 19200
Modbus Parity 9047 None Set the Modbus parity:
● none
● odd
● even
Modbus Stop Bits 9048 1 Set the Modbus stop bits:
● one
● two
Modbus Address 9070 1 1 247 Set the address of the node on the Modbus network.
Velocity Units 9080 % Designate the units for velocity values from the drive:
● %
● RPM
● Hz
Demand Scalar 9912 1 -125 125 Set the scalar for input demand reference from the
network.
Aux Demand Scalar 9913 1 -125 125 Set the auxiliary scalar for input demand reference
from the network.
Network Timeout 9934 0 0 65535 Set the timeout for network determined to be non-re‐
sponsive.

NXGpro Communication
40 Function Manual, AD, A5E33486415A
Modbus Communication
4.3 Parameter Assignment/Addressing

Table 4-13 Network 1: Register Data from Drive Menu (9400)

Parameter ID Unit Default Min Max Description


Data From Drive 01 9401 General Sta‐ Register data from drive parameter 1.
tus Register is not programmable.
Data From Drive 02 9402 Motor Speed Register data from drive parameter 2.
Register is not programmable.
Data From Drive 03 to 64 9403 to None Register data from drive parameters 3 to 64.
9464 Registers are programmable.

Table 4-14 Network 1: Register Data to Drive Menu (9600)

Parameter ID Unit Default Min Max Description


Data To Drive Reg 01 9601 Fixed Reg Register data to drive parameter 1.
Bits Register is not programmable.
Data To Drive Reg 02 9602 Velocity De‐ Register data to drive parameter 2.
mand Register is not programmable.
Data To Drive Reg 03 to 64 9603 to None Register data to drive parameters 3 to 64.
9664 Registers are programmable.

Network 2 Parameters

Table 4-15 Network 2: Configure Menu (9914)

Parameter ID Unit Default Min Max Description


Network 2 Type 9915 None Designate the type of external network connected to the
drive:
● None
● Modbus
● DeviceNet
● Profibus
● Ethernet Modbus
● ControlNet
● Ethernet I/P

NXGpro Communication
Function Manual, AD, A5E33486415A 41
Modbus Communication
4.3 Parameter Assignment/Addressing

Table 4-16 Network 2: Configure Parameters Menu (9916)

Parameter ID Unit Default Min Max Description


Modbus Baud Rate 9917 19200 Set the Modbus network baud rate:
● 1200
● 2400
● 4800
● 9600
● 19200
Modbus Parity 9947 None Set the Modbus parity:
● none
● odd
● even
Modbus Stop Bits 9948 1 Set the Modbus stop bits:
● one
● two
Modbus Address 9920 1 1 247 Set the address of the node on the Modbus network.
Velocity Units 9924 % Designate the units for velocity values from the drive:
● %
● RPM
● Hz
Demand Scalar 9926 1 -125 125 Set the scalar for input demand reference from the
network.
Aux Demand Scalar 9927 1 -125 125 Set the auxiliary scalar for input demand reference
from the network.
Network Timeout 9935 0 0 65535 Set the timeout for network determined to be non-re‐
sponsive.

Table 4-17 Network 2: Register Data from Drive Menu (9500)

Parameter ID Unit Default Min Max Description


Data From Drive 01 9501 General Sta‐ Register data from drive parameter 1.
tus Register is not programmable.
Data From Drive 02 9502 Motor Speed Register data from drive parameter 2.
Register is not programmable.
Data From Drive 03 to 64 9503 to None Register data from drive parameters 3 to 64.
9564 Registers are programmable.

NXGpro Communication
42 Function Manual, AD, A5E33486415A
Modbus Communication
4.3 Parameter Assignment/Addressing

Table 4-18 Network 2: Register Data to Drive Menu (9700)

Parameter ID Unit Default Min Max Description


Data To Drive Reg 01 9701 Fixed Reg Register data to drive parameter 1.
Bits Register is not programmable.
Data To Drive Reg 02 9702 Velocity De‐ Register data to drive parameter 2.
mand Register is not programmable.
Data To Drive Reg 03 to 64 9703 to None Register data to drive parameters 3 to 64.
9764 Registers are programmable.

NXGpro Communication
Function Manual, AD, A5E33486415A 43
Modbus Communication
4.3 Parameter Assignment/Addressing

4.3.3 Pick List Variable Tables

Table 4-19 Data from Drive Pick List Variables

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

None None None None None None


Man Id None None None None Refer to Appendix Internal Drive Network
General Status 2001 None None Bit Field ● Bit 0: Fault
● Bit 1: Alarm
● Bit 2: Running Forward
● Bit 3: Running Reverse
● Bit 4: Drive Ready
● Bit 5: Start/Stop Control From Network
● Bit 6: Speed Reference From Network
● Bit 7: At Speed Reference
● Bit 8: Speed In Percent
● Bit 9: Speed In RPM
● Bit 10: Speed In Hz
● Bit 11: Reserved for future use
● Bit 12: Reserved for future use
● Bit 13: Reserved for future use
● Bit 14: Reserved for future use
● Bit 15: Reserved for future use
Motor Voltage 2100 Volts /1 Unsigned
Total Current 2190 Amps /1 Unsigned
Output Power 2230 KW /1 Signed
Motor Speed 2014 % /10 Unsigned
RPM /1
Hz /10
Speed Demand 2060 % /100 Unsigned
Speed Reference 2010 % /100 Unsigned
Heartbeat 2220 None None Unsigned 1 count per millisecond
Drive State 2210 None None Unsigned ● 0 = Off
● 1 = Magnetizing
● 2 = Spinning Load
● 3 = Autotune
● 4 = Run
● 5 = Stop
● 6 = Coast
● 7 = Up Transfer
● 8 = Down Transfer
Inp RMS Current 2130 Amps /1 Unsigned

NXGpro Communication
44 Function Manual, AD, A5E33486415A
Modbus Communication
4.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Input Frequency 2140 Hz /100 Unsigned


Input Power Avg 2250 KW /1 Unsigned
Net1 Out Reg 1 2002 None None Bit Field Network1Flag0_I - Network1Flag15_I
Net1 Out Reg 2 2003 None None Bit Field Network1Flag16_I - Network1Flag31_I
Net1 Out Reg 3 2004 None None Bit Field Network1Flag32_I - Network1Flag37_I
Net1 Out Reg 4 2005 None None Bit Field Network1Flag48_I - Network1Flag63_I
Net2 Out Reg 1 2006 None None Bit Field Network2Flag0_I - Network2Flag15_I
Net2 Out Reg 2 2007 None None Bit Field Network2Flag16_I - Network2Flag31_I
Net2 Out Reg 3 2008 None None Bit Field Network2Flag32_I - Network2Flag37_I
Net2 Out Reg 4 2009 None None Bit Field Network2Flag48_I - Network2Flag63_I
Torque Current 2150 Amps /1 Unsigned
Magnetizing Cur 2170 Amps /1 Unsigned
Motor Flux 2015 % /100 Unsigned
Motor Torque 2160 % /100 Unsigned
Flux Reference 2011 % /100 Unsigned
Input Voltage 2120 Volts /1 Unsigned
Inp Power Factor 2012 % /100 Unsigned
Input KVars 2013 KVAR /1 Unsigned
Max Available Output 2016 Volts /1 Unsigned
Volts
Hottest Cell Temp 2017 % /100 Unsigned Duty Cycle % of Hottest Cell
Mux1 Echo None None None None Refer to Appendix Multiplexer (MUX) Data
Mux1 Data Registers
Mux2 Echo
Mux2 Data
Mux3 Echo
Mux3 Data
Mux4 Echo
Mux4 Data
Mux5 Echo
Mux5 Data
Mux6 Echo
Mux6 Data
Mux7 Echo
Mux7 Data
Mux8 Echo
Mux8 Data
Wago Inputs 1-16 2650 None None Bit Field ExternalDigitalInput01a_I - ExternalDigita‐
lInput01h_I
ExternalDigitalInput02a_I - ExternalDigita‐
lInput02h_I

NXGpro Communication
Function Manual, AD, A5E33486415A 45
Modbus Communication
4.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Wago Inputs 17-32 2651 None None Bit Field ExternalDigitalInput03a_I - ExternalDigita‐
lInput03h_I
ExternalDigitalInput04a_I - ExternalDigita‐
lInput04h_I
Wago Inputs 33-48 2652 None None Bit Field ExternalDigitalInput05a_I - ExternalDigita‐
lInput05h_I
ExternalDigitalInput06a_I - ExternalDigita‐
lInput06h_I
Wago Inputs 49-64 2653 None None Bit Field ExternalDigitalInput07a_I - ExternalDigita‐
lInput07h_I
ExternalDigitalInput08a_I - ExternalDigita‐
lInput08h_I
Wago Inputs 65-80 2654 None None Bit Field ExternalDigitalInput09a_I - ExternalDigita‐
lInput09h_I
ExternalDigitalInput10a_I - ExternalDigita‐
lInput10h_I
Wago Inputs 81-96 2655 None None Bit Field ExternalDigitalInput11a_I - ExternalDigita‐
lInput11h_I
ExternalDigitalInput12a_I - ExternalDigita‐
lInput12h_I
Wago Outputs 1-16 2656 None None Bit Field ExternalDigitalOutput01a_O - ExternalDigi‐
talOutput01h_O
ExternalDigitalOutput02a_O - ExternalDigi‐
talOutput02h_O
Wago Outputs 17-32 2657 None None Bit Field ExternalDigitalOutput03a_O - ExternalDigi‐
talOutput03h_O
ExternalDigitalOutput04a_O - ExternalDigi‐
talOutput04h_O
Wago Outputs 33-48 2658 None None Bit Field ExternalDigitalOutput05a_O - ExternalDigi‐
talOutput05h_O
ExternalDigitalOutput06a_O - ExternalDigi‐
talOutput06h_O
Wago Outputs 49-64 2659 None None Bit Field ExternalDigitalOutput07a_O - ExternalDigi‐
talOutput07h_O
ExternalDigitalOutput08a_O - ExternalDigi‐
talOutput08h_O
PFD1 None None None None Refer to Appendix Parameter Read/Write
PFD2
PFD3
PFD4
Drive Losses 2161 % /100 Unsigned
Excessive Reactive 2162 % /100 Unsigned
Current
Speed Droop Percent 2163 % /100 Unsigned
Sync Motor Field Ref 2164 % /100 Unsigned
Avail Reactive Current 3653 % /100 Unsigned

NXGpro Communication
46 Function Manual, AD, A5E33486415A
Modbus Communication
4.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Drive Efficiency 2168 % /100 Unsigned


Ids Ref Current 2276 % /100 Unsigned

Table 4-20 Data to Drive Pick List Variables

Name Unit Scaling 16 Bit Data Notes


Type

None None None None None


Fixed Reg Bits None None Bit Field When parameter 'Net Control Type' (9945) is set
to 'SOP' the bits will be used in the SOP to control
drive functions.
When parameter 'Net Control Type' (9945) is set
to 'Fixed' the bits will be defined as follows in the
control software.
● Bit 0: Run Forward
● Bit 1: Run Reverse
● Bit 2: Fault Reset
● Bit 3: Stop
● Bit 4: Reserved
● Bit 5: Start/Stop Control From Network
● Bit 6: Speed Command From Network
● Bit 7 - 15: Reserved for future assignment
Velocity Demand Hz /10 Signed Speed Demand
RPM 1
% /10
Auxiliary Demand Hz /10 Signed Auxilary Speed Demand
RPM 1
% /10
Net Input Flag 1 None None Bit Field Network 1 SOP flags:
Network1Flag0_I ~ Network1Flag15_I
Network 2 SOP flags:
Network2Flag0_I ~ Network2Flag15_I
Net Input Flag 2 None None Bit Field Network 1 SOP flags:
Network1Flag16_I ~ Network1Flag31_I
Network 2 SOP flags:
Network2Flag16_I ~ Network2Flag31_I
Net Input Flag 3 None None Bit Field Network 1 SOP flags:
Network1Flag32_I ~ Network1Flag47_I
Network 2 SOP flags:
Network2Flag32_I ~ Network2Flag47_I

NXGpro Communication
Function Manual, AD, A5E33486415A 47
Modbus Communication
4.3 Parameter Assignment/Addressing

Name Unit Scaling 16 Bit Data Notes


Type

Net Input Flag 4 None None Bit Field Network 1 SOP flags:
Network1Flag48_I ~ Network1Flag63_I
Network 2 SOP flags:
Network2Flag48_I ~ Network2Flag63_I
Ratio % % / 100 Signed
Forward Max Lim % / 10000 or Unsigned
% / 100
Reverse Max Lim % / 10000 or Unsigned
% / 100
Forward Acc Time Seconds / 10 Unsigned
Forward Dec Time Seconds / 10 Unsigned
Reverse Acc Time Seconds / 10 Unsigned
Reverse Dec Time Seconds / 10 Unsigned
Net Input Pulse None None Unsigned
Forward Min Lim % / 10000 or Unsigned
% / 100
Reverse Min Lim % / 10000 or Unsigned
% / 100
Torque Limit % / 10000 or Unsigned
% / 100
MUX1 Id None None None Refer to Appendix Multiplexer (MUX) Data Reg‐
MUX2 Id isters
MUX3 Id
MUX4 Id
MUX5 Id
MUX6 Id
MUX7 Id
MUX8 Id
PTD1 None None None Refer to Appendix Parameter Read/Write
PTD2
PTD3
PTD4
Parallel Cmd 1 None None Unsigned
Torque Demand % / 1000 Unsigned
PVCL Demand % / 100 Unsigned
Flux Demand % / 100 Unsigned
Node Count None None Unsigned
Node Index None None Unsigned
Torque Acc Time Seconds / 100 Unsigned
Torque Dec Time Seconds / 100 Unsigned
Torque Offset None / 1000 Unsigned
Torque Scalar None / 1000 Unsigned
Vars Command % / 1000 Unsigned

NXGpro Communication
48 Function Manual, AD, A5E33486415A
Modbus Communication
4.4 Planning/Configuring

Name Unit Scaling 16 Bit Data Notes


Type

No Load I Scalar None / 1000 Unsigned


Avg Field Cur Amps / 10000 Unsigned
Manual Ids Demand % / 1000 Unsigned
Avg Ids Ref Amps /10000 Unsigned

4.4 Planning/Configuring
This section describes the setup methods available for communication. The following topics
are explained:
● Fast setup procedures
● Network setup procedure
● Network status detection
● An example to illustrate the setup procedure.
Note
Fast setup procedures allow setup of a Network 1 interface with a minimum of detail.

4.4.1 Fast Setup: Control the drive using the default configuration
To control the drive using the default configuration, you must send commands to the drive's
'fixed reg bits' location. This location is register 'Data to Drive 01' as provided in
Table Correspondence between Drive Parameter ID and Communication Protocol Address in
Section Parameter Assignment/Addressing.
To control the drive from a PLC using the default configuration, complete the following steps.
1. Set parameter 'Network 1 Type' (9901) to "Modbus".
2. Set parameter 'Modbus Baud Rate' (9060); this must match the baud rate of the PLC
controller.
3. Set parameter 'Modbus Address' (9070) to the desired network address for the drive.
4. Set parameter 'Net Control Type' (9944) to "Fixed". This sets the bits at register 'Data to
Drive 01' where the fixed register bits are located. The fixed register bits are interpreted as
shown in the following table.
5. Add the following line to the SOP:
Network1RunEnable_O = TRUE;

Table 4-21 Default definitions of Fixed Register Bits

Bit Default Definition


Network1FixedRegBit0_I Run forward
Network1FixedRegBit1_I Run reverse

NXGpro Communication
Function Manual, AD, A5E33486415A 49
Modbus Communication
4.4 Planning/Configuring

Bit Default Definition


Network1FixedRegBit2_I Fault reset
Network1FixedRegBit3_I Stop1
Network1FixedRegBit4_I Reserved
Network1FixedRegBit5_I Start stop control from network
Network1FixedRegBit6_I Speed commanded from network
Network1FixedRegBit7_I
Network1FixedRegBit8_I
Network1FixedRegBit9_I Reserved for future assignment
Network1FixedRegBit10_I
Network1FixedRegBit11_I
Network1FixedRegBit12_I
Network1FixedRegBit13_I
Network1FixedRegBit14_I
Network1FixedRegBit15_I
1
Network1FixedRegBit3_I functions as a drive stop control bit only if parameter 'Start Stop Control'
(9945) is set to "Momentary". Otherwise this bit is reserved.

Note
To run the drive, the PLC must send 0x21 to register 'Data to Drive 01'. This hexadecimal value
sets bit 0 (run) and bit 5 (start/stop control from network).
To stop the drive, the PLC must send 0x08 or 0x00 to register 'Data to Drive 01'.

4.4.2 Fast Setup: Monitor drive status and speed feedback


To read status data from the drive, complete the following steps:
1. Set parameter 'Network 1 Type' (9901) to "Modbus".
2. Set parameter 'Modbus Baud Rate' (9060); this must match the baud rate of the PLC
controller.
3. Set parameter 'Modbus Address' (9070) to the desired network address for the drive.
4. Set parameter 'Velocity Units' (9080) to the desired motor speed units.
5. Refer to the Table Correspondence between Drive Parameter ID and Communication
Protocol Address in Section Parameter Assignment/Addressing to obtain the addresses for
general status (Data from Drive 01) and motor speed feedback (Data from Drive 02) from
the drive.
– 'Data from Drive 01' (9401) is read by sending the read register request in address
40001.
– 'Data from Drive 02' (9402) is read by sending the read register request in address
40002, and so on.

NXGpro Communication
50 Function Manual, AD, A5E33486415A
Modbus Communication
4.4 Planning/Configuring

The general drive status bits found in register 'Data from Drive 01' are defined in the following
table.

Table 4-22 Default definitions of General Status Bits

Bit number Meaning in drive control soft‐ Value


ware
0 Fault
1 Alarm
2 RunningForward
3 RunningReverse
4 DriveReady
5 StartStopControlFromNetwork
6 SpeedFromNetwork
7 AtSpeedReference
8 SpeedInPercent 0 = False; 1 = True
9 SpeedInRPM
10 SpeedInHz
11 Reserved for future use
12 Reserved for future use
13 Reserved for future use
14 Reserved for future use
15 Reserved for future use

Note
You cannot reprogram the drive's default interpretation of output bits.

Refer to Network Setup Procedure for details on how to read other drive data.

See also
Network Setup Procedure (Page 53)

NXGpro Communication
Function Manual, AD, A5E33486415A 51
Modbus Communication
4.4 Planning/Configuring

4.4.3 Fast Setup: Send a motor speed setting to the drive


1. Using parameter 'Velocity Units' (9080), set the desired speed units to be sent to the drive,
to one of the following options:
– %
– RPM
– Hertz
2. The PLC needs to send the desired speed setting to the drive in register 'Data to Drive 02' .
This register is reserved to hold speed settings only, as noted in Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
3. Send 0x61 in register 'Data to Drive 01' . The motor now accepts the speed setting from the
PLC.

4.4.4 Fast Setup: Control the drive using user-defined bits controlled by the SOP
To control the drive using non-default configuration, you must redefine the fixed register bits at
register 'Data to Drive 01'.

Note
The 'fixed reg bits' location is fixed at register 'Data to Drive 01', whether the default
configuration is used or not.
You cannot reprogram the 'fixed reg bits' location.
You can reprogram the definition of the bits at this address.

To control the drive this way, complete the following steps.


1. Set parameter 'Network 1 Type' (9901) to "Modbus".
2. Set parameter 'Modbus Baud Rate' (9060); this must match the baud rate of the PLC
controller.
3. Set parameter 'Modbus Address' (9070) to the desired network address for the drive.
4. Set parameter 'Net Control Type' (9944) to "SOP". This makes the definitions of the fixed
register bits in register 'Data to Drive 01' programmable.
5. Next, set up the drive to correspond with the bits you want to use in the SOP. Refer to
Section Software Programming to find the bits and locate the associated keypad pick list
variable, and use the procedures detailed in this section to complete set up.
6. To enable speed settings from the network, add the following line to the SOP file:
RawDemandNetwork1_O = true;

See also
Software Programming (Page 34)

NXGpro Communication
52 Function Manual, AD, A5E33486415A
Modbus Communication
4.4 Planning/Configuring

4.4.5 Network Setup Procedure


The Modbus™ interface is built in to all drives with NXGpro Control. It uses a dedicated serial
port. To configure the interface, configure the serial port and related operating characteristics
of the interface using the keypad or the ToolSuite drive tool.

Note
Setup functions are contained in the Configure Parameters Menu (9902), which is a submenu
of the Communications Menu (9).
Access is security-controlled at level 7; you must enter the security code to access these
parameters.
Refer to the NXGpro Control Operating Manual for further information on security access levels
and codes.

Use the following procedure to complete network setup. Refer to Table Configure Parameters
Menu (9902) in Section Parameter Assignment/Addressing for the menus needed to complete
setup.

Procedure
1. Select a protocol using parameter 'Network 1 Type' (9901). Scroll to "Modbus" and press
[ENTER]. The Modbus™ configuration parameters are viewable.
2. Set parameter 'Modbus Baud Rate' (9060); this must match the baud rate of the PLC
controller.
3. Set parameter 'Modbus Parity' (9047) to match the parity of the PLC controller.
4. Set parameter 'Modbus Address' (9070) to the desired network address for the drive.
5. Set parameter 'Velocity Units' (9080) to the desired motor speed units for motor
commanded speed and motor feedback speed scaling.
6. Where necessary, set parameter 'Demand Scalar' (9912) to:
n x commanded speed where –125 % to 125 %
7. Set parameter 'Aux Demand Scalar' (9913) if used.
8. Use Table Correspondence between Drive Parameter ID and Communication Protocol
Address in Section Parameter Assignment/Addressing to program the drive to send data to
and receive commands from the network. The table provides all available addresses with
corresponding parameter ID as well as pre-programmed addresses, which provide basic
drive send and receive functionality and are not changeable.
9. Define the bits in the available addresses using one of the following methods:

NXGpro Communication
Function Manual, AD, A5E33486415A 53
Modbus Communication
4.4 Planning/Configuring

● Enter from a choice of variables in the pick lists. The pick lists in the menus contain the most
commonly used data variables. Refer to Section Parameter Assignment/Addressing for the
pick lists.
Note
A pick list item can only be used once for each 'Data to Drive' register.

● For 'Data from Drive' registers, choose pick list option "Man Id" (manual ID) to manually
enter a variable that is not included in the pick lists, using the output data ID number. Use
the list of data IDs available in Appendix Output Data IDs to locate the variable and use the
corresponding ID number to enter the variable into the 'Data from Drive' register.
Note
The output data ID number is not the same as a parameter ID number.

● Custom program using the drive's SOP. Refer to Section Software Programming for details.
Note
The PLC can receive data from the drive without any changes to the SOP.
Only if you need to control the drive through the network will you need to set any flags in the
SOP.

See also
Software Programming (Page 34)
Correspondence between Drive Parameter ID and Communication Protocol Address (Page 38)
Parameter Tables (Page 39)
Pick List Variable Tables (Page 44)

Set flags in the SOP for drive control through a network


Ensure the SOP file has the necessary code to enable control of the drive over a network:
1. To control the drive through a network by sending commands to the drive, the following
network control flag must be in the source code of the drive's SOP:
Network1RunEnable_O = TRUE;
2. To control the drive through a second network, the following network control flag must be in
the source code of the drive's SOP:
Network2RunEnable_O = TRUE;

4.4.6 Network Status Detection Setup


An SOP flag is available to show the network status:
● For network 1: Network1CommOk_I
● For network 2: Network2CommOk_I

NXGpro Communication
54 Function Manual, AD, A5E33486415A
Modbus Communication
4.4 Planning/Configuring

The SOP flag is set to "1" (true) when the network connection is operating normally, and "0"
(false) when it is not operating normally.
The network status cannot be automatically detected. Instead, a "Pulse Timeout" method is
used to set the network status flags.
The "Pulse Timeout" status detection must be set up in the menu system, and has to be
“strobed” by a network device that is communicating with the drive.

Procedure for Pulse Timeout Setup


1. Pick one of the 62 selectable "Data to Drive" registers and set the pick list item to "Net Input
Pulse".
2. Set parameter 'Network Timeout' (9934) for network 1 and (9935) for network 2, in the
'Config Parameters' menu, to a value (in seconds) to activate the network timeout. 0
seconds = disable timeout.

Pulse Timeout Operation


● A network device must set a unique (different) value into the "Net Input Pulse" register
before an internal timer reaches the "Network Timeout" value.
● If the network device writes a unique value, the network status flag is set to "1" and the
internal timer is reset.
● If the network device fails to write a unique value to the "Net Input Pulse" register before the
internal timer times to the value set by the "Network Timeout" parameter then the status flag
is set to "0".

4.4.7 Setup Example

Task
Set up network to indicate the following drive outputs on the PLC:
● general status
● motor speed
● output power
● number of active faults.

Procedure
Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address in Section Parameter Assignment/Addressing to establish whether an address or
register is changeable.
To indicate general status and motor speed:
1. The table shows that:

NXGpro Communication
Function Manual, AD, A5E33486415A 55
Modbus Communication
4.4 Planning/Configuring

● 'Data from Drive 01' is not changeable; it is set to indicate general status. No action is
required.
● 'Data from Drive 02' is not changeable; it is set to indicate motor speed. No action is required.
To indicate output power:
1. The table shows that 'Data from Drive 03' is changeable, this can be set to indicate output
power.
2. Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address to determine that the corresponding parameter ID is 9403.
3. Enter parameter ID 9403.
4. Choose "output power" from the pick list.
The output power will be sent to the PLC using register 'Data from Drive 03'.
To indicate the number of active faults:
1. The table shows that 'Data from Drive 04' is changeable, this can be set to indicate the
number of active faults.
2. Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address to determine that the corresponding parameter ID is 9404.
3. Enter parameter ID 9404.
4. The pick list of data from drive variables appears. As "number of active faults" is not an
option in the pick list, you must specify it manually.
5. Refer to Table Data From Drive Pick List Variables in Section Parameter Assignment/
Addressing for a list of 'data from drive' pick list variables.
Since "number of active faults" is not a choice in the pick list, instead choose "Man Id"
(manual ID). The display shows "ManId-0000".
6. Refer to Appendix Output Data IDs and locate "number of active faults" in the tables to
determine its data ID number (3000).
7. Use arrow or number keys to enter 3000, and press [ENTER]. The display now shows
"ManId-3000".
The number of active faults will be sent to the PLC using register 'Data from Drive 04'.
● If the data ID number is not found, the error message "Invalid Id Entered" is displayed.
Ensure that the data ID is correct.

Table 4-23 Completed Settings for Given Example

PLC Address or Register Data Scaling


Data from Drive 01 (not changeable) General status 16 bits
Data from Drive 02 (not changeable) Motor speed RPM
Data from Drive 03 Output power kW
Data from Drive 04 Number of faults 0 to 128

See also
Correspondence between Drive Parameter ID and Communication Protocol Address (Page 38)

NXGpro Communication
56 Function Manual, AD, A5E33486415A
Modbus Communication
4.5 Functions

4.5 Functions

Supported Command Set


The NXGpro Control implements the following Modbus™ commands:
● Read coil (function code 0x01)
● Read holding registers (function code 0x03)
● Write multiple coils (function code 0x0F)
● Write single register (function code 0x06)
● Loop back diagnostic test (function code 0x08)
● Write multiple registers (function code 0x10)
Commands are issued by the Modbus™ master (PLC) and sent over the network to the
Siemens slave[s]. Commands are listed and described in the sections that follow.

4.5.1 Read Coil Command (0x01)

Description
The "read coil" command allows you to obtain the ON or OFF status of logic coils used to control
discrete outputs from the addressed slave.
Coils are numbered beginning from 0 (coil number 1 = 0, coil number 2 = 1, and so on).

Example
A sample of a "read coil" request to read coils 0020 to 0056 from a slave device number 3 and
the associated response is given below.

Read Coil Command


TX (Request) 01 01 00 13 00 25 -- --
RX (Response) 01 01 CD 6B B2 0E 1B -- --

The meaning of the sample request and associated response is detailed in the following tables.

Request Details

Table 4-24 Read Coils Request (TX) to Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x01 Read coils command
Start address of coils to read (high) 0x00 Start address is coil number 20
Start address of coils to read (low) 0x13

NXGpro Communication
Function Manual, AD, A5E33486415A 57
Modbus Communication
4.5 Functions

Field Name Value (in Hex) Description


Number of coils to read (high) 0x00 Read 37 coils starting from coil 20
Number of coils to read (low) 0x25
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Response Details

Table 4-25 Read Coils Response (RX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x01 Read coils command
Data from coils 0xCD Decoded data from coils*
Data from coils 0x6B
Data from coils 0x02
Data from coils 0x0E
Data from coils 0x1B Decoded data, high bits are filled with
zeros if no data requested
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

*The response includes data that is decoded as follows:


● Data is packed with 1 bit for each coil (1 = ON, 0 = OFF).
● The low order bit of the first character contains the addressed coil. The remainder bits follow.
● For coil quantities that are not even multiples of 8, the last characters are filled in with zeros
at high order end.
● The status of coils 20-27 is shown as CD (HEX) = 1100 1101 (binary). Reading left to right,
this shows that coils 27, 26, 23, 22, and 20 are all on. The other coil data bytes are decoded
similarly.
● Due to the quantity of coil statuses requested, the last data field, shown as 1B (HEX) = 001
1011 (binary), contains the status of only 5 coils (52-56) instead of 8 coils. The 3 left-most
bits are provided as zeros to fill the 8-bit format.

4.5.2 Read Holding Registers Command (0x03)

Description
The "read holding registers" command allows the Modbus master to read up to 64 consecutive
memory registers from the drive.

NXGpro Communication
58 Function Manual, AD, A5E33486415A
Modbus Communication
4.5 Functions

Example
A sample of a "read holding registers" request to read 2 registers (40005 and 40006) and the
associated response, in hexadecimal, is given below.

Read Holding Registers Command


TX (Request) 01 03 00 04 00 02 -- --
RX (Response) 01 03 04 04 A5 90 B1 -- --

The meaning of the sample request and associated response is detailed in the following tables.

Request Details

Table 4-26 Read Holding Registers Request (TX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x03 Read holding registers command
Starting Address (high) 0x00 Register number 40005
Starting Address (low) 0x04
Number of Registers to Read (high) 0x00 Read 2 (0x0002) registers
Number of Registers to Read (low) 0x02
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Response Details

Table 4-27 Read Holding Registers Response (RX) from Drive

Field Name Value (in Hex) Actual Result Scaled Value Description
Slave Address 0x01 N/A N/A 0x01 = 1 decimal
Function 0x03 N/A N/A Read holding registers
command
Byte Count 0x04 N/A N/A 4 bytes in response
Data Value 1 (MSB) 0x04 0x04A5 This register is user program‐ High byte of item 1
Data Value 1 (LSB) 0xA5 mable. See Table Register Da‐ Low byte of item 1
ta from Drive Menu (9400).
Data Value 2 (MSB) 0x90 0x90B1 High byte of item 2
Data Value 2 (LSB) 0xB1 Low byte of item 2
CRC byte 1 --- N/A N/A Byte 1 for this mes‐
sage
CRC byte 2 --- N/A N/A Byte 2 for this mes‐
sage

NXGpro Communication
Function Manual, AD, A5E33486415A 59
Modbus Communication
4.5 Functions

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

Note
For responses received from the drive such as in Table Read Holding Registers Response
(RX) from Drive , the keypad parameter 'Velocity Units' (9080) is set to "Percent" by default.
Scaled values differ depending on how this parameter is configured. This is described in
Table Configure Parameters Menu (9902) in Section Parameter assignment/addressing.
Refer to Table General Data Register Assignments in Appendix Output Data IDs for data
scaling.

4.5.3 Write Multiple Coils Command (0x0F)

Description
The "write multiple coils" command forces multiple coils in a consecutive block to a desired ON
or OFF state. Any coil that exists within the controller can be forced to either state. The
controller can also alter the state of the coil.
Coils are numbered beginning from 0 (coil number 1 = 0, coil number 2 = 1, and so on).

Example
A sample of a "write multiple coils" request to force a slave device number 1 to write 10 coils
starting at address 20 (13 HEX), and the associated response is given below.

Write Multiple Coils Command


TX (Request) 01 0F 00 13 00 0A 02 CD 00 -- --
RX (Response) 01 0F 00 13 00 0A -- --

The 2 data fields, CD = 1100 and 00 = 000 0000, indicate that coils 27, 26, 23, 22, and 20 are
to be forced on.
The meaning of the sample request and associated response is detailed in the following tables.

Request Details

Table 4-28 Write Multiple Coils Request (TX) to Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x0F Write multiple coils command

NXGpro Communication
60 Function Manual, AD, A5E33486415A
Modbus Communication
4.5 Functions

Field Name Value (in Hex) Description


Start address of coils to write (high) 0x00 Start address is coil number 20
Start address of coils to write (low) 0x13
Number of coils to write (high) 0x00 Write 10 coils starting from coil 20
Number of coils to write (low) 0x0A
Byte count 0x02 2 bytes total
Data to write coils 20 - 27 0xCD
Data to write coils 28 – 29 0x00
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Response Details

Table 4-29 Write Multiple Coils Response (RX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x0F Write multiple coils command
Start address of coils to write (high) 0x00 Start address is coil number 20
Start address of coils to write (low) 0x13
Number of coils to write (high) 0x00 Write 10 coils starting from coil 20
Number of coils to write (LOW) 0x0A
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

4.5.4 Write Single Input Register Command (0x06)

Description
The "write input register" command allows the Modbus master to write a value to a specified
input register in the drive.

Example
A sample of a "write input register" request to write a value to register 40067 and the associated
response, in hexadecimal, is given below.

Write Input Register Command


TX (Request) 01 06 00 42 00 64 -- --
RX (Response) 01 06 00 42 00 64 -- --

The meaning of the sample request and associated response is detailed in the following table.

NXGpro Communication
Function Manual, AD, A5E33486415A 61
Modbus Communication
4.5 Functions

Request Details

Table 4-30 Write Input Register Request (TX) from Master

Field Name Value (in Hex) Notes


Slave Address 0x01 0x01 = 1 decimal
Function 0x06 Write input register command
Register Address (high) 0x00 Register number 40067
Register Address (low) 0x42
Preset Data (high) 0x00 Value = 100
Preset Data (low) 0x64
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Response Details
The write input register response (RX) from the drive is an echo of the request and therefore is
identical; refer to table above.

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

4.5.5 Loop Back Diagnostic Test Command (0x08)

Description
The "loop back test" command allows the Modbus master to test the communication link to the
drive.

Example
A sample of a "loop back test" request and the associated response, in hexadecimal, is given
below.

Loop Back Test Command


TX (Request) 01 08 00 00 03 E8 -- --
RX (Response) 01 08 00 00 03 E8 -- --

The loop back test response (RX) from the drive is an echo of the request and therefore is
identical.

NXGpro Communication
62 Function Manual, AD, A5E33486415A
Modbus Communication
4.5 Functions

4.5.6 Write Multiple Input Registers Command (0x10)

Description
The "write multiple input registers" command allows the Modbus master to write up to 64 values
(in a single command) to multiple input registers in the drive.

Example
A sample of a "write multiple input registers" command to write to 2 registers and the
associated response, in hexadecimal, is given below.

Write Multiple Input Registers Command


TX (Request) 01 10 00 43 00 02 04 00 64 24 E3 -- --
RX (Response) 01 10 00 43 00 02 -- --

The meaning of the sample request and associated response is detailed in the following tables.

Request Details

Table 4-31 Write Multiple Input Registers Request (TX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x10 Write multiple input registers command
Starting Address (high) 0x00 Register number 40068
Starting Address (low) 0x43
Number of Registers (high) 0x00 Write to 0x0002 (2) registers
Number of Registers (low) 0x02
Byte Count 0x04 4 bytes total
Preset Data 1 (high) 0x00 Value = 0x0064 (100 decimal)
Preset Data 1 (low) 0x64
Preset Data 2 (high) 0x24 Value = 0x24E3 (9443 decimal)
Preset Data 2 (low) 0xE3
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Response Details

Table 4-32 Write Multiple Input Registers Response (RX) from Drive

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x10 Write multiple input registers command

NXGpro Communication
Function Manual, AD, A5E33486415A 63
Modbus Communication
4.5 Functions

Field Name Value (in Hex) Description


Starting Address (high) 0x00 Register number 40068
Starting Address (low) 0x43
Number of Registers (high) 0x00 Write to 0x0002 (2) registers
Number of Registers (low) 0x02
Error Check (CRC) byte 1 — Byte 1 of CRC for this message
Error Check (CRC) byte 2 — Byte 2 of CRC for this message

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

NXGpro Communication
64 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication 5
This chapter contains instructions for controlling the drive using a PLC over an Modbus™
Ethernet network. It addresses the following topics:
● Description of the interface
● User Programming
● Parameter assignment and addressing
● Configuration and setup options
● Available functions

5.1 Description
The Modbus™ Ethernet communication interface is based on the TCP/IP protocol. All
addressing is based on IP addresses.
The drive always acts as a Modbus™ slave. This means that the drive does not initiate dialog
on the Modbus™ Ethernet network. Rather, it listens to and then responds to the Modbus™
Ethernet master.

Note
Only register-based read and write functions of the Modbus™ protocol are supported. These
functions are used to monitor and control analog and digital inputs and outputs of the drive.
Only the Remote Terminal Unit (RTU) format of the Modbus™ protocol is supported by the
NXGpro Control. All requests are sent via register port 502.
Refer to Section Functions for function codes supported by the NXGpro Control.

To enable dual network functionality, this protocol requires an additional Anybus™ module.

See also
Functions (Page 93)

NXGpro Communication
Function Manual, AD, A5E33486415A 65
Modbus Ethernet Communication 5
This chapter contains instructions for controlling the drive using a PLC over an Modbus™
Ethernet network. It addresses the following topics:
● Description of the interface
● User Programming
● Parameter assignment and addressing
● Configuration and setup options
● Available functions

5.1 Description
The Modbus™ Ethernet communication interface is based on the TCP/IP protocol. All
addressing is based on IP addresses.
The drive always acts as a Modbus™ slave. This means that the drive does not initiate dialog
on the Modbus™ Ethernet network. Rather, it listens to and then responds to the Modbus™
Ethernet master.

Note
Only register-based read and write functions of the Modbus™ protocol are supported. These
functions are used to monitor and control analog and digital inputs and outputs of the drive.
Only the Remote Terminal Unit (RTU) format of the Modbus™ protocol is supported by the
NXGpro Control. All requests are sent via register port 502.
Refer to Section Functions for function codes supported by the NXGpro Control.

To enable dual network functionality, this protocol requires an additional Anybus™ module.

See also
Functions (Page 93)

NXGpro Communication
Function Manual, AD, A5E33486415A 65
Modbus Ethernet Communication
5.1 Description

5.1.1 Network Configuration Options


This section provides information on the configuration options for the Anybus™ Ethernet
Modbus™module for dual network functionality.
● Network 1 communication can be supported by two methods, which are as follows:
– CPU: Ethernet Modbus™ communication is only valid for NXpro software version 6.1
and earlier and is supported via the NXGpro CPU Ethernet connection
– Anybus™ Ethernet module ethernet communication is supported via an Anybus™
Ethernet module connected to the Network 1 connector of the NXGpro control. The
benefit of this method is that the CPU of the drive cannot experience any interrupt or
associated issues.
● Network 2 communication is supported via an Anybus™ Ethernet module as described in
the following section.
Note
The CPU Ethernet connection will only support Ethernet Modbus™ for Network for NXGpro
software version 6.1 and earlier. It cannot be used for Network 2.

5.1.2 Anybus Modbus Ethernet Module

Description

Note
Network Usage
The Anybus™ Ethernet module is the only hardware that can be used for Network 2 .

The following figure shows the connector and status indicators on the Anybus™ Modbus™
Ethernet module. The DIP switches are not used for the NXGpro application.

NXGpro Communication
66 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.1 Description

1 RJ-45 connector
2 DIP switches (not used)
3 Status indicators
Figure 5-1 Anybus Ethernet Module

Status Indicators
The following figure shows the status indicators.

 

 

Figure 5-2 Status Indicators

.Refer to Table Status Indicator Table to view explanation of the various status indicators

Table 5-1 Status Indicator Table

Status Indicator Indication State Description


(figure number)
1 Link present On The module has a link.
Off The module does not sense a link.
2 Module status Off No power applied to the module.
Green The module is operating correctly.
Green, flashing The module has not been configured.
Red A major internal error has been detected.
Red, flashing A minor recoverable fault has been detected.
Green / red flashing The module is performing a power-on self-test.

NXGpro Communication
Function Manual, AD, A5E33486415A 67
Modbus Ethernet Communication
5.2 Software Programming

Status Indicator Indication State Description


(figure number)
3 Network status Flashing Number of flashes = number of established Modbus/TCP
connections to the module
4 Data activity Flashing A packet is being received or transmitted.

5.2 Software Programming


This section provides details for user programming through the SOP.
The fixed register bits are defined by the drive's software by default. To reprogram the definition
of the bits, complete these steps:
1. Set parameters using the procedure Fast Setup: control the drive using user-defined bits
controlled by the SOP in Section Planning/Configuring.
2. Refer to the procedures detailed in this section to complete setup:
– programmable inputs to the drive
– programmable outputs from the drive
The following table shows how the fixed register bits correspond with programmable bits
available for use in the SOP (drctry.pro bits).

Table 5-2 Network 1 and 2: Fixed Register Bits

Pick list variable in 'Data to Drive Reg nn' menus Corresponding Drctry.pro bits Modbus Address
Fixed Reg Bits (network 1) CPU Network1FixedRegBit0_I ~ Network1FixedReg‐ 40065 or 41025
(only valid on NXGpro software version 6.1 and Bit15_I
earlier)
Fixed Reg Bits (network 1) Anybus Network1FixedRegBit0_I ~ Network1FixedReg‐ 41025
Bit15_I
Fixed Reg Bits (network 2) Network2FixedRegBit0_I ~ Network2FixedReg‐ 41025
Bit15_I

5.2.1 Programmable Inputs to the Drive

Description
There are 64 input bits available for user programming through the SOP file. These bits can be
programmed to set or reset any other bits used within the SOP.

NXGpro Communication
68 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.2 Software Programming

Programming Procedure
1. Locate the first data to drive register that is programmable using Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
You will see that the first programmable data to drive register for network 1 is register 'Data
to Drive 03', which corresponds to parameter ID (9603).
2. Enter parameter ID (9603).
3. The pick list of data to drive variables will appear. Refer to Table Data to Drive Pick List
Variables and Scaling in Section Parameter Assignment/Addressing for a list of data to drive
pick list variables.
4. Scroll through the pick list until you come to 'Net Input Flag 1' and press [ENTER]. This
setting uses the first 16 bits of the possible 64 bits.
Now the corresponding bits from the drctry.pro file can be used in the SOP, as shown below:
;Network1Flag0_I Use bit 0 for Stop bit
;Network1Flag1_I Use bit 1 for Run Forward bit
RunRequest_O = /Network1Flag0_I * Network1Flag1_I;Run drive using
bit 1,stop using bit 0
5. Select 'Net Input Flag 2' to use the second set of 16 bits, and so on.
Note
By choosing 'Data to Drive 03' as the write register, the PLC must now send 0x02 in register
'Data to Drive 03' to run the drive.
To stop the drive, the PLC must send 0x01 in register 'Data to Drive 03'.

The pick list variables and the corresponding programmable input bits are found in the following
tables for network 1 and 2, respectively.

Table 5-3 Network 1: Programmable input bits (parameter ID 9603-9664)

Pick list variable in 'Data to Drive Reg nn' menus Related Drctry.pro bits
Net Input Flag 1 Network1Flag0_I ~ Network1Flag15_I
Net Input Flag 2 Network1Flag16_I ~ Network1Flag31_I
Net Input Flag 3 Network1Flag32_I ~ Network1Flag47_I
Net Input Flag 4 Network1Flag48_I ~ Network1Flag63_I

Table 5-4 Network 2: Programmable input bits (parameter ID 9703-9764)

Pick list variable in 'Data to Drive Reg nn' menus Related Drctry.pro bits
Net Input Flag 1 Network2Flag0_I ~ Network2Flag15_I
Net Input Flag 2 Network2Flag16_I ~ Network2Flag31_I
Net Input Flag 3 Network2Flag32_I ~ Network2Flag47_I
Net Input Flag 4 Network2Flag48_I ~ Network2Flag63_I

NXGpro Communication
Function Manual, AD, A5E33486415A 69
Modbus Ethernet Communication
5.2 Software Programming

Example
The following example shows how the network can be programmed to trip the input medium
voltage:
● The PLC writes to register 'Data to Drive 03' which is programmed to 'Net Input Flag 1' using
the procedure above.
● The SOP sets a flag bit that uses a digital output to trip input medium voltage, using the
following SOP source code:

;ExternalDigitalOutput01h_O Use digital output to trip input medium voltage


ExternalDigitalOutput01h_O = Network1FixedRegBit9_I;

● The PLC writes the contents of 'Net Input Flag 1', bit 9 (Network1Flag9_I) to create an input
medium voltage trip.

5.2.2 Programmable Outputs from the drive

Description
There are 64 output bits available for user programming through the SOP file. These bits can
be programmed to set or reset any other bits used within the SOP.

Programming Procedure
1. Locate the first data from drive register that is programmable using Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
You will see that the first programmable data from drive register for network 1 is register
'Data from Drive 03', which corresponds to parameter ID (9403).
2. Enter parameter ID (9403).
3. The pick list of data from drive variables will appear. Refer to Table Data from Drive Pick List
Variables in Section Parameter Assignment/Addressing for a list of data from drive pick list
variables.
4. Scroll through the pick list until you come to 'Net1 Out Reg 1' and press [ENTER]. This
setting uses the first 16 bits of the possible 64 bits.
5. Select 'Net1 Out Reg 2' to use the second set of 16 bits, and so on.
The pick list variables and the corresponding programmable output bits are found in the
following tables for network 1 and 2, respectively.

Table 5-5 Network 1: Programmable output bits (parameter ID 9403-9464)

Pick list variable in 'Data from Drive Reg nn' menus Related Drctry.pro bits
Net1 Out Reg 1 Network1Flag0_O ~ Network1Flag15_O
Net1 Out Reg 2 Network1Flag16_O ~ Network1Flag31_O

NXGpro Communication
70 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Pick list variable in 'Data from Drive Reg nn' menus Related Drctry.pro bits
Net1 Out Reg 3 Network1Flag32_O ~ Network1Flag47_O
Net1 Out Reg 4 Network1Flag48_O ~ Network1Flag63_O

Table 5-6 Network 2: Programmable output bits (parameter ID 9503-9564)

Pick list variable in 'Data from Drive Reg nn' menus Related Drctry.pro bits
Net2 Out Reg 1 Network2Flag0_O ~ Network2Flag15_O
Net2 Out Reg 2 Network2Flag16_O ~ Network2Flag31_O
Net2 Out Reg 3 Network2Flag32_O ~ Network2Flag47_O
Net2 Out Reg 4 Network2Flag48_O ~ Network2Flag63_O

Example
The following example shows how the network can be programmed to detect a trip on the input
medium voltage:
● The PLC reads register 'Data from Drive 03', which is programmed to 'Net1 Out Reg 1' using
the procedure above.
● The SOP sets a flag bit that corresponds to a medium voltage low fault, using the following
SOP source code:

; Monitor medium voltage fault on the Modbus network


Network1Flag9_O = MediumVoltageLowFault_I;

● This example uses bit 9 of 'Net1 Out Reg 1', which is Network1Flag9_O, to set the network
flag true if the medium voltage low fault is active.
● The PLC reads the contents of 'Net1 Out Reg 1', bit 9 (Network1Flag9_O) to determine if a
medium voltage fault occured.

5.3 Parameter Assignment/Addressing


This section provides the following information for communication configuration and
programming:
● Drive parameter ID and corresponding communication protocol address
● Parameter tables:
– Network configuration parameters
– Network 1 configuration parameters
– Network 2 configuration parameters
● Pick list variable tables:
– Data from Drive variables
– Data to Drive variables

NXGpro Communication
Function Manual, AD, A5E33486415A 71
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

5.3.1 Correspondence between Drive Parameter ID and Communication Protocol


Address
The following table provides drive parameter IDs and the corresponding Modbus™ addresses.
The following data is provided:
● Parameter ID
The drive parameter ID number to enter via the keypad or the ToolSuite.
● Modbus™ Address
A digital location provided by the Modbus™ Protocol, which stores values for use by the
master (PLC) and slave (Siemens drive) devices. To establish functional communication
between the PLC and the drive via the drive's Modbus™ connection, the control software in
the drive must be configured to know what certain addresses are used for.
● Data From Drive
Data that the PLC will receive from the drive to determine how the drive is functioning.
Each register contains a 16-bit digital representation of the status of a particular aspect of
drive functionality.
Some registers are fixed to track certain drive functions; others are programmable to track
any of a number of drive status choices.
● Data To Drive
Data that the PLC will send to the drive to control it.
Each register contains a 16-bit digital representation of the PLC's command for a particular
aspect of drive functionality.
Some registers are fixed to control certain functions; others are programmable to control
any of a number of drive function choices.
– Network 1 Data to drive can use either listed register range. There are 2 ranges available
to allow compatibility with the Anybus™ module on Network 2, and remain backward
compatible with the Modbus™ Ethernet implementation.

Table 5-7 Correspondence between Drive Parameter ID and Modbus Address

Network Parameter ID Description Default Contents Modbus Address


1 9401 Data From Drive 01 General Status 40001
(not changeable)
1 9402 Data From Drive 02 Motor Speed 40002
(not changeable)
1 9403 to 9464 Data From Drive 03 to 64 None 40003 to 40064
1 9601 Data To Drive 01 Fixed Register When parameter "Ethernet Modbus Type"
Bits (9906) is set to "Internal CPU" and NXGpro
(not changeable) software version 6.1 and earlier is used:
40065
When parameter "Ethernet Modbus Type"
(9906) is set to "Anybus Module" or NXGpro
software 6.2 or later is used: 41025

NXGpro Communication
72 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Network Parameter ID Description Default Contents Modbus Address


1 9602 Data To Drive 02 Velocity Demand When parameter "Ethernet Modbus Type"
(not changeable) (9906) is set to "Internal CPU" and NXGpro
software version 6.1 and earlier is
used:40066
When parameter "Ethernet Modbus Type"
(9906) is set to "Anybus Module" or NXGpro
software 6.2 or later is used: 41026
1 9603 to 9664 Data To Drive 03 to 64 None When parameter "Ethernet Modbus Type"
(9906) is set to "Internal CPU" and NXGpro
software version 6.1 and earlier is used:
40067 to 40128
When parameter "Ethernet Modbus Type"
(9906) is set to "Anybus Module" or NXGpro
software 6.2 or later is used:
41027 to 41088
2 9501 Data From Drive 01 General Status 40001
(not changeable)
2 9502 Data From Drive 02 Motor Speed 40002
(not changeable)
2 9503 to 9564 Data From Drive 03 to 64 None 40003 to 40064
2 9701 Data To Drive 01 Fixed Register 41025
Bits (not change‐
able)
2 9702 Data To Drive 02 Velocity Demand 41026
(not changeable)
2 9703 to 9764 Data To Drive 03 to 64 None 41027 to 41088

5.3.2 Parameter Tables

Network Parameters

Table 5-8 Network Control Menu (9943)

Parameter ID Unit Default Min Max Description


Net Control Type 9944 SOP Set bit definition:
● SOP
● Fixed
Start Stop Control 9945 Maintained Set Start/Stop bit inputs:
● Maintained
● Momentary

NXGpro Communication
Function Manual, AD, A5E33486415A 73
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Table 5-9 Network 1 to 2 Register Copy (9946)

Parameter ID Unit Default Min Max Description


Net 1 to 2 reg. copy 9946 Function Copy Network 1 registers to Network 2
registers.

Network 1 Parameters

Table 5-10 Network 1: Configure Menu (9900)

Parameter ID Unit Default Min Max Description


Network 1 Type 9901 None Designate the type of external network connected to
the drive:
● None
● Modbus
● DeviceNet
● Profibus
● Ethernet Modbus
● ControlNet
● Ethernet I/P
Ethernet Modbus 9906 Internal Select the type of Modbus Ethernet connection to the
Type (CPU) drive:
(only valid for ● Internal (CPU)
NXGpro software
version 6.1 and ear‐ ● Anybus Module
lier)

Table 5-11 Network 1: Configure Parameters Menu (9902)

Parameter ID Unit Default Min Max Description


Velocity Units 9080 % Designate the units for velocity values from
the drive:
● %
● RPM
● Hz
Demand Scalar 9912 1 -125 125 Set the scalar for input demand reference
from the network.
Aux Demand Scalar 9913 1 -125 125 Set the auxiliary scalar for input demand
reference from the network.
Network Timeout 9934 0 0 65535 Set the timeout for network determined to
be non-responsive.

NXGpro Communication
74 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Table 5-12 Network 1: TCP/IP Setup Menu (9300) when "Ethernet Modbus Type" (9906) is set to "Internal CPU" 1

Parameter ID Unit Default Min Max Description


IP Address 9310 172.16.20.16 Set the system TCP/IP address.
Subnet Mask 9320 255.255.0.0 Set the system TCP/IP subnet mask.
Gateway Address 9330 172.16.1.1 Set the system TCP/IP gateway address.
1
Only valid for NXGpro software version 6.1 and earlier

Table 5-13 Network 1: TCP/IP Setup Menu (9902) when "Ethernet Modbus Type" (9906) is set to "Anybus Module"1,2

Parameter ID Unit Default Min Max Description


IP Address 9960 172.16.20.18 Set the system TCP/IP address.
Subnet Mask 9961 255.255.0.0 Set the system TCP/IP subnet mask.
Gateway Address 9962 172.17.1.1 Set the system TCP/IP gateway address.
1
NXGpro software version 6.1 and earlier uses this table or the preceeding table specifiying TCP/IP parameters.
2
NXGpro software version 6.2 and greater uses only this table.

Table 5-14 Network 1: Register Data from Drive Menu (9400)

Parameter ID Unit Default Min Max Description


Data From Drive 01 9401 General Sta‐ Register data from drive parameter 1.
tus Register is not programmable.
Data From Drive 02 9402 Motor Speed Register data from drive parameter 2.
Register is not programmable.
Data From Drive 03 to 64 9403 to None Register data from drive parameters 3 to 64.
9464 Registers are programmable.

Table 5-15 Network 1: Register Data to Drive Menu (9600)

Parameter ID Unit Default Min Max Description


Data To Drive Reg 01 9601 Fixed Reg Register data to drive parameter 1.
Bits Register is not programmable.
Data To Drive Reg 02 9602 Velocity De‐ Register data to drive parameter 2.
mand Register is not programmable.
Data To Drive Reg 03 to 64 9603 to None Register data to drive parameters 3 to 64.
9664 Registers are programmable.

NXGpro Communication
Function Manual, AD, A5E33486415A 75
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Network 2 Parameters

Table 5-16 Network 2: Configure Menu (9914)

Parameter ID Unit Default Min Max Description


Network 2 Type 9915 None Designate the type of external network connected to the
drive:
● None
● Modbus
● DeviceNet
● Profibus
● Ethernet Modbus
● ControlNet
● Ethernet I/P

Table 5-17 Network 2: Configure Parameters Menu (9916)

Parameter ID Unit Default Min Max Description


Velocity Units 9924 Designate the units for velocity values
from the drive:
● %
● RPM
● Hz
Demand Scalar 9926 1 -125 125 Set the scalar for input demand reference
from the network.
Aux Demand Scalar 9927 1 -125 125 Set the auxiliary scalar for input demand
reference from the network.
Network Timeout 9935 0 0 65535 Set the timeout for network determined to
be non-responsive.
IP Address 9936 172.16.20.17 Set the system TCP/IP address.
Subnet Mask 9937 255.255.0.0 Set the system TCP/IP subnet mask.
Gateway Address 9938 172.17.1.1 Set the system TCP/IP gateway address.

Table 5-18 Network 2: Register Data from Drive Menu (9500)

Parameter ID Unit Default Min Max Description


Data From Drive 01 9501 General Sta‐ Register data from drive parameter 1.
tus Register is not programmable.
Data From Drive 02 9502 Motor Speed Register data from drive parameter 2.
Register is not programmable.
Data From Drive 03 to 64 9503 to None Register data from drive parameters 3 to 64.
9564 Registers are programmable.

NXGpro Communication
76 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Table 5-19 Network 2: Register Data to Drive Menu (9700)

Parameter ID Unit Default Min Max Description


Data To Drive Reg 01 9701 Fixed Reg Register data to drive parameter 1.
Bits Register is not programmable.
Data To Drive Reg 02 9702 Velocity De‐ Register data to drive parameter 2.
mand Register is not programmable.
Data To Drive Reg 03 to 64 9703 to None Register data to drive parameters 3 to 64.
9764 Registers are programmable.

5.3.3 Pick List Variable Tables

Table 5-20 Data from Drive Pick List Variables

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

None None None None None None


Man Id None None None None Refer to Appendix Internal Drive Network
General Status 2001 None None Bit Field ● Bit 0: Fault
● Bit 1: Alarm
● Bit 2: Running Forward
● Bit 3: Running Reverse
● Bit 4: Drive Ready
● Bit 5: Start/Stop Control From Network
● Bit 6: Speed Reference From Network
● Bit 7: At Speed Reference
● Bit 8: Speed In Percent
● Bit 9: Speed In RPM
● Bit 10: Speed In Hz
● Bit 11: Reserved for future use
● Bit 12: Reserved for future use
● Bit 13: Reserved for future use
● Bit 14: Reserved for future use
● Bit 15: Reserved for future use
Motor Voltage 2100 Volts /1 Unsigned
Total Current 2190 Amps /1 Unsigned
Output Power 2230 KW /1 Signed
Motor Speed 2014 % /10 Unsigned
RPM /1
Hz /10
Speed Demand 2060 % /100 Unsigned
Speed Reference 2010 % /100 Unsigned
Heartbeat 2220 None None Unsigned 1 count per millisecond

NXGpro Communication
Function Manual, AD, A5E33486415A 77
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Drive State 2210 None None Unsigned ● 0 = Off


● 1 = Magnetizing
● 2 = Spinning Load
● 3 = Autotune
● 4 = Run
● 5 = Stop
● 6 = Coast
● 7 = Up Transfer
● 8 = Down Transfer
Inp RMS Current 2130 Amps /1 Unsigned
Input Frequency 2140 Hz /100 Unsigned
Input Power Avg 2250 KW /1 Unsigned
Net1 Out Reg 1 2002 None None Bit Field Network1Flag0_I - Network1Flag15_I
Net1 Out Reg 2 2003 None None Bit Field Network1Flag16_I - Network1Flag31_I
Net1 Out Reg 3 2004 None None Bit Field Network1Flag32_I - Network1Flag37_I
Net1 Out Reg 4 2005 None None Bit Field Network1Flag48_I - Network1Flag63_I
Net2 Out Reg 1 2006 None None Bit Field Network2Flag0_I - Network2Flag15_I
Net2 Out Reg 2 2007 None None Bit Field Network2Flag16_I - Network2Flag31_I
Net2 Out Reg 3 2008 None None Bit Field Network2Flag32_I - Network2Flag37_I
Net2 Out Reg 4 2009 None None Bit Field Network2Flag48_I - Network2Flag63_I
Torque Current 2150 Amps /1 Unsigned
Magnetizing Cur 2170 Amps /1 Unsigned
Motor Flux 2015 % /100 Unsigned
Motor Torque 2160 % /100 Unsigned
Flux Reference 2011 % /100 Unsigned
Input Voltage 2120 Volts /1 Unsigned
Inp Power Factor 2012 % /100 Unsigned
Input KVars 2013 KVAR /1 Unsigned
Max Available Output 2016 Volts /1 Unsigned
Volts
Hottest Cell Temp 2017 % /100 Unsigned Duty Cycle % of Hottest Cell

NXGpro Communication
78 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Mux1 Echo None None None None Refer to Appendix Multiplexer (MUX) Data
Mux1 Data Registers
Mux2 Echo
Mux2 Data
Mux3 Echo
Mux3 Data
Mux4 Echo
Mux4 Data
Mux5 Echo
Mux5 Data
Mux6 Echo
Mux6 Data
Mux7 Echo
Mux7 Data
Mux8 Echo
Mux8 Data
Wago Inputs 1-16 2650 None None Bit Field ExternalDigitalInput01a_I - ExternalDigita‐
lInput01h_I
ExternalDigitalInput02a_I - ExternalDigita‐
lInput02h_I
Wago Inputs 17-32 2651 None None Bit Field ExternalDigitalInput03a_I - ExternalDigita‐
lInput03h_I
ExternalDigitalInput04a_I - ExternalDigita‐
lInput04h_I
Wago Inputs 33-48 2652 None None Bit Field ExternalDigitalInput05a_I - ExternalDigita‐
lInput05h_I
ExternalDigitalInput06a_I - ExternalDigita‐
lInput06h_I
Wago Inputs 49-64 2653 None None Bit Field ExternalDigitalInput07a_I - ExternalDigita‐
lInput07h_I
ExternalDigitalInput08a_I - ExternalDigita‐
lInput08h_I
Wago Inputs 65-80 2654 None None Bit Field ExternalDigitalInput09a_I - ExternalDigita‐
lInput09h_I
ExternalDigitalInput10a_I - ExternalDigita‐
lInput10h_I
Wago Inputs 81-96 2655 None None Bit Field ExternalDigitalInput11a_I - ExternalDigita‐
lInput11h_I
ExternalDigitalInput12a_I - ExternalDigita‐
lInput12h_I
Wago Outputs 1-16 2656 None None Bit Field ExternalDigitalOutput01a_O - ExternalDigi‐
talOutput01h_O
ExternalDigitalOutput02a_O - ExternalDigi‐
talOutput02h_O

NXGpro Communication
Function Manual, AD, A5E33486415A 79
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Name Manual ID Unit Scaling 16 Bit Data Notes


Type

Wago Outputs 17-32 2657 None None Bit Field ExternalDigitalOutput03a_O - ExternalDigi‐
talOutput03h_O
ExternalDigitalOutput04a_O - ExternalDigi‐
talOutput04h_O
Wago Outputs 33-48 2658 None None Bit Field ExternalDigitalOutput05a_O - ExternalDigi‐
talOutput05h_O
ExternalDigitalOutput06a_O - ExternalDigi‐
talOutput06h_O
Wago Outputs 49-64 2659 None None Bit Field ExternalDigitalOutput07a_O - ExternalDigi‐
talOutput07h_O
ExternalDigitalOutput08a_O - ExternalDigi‐
talOutput08h_O
PFD1 None None None None Refer to Appendix Parameter Read/Write
PFD2
PFD3
PFD4
Drive Losses 2161 % /100 Unsigned
Excessive Reactive 2162 % /100 Unsigned
Current
Speed Droop Percent 2163 % /100 Unsigned
Sync Motor Field Ref 2164 % /100 Unsigned
Avail Reactive Current 3653 % /100 Unsigned
Drive Efficiency 2168 % /100 Unsigned
Ids Ref Current 2276 % /100 Unsigned

NXGpro Communication
80 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Table 5-21 Data to Drive Pick List Variables

Name Unit Scaling 16 Bit Data Notes


Type

None None None None None


Fixed Reg Bits None None Bit Field When parameter 'Net Control Type' (9945) is set
to 'SOP' the bits will be used in the SOP to control
drive functions.
When parameter 'Net Control Type' (9945) is set
to 'Fixed' the bits will be defined as follows in the
control software.
● Bit 0: Run Forward
● Bit 1: Run Reverse
● Bit 2: Fault Reset
● Bit 3: Stop
● Bit 4: Reserved
● Bit 5: Start/Stop Control From Network
● Bit 6: Speed Command From Network
● Bit 7 - 15: Reserved for future assignment
Velocity Demand Hz /10 Signed Speed Demand
RPM 1
% /10
Auxiliary Demand Hz /10 Signed Auxilary Speed Demand
RPM 1
% /10
Net Input Flag 1 None None Bit Field Network 1 SOP flags:
Network1Flag0_I ~ Network1Flag15_I
Network 2 SOP flags:
Network2Flag0_I ~ Network2Flag15_I
Net Input Flag 2 None None Bit Field Network 1 SOP flags:
Network1Flag16_I ~ Network1Flag31_I
Network 2 SOP flags:
Network2Flag16_I ~ Network2Flag31_I
Net Input Flag 3 None None Bit Field Network 1 SOP flags:
Network1Flag32_I ~ Network1Flag47_I
Network 2 SOP flags:
Network2Flag32_I ~ Network2Flag47_I
Net Input Flag 4 None None Bit Field Network 1 SOP flags:
Network1Flag48_I ~ Network1Flag63_I
Network 2 SOP flags:
Network2Flag48_I ~ Network2Flag63_I
Ratio % % / 100 Signed
Forward Max Lim % / 10000 or Unsigned
% / 100
Reverse Max Lim % / 10000 or Unsigned
% / 100

NXGpro Communication
Function Manual, AD, A5E33486415A 81
Modbus Ethernet Communication
5.3 Parameter Assignment/Addressing

Name Unit Scaling 16 Bit Data Notes


Type

Forward Acc Time Seconds / 10 Unsigned


Forward Dec Time Seconds / 10 Unsigned
Reverse Acc Time Seconds / 10 Unsigned
Reverse Dec Time Seconds / 10 Unsigned
Net Input Pulse None None Unsigned
Forward Min Lim % / 10000 or Unsigned
% / 100
Reverse Min Lim % / 10000 or Unsigned
% / 100
Torque Limit % / 10000 or Unsigned
% / 100
MUX1 Id None None None Refer to Appendix Multiplexer (MUX) Data Reg‐
MUX2 Id isters
MUX3 Id
MUX4 Id
MUX5 Id
MUX6 Id
MUX7 Id
MUX8 Id
PTD1 None None None Refer to Appendix Parameter Read/Write
PTD2
PTD3
PTD4
Parallel Cmd 1 None None Unsigned
Torque Demand % / 1000 Unsigned
PVCL Demand % / 100 Unsigned
Flux Demand % / 100 Unsigned
Node Count None None Unsigned
Node Index None None Unsigned
Torque Acc Time Seconds / 100 Unsigned
Torque Dec Time Seconds / 100 Unsigned
Torque Offset None / 1000 Unsigned
Torque Scalar None / 1000 Unsigned
Vars Command % / 1000 Unsigned
No Load I Scalar None / 1000 Unsigned
Avg Field Cur Amps / 10000 Unsigned
Manual Ids Demand % / 1000 Unsigned
Avg Ids Ref Amps /10000 Unsigned

NXGpro Communication
82 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.4 Planning/Configuring

5.4 Planning/Configuring
This section describes the setup methods available for communication. The following topics
are explained:
● Fast setup procedures
● Network interfaces
● Network setup procedure
● Network status detection
● An example to illustrate the setup procedure.

Note
Fast setup procedures allow setup of a Network 1 interface with a minimum of detail.

5.4.1 Fast Setup: Control the drive using the default configuration
To control the drive using the default configuration, you must send commands to the drive's
'fixed reg bits' location. This location is register 'Data to Drive 01' as provided in
Table Correspondence between Drive Parameter ID and Communication Protocol Address in
Section Parameter Assignment/Addressing.
To control the drive from a PLC using the default configuration, complete the following steps.
1. Set parameter 'Network 1 Type' (9901) to "Ethernet Modbus". This setup assumes that an
existing working TCP/IP network is established.
2. Verify the network settings for the parameters 'Subnet Mask' and 'Gateway Address' . Refer
to Tables titled Network 1: TCP/IP Setup Menu. and Network 1: TCIP/IP Setup Menu
located in the previous section of this chapter to find the parameter numbers for the
'Gateway Address' and the 'Subnet Mask' based on the NXGpro software version and
hardware configuration.
3. Set parameter 'IP Address'. The IP address must be unique to the drive. Refer to Tables
titled Network 1: TCP/IP Setup Menu. and Network 1 : TCIP/IP Setup Menu located in the
previous section of this chapter to find the parameter number for the 'IP Address' based on
the NXGpro software version and hardware configuation.
4. Set parameter 'Net Control Type' (9944) to "Fixed". This sets the bits at register 'Data to
Drive 01' where the fixed register bits are located. The fixed register bits are interpreted as
shown in the following table.
5. Add the following line to the SOP:
Network1RunEnable_O = TRUE;

Table 5-22 Default definitions of Fixed Register Bits

Bit Default Definition


Network1FixedRegBit0_I Run forward
Network1FixedRegBit1_I Run reverse

NXGpro Communication
Function Manual, AD, A5E33486415A 83
Modbus Ethernet Communication
5.4 Planning/Configuring

Bit Default Definition


Network1FixedRegBit2_I Fault reset
Network1FixedRegBit3_I Stop1
Network1FixedRegBit4_I Reserved
Network1FixedRegBit5_I Start stop control from network
Network1FixedRegBit6_I Speed commanded from network
Network1FixedRegBit7_I
Network1FixedRegBit8_I
Network1FixedRegBit9_I Reserved for future assignment
Network1FixedRegBit10_I
Network1FixedRegBit11_I
Network1FixedRegBit12_I
Network1FixedRegBit13_I
Network1FixedRegBit14_I
Network1FixedRegBit15_I
1
Network1FixedRegBit3_I functions as a drive stop control bit only if parameter 'Start Stop Control'
(9945) is set to "Momentary". Otherwise this bit is reserved.

Note
To run the drive, the PLC must send 0x21 to register 'Data to Drive 01'. This hexadecimal value
sets bit 0 (run) and bit 5 (start/stop control from network).
To stop the drive, the PLC must send 0x08 or 0x00 to register 'Data to Drive 01'.

5.4.2 Fast Setup: Monitor drive status and speed feedback


To read status data from the drive, complete the following steps:
1. Set parameter 'Network 1 Type' (9901) to "Ethernet Modbus". This setup assumes that an
existing working TCP/IP network is established.
2. Verify the network settings for the parameters 'Subnet Mask' and 'Gateway Address' . Refer
to Tables titled Network 1: TCP/IP Setup Menu. and Network 1: TCIP/IP Setup Menu
located in the previous section of this chapter to find the parameter numbers for the
'Gateway Address' and the 'Subnet Mask' based on the NXGpro software version and
hardware configuration.
3. Set parameter 'IP Address'. The IP address must be unique to the drive. Refer to Tables
titled Network 1: TCP/IP Setup Menu. and Network 1 : TCIP/IP Setup Menu located in the
previous section of this chapter to find the parameter number for the 'IP Address' based on
the NXGpro software version and hardware configuation.

NXGpro Communication
84 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.4 Planning/Configuring

4. Set parameter 'Velocity Units' (9080) to the desired motor speed units.
5. Refer to the Table Correspondence between Drive Parameter ID and Communication
Protocol Address in Section Parameter Assignment/Addressing to obtain the addresses for
general status (Data from Drive 01) and motor speed feedback (Data from Drive 02) from
the drive.
– 'Data from Drive 01' (9401) is read by sending the read register request in address
40001.
– 'Data from Drive 02' (9402) is read by sending the read register request in address
40002, and so on.
The general drive status bits found in register 'Data from Drive 01' are defined in the following
table.

Table 5-23 Default definitions of General Status Bits

Bit number Meaning in drive control soft‐ Value


ware
0 Fault
1 Alarm
2 RunningForward
3 RunningReverse
4 DriveReady
5 StartStopControlFromNetwork
6 SpeedFromNetwork
7 AtSpeedReference
8 SpeedInPercent 0 = False; 1 = True
9 SpeedInRPM
10 SpeedInHz
11 Reserved for future use
12 Reserved for future use
13 Reserved for future use
14 Reserved for future use
15 Reserved for future use

Note
You cannot reprogram the drive's default interpretation of output bits.

Refer to Network Setup Procedure for details on how to read other drive data.

NXGpro Communication
Function Manual, AD, A5E33486415A 85
Modbus Ethernet Communication
5.4 Planning/Configuring

5.4.3 Fast Setup: Send a motor speed setting to the drive


1. Using parameter 'Velocity Units' (9080), set the desired speed units to be sent to the drive,
to one of the following options:
– %
– RPM
– Hertz
2. The PLC needs to send the desired speed setting to the drive in register 'Data to Drive 02' .
This register is reserved to hold speed settings only, as noted in Table Correspondence
between Drive Parameter ID and Communication Protocol Address in Section Parameter
Assignment/Addressing.
3. Send 0x61 in register 'Data to Drive 01' . The motor now accepts the speed setting from the
PLC.

5.4.4 Fast Setup: Control the drive using user-defined bits controlled by the SOP
To control the drive using non-default configuration, you must redefine the fixed register bits at
register 'Data to Drive 01'.

Note
The 'fixed reg bits' location is fixed at register 'Data to Drive 01', whether the default
configuration is used or not.
You cannot reprogram the 'fixed reg bits' location.
You can reprogram the definition of the bits at this address.

To control the drive this way, complete the following steps.


1. Set parameter 'Network 1 Type' (9901) to "Ethernet Modbus". This setup assumes that an
existing working TCP/IP network is established.
2. Verify the network settings for the parameters 'Subnet mask' and 'Gateway address' . Refer
to Tables titled Network 1: TCP/IP Setup Menu. and Network 1: TCIP/IP Setup Menu
located in the previous section of this chapter to find the parameter numbers for the
'Gateway Address' and the 'Subnet Mask' based on the NXGpro software version and
hardware configuration.
3. Set parameter 'IP Address'. The IP address must be unique to the drive. Refer to Tables
titled Network 1: TCP/IP Setup Menu. and Network 1: TCIP/IP Setup Menu located in the
previous section of this chapter to find the parameter number for the 'IP Address' based on
the NXGpro software version and hardware configuation.
4. Set parameter 'Net Control Type' (9944) to "SOP". This makes the definitions of the fixed
register bits in register 'Data to Drive 01' programmable.

NXGpro Communication
86 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.4 Planning/Configuring

5. Next, set up the drive to correspond with the bits you want to use in the SOP. Refer to
Section Software Programming to find the bits and locate the associated keypad pick list
variable, and use the procedures detailed in this section to complete set up.
6. To enable speed settings from the network, add the following line to the SOP file:
RawDemandNetwork1_O = true;

See also
Software Programming (Page 68)

5.4.5 Network Interfaces


The NXGpro Control is equipped with a high performance 32-bit Ethernet chipset which is fully
compliant with IEEE 802.3 100 MBPS CSMA/CD standards.
● It uses a dedicated standard RJ-45 port located on the front of the CPU board that supports
Network 1.
● The Anybus™ Modbus™ Ethernet module uses a standard RJ-45 port located on the
module to support Network 2.
Possible configurations for Ethernet communication between an Modbus™ Ethernet device
and the NXGpro Control software are described below. Choose a configuration based on the
site infrastructure.

Direct Ethernet Connection


Direct connection is intended for a single Modbus™ Ethernet device that is connected to the
drive using an Ethernet crossover cable. This cable allows direct connection to the drive without
a hub or server.

(WKHUQHW0RGEXV'HYLFH 1;*SUR&RQWURO

&URVVRYHUFDEOH
DQGFRXSOHU

Figure 5-3 Direct Modbus Ethernet Communication Connection

The following hardware is required for this connection method:


● Crossover patch cable
● Coupler

NXGpro Communication
Function Manual, AD, A5E33486415A 87
Modbus Ethernet Communication
5.4 Planning/Configuring

Multiple Drive LAN Ethernet Connection


To use the LAN connection to control one or more drives on an existing network complete the
following steps:
● Assign a unique IP address to each drive.
● Set the menu items of the TCP/IP Setup Menu (9300) for each drive.
● For Network 1, set the following menu items based on the settings unique to the network.
Verify the network settings for the parameters 'IP Address", 'Subnet Mask' and 'Gateway
Address'. Refer to Tables titled Network 1: TCP/IP Setup Menu. and Network 1 : TCIP/IP
Setup Menu located in the previous section of this chapter to find the parameter numbers for
"IP Address', 'Subnet Mask' and the 'Gateway Address' based on the NXGpro software
version and hardware configuration.
● For Network 2, set the following menu items based on the settings unique to the network:
– IP Address (9336)
– Subnet Mask (9337)
– Gateway Address (9338)
Refer to Table Network 2 Configure Parameters Menu (9916) in Section Parameter
Assignment/Addressing of this chapter.

1;*SUR&RQWURO

(WKHUQHW,3'HYLFH +XE

1;*SUR&RQWURO

Figure 5-4 Network Modbus™ Ethernet Communication Connection

The following hardware is required for this connection method:


● EtherFast 10/100 hub
● Ethernet Cat5 cable

NXGpro Communication
88 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.4 Planning/Configuring

5.4.6 Network Setup Procedure

Note
Setup functions are contained in the Configure Parameters Menu (9902), which is a submenu
of the Communications Menu (9).
Access is security-controlled at level 7; you must enter the security code to access these
parameters.
Refer to the NXGpro Control Operating Manual for further information on security access levels
and codes.

Use the following procedure to complete network setup. Refer to Table Configure Parameters
Menu (9902) in Section Parameter Assignment/Addressing for the menus needed to complete
setup.

Procedure
1. Select a protocol using parameter 'Network 1 Type' (9901). Scroll to "Ethernet/IP" and press
[ENTER]. The configuration parameters are viewable.
2. Set parameter 'Velocity Units' (9080) to the desired motor speed units for motor
commanded speed and motor feedback speed scaling.
3. Where necessary, set parameter 'Demand Scalar' (9912) to:
n x command speed where –125 % to 125 %
4. Set parameter 'Aux Demand Scalar' (9913) if used.
5. Use Table Correspondence between Drive Parameter ID and Communication Protocol
Address in Section Parameter Assignment/Addressing to program the drive to send data to
and receive commands from the network. The table provides all available addresses with
corresponding parameter ID as well as pre-programmed addresses, which provide basic
drive send and receive functionality and are not changeable.
6. Define the bits in the available addresses using one of the following methods:

NXGpro Communication
Function Manual, AD, A5E33486415A 89
Modbus Ethernet Communication
5.4 Planning/Configuring

● Enter from a choice of variables in the pick lists. The pick lists in the menus contain the most
commonly used data variables. Refer to Section Parameter Assignment/Addressing for the
pick lists.
Note
A pick list item can only be used once for each 'Data to Drive' register.

● For 'Data from Drive' registers, choose pick list option "Man Id" (manual ID) to manually
enter a variable that is not included in the pick lists, using the output data ID number. Use
the list of data IDs available in Appendix Output Data IDs to locate the variable and use the
corresponding ID number to enter the variable into the 'Data from Drive' register.
Note
The output data ID number is not the same as a parameter ID number.

● Custom program using the drive's SOP. Refer to Section Software Programming for details.
Note
The PLC can receive data from the drive without any changes to the SOP.
Only if you need to control the drive through the network will you need to set any flags in the
SOP.

See also
Output Data IDs (Page 263)
Software Programming (Page 103)

Set flags in the SOP for drive control through a network


Ensure the SOP file has the necessary code to enable control of the drive over a network:
1. To control the drive through a network by sending commands to the drive, the following
network control flag must be in the source code of the drive's SOP:
Network1RunEnable_O = TRUE;
2. To control the drive through a second network, the following network control flag must be in
the source code of the drive's SOP:
Network2RunEnable_O = TRUE;

5.4.7 Network Status Detection Setup


An SOP flag is available to show the network status:
● For network 1: Network1CommOk_I
● For network 2: Network2CommOk_I
The SOP flag is set to "1" (true) when the network connection is operating normally, and "0"
(false) when it is not operating normally.

NXGpro Communication
90 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.4 Planning/Configuring

The network status cannot be automatically detected. Instead, a "Pulse Timeout" method is
used to set the network status flags.
The "Pulse Timeout" status detection must be set up in the menu system, and has to be
“strobed” by a network device that is communicating with the drive.

Procedure for Pulse Timeout Setup


1. Pick one of the 62 selectable "Data to Drive" registers and set the pick list item to "Net Input
Pulse".
2. Set parameter 'Network Timeout' (9934) for network 1 and (9935) for network 2, in the
'Config Parameters' menu, to a value (in seconds) to activate the network timeout. 0
seconds = disable timeout.

Pulse Timeout Operation


● A network device must set a unique (different) value into the "Net Input Pulse" register
before an internal timer reaches the "Network Timeout" value.
● If the network device writes a unique value, the network status flag is set to "1" and the
internal timer is reset.
● If the network device fails to write a unique value to the "Net Input Pulse" register before the
internal timer times to the value set by the "Network Timeout" parameter then the status flag
is set to "0".

5.4.8 Setup Example

Task
Set up network to indicate the following drive outputs on the PLC:
● general status
● motor speed
● output power
● number of active faults.

Procedure
Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address in Section Parameter Assignment/Addressing to establish whether an address or
register is changeable.
To indicate general status and motor speed:
1. The table shows that:
● 'Data from Drive 01' is not changeable; it is set to indicate general status. No action is
required.
● 'Data from Drive 02' is not changeable; it is set to indicate motor speed. No action is required.

NXGpro Communication
Function Manual, AD, A5E33486415A 91
Modbus Ethernet Communication
5.4 Planning/Configuring

To indicate output power:


1. The table shows that 'Data from Drive 03' is changeable, this can be set to indicate output
power.
2. Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address to determine that the corresponding parameter ID is 9403.
3. Enter parameter ID 9403.
4. Choose "output power" from the pick list.
The output power will be sent to the PLC using register 'Data from Drive 03'.
To indicate the number of active faults:
1. The table shows that 'Data from Drive 04' is changeable, this can be set to indicate the
number of active faults.
2. Refer to Table Correspondence between Drive Parameter ID and Communication Protocol
Address to determine that the corresponding parameter ID is 9404.
3. Enter parameter ID 9404.
4. The pick list of data from drive variables appears. As "number of active faults" is not an
option in the pick list, you must specify it manually.
5. Refer to Table Data From Drive Pick List Variables in Section Parameter Assignment/
Addressing for a list of 'data from drive' pick list variables.
Since "number of active faults" is not a choice in the pick list, instead choose "Man Id"
(manual ID). The display shows "ManId-0000".
6. Refer to Appendix Output Data IDs and locate "number of active faults" in the tables to
determine its data ID number (3000).
7. Use arrow or number keys to enter 3000, and press [ENTER]. The display now shows
"ManId-3000".
The number of active faults will be sent to the PLC using register 'Data from Drive 04'.
● If the data ID number is not found, the error message "Invalid Id Entered" is displayed.
Ensure that the data ID is correct.

Table 5-24 Completed Settings for Given Example

PLC Address or Register Data Scaling


Data from Drive 01 (not changeable) General status 16 bits
Data from Drive 02 (not changeable) Motor speed RPM
Data from Drive 03 Output power kW
Data from Drive 04 Number of faults 0 to 128

See also
Correspondence between Drive Parameter ID and Communication Protocol Address (Page 72)

NXGpro Communication
92 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.5 Functions

5.5 Functions

Supported Command Set


The NXGpro Control implements the following Modbus™ commands:
● Read holding registers (function code 0x03)
● Write single register (function code 0x06)
● Write multiple registers (function code 0x10)
Commands are issued by the Modbus™ master (PLC) and sent over the network to the
Siemens slave[s]. The request and response message prefix for all codes is a 6 byte prefix, as
defined in the following table.

Definition of Byte Number


Transaction identifier usually 0 (copied by server)
Transaction identifier usually 0 (copied by server)
Protocol identifier 0
Protocol identifier 0
Length field (upper byte) 0 (all messages are less than 256 bytes)
Length field (lower byte) number of bytes to follow

Commands are listed and described in the sections that follow.

5.5.1 Read Holding Registers Command (0x03)

Description
The "read holding registers" command allows the Modbus master to read up to 64 consecutive
memory registers from the drive.

Example
A sample of a "read holding registers" request to read 2 registers (40005 and 40006) and the
associated response, in hexadecimal, is given below.

Read Holding Registers Command


TX (Request) 01 03 00 04 00 02 -- --
RX (Response) 01 03 04 04 A5 90 B1 -- --

The meaning of the sample request and associated response is detailed in the following tables.

NXGpro Communication
Function Manual, AD, A5E33486415A 93
Modbus Ethernet Communication
5.5 Functions

Request Details

Table 5-25 Read Holding Registers Request (TX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x03 Read holding registers command
Starting Address (high) 0x00 Register number 40005
Starting Address (low) 0x04
Number of Registers to Read (high) 0x00 Read 2 (0x0002) registers
Number of Registers to Read (low) 0x02

Response Details

Table 5-26 Read Holding Registers Response (RX) from Drive

Field Name Value (in Hex) Actual Result Scaled Value Description
Transaction identifier 0
Transaction identifier 0
Protocol identifier 0
Protocol identifier 0
Length field (upper 0
byte)
Length field (lower Number of bytes to
byte) follow
Slave Address 0x01 N/A N/A 0x01 = 1 decimal
Function 0x03 N/A N/A Read holding registers
command
Byte Count 0x04 N/A N/A 4 bytes in response
Data Value 1 (MSB) 0x04 0x04A5 This register is user program‐ High byte of item 1
Data Value 1 (LSB) 0xA5 mable. See Table Register Da‐ Low byte of item 1
ta from Drive Menu (9400).
Data Value 2 (MSB) 0x90 0x90B1 High byte of item 2
Data Value 2 (LSB) 0xB1 Low byte of item 2

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

NXGpro Communication
94 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.5 Functions

Note
For responses received from the drive such as in Table Read Holding Registers Response
(RX) from Drive , the keypad parameter 'Velocity Units' (9080) is set to "Percent" by default.
Scaled values differ depending on how this parameter is configured. This is described in
Table Configure Parameters Menu (9902) in Section Parameter assignment/addressing.
Refer to Table General Data Register Assignments in Appendix Output Data IDs for data
scaling.

5.5.2 Write Single Input Register Command (0x06)

Description
The "write input register" command allows the Modbus master to write a value to a specified
input register in the drive.

Example
A sample of a "write input register" request to write a value to register 40067 and the associated
response, in hexadecimal, is given below.

Write Input Register Command


TX (Request) 01 06 00 42 00 64 -- --
RX (Response) 01 06 00 42 00 64 -- --

The meaning of the sample request and associated response is detailed in the following table.

Request Details

Table 5-27 Write Input Register Request (TX) from Master

Field Name Value (in Hex) Notes


Slave Address 0x01 0x01 = 1 decimal
Function 0x06 Write input register command
Register Address (high) 0x00 Register number 40067
Register Address (low) 0x42
Preset Data (high) 0x00 Value = 100
Preset Data (low) 0x64

NXGpro Communication
Function Manual, AD, A5E33486415A 95
Modbus Ethernet Communication
5.5 Functions

Response Details
The write input register response (RX) from the drive is an echo of the request and therefore is
identical; refer to table above.

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

5.5.3 Write Multiple Input Registers Command (0x10)

Description
The "write multiple input registers" command allows the Modbus master to write up to 64 values
(in a single command) to multiple input registers in the drive.

Example
A sample of a "write multiple input registers" command to write to 2 registers and the
associated response, in hexadecimal, is given below.

Write Multiple Input Registers Command


TX (Request) 01 10 00 43 00 02 04 00 64 24 E3 -- --
RX (Response) 01 10 00 43 00 02 -- --

The meaning of the sample request and associated response is detailed in the following tables.

Request Details

Table 5-28 Write Multiple Input Registers Request (TX) from Master

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x10 Write multiple input registers command
Starting Address (high) 0x00 Register number 40068
Starting Address (low) 0x43
Number of Registers (high) 0x00 Write to 0x0002 (2) registers
Number of Registers (low) 0x02
Byte Count 0x04 4 bytes total
Preset Data 1 (high) 0x00 Value = 0x0064 (100 decimal)
Preset Data 1 (low) 0x64
Preset Data 2 (high) 0x24 Value = 0x24E3 (9443 decimal)
Preset Data 2 (low) 0xE3

NXGpro Communication
96 Function Manual, AD, A5E33486415A
Modbus Ethernet Communication
5.5 Functions

Response Details

Table 5-29 Write Multiple Input Registers Response (RX) from Drive

Field Name Value (in Hex) Description


Slave Address 0x01 0x01 = 1 decimal
Function 0x10 Write multiple input registers command
Starting Address (high) 0x00 Register number 40068
Starting Address (low) 0x43
Number of Registers (high) 0x00 Write to 0x0002 (2) registers
Number of Registers (low) 0x02

Note
Parameter names and their corresponding data ID numbers are listed in Appendix Output Data
IDs.

NXGpro Communication
Function Manual, AD, A5E33486415A 97
Modbus Ethernet Communication
5.5 Functions

NXGpro Communication
98 Function Manual, AD, A5E33486415A
Ethernet / IP Communication
6.5 Planning/Configuring

PLC Address or Register Data Scaling


Data from Drive 03 Output power kW
Data from Drive 04 Number of faults 0 to 128

NXGpro Communication
Function Manual, AD, A5E33486415A 125

You might also like