background image

 

 

 

 

 

 

 

 

UPS2000-(6 kVA-20 kVA) 

 

 

Modbus Protocol Development 
Guide

 

 

 

Issue 

02

 

Date 

2016-03-10

 

HUAWEI TECHNOLOGIES CO., LTD. 

Summary of Contents for UPS2000 Series

Page 1: ...UPS2000 6 kVA 20 kVA Modbus Protocol Development Guide Issue 02 Date 2016 03 10 HUAWEI TECHNOLOGIES CO LTD ...

Page 2: ... Huawei and the customer All or part of the products services and features described in this document may not be within the purchase scope or the usage scope Unless otherwise specified in the contract all statements information and recommendations in this document are provided AS IS without warranties guarantees or representations of any kind either express or implied The information in this docum...

Page 3: ... that may be found in this document are defined as follows Symbol Description Indicates an imminently hazardous situation which if not avoided will result in death or serious injury Indicates a potentially hazardous situation which if not avoided could result in death or serious injury Indicates a potentially hazardous situation which if not avoided may result in minor or moderate injury Indicates...

Page 4: ...t damage and environment deterioration Change History Changes between document issues are cumulative The latest document issue contains all the changes made in earlier issues Issue 02 2016 03 10 The product type UPS2000A was added The collection signal and alarm signal lists were updated The examples of communication processes with the host were changed Issue 01 2015 07 14 This issue is the first ...

Page 5: ...the Read Device Identifier Command 10 1 5 3 1 Frame Format 10 1 5 3 2 Command Definition 10 1 5 3 3 Frame Format Examples 13 1 5 3 4 Query Device Identification Information Command 15 1 5 3 4 1 Request Frame Format 15 1 5 3 4 2 Response Frame Format 15 1 5 4 Definition and Format of Read Command 16 1 5 4 1 Read Command Definition 16 1 5 4 2 Read Command Format 16 1 5 4 2 1 Request Frame Format 16 ...

Page 6: ...rietary and Confidential Copyright Huawei Technologies Co Ltd v 2 1 2 Collection Signal List 18 2 1 3 Configuration and Control Signal List 25 2 2 Alarms 28 2 2 1 Signal List Description 28 2 2 2 Alarm Signal List 28 3 Examples for the Host Communication Process 34 A Acronyms and Abbreviations 37 ...

Page 7: ...ers This protocol supports one host networked with multiple slave devices The slave devices are distinguished by address The address setting range is from 1 to 247 Different slave nodes correspond to different addresses The slave nodes connected to the same communication bus must not have the same address 1 2 Glossary Master node runs in the background and is responsible for communicating with sla...

Page 8: ...ter node through the RS485 or RS232 serial ports Information transmission method 1 Use the RTU transmission mode of the Modbus 2 The transmission mode for the character information is asynchronous mode using a frame format of one start bit eight data bits information byte and one stop bit 10 bits in total 1 3 2 Data Transmission Speed The data transmission baud rate is fixed at 9600 bit s When con...

Page 9: ... to set the DIP switch Table 1 1 lists the mapping between addresses and toggle switches Table 1 1 Mapping between addresses and toggle switches Addre ss Toggle Switch 1 Toggle Switch 2 Toggle Switch 3 Toggle Switch 4 Toggle Switch 5 Toggle Switch 6 Toggle Switch 7 Toggle Switch 8 1 OFF ON ON ON ON ON ON ON 2 ON OFF ON ON ON ON ON ON 3 OFF OFF ON ON ON ON ON ON 4 ON ON OFF ON ON ON ON ON 5 OFF ON ...

Page 10: ... OFF OFF OFF OFF ON ON ON ON 16 ON ON ON ON OFF ON ON ON 17 OFF ON ON ON OFF ON ON ON 18 ON OFF ON ON OFF ON ON ON 19 OFF OFF ON ON OFF ON ON ON 20 ON ON OFF ON OFF ON ON ON 21 OFF ON OFF ON OFF ON ON ON 22 ON OFF OFF ON OFF ON ON ON 23 OFF OFF OFF ON OFF ON ON ON 24 ON ON ON OFF OFF ON ON ON 25 OFF ON ON OFF OFF ON ON ON 26 ON OFF ON OFF OFF ON ON ON 27 OFF OFF ON OFF OFF ON ON ON 28 ON ON OFF OF...

Page 11: ...le Switch Definition Settings Remarks 1 Reserved ON 0 OFF 1 Toggle switches 1 2 and 3 are used together to set a 3 bit baud rate Currently the software version supports only a baud rate of 9600 bits s in this case toggle switches 1 2 and 3 are ON 2 Reserved ON 0 OFF 1 3 Reserved ON 0 OFF 1 4 RS485 protocol toggle switch ON 0 OFF 1 0 Modbus protocol 5 Toggle switch for selecting a two wire or four ...

