Technical Information: Sma Cluster Controller Modbus Interface
Technical Information: Sma Cluster Controller Modbus Interface
Legal Provisions
The information contained in these documents is the property of SMA Solar Technology AG.
Any publication, whether in whole or in part, requires prior written approval by
SMA Solar Technology AG. Internal reproduction used solely for the purpose of product evaluation
or other proper use is allowed and does not require prior approval.
Trademarks
All trademarks are recognized, even if not explicitly identified as such. Missing designations do not
mean that a product or brand is not a registered trademark.
®
Modbus is a registered trademark of Schneider Electric and is licensed by the Modbus Organiza-
tion, Inc.
Table of Contents
1 Information on this Document ................................................................. 5
2 Safety .......................................................................................................... 7
2.1 Intended Use ...............................................................................................................7
2.2 Skills of Qualified Persons .........................................................................................7
2.3 Safety Information ......................................................................................................7
2.4 Information on Data Security ....................................................................................8
7 Troubleshooting .......................................................................................33
8 Technical Data .........................................................................................34
8.1 Supported SMA Inverters ....................................................................................... 34
8.2 Number of SMA Devices ....................................................................................... 34
8.3 Modbus Communication Ports............................................................................... 34
8.4 Data Processing and Time Behavior ..................................................................... 35
8.5 Number Codes of the Time Zones ........................................................................ 36
8.6 Frequently Used Number Codes (ENUM) .......................................................... 38
9 Contact ......................................................................................................39
Target Group
This document is intended for qualified persons. Only persons with appropriate skills are allowed to
perform the tasks described in this document (see Section 2.2 "Skills of Qualified Persons", page 7)
Symbols
Icon Explanation
Typographies
Typography Application Example
Nomenclature
Complete designation Designation in this document
Abbreviations
Abbreviation Designation Explanation
GFDI Ground-Fault Detection and Detection of the grounding error and subse-
Interruption quent interruption of the electric circuit.
PMAX Set active power limit The device can generate active power up to
this limit.
2 Safety
2.1 Intended Use
The Modbus interface of the SMA Cluster Controller is designed for industrial use and has the
following tasks:
• Remote control of the grid management services of a PV system.
• Remote-controlled querying of the measured values of a PV system.
• Remote-controlled changing of the parameters of a PV system.
The Modbus interface can be used via the protocol Modbus TCP and
by the protocol Modbus UDP.
The enclosed documentation is an integral part of this product:
• Read and observe the documentation.
• Keep the documentation in a convenient place for future reference.
You can connect the Cluster Controller to the Internet. When connecting to the Internet,
there is a risk that unauthorized users can access and manipulate the data of your PV sys-
tem.
• Take appropriate protective measures, for example:
• Set up a firewall
• Close unnecessary network ports
• Only enable remote access via VPN tunnel
• Do not set up port forwarding at the Modbus port in use
3 Product Description
3.1 Modbus Protocol
The Modbus Application Protocol is an industrial communication protocol that is currently used in
the solar sector mainly for system communication in PV power plants.
The Modbus protocol has been developed for reading data from or writing data to clearly defined
data areas. The Modbus specification does not prescribe what data is within which data area. The
data areas must be defined device-specifically in Modbus profiles. With knowledge of the device-
specific Modbus profile, a Modbus master (e.g. SCADA system) can access the data of a Modbus
slave (e.g. SMA Cluster Controller). Information on firmware versions and device-specific Modbus
registers of SMA products can be found on our product pages or Modbus page at
www.SMA-Solar.com.
The special Modbus profile for SMA devices is the SMA Modbus profile.
Line Explanation
Unit ID Explanation
The unit IDs 3 to 247 are used for addressing individual devices and for the user-
defined Modbus profile. Information on firmware versions and device-specific Mod-
3 to 247 bus registers of SMA products can be found on our product pages or Modbus page
at www.SMA-Solar.com. You can change the assignment of these unit IDs (see Sec-
tion 4.2 "Information on Changing Unit IDs", 17).
Devices which are assigned to this unit ID, were connected to the Cluster Controller or
replaced after activation of the Modbus server. The devices cannot be addressed with
255
this unit ID. You must assign unit IDs from the range 3 to 247 to these devices (see
Section 4.2 "Information on Changing Unit IDs", page 17).
1
Number of Modbus registers transferable as data block per command
U32 For status values, only the lower 24 bits of a double word (32- 0xFFFF FD or 0xFFFF
bit) are used. FE or -1
Format Explanation
Coded numerical values. The breakdown of the possible codes can be found directly
ENUM under the designation of the Modbus register in the SMA Modbus profile—assignment
tables (see also Section 8.6 "Frequently Used Number Codes", page 38).
Text or number. A RAW number has no decimal places and no thousand or other
RAW
separation indicators.
Temperature values are stored in special Modbus registers in degrees Celsius (°C), in
TEMP degrees Fahrenheit (°F), or in Kelvin K. The values are commercially rounded, with
one decimal place.
Firmware version extract, format "FW": From the delivered DWORD, four values are extract-
ed. The values Major and Minor are contained BCD-coded in bytes 1 and 2. Byte 3 contains the
Build value (not BCD-coded). Byte 4 contains the Release Type value according to the following
table:
0 N No revision number
1 E Experimental release
2 A Alpha release
3 B Beta release
4 R Release
5 S Special release
>5 As number No special interpretation
Example:
Firmware version of the product: 1.5.10.R
Values from DWORD: Major: 1, Minor: 5, Build: 10, Release type: 4
(Hex: 0x1 0x5 0xA 0x4)
You access the gateway via the IP address of the Cluster Controller, under the unit ID = 1.
The assignment of the system devices for unit IDs 3 to 247 is stored in the Modbus registers from
address 42109. Each assignment has an address range of four Modbus registers. You can find the
Modbus register of the gateway in Section 5.2 "Gateway", page 24.
Example "Read out additional device from the gateway“
Via automatic detection, an additional SMA device was assigned to unit ID = 255 (indicated with
C in column "Device #" in the following table). The assignments of the gateway were, as follows
here, shown with a SCADA system as a table:
… … …
42112 3 Unit ID A
42116 4 Unit ID B
… … … …
The file usrplant.xml must be activated in the Cluster Controller. Once the file usrplant.xml is
activated, the file sysplant.xml is not taken into consideration for the duration of the activation.
<device…/> Within the tag "Device" is the assignment of a device to a unit ID.
regoffs=”aaa“ Number of the device in file sysplant.xml. The number must not neces-
sarily be assigned sequentially. There are four Modbus register ad-
dresses between two devices. Regoffs = 0 defines the first device under
the Modbus address 42109, Regoffs = 244 the last device under the
Modbus address 43085.
Without the device tags in the file usrplant.xml, the system returns to the specifications saved in
the file sysplant.xml. A changed usrplant.xml becomes effective a few seconds after it is saved
to the Cluster Controller.
Information Explanation
ADR (DEC) Decimal Modbus address (see Section 3.5.3 "Modbus Register Address,
Register Width and Data Block", page 13 onwards)
Description/ Short description of the Modbus register and the number codes used.
number code(s)
Type Data type, e.g. V32 = 32 bits without prefix (see Section 3.7 "SMA Data
Types and NaN Values", page 15).
Format Data format of saved value, e.g. DT = date, FIX n = output with n decimal
places, TEMP = output as temperature (see Section 3.8 "SMA Data For-
mats", page 15).
(WORD)
Description/number code(s)
Format
Access
Type
CNT
30001 Version number of the SMA Modbus profile 2 U32 RAW RO
30003 SUSy ID (of the Cluster Controller) 2 U32 RAW RO
30005 Serial number (of the Cluster Controller) 2 U32 RAW RO
Modbus data change: meter value is increased by
30007 2 U32 RAW RO
the Cluster Controller if new data is available.
Device class:
8000 = All devices
8001 = PV inverter
8002 = Wind power inverter
30051 8007 = Battery inverter 2 U32 ENUM RO
8033 = Load
8064 = Sensor technology general
8065 = Energy meter
8128 = Communication products
30193 UTC system time (s) 2 U32 DT RO
Total energy fed in across all line conductors, in Wh
30513 4 U64 FIX0 RO
(accumulated values of the inverters)
Energy fed in on current day across all line conduc-
30517 4 U64 FIX0 RO
tors, in Wh (accumulated values of the inverters)
Current active power on all line conductors (W),
30775 2 S32 FIX0 RO
accumulated values of the inverters
Reactive power on all line conductors (var),
30805 2 S32 FIX0 RO
accumulated values of the inverters
Unit ID = 255
For unit ID = 255, observe Section 4.3 "Changing Unit IDs via the Gateway", page 18.
(WORD)
Description/number code(s)
Format
Access
Type
CNT
Direct marketer:
Active power setpoint P, in % of the maximum active
power (PMAX) of the PV plant.
40493 Value range: 1 S16 FIX2 WO
-100.00% to < 0% = Load
0% = No active power
< 0% to +100.00% = Generator
41167 Active power setpoint in % (manual specification) 2 U32 FIX2 RO
unitid="aaa" Specifies the unit ID of the device whose Modbus addresses are to be
used as a source. Possible unit IDs for individual devices are 3 to 247.
destination="ccccc" Specifies the new Modbus address at which the parameter or measured
value is to be accessed (0 to 65535). Note the number of Modbus
registers that are stored at the original address. The destination registers
must not overlap. If incomplete Modbus registers are called up later, a
Modbus exception is generated. If register addresses are called up,
which are not filled with values, NaN is returned.
<!--xyz--> Comments out the range xyz, for example, to deactivate an instruction.
Modbus exceptions
For Modbus exceptions, see "Modbus Application Protocol Specification" at
http://www.modbus.org/specs.php.
(WORD)
Description/number code(s)
Format
Access
Type
CNT
30775 AC active power across all line conductors (W) 2 S32 FIX0 RO
30805 Reactive power across all line conductors (VAr) 2 S32 FIX0 RO
30813 Apparent power across all line conductors (VA) 2 S32 FIX0 RO
The exact appearance of the XML file follows from the example:
<?xml version=“1.0“ encoding=“UTF-8“?>
<virtual_modbusprofile>
<channel unitid=”3” source=”30775” destination=”0” />
<channel unitid=”3” source=”30805” destination=”2” />
<channel unitid=”3” source=”30813” destination=”4” />
<channel unitid=”4” source=”30775” destination=”6” />
<channel unitid=”4” source=”30805” destination=”8” />
<channel unitid=”4” source=”30813” destination=”10” />
</virtual_modbusprofile>
7 Troubleshooting
You can find information on error analysis of the SMA Modbus profile in Section 3.6 "Reading and
Writing of Data", page 14.
For troubleshooting of the SMA devices, go to Modbus address 30197 and use the event numbers
displayed here.
The event numbers of the SMA devices cannot be decrypted with the number
codes in this document.
The event numbers of the SMA devices are device-specific and cannot be decrypted with
the number codes in this document.
To decrypt the event numbers of low or medium-power inverters, you require additional
information (operating parameters/measured values, see Technical Description "Measured
Values and Parameters" at www.SMA-Solar.com).
To decrypt the event numbers of central inverters, contact the SMA Service Line (see Section
9 "Contact", page 39).
8 Technical Data
8.1 Supported SMA Inverters
All inverters with integrated or retrofitted Speedwire/Webconnect interfaces are supported.
Information on whether an inverter has an integrated Speedwire/Webconnect interface or can be
retrofitted with a Speedwire/Webconnect interface can be found on the product page of the re-
spective inverter at www.SMA-Solar.com.
City/Country Code Time zone Denver, Salt Lake City, Calgary 9547 UTC-07:00
Abu Dhabi, Muscat 9503 UTC+04:00 Dublin, Edinburgh, Lisbon, London 9534 UTC+00:00
Adelaide 9513 UTC+09:30 Yerevan 9512 UTC+04:00
Alaska 9501 UTC-09:00 Fiji, Marshall Islands 9531 UTC+12:00
Amman 9542 UTC+02:00 Georgetown, La Paz, San Juan 9591 UTC-04:00
Amsterdam, Berlin, Bern, Rome, Greenland 9535 UTC-03:00
9578 UTC+01:00
Stockholm, Vienna Guadalajara, Mexico City,
9584 UTC-06:00
Arizona 9574 UTC-07:00 Monterrey
Astana, Dhaka 9515 UTC+06:00 Guam, Port Moresby 9580 UTC+10:00
Asuncion 9594 UTC-04:00 Harare, Pretoria 9567 UTC+02:00
Athens, Bucharest, Istanbul 9537 UTC+02:00 Hawaii 9538 UTC-10:00
Atlantic (Canada) 9505 UTC-04:00 Helsinki, Kiev, Riga, Sofia, Tallinn,
9532 UTC+02:00
Auckland, Wellington 9553 UTC+12:00 Vilnius
Azores 9509 UTC-01:00 Hobart 9570 UTC+10:00
Baghdad 9504 UTC+03:00 Indiana (East) 9573 UTC-05:00
Baku 9508 UTC+04:00 International Date Line (West) 9523 UTC-12:00
Bangkok, Hanoi, Jakarta 9566 UTC+07:00 Irkutsk 9555 UTC+08:00
Beirut 9546 UTC+02:00 Islamabad, Karachi 9579 UTC+05:00
Belgrade, Bratislava, Budapest, Yakutsk 9581 UTC+09:00
9517 UTC+01:00
Ljubljana, Prague Yekaterinburg 9530 UTC+05:00
Bogotá, Lima, Quito 9563 UTC-05:00 Jerusalem 9541 UTC+02:00
Brasilia 9527 UTC-03:00 Kabul 9500 UTC+04:30
Brisbane 9525 UTC+10:00 Cairo 9529 UTC+02:00
Brussels, Copenhagen, Madrid, Cape Verde Islands 9511 UTC-01:00
9560 UTC+01:00
Paris Katmandu 9552 UTC+05:45
Buenos Aires 9562 UTC-03:00 Caucasus Standard Time 9582 UTC+04:00
Canberra, Melbourne, Sydney 9507 UTC+10:00 Krasnoyarsk 9556 UTC+07:00
Caracas 9564 UTC-04:30 Kuala Lumpur, Singapore 9544 UTC+08:00
Casablanca 9585 UTC+00:00 Kuwait, Riyadh 9502 UTC+03:00
Cayenne 9593 UTC-03:00 Magadan, Solomon Islands, New
9519 UTC+11:00
Chennai, Kolkata, Mumbai, New Caledonia
9539 UTC+05:30
Delhi Manaus 9516 UTC-04:00
Chicago, Dallas, Kansas City, Midway Islands, Samoa 9565 UTC-11:00
9583 UTC-06:00
Winnipeg Minsk 9526 UTC+02:00
Chihuahua, La Paz, Mazatlán 9587 UTC-07:00 Mid-Atlantic 9545 UTC-02:00
Darwin 9506 UTC+09:30 Monrovia, Reykjavík 9536 UTC+00:00
Event Numbers
The event numbers displayed by the inverters under the Modbus address 30197 are device-
specific. You cannot decrypt the event numbers with the number codes in this document (see
Section 7 "Troubleshooting", page 33).
9 Contact
If you have technical problems with our products, please contact the SMA Service Line. We require
the following information in order to provide you with the necessary assistance:
South Africa SMA Solar Technology Argentina SMA South America SPA
South Africa Pty Ltd. Brasil Santiago de Chile
Cape Town Chile +562 2820 2101
08600SUNNY Perú
(08600 78669)
International:
+27 (0)21 826 0600
SMA Online Service Center
www.SMA-Service.com
Australia SMA Australia Pty. Ltd. Other countries International
Sydney SMA Service Line
Toll free for Australia: Niestetal
1800 SMA AUS 00800 SMA SERVICE
(1800 762 287) (+800 762 7378423)
International:
+61 2 9491 4200
www.SMA-Solar.com