You are on page 1of 31

Quick start guide

Modbus TCP communication between X2


control and BFI-E3
SER0020 – X2 control communication with BFI-E3 by Modbus TCP
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

1 Function and area of use


This document provides guidelines when working with X2 control as Modbus TCP master in
CODESYS/ BCS Tools communicating with Beijer Frequency Inverter, BFI-E3 or gateway
OPT-2-ETHG-IN. Please note:
• It does not work towards BFI-H3 or BFI-P2 with Modbus TCP option boards.
• It is not possible to run Modbus RTU and Modbus TCP at the same time.
• This project contains three BFI-E3 with built-in Ethernet, Modbus TCP.

2 About this document


This quick start document should not be considered as a complete manual. It is an aid to be able
to startup a normal application quickly and easily.

Copyright © Beijer Electronics, 2020


This documentation (below referred to as ‘the material’) is the property of Beijer Electronics. The holder or user has a
non-exclusive right to use the material. The holder is not allowed to distribute the material to anyone outside his/her
organization except in cases where the material is part of a system that is supplied by the holder to his/her customer.
The material may only be used with products or software supplied by Beijer Electronics. Beijer Electronics assumes no
responsibility for any defects in the material, or for any consequences that might arise from the use of the material. It is
the responsibility of the holder to ensure that any systems, for whatever applications, which is based on or includes the
material (whether in its entirety or in parts), meets the expected properties or functional requirements. Beijer Electronics
has no obligation to supply the holder with updated versions.

Use the following hardware, software, drivers and utilities in order to obtain a stable application:

In this document we have used following software and hardware

Software:
• CODESYS V3.5 SP13 Patch3
• BCS Tools 3.30
• iX Developer 2.40 SP5
• BFI-Tools 2.7.0.0
• Web Browser Chrome

Hardware:
• X2 control or BoX2 pro SC or X2 marine SC or X2 extreme SC
• BFI-E3-……….-MTP (MTP means built-in Modbus TCP), Firmware 3.09

For further information refer to


• BFI-E3 User Guide
• BFI-E3 Start-Up Manual KI00369B
• Installation Manual X2 pro, X2 marine, X2 control
• Beijer Electronics knowledge database, HelpOnline

This document and other quick start documents can be obtained from our homepage. Please use
the address support.europe@beijerelectronics.com for feedback.
Normal.dotm, 2020-07-01

2 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

3 Table of Contents
1 Function and area of use .........................................................................................2
2 About this document ..............................................................................................2
3 Table of Contents ..................................................................................................3
4 System set up ......................................................................................................4
5 Hardware ............................................................................................................5
Modbus TCP port of X2 control ........................................................................... 5
IP-address setting in X2 control .......................................................................... 5
Modbus TCP port of BFI-E3 ................................................................................ 6
Indication of status on LED of BFI-E3 .................................................................... 7
6 Web server in BFI-E3 ..............................................................................................8
Module Configuration ...................................................................................... 8
Network Statistic ........................................................................................... 8
Modbus Statistics ........................................................................................... 9
How to change IP-address and Network mask .......................................................... 9
7 Connect BFI-Tools to BFI-E3 through Ethernet ............................................................ 10
Parameter settings for Modbus TCP in BFI-E3 ........................................................ 11
Ethernet Cyber Security control ........................................................................ 11
8 Function Block X2_BFI_E3_ModbusTCP ..................................................................... 12
9 Program example CODESYS, BCS Tools and iX Developer ................................................ 14
Explanation of the CODESYS/BCS Tools project ...................................................... 14
Enable/Disable Devices .................................................................................. 16
Ethernet setting in CODESYS/BCS Tools ............................................................... 17
iX-project .................................................................................................. 20
10 Troubleshooting Communication problems ................................................................. 21
11 Modbus Register Mapping BFI-E3 ............................................................................. 23
Table 1: Control and status registers .................................................................. 23
Write registers ............................................................................................ 24
Read registers ............................................................................................. 25
Parameters ................................................................................................ 26
Modbus Exception Response Telegrams ............................................................... 29
Register Changes for Single Phase Output Drives .................................................... 30
12 About Beijer Electronics ....................................................................................... 31
Contact us ................................................................................................. 31
Global offices and distributors ........................................................................................... 31
Normal.dotm, 2020-07-01

3 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

4 System set up
Here comes a short description of what needs to be done and what tools are to be used to make X2
control work together with one or several BFI-E3-…..-MTP in a Modbus TCP network:

1. Set up of IP-address of BFI-E3-……-MTP.


Use the Web browser in BFI-E3 and IP address 192.168.1.253. Make sure IP-address
corresponds with the BFI-E3 setting in CODESYS/BCS Tools. See chapter 6.4
2. Set up parameters in BFI-E3….-MTP
Either set them up on the display of BFI-E3, PC software BFI-Tools or a device with BFI-Tools
Mobile. See chapter 7.1
3. Software enable needs to be activated by a jumper between terminal 1 and 2 of BFI-E3
4. Set up the IP-address of X2 control. See chapter 8.1
5. Connect the patch cable from X2 control, port LAN B, to ethernet port P1 of BFI-E3
6. Download the PLC-project to X2 control. Use BCS Tools 3.30 or later or CODESYS V3.5
SP13 Patch3 for the PLC-project.
7. Download the iX-project to X2 control. Use iX Developer 2.40 SP5 or later.
Normal.dotm, 2020-07-01

4 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

5 Hardware
The following chapter describes the ethernet connections of X2 control and BFI-E3.

Modbus TCP port of X2 control