Page 12: ...tended card slot of the UPS and tighten the screws as shown in Figure 1 4 Figure 1 4 Inserting the Modbus card into the optional card slot Step 4 Set up a network as shown in Figure 1 5 1 Connect the COM_1 port the COM_2 port is used for cascading on the Modbus card to the RS485 port on the RS232 RS485 adapter over a network cable a shielded twisted pair is recommended that meets pin sequence requ...

Page 13: ... RJ45 port pins For port pin definitions and cable connections see Table 1 3 Figure 1 6 RJ45 ports Table 1 3 Pins on an RJ45 port Pin No Signal Corresponding Signal of RS232 RS485 Adapter Two wire system Four wire system 1 Four wire system RS485 TX Two wire system A A RS485 RX 2 Four wire system RS485 TX Two wire system B B RS485 RX 3 None N A N A 4 Four wire system RS485 RX N A RS485 TX 5 Four wi...

Page 14: ...des receive the relevant command the slave nodes return the queried information to the master node under normal conditions Under abnormal conditions the slave nodes return the specific error codes corresponding to the error types Table 1 4 lists the error codes Table 1 4 Error code list No Name Description 0x01 Invalid function code Slave nodes received unsupported or incorrect function codes 0x02...

Page 15: ...r 1 5 1 Function Code List Function Code Meaning Remarks 0x03 Read command Continuously read a single or multiple registers 0x06 Write single register command Write commands to a single register 0x2B Read device identifier command N A 1 5 2 CRC Checking Algorithm unsigned short count_CRC unsigned char addr int num unsigned short CRC 0xFFFF int i while num CRC addr for i 0 i 8 i if CRC 1 CRC 1 CRC ...

Page 16: ...s of a set of addressable data elements The data elements are objects to be read and the object IDs determine these data elements A data element consists of three elements Basic device identifier All objects are mandatory such as the manufacturer name product code and revision version Normal device identifier Except the basic data objects the device provides additional and optional identifiers and...

Page 17: ...4 request to obtain the special device identifier special access If the identifier data is not suitable for individual responses you can require several request and response transactions The object ID byte provides the first identifier code obtained For the first transaction the client must set the object ID to 0x00 to obtain the start of the device identifier data For the subsequent transactions ...

Page 18: ...ream access and single access More If the identifier code is 0x01 0x02 or 0x03 stream access and the identifier data does not match the single response you can require several request and response transactions 0x00 The object is no longer usable 0xFF Other identifier objects are usable and more Modbus transactions are required For the ReadDevID code 0x04 single access this field must be set to 0x0...

Page 19: ...t Response Domain Value Domain Value Function Code 0x2B Function Code 0x2B MEI Type 0x0E MEI Type 0x0E ReadDevID Code 0x01 ReadDevID code 0x01 Object ID 0x00 Consistency Level 0x01 More 0x00 Next Object ID 0x00 Object Number 0x03 Object ID 0x00 Object Length 0x16 Object Value Company identifier Object ID 0x01 Object Length 0x0A Object Value Product code Object ID 0x02 Object Length 0x05 Object Val...

Page 20: ...vel 0x01 More 0xFF Next Object ID 0x02 Object Number 0x03 Object ID 0x00 Object Length 0x16 Object Value Company identifier Object ID 0x01 Object Length 0x1A Object Value Product code Second transaction Request Response Domain Value Domain Value Function Code 0x2B Function Code 0x2B MEI Type 0x0E MEI Type 0x0E ReadDevID Code 0x01 ReadDevID code 0x01 Object ID 0x02 Consistency Level 0x01 More 0x00 ...

Page 21: ... 1 byte 0x2B MEI Type 1 byte 0x0E ReadDevID Code 1 byte 0x01 Consistency Level 1 byte 0x01 More 1 byte N A Next Object ID 1 byte N A Object Number 1 byte N A Object List First Object Object ID 1 byte 0x00 Object Length 1 byte N Object Value N byte N A Object ID Object Name or Description Description Category 0x00 Manufacturer name HUAWEI Basic 0x01 Product code UPS2000 UPS2000A 0x02 Main revision ...

Page 22: ...address 03 is the read command 2AF8 is the register address 0001 indicates the number of registers to be read is 1 0F73 is the CRC checking value 1 5 4 2 2 Response Frame Format Byt e 0 1 2 3 4 5 6 L 1 L 2 L 3 L 4 Fiel d AD DR CM D Len gth MS B LSB MS B LSB MS B LSB LSB MS B Des crip tion Con troll er addr ess Co mm and type Dat a leng th L n x 2 First register value Second register value Last reg...