X2 control has 2 ethernet ports to be used for Modbus TCP, either LAN A or LAN B.
This program example is using LAN B for Modbus TCP communication.

IP-address setting in X2 control


The setting of the Ethernet ports in X2 control is being done on the X2 control itself.
Turn Power on and keep your finger attached to the screen. After a while follow the instructions as in the
picture below.
Normal.dotm, 2020-07-01

5 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Modbus TCP port of BFI-E3


BFI-E3 of all voltages and current ratings exists in two versions, one with and one without built-in Modbus
TCP. Modbus TCP is available in all BFI-E3 with the extension -MTP. For example:

Without Ethernet ports:


BFI-E3-12-0023-1F1A, Item number 63510
General Purpose Inverter 0,37kW, 2,3A, Input 1x230 V AC, Output 3x230 V AC, IP66, No Brake
transistor, EMC, Size 1

With Ethernet ports:


BFI-E3-12-0023-1F1A-MTP, Item number 63510-MTP
General Purpose Inverter 0,37kW, 2,3A, Input 1x230 V AC, Output 3x230 V AC, IP66, 2 Ethernet Modbus
TCP ports, No Brake transistor, EMC, Size 1

The 2 Ethernet ports are marked P1 and P2 and have the same IP-address.
The 2 ports on the left side marked D1 and D2 are serial ports not intended for Ethernet. Faulty connection
of cables might cause damage to either BFI-E3 or other equipment.
Normal.dotm, 2020-07-01

6 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Indication of status on LED of BFI-E3


Example of LED indication of ethernet ports in BFI-E3.

Communication working Communication interruption

Network Status Indicator, NS


State Indication
Steady Off BFI is not powered up or no IP address
Flashing Green Online, no Modbus TCP connections active
Steady Green Online, Modbus TCP connections active
Flashing Red Connection Timeout after working Modbus TCP connection
Steady Red Duplicate IP address
Normal.dotm, 2020-07-01

7 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

6 Web server in BFI-E3


Default IP-address of BFI-E3 is 192.168.1.253 and Subnet: 255.255.255.0
Enter IP-address in the web browser. Username is Admin and Password is the serial number of the BFI.

Module Configuration

• OPT-3-MTPIG-BFI is the name for the internal Modbus TCP board .


• The serial number is the identification for the complete BFI.
• Hardware version is 0419
• Latest available firmware in October 2020 is V101 R003 S0168

Network Statistic

• 192.168.1.29 is the IP-address of the PC. Local port 80 with Socket type TCP is the web browser
Normal.dotm, 2020-07-01

connection with BFI.

8 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

• 192.168.1.29 is the IP-address of the PC. Local port 47850 with Socket type TCP is PC-program BFI-
Tools running on the PC.

• 192.168.1.40 is the IP-address of one X2-Control.

Modbus Statistics
Correct working communication without any fault should look like below. Counter of Transmitted,
Received and Successful Transmissions are calculating upwards Error counters stays at 0.

How to change IP-address and Network mask


• Enter new IP-address and/or Network Mask
• Push on Apply New Values
Normal.dotm, 2020-07-01

9 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

7 Connect BFI-Tools to BFI-E3 through Ethernet


BFI-Tools can only communicate with one BFI-E3 at a time. How to set up the communication is:

- Choose way of communication with BFI.

1. Chose Ethernet Module.


2. Set the Local PC IP-adress to 192.168.1.x were 0 < x < 250
3. Re-Scan Network to find BFI-E3s in the network or tap in the IP-adress manually
4. All BFI-E3 available in the Network will appear.
5. Chose which BFI-E3 to communicate with. Then push connect to start up communication.

And after connection BFI-Tools works in exactly the same way as when using other ways of communication.
Normal.dotm, 2020-07-01

10 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Parameter settings for Modbus TCP in BFI-E3


Set following parameters in BFI-E3-….-MTP
- P12=3. Modbus TCP control with Acceleration and Deceleration time in parameter P-03/ P-04.
- P12=4. Modbus TCP control with Acceleration and Deceleration time sent by Modbus TCP.

Adjust if necessary
- P14=201 to make all parameters available.
- P36 = Station number must be 1.
- P36 = Communication speed must be 115,2 Kbits/sec.
- P36 = Timeout.
t => BFI will trip when no communication
r => BFI will coast to stop
Function can either be disabled by setting 0 second or set to 30, 100, 1000 or 3000 milliseconds

Ethernet Cyber Security control


There are two parameters, P-61 and P-62, intended for cyber security control. By combining these two
parameters it is possible to restrict access to the Webserver of the drive. But Modbus TCP is working
properly. These two parameters are available in BFI-E3 with firmware version 3.09 and later. It works
according to table below.

P-61 is Cyber Security Access. 0 = Disable, 1=Enable All service


P-62 is Cyber Security Reset Timeout. 0 = No Cyber security, 1-60 minute

Function P-61 P-62 Explanation


[minutes]
No Cyber Security control Any Value 0 Always access to the ethernet port of BFI
No Cyber Security control 0 1-60 Always access to the ethernet port of BFI
Enable all service 0 1-60 All services are enabled from P-61 is set to 1
changed to until time in P-62 has elapsed. After that there is
1 no access to the Web browser and parameter P-
61 is turned back to zero
Normal.dotm, 2020-07-01

11 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

8 Function Block X2_BFI_E3_ModbusTCP

Information Description
Library X2 BFI-E3 Modbus TCP
Versions in CODESYS CODESYS runtime 3.5.13.30.7
and BCS Tools Compiler: 3.5.13.30
Device (Beijer X2 control) 3.5.13.30
iX image 775 or later
Ethernet: 3.5.13.0
Modbus_TCP_Master: 3.5.13.0
Modbus_TCP_Slave: 3.5.12.0
Function Block X2_BFI_E3_ModbusTCP
Functionality This function block is used to control and Read/Write Data
with a BFI-E3..-MTP by Modbus TCP
PLC Types X2 control or BoX2 pro SC or X2 marine SC or X2 extreme SC
Version 1.0.0

Input_Output Type Function


io_Drive strDRIVE_REF_BFI Reference to variables connected to BFI by Modbus TCP.
io_BFI ModbusTCPSlave Connection to Modbus slave (Name of the Modbus Slave)
io_BEHMI strBFIDrvBEHMI Reference to variables from/to HMI
Normal.dotm, 2020-07-01

12 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Input Type Function


i_Start BOOL Start of Drive. 0=>Stop 1=>Running.
Direction decided by sign of Set frequency.
i_FastStop BOOL 1=>Fast stop of motor with ramp in P2-25 for BFI-P2/H3.
i_CoastingStop BOOL 1=> Coasting stop of motor. No output frequency.
i_SetFrequency REAL Set frequency for motor, 50.0=50.0 Hz. Positive value => Rotation
clockwise. Negative value=> Rotation counter clockwise.
i_AccDecTime REAL Used if P-12=4. If so, Acceleration and Deceleration time [0.1 sec].
i_Reset BOOL Reset an alarm or error message from BFI.
i_PrmReadExecute BOOL Read a value from a Parameter in BFI.
i_PrmWriteExecute BOOL Write a value to a Parameter in BFI.
i_PrmNumber INT Specifies parameter number to be read or written.
Input_Output Type Function
io_PrmValue INT Value to be written to a parameter or read value from a parameter.
Output Type Function
o_ComOk BOOL Status of Communication.
o_CommunicationStat UINT Status of Communication
e 0= No Slave
1=TCP connect request
2=TCP connection established
3=TCP connection aborted
4=TCP Socket error.
o_BEHMIEnabled BOOL BeHMI override enabled.
o_ReadyToRun BOOL FI Ready to run. Power ON, Enabled, Safety ok.
o_SafetyOff BOOL Not available for BFI-E3
o_Run BOOL Start signal received by BFI.
o_Auto BOOL Not available for BFI-E3
o_MotorCurrent REAL Motor current / A.
o_OutputFrequency REAL Output frequency / Hz.
o_RunningHours INT Total Running Hours / Hours.
o_Alarm BOOL Alarm in inverter.
o_AlarmCode STRIN Error code of the alarm, read automatically.
G
o_PrmDone BOOL Read or Write of parameter has been done.
o_DriveInfo STRIN Drive ID, Type, Voltage, Firmware version, serial number.
G
o_PrmError BOOL Parameter operation error or not allowed message was sent to BFI.
o_ErrorDescription STRIN Error and status description.
G
Normal.dotm, 2020-07-01

o_CommErrorCounter UDINT Total number of errors or interruptions of communication messages


on the bus since PLC was put into Run. Can’t be reseted by user.

13 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

9 Program example CODESYS, BCS Tools and iX Developer


BFI and X2 control Start Up project is a very powerful tool providing a project starting point way beyond what
would otherwise be possible. It is tested to a great extent and its use is strongly recommended.
The project contains one HMI-screen to handle the BFI, start/stop, read/write parameters, read type of BFI,
handling alarms. The purpose of the screen is to keep them for future use by technicians and/or maintenance
personnel. In addition, the project contains a CODESYS/BCS Tools PLC-program correctly configured for
use with BFI with a function block comprising all standard drive functionality.

Explanation of the CODESYS/BCS Tools project

1. Device (X2 control 4 – Powerfail)


The X2 control hardware must be defined in detail due to allocation of memory. In this case a 4 inch.
How to handle Retain data at Power interruption must also be chosen. Either cyclic storage or when
power interruption occurs. With limited Retain data Powerfail is a sufficient choice. Should be at least
version 3.5.13.30. This or later versions are to be downloaded on www.beijerelectronics.com.

2. Folder Beijer BFI-E3 Modbus TCP


Contain everything necessary for Modbus TCP control of BFI.

3. gvlBFI
Contain Structs for Variables connected on pins to/from FB, Variables to/from iX used inside FB and
Variables connecting each BFI with corresponding input/output data (ModbusTCPSlave I/O
Mapping).
Normal.dotm, 2020-07-01

14 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

4. gvlBFI_HMI
Contain variables to be used together with HMI. Important are the constant describing number of BFI
in network and Structure containing variables copied to/from HMI.

5. prgBeijerMain_BFI
Contain code for exchanging data between HMI and CODESYS/BCS Tools.

6. prgBFI_ModbusTCP
Containing Function blocks, one FB for each BFI.

7. Library Manager
One of the libraries is X2 control BFI Modbus TCP. Contains the FB to control BFI by Modbus TCP.
The FB is compiled and by that not possible to open up. Requires one FB per BFI.

8. BFI slaves
BFI slaves in the network. Important that each physical BFI has an individual IP-address in
CODESYS/BCS Tools corresponds with the setting in each BFI.

How to add an additional BFI in the network


• Enter GVL called gvlBFI_HMI. Adjust the global constant gvlBFI_HMI.gc_iNrOfDrive to
number of BFI. If 4 pieces of BFI-E3 constant should be 4.
• Enter GVL called gvlBFI. Adjust the global array variable gvlBFI.g_aDrive[]. Set the
array to [1..Number of BFI in the network]. If 4 pieces of BFI-E3 constant should be 4.
• Enter GVL called gvlBFI . Adjust the global array variable gvlBFI.g_aDriveBEHMI[]. Set
the array to [1..Number of BFI in the network]. If 4 pieces of BFI-E3 constant should be 4.
• Add another BFI into Modbus TCP network
- Chose Modbus_TCP_Master (Modbus TCP Master)
- Right click and ADD Device
- Chose Modbus TCP Slave
- Rename it. If it is BFI number 5, Refactoring it to BFI_5.
Normal.dotm, 2020-07-01

• Chose the new BFI


- In Folder General, set Slave IP-address of the new BFI

15 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

- In Folder General, keep Unit-ID: 1


- In Folder General, keep Response Timeout(ms): 1000
- In Folder General, keep Port: 502
- In Folder Modbus Slave Channel, Copy all data from an existing BFI to new BFI.
- In Folder MobusTCPSlave I/O Mapping, Copy all variable names from BFI_1, to
the new BFI. If the new BFI will be BFI5 then: Rename
Application.Drive1.PlcToFromDrv.iRunningHours, to
Application.Drive5.PlcToFromDrv.iRunningHours,
• Add FB for a new BFI in prgBFI_ModbusTCP. Copy network 1 and paste. If new BFI is
to be number 5 then:
- Change name fbControlBFI1 to fbControlBFI5
- Change name Drive1 to Drive5
- Change name BFI_1 to BFI_5
- Change name for all [1] to [5] for all other variables in the network

How to remove BFI in the network


• Enter GVL called gvlBFI_HMI. Adjust the global constant gvlBFI_HMI.gc_iNrOfDrive to
number of BFI.
• Enter GVL called gvlBFI. Adjust the global array variable gvlBFI.g_aDrive[] to
[1..Number of BFI in the network].
• Enter GVL called gvlBFI . Adjust the global array variable gvlBFI.g_aDriveBEHMI[] to
[1..Number of BFI in the network].
• Remove not used BFI in Modbus_TCP_Master

Enable/Disable Devices
If a BFI is not to be used in the network during commissioning or other reasons it can be excluded, and
communication shut off. Go Offline, chose the slave and then Disable Device.
When to enable a device chose Enable Device instead.
Normal.dotm, 2020-07-01

16 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Ethernet setting in CODESYS/BCS Tools


The setting of ethernet ports must also be done in CODESYS/BCS Tools, both for the master and for all
slaves.

1. Setting of Interface, LAN port A or B for Modbus TCP communication. If LAN B is used for
Modbus TCP either of the settings above can be used. Upper example with Adjust Operating
System Settings activated the X2 control detects automatically LAN B as Modbus TCP port. In
the other example LAN B is defined as Ethernet post and corresponding with setting in the HMI.

2. IP address of the Ethernet port. This IP address must be the same as, in this case LAN B, of the
X2 control.

Picture showing IP-address settings in X2 control duting start up


Normal.dotm, 2020-07-01

17 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

3: Response Timeout
The response timeout sets the time interval that the master will wait for the answer from a slave node. If
the nodes do not answer within this time interval, then an error is recorded for the implicit slave function
block. The value entered for the time interval is also the default value for each node. For each node, you
can still set a specific value within its Modbus TCP slave configuration.

4: Socket Timeout
Maximum time to wait for incoming TCP/IP packages. The bus cycle task can be blocked during this
time, for example if a Modbus TCP slave is disconnected.

5: Auto-reconnect
When a slave is missing in the network the master tries to automatically reconnect.

6: IP Address of the BFI. Must correspond to the settings in the option module inside BFI set by software
IP Config.

7: Time interval for the master to wait for the response from the slave. This is especially configured for
this slave node and overwrites the general response timeout setting of the respective master.

8: Port number (TCP/IP) of the slave 502 is default for Modbus


Normal.dotm, 2020-07-01

18 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

9: Cyclic Read and Write of 4 words.


10: Cyclic Read of total running hours.
11: Read of Drive info every time communication is established.
12: Read of serial number every time communication is established.
13: Write parameter number to access when required.
14: Read Parameter value when required.
15: Write parameter value when required.

16: Digital control bits from BFI.


17: Output frequency from BFI.
20: Digital control bits to BFI.
21: Set frequency to BFI.
24: Running Hours
25: Detailed Drive info
26: Serial number
27: Parameter number
28: Read parameter value
29: Parameter value to be written
Normal.dotm, 2020-07-01

19 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

iX-project
CODESYS/BCS Tools project, X2 control BFI-E3 Modbus TCP, has a corresponding iX project. The
project contains one Start_Screen and one BFI_Control Screen. Explanation of project:
1. Choose which BFI to be monitored. Either tap in the figure or use Increase/Decrease buttons
2. BFI data
a. Type of BFI
b. Input voltage and number of phases
c. Power
d. Physical size
e. Firmware version
f. Serial number
3. Description of Communication error or User error
4. Actual status of BFI
a. Ready to Run or not
b. Safety Status (STO) in BFI-H3 and BFI-P2
c. Total Running Hours
d. Motor in Run or Stop
e. Motor current
f. Output frequency
g. If Alarm in BFI it is shown
h. Explanation of what the alarm means
5. Take control of the BFI from this menu. PLC-program is neglected.
6. Start/stop- Coast- and Fast stop buttons
7. Frequency Setpoint
8. Acceleration/Deceleration Time to be used if P-12=4 in BFI-E3
9. Parameter handling
a. Parameter number to be either tapped in or Increase/Decrease buttons
b. Name/Explanation of parameter is shown
c. Read Parameter value or to be written
d. Button Read Parameter
e. Button Write Parameter
f. Status whether Read/Write of parameter Succeeded or not
Normal.dotm, 2020-07-01

It is possible to have a Sheet containing Data from several BFI. But this needs to be configured in Symbol
Manager of CODESYS/BCS Tools and then imported to iX Developer.

20 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

10 Troubleshooting Communication problems


CODESYS/BCS Tools is the tool to check status of Modbus TCP communication.

CODESYS in RUN with communication with slaves CODESYS is in STOP

Example of communication when for instance slave BFI_3 is not replying correct could look like:

Check following items:


Hardware
- Is the patch cable connected to correct LAN port of X2 control and port P1 of BFI-E3.-
MTP?
- Power on to X2 control?
- Power turned on to BFI-E3…-MTP?

Software or settings
- IP-address correct set in BFI-E3…-MTP and corresponding with CODESYS?
- P-12 set to 3 or 4 in BFI-E3…-MTP?
- P-36 not changed? Station number must be 1 and communication speed 115,2 bit/sec
- Setting of Modbus TCP Master and BFI according to chapter 9?
- No overlapping IP-addresses?
- LAN A or LAN B correct configured in X2Control?
- Possible to ping the BFI-E3…-MTP from PC
Normal.dotm, 2020-07-01

21 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Communication is working but BFI-E3…-MTP doesn’t run the motor correct:


- Software enable bridge between terminal 1 and 2 in place?
- BFI-E3…-MTP is powered up?
- No alarm in BFI-E3…-MTP?
- Parameter P-12 set to 3 or 4 in BFI-E3…-MTP?
- Variable Ready to Run must be 1 to run the BFI-E3
- Stop in display?
o Start signal by bus is missing. As soon as BFI receives a start signal a value
between 0 and Maximum speed is displayed instead of Stop.
- H 0.0 in display?
Start signal arrived but no speed setpoint
o Speed sent to BFI-E3 must be a value between parameter value P1-01 and P1-02.
o Speed into Function block is a REAL. Value 50.0 Hz means value 500 being sent
to BFI-E3
o Check that sent speed by bus corresponds with value in P0-03 in BFI-E3.
Normal.dotm, 2020-07-01

22 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

11 Modbus Register Mapping BFI-E3


Table 1: Control and status registers
Note : All registers are Holding Registers
Register Parameter Upper Lower Format Min Max Command Type Scaling
Number Number byte Byte
1 - Control Word WORD -. - 03, 06, 16 R/W See Below
2 - Frequency Setpoint S16 -5000 5000 03, 06, 16 R/W 1dp, e.g. 100 = 10.0Hz
3 - Reserved - - - 03, 06, 16 R/W No Function
4 - Modbus ramp control U16 0 60000 03, 06, 16 R/W 2dp, e.g. 500 = 5.00s
time
5 - High resolution S16 - 30000 03 R See Below
Frequency Setpoint 30000
6 - Error Drive WORD - - 03 R See Below
code status
7 - Output Frequency S16 0 5000 03 R 1dp, e.g. 100 = 10.0Hz
8 - Motor Current U16 0 - 03 R 1dp, e.g. 100 = 10.0A
9 - Motor Torque S16 0 2000 03 R 1dp, e.g. 100 = 10.0%
10 - Motor Power U16 0 - 03 R 1dp, e.g. 100 = 10.0kW
11 P00-04 Digital Input Status WORD - - 03 R See Below
12 P00-20 Rating ID U16 - - 03 R Internal Value
13 P00-20 Power rating U16 - - 03 R 2dp, e.g. 37 = 0.37kW
14 P00-20 Voltage rating U16 - - 03 R See Below
15 P00-18 IO processor software U16 - - 03 R 2dp, e.g. 300 = 3.00
version
16 P00-18 Motor control U16 - - 03 R 2dp, e.g. 300 = 3.00
processor software
version
17 P00-20 Drive type U16 - - 03 R Internal Value
18 P00-48 Scope Channel 1 Data S16 - - 03 R See Below
19 P00-48 Scope Channel 2 Data S16 - - 03 R See Below
20 P00-01 Analog 1 input result U16 0 1000 03 R 1dp, e.g. 500 = 50.0%
21 P00-02 Analog 2 input result U16 0 1000 03 R 1dp, e.g. 500 = 50.0%
22 P00-03 Speed reference value S16 0 5000 03 R 1dp, e.g. 500 = 50.0Hz
23 P00-08 DC bus voltages U16 0 1000 03 R 600 = 600 Volts
24 P00-09 Drive temperature S16 -10 150 03 R 50 = 50°C
25 P00-30 Drive Serial Number 4 U16 - - 03 R See Below
26 P00-30 Drive Serial Number 3 U16 - - 03 R
27 P00-30 Drive Serial Number 2 U16 - - 03 R
28 P00-30 Drive Serial Number 1 U16 - - 03 R
29 - Relay Output Status WORD 03 R Bit0 Indicates Relay
Status. 1=Relay
Contact Closed
30 - Reserved - - - 03 R No Function
31 - Reserved - - - 03 R No Function
32 P00-26 kWh Meter U16 0 9999 03 R 100 = 10.0kWh
33 P00-26 MWh Meter U16 0 03 R 10 = 10MWh
34 P00-10 Running Time– Hours U16 03 R 1 = 1 Hour
35 P00-10 Running Time– U16 03 R 100 = 100 Seconds
Minutes & Seconds
36 P00-14 Run time since last U16 03 R 1 = 1 Hour
enable – Hours
37 P00-14 Run time since last U16 03 R 100 = 100 Seconds
enable – Min & sec
Normal.dotm, 2020-07-01

38 - Reserved U16 03 R No Function


39 P00-20 Internal Drive S16 -20 100 03 R 50 = 50°C
Temperature

23 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

40 - Speed Reference U16 0 P-01 03 R 3000=50 Hz


41 - Reserved - - - 03 R No Function
42 - Digital Pot / Keypad U16 0 P-01 03 R 3000=50 Hz
Reference
43 P00-07 Output Voltage U16 0 - 03 R 100=100 VAC RMS
44 - Parameter Access U16 1 60 03 R See Below
Index
45 - Parameter Access S16 - - 03 R See Below
Value
WORD = WORD Format, functions assigned to individual bits
S16 = Signed 16 Bit Integer
U16 = Unsigned 16-bit Integer

Write registers
Write Register 1: Digital Control bits
Drive command
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
High byte Low byte

Bit 0: Run/Stop command: Set to 1 to enable the drive. Set to 0 to stop the drive.
Bit 1: Fast stop request. Set to 1 to enable drive to stop with 2nd deceleration ramp.
Bit 2: Reset request. Set to 1 in order to reset the drive if drive is under trip condition.
User must clear this bit when drive is under normal condition to prevent un-expected reset.
Bit 3: Coast stop request. Set to 1 to issue a coast stop command.

For normal operation, Bit 3 has the highest priority, bit 0 has the lowest priority (bit 3>bit 1>bit 0). For
example, if user set command as 0x0009, drive will do a coast stop rather than run. For normal run/start,
just set this register to 1.
Note that stat/stop(bit 0), fast stop(bit 1) and coast stop(bit 3) only works if P-31= 0 or 1. Otherwise,
start/stop function is controlled by drive control terminals. Reset function(bit 2) works all the time as long
as drive is operated under Modbus control mode (P-12=3 or 4).

Write Register 2: Speed reference setup


This register holds the speed reference value with one decimal place (200 = 20.0Hz). The maximum speed
reference value is limited by P-01. Either register 2 or register 5 can be used for speed reference control,
however only one reference should be used in any control system, otherwise unexpected behaviour can
result.

Write Register 4: Acceleration /Deceleration Ramp Time


Active only when P-12 = 4, this register specifies the drive acceleration and deceleration ramp time. The
same value is applied simultaneously to the acceleration and deceleration ramp times. The value has two
decimal places, e.g. 500 = 5.00 seconds.

Write Register 5: High Resolution Speed Reference


This register allows the user to set the speed reference value in the internal format, e.g. 3000 = 50.0Hz. This
allows control resolution to 1 RPM with a 2-pole motor . The maximum allowed value is limited by P-01.
Either register 2 or register 5 can be used for speed reference control, however only one reference should be
Normal.dotm, 2020-07-01

used in any control system, otherwise unexpected behaviour can result.

24 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Read registers
Read Register 6: Drive status and error code
High byte gives drive error code. (Valid when the drive is tripped, see Appendix E – Drive Fault Code and
Information for further details). Low byte gives drive status information as follows :-
Bit 0: 0 =Drive Stopped, 1 = Drive Running
Bit 1: 0 = OK, 1 = Drive Tripped
Bit 5: 0 = OK, 1 = In Standby Mode
Bit 6: 0 = Not Ready, 1 = Drive Ready to Run (not tripped, hardware enabled and no mains loss condition)

Read Registers 18 & 19 : Scope Channel 1 & 2 Data Values


These registers show the scope present data sample value for the first two scope channels. The channel data
source selection is carried out through BFI-Tools.

Read Registers 25 - 28: Drive Serial Number


The drive serial number, 11 digits, may be read using these four registers stored as follows:

Indirect Parameter Access Registers


BFI-E3 allows Read / Write access to all user adjustable parameters using a simple method as detailed
below. This is achieved using the following two Modbus registers.

Register 44: Drive parameter index


This index value will be used by register 45 to carry out parameter read and write function. The valid range
of this parameter is from 1 to 60 (maximum number of drive user adjustable parameters).

Register 45: Drive parameter value


When reading this register, value represents the drive parameter value which index is specified by register44.
When write to this register, value will be written to the parameter which index is specified by register 44.

Parameter Read Method


In order to read a parameter, firstly write the parameter number to register 44, then read the value from
register 45, e.g. to Read the Value of P-01:
- Write 1 to Register 44.
- Read the Value of Register 45.

Parameter Write Method


Writing parameter values can be achieved by the same method, however, Register 45 is used to write the
parameter value after the parameter number has been selected using Register 44, e.g. to Write a Value of
60.0Hz to parameter P1-01:
- Write 1 to Register 44
- Register 45 will return the present value of P-01, which can be Read if required
Parameter Registers and Scaling apply any scaling necessary. In this case, 60.0Hz = 3600
- Write the scaled value to Register 45. P-01 now changes to 60.0Hz, or an exception code may be
Normal.dotm, 2020-07-01

returned.

25 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Parameters
Parameter Registers and Scaling
All user adjustable parameters within the drive are accessible by Modbus and can be Read or Written to. For
further information regarding the parameter functions and specific settings, please refer to the User Guide.
Para-
Register Description Format Min Max Data format
meter
129 01 Max speed limit U16 0 5*P-09 Internal value (3000 = 50.0Hz)
130 02 Min speed limit U16 0 P-01 Internal value (3000 = 50.0Hz)
131 03 Accel ramp time U16 0 60000 2dp, e.g. 300=3.00s
132 04 Decel ramp time U16 0 60000 2dp, e.g. 300=3.00s
0: Ramp to stop + Main Loss Ride Through
1: Coast to stop
133 05 Stop mode select U16 0 3
2: Ramp to stop + Fast Stop
3 : AC Flux Braking + Fast Stop
0: Disabled
134 06 Energy save U16 0 1
1: Enabled
135 07 Motor rated voltage U16 0 250 or 500 400 = 400 Volts
Drive
136 08 Motor rated current U16 0 1dp, e.g. 100 = 10.0A
Dependent
Motor rated
137 09 U16 25 500 Data unit is in Hz
frequency
Maximum value equals to the sync speed of
138 10 Motor rated speed U16 0 30000
a typical 2-pole motor
Drive
139 11 Boost voltage value U16 0 1dp, e.g. 100 = 10.0%
Dependent
0: Terminal Control
1: Keypad forward only
2: Keypad forward and reverse
3: Modbus control mode
4: Modbus control with ramp control
140 12 Control mode U16 0 9
5 : PID control
6 : PID control with analog speed sum
7 : CAN Open
8 : CAN Open + Ramp Control
9 : Slave Mode
0 : Industrial Mode
141 13 Application Mode U16 0 2 1 : Pump Mode
2 : Fan Mode
142 14 Access code U16 0 9999 No Scaling
143 15 Digital input function U16 0 17 See user guide for function details
0: 0…10V 1: b 0…10V
2: 0…20mA 3: t 4…20mA
144 16 Analog input format U16 0 7
4: r 4…20mA 5: t 20…4mA
6: r 20…4mA 7 : 10…0V
0 = 4kHz 1 = 8kHz
Effective switching
145 17 U16 0 Drive 2 = 12kHz 3 =16kHz
frequency
Dependent 4 = 24kHz 5 = 32kHz
Relay output
146 18 U16 0 9 See user guide for function details
function
147 19 Digital output limit U16 0 1000 100 = 10.0%
148 20 Preset speed 1 U16 -P-01 P-01 Internal value (3000 = 50.0Hz)
149 21 Preset speed 2 U16 -P-01 P-01 Internal value (3000 = 50.0Hz)
150 22 Preset speed 3 U16 -P-01 P-01 Internal value (3000 = 50.0Hz)
151 23 Preset speed 4 U16 -P-01 P-01 Internal value (3000 = 50.0Hz)
Normal.dotm, 2020-07-01

2nd deceleration
152 24 U16 0 2500 250 = 2.50s
ramp

26 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Para-
Register Description Format Min Max Data format
meter
Analog output
153 25 U16 0 10 See user guide for function details
function
154 26 Skip frequency U16 0 P-01 Internal value (3000 = 50.0Hz)
155 27 Skip freq band U16 0 P-01 Internal value (3000 = 50.0Hz)
156 28 V/F adjust voltage U16 0 P-07 100 = 100V
157 29 V/F adjust frequency U16 0 P-09 50 = 50Hz
0: Edgr-r 1: Auto_0
158 30 Start mode select U16 0 6
2…6: Auto_1 to Auto_5
159 31 Keypad restart mode U16 0 7 See user guide for details
160 32 DC injection enable U16 See Below
161 33 Spin start enable U16 0 2 See user guide for function details
162 34 Brake circuit enable U16 0 4 See user guide for function details
163 35 Analog input scaling U16 0 20000 1000 = 100%
Communication
164 36 WORD See Below
Settings
Access code
165 37 U16 0 9999
definition
166 38 Parameter lock U16 0 1 0: Unlock or 1: Locked
167 39 Analog input offset U16 -5000 5000 1dp, e.g. 300=30.0%
Display scaling
168 40 U16 See Below
factor
169 41 User PI P gain U16 1 300 1dp, e.g. 10 = 1.0
User PI I time
170 42 U16 0 300 1dp, e.g. 10 = 1.0s
constant
171 43 User PI mode select U16 0 1 See user guide for more information
User PI reference
172 44 U16 0 1 See user guide for more information
select
User PI digital
173 45 U16 0 1000 1dp, e.g. 100 =10.0%
reference
User PI feedback
174 46 U16 0 3 See user guide for more information
select
0: 0...10V 1: 0…20mA
2: t 4...20mA 3: r 4...20mA
175 47 2nd an input format U16 0 6
4: t 20...4mA 5: r 20...4mA
6: Ptc-th
176 48 Standby Mode Timer U16 0 250 1dp, e.g. 250 = 25.0s
PI Wake Up Error
177 49 U16 0 1000 1dp, e.g. 50 = 5.0%
Level
User Relay Output
178 50 U16 0 1000 1dp e.g. 100 = 10.0%
Hysteresis
0 : IM Vector 1 : V/F
2 : PM Motor 3 : BLDC
179 51 Motor Control Mode U16 0 4 Motor
4 : SynRM Motor 5 : LSPM
Motor
Motor Parameter
180 52 U16 0 1
Autotune
181 53 Vector Mode Gain U16 0 2000 1dp, e.g. 500 = 50.0%
Maximum Current
182 54 U16 0 1750 1dp, e.g. 1000 = 100.0%
Limit
Motor Stator
183 55 U16 0 65535 2dp, e.g. 100 = 1.00 ohm
Resistance
Motor Stator d-axis 1dp, e.g. 1000 = 100.0mH
184 56 U16 0 65535
Inductance (Lsd)
Normal.dotm, 2020-07-01

Motor Stator q-axis 1dp, e.g. 1000 = 100.0mH


185 57 U16 0 65535
Inductance (Lsq)
186 58 DC Injection Speed U16 0 P-01 3000 = 50.0Hz

27 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Para-
Register Description Format Min Max Data format
meter
187 59 DC Injection Current U16 0 1000 1dp, e.g. 100 = 10.0%
Thermal Overload
188 60 U16 0 1
Retention

Additional Information
Register 160 which is Parameter P-32: DC Injection Configuration
The parameter value is stored as a combined 16-bit word which is constructed as follows:

Register 164 which is Parameter P-36: Communications Configuration


This Register entry contains multiple data entries, as follows:-
High Byte Low Byte
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Trip Configuration Baud Rate Drive Address
Data values can be interpreted as follows:

Register 168 which is Parameter P-36: Display Scaling


The parameter value is stored as a combined 16-bit word which is constructed as follow:
Normal.dotm, 2020-07-01

28 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Modbus Exception Response Telegrams


Under some circumstances, the drive may reply with an Exception Response (error) in response to a request
telegram sent from the network master, for example where the master tries to read a register which does not
exist. Exception Responses which can be generated by the drive are listed below:-
Exception Code 1: Invalid Request
Returned under the following conditions
- Network Master sends an unsupported Modbus command (e.g. Read Coils).
- Run command issued to drive whilst the drive is not set for Modbus Control Mode (P-12 <>3 or 4).
- Run command issued to drives whilst the drive is not enabled (e.g. Digital Input 1 is open).
- Run command issued to drive whilst the drive is in a tripped condition.
Exception Code 2: Invalid Modbus register
Returned under the following conditions
- Network Master attempts to read or write a register that does not exist within the drive.
Exception Code 3: Register Value Out of Range
Returned under the following conditions
- Network Master attempts to write a holding register with a value outside the range of the register
Exception Code 6: Drive Busy
Returned under the following conditions
- Drive busy due to internal data transfer. The Network Master should re-send the message after a delay

Dataflow example:
Read data from register 6
Request:[01] [03] [00] [05] [00] [01] [94] [0B]
(Drive Addr) (Command) (Reg start addr) (No. of Registers) (Checksum)

Reply: [01] [03] [02] [00] [00] [B8] [44]


(Drive Addr) (Command) (No of data bytes) (Data) (Checksum)
Note: The actual start address of register 6 is 5. All data in [ ] is in 8bits Hex format.

Write start command to the register 1 (suppose P-12 = 3, P-15 =0 and digital input 1 is closed):
Request: [01] [06] [00] [00] [00] [01] [48] [0A]
(Drive Addr) (Command) (Reg addr) (Data value) (Checksum)

Reply: [01] [06] [00] [00] [00] [01] [48] [0A]


(Drive Addr) (Command) (Reg addr) (Data value) (Checksum)
Note: The actual address of register 1 on the data link is 0. All data in [ ] is in 8bits Hex format.

Reply can be error message depending on drive parameter settings and digital input status.
Normal.dotm, 2020-07-01

29 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

Register Changes for Single Phase Output Drives


The Single-Phase Output drive has some registers that are different to the standard three phase output
drive, as listed below:
Register Parameter Description Format Min Max Command Type Scaling
134 06 Reserved S16 0 5000 03,06 R/W 1dp, e.g. 100 = 10.0Hz
139 11 Boost Value - - - - -
141 13 Reserved U16 0 - 03 R 2dp, e.g. 100 = 1.00kW
148 20 Preset speed 1 U16 0 P-01 03 R 3000 = 50.0Hz

Register Parameter Description Format Min Max Data format / Scaling


134 06 Reserved - - - No Function
U16 0 Drive Rating
139 11 Boost Value 1dp, e.g. 100 = 10.0%
Dependent
141 13 Reserved U16 - - No Function
148 20 Preset speed 1 U16 0 P-01 3000 = 50.0Hz
149 21 Preset speed 2 U16 0 P-01 3000 = 50.0Hz
150 22 Preset speed 3 U16 0 P-01 3000 = 50.0Hz
151 23 Preset speed 4 U16 0 P-01 3000 = 50.0Hz
160 32 Boost Frequency U16 0 1500 1dp, e.g. 100 = 10.0%
161 33 Boost Period Duration U16 0 2 See User guide for details
179 51 Thermal Overload Retention U16 0 1 -
Registers above 179 are not present in Single Phase Output Drives
Normal.dotm, 2020-07-01

30 (31)
X2 Control communication with BFI-E3 by Modbus TCP
SER0020_V1.0.0 2020-11

12 About Beijer Electronics


Beijer Electronics is a multinational, cross-industry innovator that connects people and
technologies to optimize processes for business-critical applications. Our offer includes operator
communication, automation solutions, digitalization, display solutions and support. As experts in
user-friendly software, hardware
and services for the Industrial Internet of Things, we empower you to meet your challenges
through leading-edge solutions.
Beijer Electronics is a Beijer Group company. Beijer Group has a sale over 1.6 billion SEK in
2019 and is listed on the NASDAQ OMX Nordic Stockholm Small Cap list under the ticker
BELE. www.beijergroup.com

China NORWAY TAIWAN


Shanghai Drammen Taipei

DENMARK SOUTH KOREA TURKEY


Roskilde Seoul Istanbul

FRANCE SWEDEN UNITED KINGDOM


Paris Göteborg Nottingham
Malmö
Stockholm

GERMANY USA
Nürtingen Salt Lake City

Contact us
Global offices and distributors
Normal.dotm, 2020-07-01

31 (31)

You might also like