Page 23: ...0 01 52 BA 11 is the slave device address 06 is the write single register command 2B15 is the register address 0001 is the setting value 52BA is the CRC checking value 1 5 5 2 2 Response Frame Format Byte 0 1 2 3 4 5 6 7 Field ADDR CMD MSB LSB MSB LSB LSB MSB Descri ption Control ler address Comma nd type Register address Data CRC checking The format of the request and response frames is the same ...

Page 24: ...short integers to avoid the Modbus frames transmitting overly complex data For the R W attributes R is read only W is write only and RW is read and write For the register addresses N is the UPS number with a range from 1 to 4 This number is assigned by the RMS MODBUS01A card You can identify any UPS number by its corresponding ESN number For example the register address of the UPS 1 phase A input ...

Page 25: ...pass frequency Floating point 10 Hz N1007 1 R Output phase voltage A Floating point 10 V N1008 1 R Output phase voltage B Floating point 10 V N1009 1 R Output phase voltage C Floating point 10 V N1010 1 R Output current A Floating point 10 A N1011 1 R Output current B Floating point 10 A N1012 1 R Output current C Floating point 10 A N1013 1 R Output frequency Floating point 10 Hz N1014 1 R Output...

Page 26: ...its R W Attribute apparent power C point Load ratio A Floating point 10 N1021 1 R Load ratio B Floating point 10 N1022 1 R Load ratio C Floating point 10 N1023 1 R Power status Unsigned short integer 16 bits 1 0 No power supplied 1 Bypass mode 2 Mains mode 3 Battery mode 5 Mains ECO 6 Battery ECO N1024 1 R Input mode Unsigned short integer 16 bits 1 0 single p hase 1 three ph ase The input system ...

Page 27: ...signed short integer 16 bits 1 0 single p hase 1 three ph ase The output system determi nes whether the bypass and output modes are single or three ph ase N1026 1 R Inside UPS temperature Floating point 10 C N1027 1 R Redundant number Unsigned short integer 16 bits 1 0 3 N1041 1 R Battery voltage Floating point 10 V N2000 1 R Battery current Floating point 10 A N2001 1 R Battery status Unsigned sh...

Page 28: ...kW N4000 1 R Parallel output active power B Floating point 10 kW N4001 1 R Parallel output active power C Floating point 10 kW N4002 1 R Parallel output apparent power A Floating point 10 kVA N4003 1 R Parallel output apparent power B Floating point 10 kVA N4004 1 R Parallel output apparent power C Floating point 10 kVA N4005 1 R Parallel load ratio A Floating point 10 N4006 1 R Parallel load rati...

Page 29: ... to the right N9006 bit 3 2 1 R Energy flow diagram segment 3 Unsigned short integer 16 bits 1 00 hollow 01 solid 10 flow to the right N9006 bit 5 4 1 R Energy flow diagram segment 4 Unsigned short integer 16 bits 1 00 hollow 01 solid 10 flow downwa rds 11 flow upwards N9006 bit 7 6 1 R Energy flow diagram segment 5 Unsigned short integer 16 bits 1 00 hollow 01 solid 10 flow to the right N9006 bit...

Page 30: ... 00 hollow 01 solid 10 flow to the right N9006 bit 15 14 1 R UPS hardware power level Unsigned short integer 16 bits 1 16 6 kVA 32 10 kVA 64 20 kVA N9007 1 R UPS device connection state Unsigned short integer 16 bits 1 1 normal 0 disconn ect 2 normal commun ication invalid service function s Not used to determi ne whether the UPS is online N9008 1 R UPS model Floating point 10 0 100 N9009 1 R UPS ...

Page 31: ...ting point type returned by one register 0xFFFF invalid value of a type other than the floating point type returned by one register 0xFFFFFFFF invalid value returned by two registers 2 1 3 Configuration and Control Signal List Signal Name Parameter Type Range Gain Register Address Address Length Number of Digits R W Attribute Startup state Unsigned short integer 16 bits 00 Shutdown you can start 0...

Page 32: ...nly configurable when the startup state is 00 or 10 1 N1031 1 R EPO Unsigned short integer 16 bits The register value is fixed at 1 1 N1042 1 W Shallow discharg e test Unsigned short integer 16 bits 0 disabled 1 enabled 1 N2008 1 RW Time interval Unsigned short integer 16 bits 30 90 Day 1 N2009 1 RW Discharg e ratio Unsigned short integer 16 bits 10 50 1 N2010 1 RW Battery conversi on from floatin...

Page 33: ...om manual charging to floating charging Unsigned short integer 16 bits The register value is fixed at 1 1 N2016 1 W Battery test Unsigned short integer 16 bits 0 Both a shallow discharge test and a capacity test can be conducted If bit 15 is 1 and bits 14 8 are 0 Only a shallow discharge test can be conducted Other cases No test can be conducted 1 N2019 1 R Shallow discharg e test Unsigned short i...

Page 34: ... basic register address UPS number x 1024 The range of the UPS number is from 1 to 4 For example the register address of the UPS 1 mains abnormal voltage alarm is 40155 1024 41179 0xA0DB the register address of the UPS 2 mains abnormal voltage alarm is 40155 2 x 1024 42203 0xA4DB When the RMS MODBUS01A card is connected to only one UPS you can use 0 as the UPS number That is you can directly use t...

Page 35: ...Mains overload 40156 2 0030 1 UPS internal overtemperature 40156 3 0041 3 Rectifier fault 40156 4 0065 2 Power segment 40156 5 0061 1 Inverter alarm 40158 0 0061 2 Inverter alarm 40158 1 0065 1 Power segment 40159 0 0067 1 Parallel set failure 40159 1 0084 2 Parallel cable alarm 40159 2 0084 3 Parallel cable alarm 40159 3 0094 1 Redundancy failure 40159 4 0131 1 Ambient overtemperature 40160 0 013...

Page 36: ... 1 Bypass neutral loss 40165 6 0096 1 Abnormal ECO voltage 40165 13 0028 1 Breaker OFF 40168 0 0028 2 Breaker OFF 40168 1 0028 3 Breaker OFF 40168 2 0105 5 Communication failure 40168 3 0125 1 Inconsistent parallel parameters 40168 4 61440 1 Flash fault 40168 5 0040 1 Rectifier fault 40169 0 0040 2 Rectifier fault 40169 1 0040 4 Rectifier fault 40169 3 0040 5 Rectifier fault 40169 4 0040 6 Rectifi...

Page 37: ... 4 0042 11 Internal fault 40171 5 0042 12 Internal fault 40171 6 0042 13 Internal fault 40171 7 0159 1 Battery mode alarm 40171 8 0060 1 Inverter fault 40172 0 0060 2 Inverter fault 40172 1 0060 3 Inverter fault 40172 2 0060 4 Inverter fault 40172 3 0060 5 Inverter fault 40172 4 0060 8 Inverter fault 40172 7 0042 3 Internal fault 40172 14 0044 4 Incompatible version 40173 0 0044 5 Incompatible ver...

Page 38: ...ule internal fault 40174 12 0158 1 Bypass mode alarm 40174 13 0031 1 Battery OTP 40179 3 0001 4 Abnormal mains voltage 40179 12 0042 14 Internal fault 40179 13 0042 15 Internal fault 40179 14 0042 17 Internal fault 40179 15 0035 1 Replace battery 40180 0 0042 18 Internal fault 40180 1 0042 19 Internal fault 40180 2 0042 20 Internal fault 40180 3 0042 23 Internal fault 40180 4 0042 24 Internal faul...

Page 39: ...nternal fault 40182 1 0042 40 Internal fault 40182 2 0042 41 Internal fault 40182 3 0042 42 Internal fault 40182 4 0085 1 EPO 40182 5 0042 48 Internal fault 40182 8 0042 49 Internal fault 40182 9 0042 60 Internal fault 40182 10 0043 2 Fan fault 40182 11 0058 1 Flash fault 40182 12 0066 3 Output overload 40182 13 0066 4 Output overload 40182 14 0059 1 Maintenance breaker ON 40182 15 0042 55 Interna...

Page 40: ...types of the communication protocols you can identify the register addresses of every UPS semaphore There is a need for the UPS serial number offset Before collecting and setting the UPS semaphores query the condition of the southbound connections between the RMS MODBUS01A card and the UPS and confirm the number assigned to every UPS by the RMS MODBUS01A card ensuring normal query of semaphores ne...

Page 41: ...e for the convenience of viewing the response frame is shown in segments 11 2B 0E 01 01 00 00 03 00 06 48 55 41 57 45 49 01 07 55 50 53 32 30 30 30 02 13 55 50 53 32 30 30 30 20 56 31 30 30 52 30 30 31 43 30 30 D9 03 According to section 1 5 3 4 Query Device Identification Information Command the following information can be obtained Object ID Object Name or Description Description 0x00 Manufactur...

Page 42: ...e UPS number you can query and set the corresponding semaphores C Query the phase A input voltage of UPS 1 Query frame 11 03 2A F8 00 01 0F 73 Response frame 11 03 02 08 9D BF EE According to section 2 1 2 Collection Signal List the register address of the UPS 1 phase A input voltage is 11000 which is 0x2AF8 in hexadecimal format The response data is 0x089D which is 2205 in decimal format Divided ...

Page 43: ...iations Issue 02 2016 03 10 Huawei Proprietary and Confidential Copyright Huawei Technologies Co Ltd 37 A Acronyms and Abbreviations C CRC Cyclical Redundancy Check E ECO Economic Control Operation EOD End Of Discharge EPO Emergency Power Off U UPS Uninterruptible Power Supply ...

Reviews: