MODBUS APPLICATION MANUAL DFC-0124

Transcription

1 MODBUS APPLICATION MANUAL DFC

2 COPYRIGHT NOTICE Any unauthorized use or copying of the contents or any part of this document is prohibited. This applies in particular to trademarks, model denominations, part numbers and drawings. ABOUT THIS DOCUMENT This document describes minimum required details for the successfull interfacing of the DFC-0124 family units to 3rd party Modbus and Modbus-TCP/IP based applications. Follow carefully advices given in the document. These are often good practices for the installation of the unit which reduce future issues. For all technical queries please contact Datakom at below address: SCOPE OF THIS DOCUMENT This document will apply to both Modbus through RS-485 and Modbus-TCP/IP communications. RELATED DOCUMENTS FILENAME 0124_DATA 0124_TFT_DATA 0124_PRESENTATION DFC0124 Brochure DFC0124-TFT Brochure DFC0124 Power Factro Controller and Remote Monitoring Presentation REVISION HISTORY REVISION DATE AUTHOR TO First release. Firmware V4.7 TERMINOLOGY CAUTION: Potential risk of injury or death. WARNING: Potential risk of malfunction or material damage. ATTENTION: Useful hints for the understanding of device operation

3 The Modbus communication is widely used in the connection of industrial control units to various management systems for remote monitoring and control. It has begun the basic industry standard in the last decades. The unit offers the possibility of MODBUS communication through below carriers: -RS485 serial port, with adjustable baud rate between 2400 and bauds -MODBUS-TCP/IP through Ethernet port (10/100Mb) -MODBUS-TCP/IP through GSM-GPRS modem. (84/42kb) Detailed description about the MODBUS protocol is found in the document Modicon Modbus Protocol Reference Guide. This document may be downloaded at: Detailed description about the MODBUS-TCP/IP protocol is found in the document MODBUS APPLICATION PROTOCOL SPECIFICATION. This document may be downloaded at: The MODBUS properties of the unit are: -Data transfer mode: RTU -Serial data: selectable baud rate, 8 bit data, no parity, 1 bit stop -Modbus-TCP/IP: Ethernet 10/100Mb or GPRS Class 10. -Supported functions: MODBUS COMMUNICATION BASICS -Function 3 (Read multiple registers) -Function 6 (Write single register) -Function 16 (Write multiple registers) Each register consists of 2 bytes (16 bits). A larger data structure will contain multiple registers. MODBUS CONFIGURATION The Modbus communications requires a slave address to be assigned to each device in the Modbus network. This address ranges between 1 and 240 and allows the addressing of different slave devices in the same network. Each device in the same RS-485 serial network must be assigned a different slave address. Otherwise the Modbus communications will not be performed. Devices using Modbus-TCP/IP with different IP or port addresses may use any slave address. It is advised to set these slave addresses to the default setting which is

4 Parameters required for RS-485 Modbus operation Modbus Slave Address: may be set between 1 and 240 RS-485 Enable: must be set to 1 (or checkbox enabled) RS-485 Baud Rate: selectable between 2400 and bauds. All devices in the same network must use the same Baud Rate. Selecting a higher baud rate will allow faster communication, but will reduce the communication distance. Selecting a lower baud rate will increase the communication distance, but will cause slower response times. Typically 9600 bauds will allow 1200m distance with special balanced 120 ohms cable. Parameters required for Modbus-TCP/IP through Ethernet port Modbus Slave Address: may be set between 1 and 240. If only one unit is available in the same IP address, it is advised to keep the default address (1). Ethernet Enable: This parameter should be set to 1 (or checked) in order to enable the ethernet port. Modbus TCP/IP Port: The usual setting is 502. However the unit is able to work on any port address. User IP Mask: There are 3 mask registers available. The use of the registers are emphasized in the D- 500/700 User Manual. Please set the first mask as for the proper operation. Ethernet Network IP: May be left as for automatic address claim or set to a value in order to claim a defined address. Ethernet Gateway IP: Should be set in accordance with your local switch configuration. Ethernet Subnet Mask: Should be set in accordance with your local switch configuration. Parameters required for Modbus-TCP/IP through GSM_GPRS Modem Modbus Slave Address: may be set between 1 and 240. If only one unit is available in the same IP address, it is advised to keep the default address (1). Modem Selection: Internal or external following your configuration. Modem Baud Rate: Selectable only for external modem bauds advised. Selecting a lower baud rate will slow down communication between the controller and the modem. GPRS Connection Enable: This parameter should be set to 1 (or checked). Modbus TCP/IP Port: Set this value to 80. User IP Mask: There are 3 mask registers available. The use of the registers are emphasized in the DFC User Manual. Please set the first mask as for the proper operation

5 Modbus address Modbus-TCP/IP port Modem Selection RS-485 port enable RS-485 Baud Rate - 5 -

6 User Masks IP Ethernet port enable Ethernet IP address Ethernet gateway IP Ethernet subnet mask GPRS enable - 6 -

7 DATA READING The function 03 (read multiple registers) will be used for data reading. The MODBUS master will send a query. The answer will be one of the below: -A response containing the requested data -An exceptional response indicating a read error. The maximum number of registers read in one message is 16. If more registers are requested, the unit will send only the first 16 registers. The query message specifies the starting register and quantity of registers to be read. message structure is below: The Byte Description Value 0 Controller address 1 to Function code 3 2 Starting address high See below the description of available registers 3 Starting address low 4 Number of registers high always 0 5 Number of registers low max 10h (16 decimal) 6 CRC low byte See below for the checksum calculation 7 CRC high byte Here is the sequence to read 16 registers starting from address 20h (32 decimal): CC (each byte is expressed as 2 hexadecimal characters) The checksum value in the above message may be used for the verification of checksum calculation algorithm. The normal response will be: Byte Description Value 0 Controller address same as in the query 1 Function code 3 2 Data lenght in bytes (L) number of registers * 2 3 High byte of 1st register 4 Low byte of 1st register 5 High byte of 2nd register 6 Low byte of 2nd register... L+1 High byte of the last register L+2 Low byte of the last register L+3 CRC low byte See below for the checksum calculation L+4 CRC high byte The exceptional response will be: Byte Description Value 0 Controller address same as in the query 1 Function code 131 (function code + 128) 2 Exception code 2 (illegal address) 3 CRC low byte See below for the checksum calculation 4 CRC high byte - 7 -

8 DATA WRITING (SINGLE REGISTER) The function 06 (write single register) and the function 16 (write multiple registers) are used for data writing. The MODBUS master will send a query containing data to be written. The answer will be one of the below: -A normal response confirming successful write, -An exceptional response indicating a write error. Only some of the available registers are authorized to be written. An attempt to write a write protected register will result to the exceptional response. The query message specifies the register address and data. The message structure is below: Byte Description Value 0 Controller address 1 to Function code 6 2 Register address high See below the description of available registers 3 Register address low 4 Data high byte 5 Data low byte 6 CRC low byte See below for the checksum calculation 7 CRC high byte Here is the sequence to write the value 0010h to the register 40h (64 decimal): D2 (each byte is expressed as 2 hexadecimal characters) The checksum value in the above message may be used for the verification of checksum calculation algorithm The normal response will be the same as the query: Byte Description Value 0 Controller address 1 to Function code 6 2 Register address high See below the description of available registers 3 Register address low 4 Data high byte 5 Data low byte 6 CRC low byte See below for the checksum calculation 7 CRC high byte The exceptional response will be: Byte Description Value 0 Controller address same as in the query 1 Function code 134 (function code + 128) 2 Exception code 2 (illegal address) or 10 (write protection) 3 CRC low byte See below for the checksum calculation 4 CRC high byte - 8 -

9 DATA WRITING (MULTIPLE REGISTERS) The function 06 (write single register) and the function 16 (write multiple registers) are used for data writing. The MODBUS master will send a query containing data to be written. The answer will be one of the below: -A normal response confirming successful write, -An exceptional response indicating a write error. Only some of the available registers are authorized to be written. An attempt to write a write protected register will result to the exceptional response. The query message specifies the register address and data. The message structure is below: Byte Description Value 0 Controller address 1 to Function code 16 2 Starting address high See below the description of available registers 3 Starting address low 4 Number of registers high always 0 5 Number of registers low max 6 Data lenght in bytes (L) number of registers * 2 7 High byte of 1st register 8 Low byte of 1st register 9 High byte of 2nd register 10 Low byte of 2nd register... L+5 High byte of the last register L+6 Low byte of the last register L+7 CRC low byte See below for the checksum calculation L+8 CRC high byte The normal response is below: Byte Description Value 0 Controller address 1 to Function code 16 2 Starting address high See below the description of available registers 3 Starting address low 4 Number of registers high always 0 5 Number of registers low max 6 CRC low byte See below for the checksum calculation 7 CRC high byte The exceptional response will be: Byte Description Value 0 Controller address same as in the query 1 Function code 144 (function code + 128) 2 Exception code 2 (illegal address) or 10 (write protection) 3 CRC low byte See below for the checksum calculation 4 CRC high byte - 9 -

10 Here is a procedure for generating a CRC: CRC CALCULATION 1) Load a 16 bit register with FFFF hex (all 1 s). Call this the CRC register. 2) Exclusive OR the first 8 bit byte of the message (the function code byte) with the low order byte of the 16 bit CRC register, putting the result in the CRC register. 3) Shift the CRC register one bit to the right (toward the LSB), zero filling the MSB. Extract and examine the LSB. The LSB is the least significant bit of the CRC before the shift operation. 4) If the LSB is 1: Exclusive OR the CRC register with the polynomial value A001 hex. 5) Repeat Steps 3 and 4 until 8 shifts have been performed. Thus, a complete 8 bit byte will be processed. 6) Repeat Steps 2 through 5 for the next 8 bit byte of the message. Continue doing this until all bytes have been processed. 7) The final contents of the CRC register is the CRC value. 8) Place the CRC into the message such that the low byte is transmitted first. The algorithm should give the correct CRC for below messages: CC D2 Error codes Only 3 error codes are used: 01: illegal function code 02: illegal address 10: write protection (attempt to write a read_only register) Data types Each register consists of 16 bits (2 bytes) If the data type is a byte, only the low byte will contain valid data. High byte is don t care. For data type longer than 16 bits, consecutive registers are used. The least significant register comes first. DATA FORMATS 16bit variables: These variables are stored in a single register. Bit_0 denotes the LSB and bit 15 denotes the MSB. 32 bit variables: These variables are stored in 2 consecutive registers. The high order 16 bits are in the first register and the low order 16 bits are in the second register Bit arrays: Arrays larger than 16 bits are stored in multiple registers. The LSB of the first register is bit_0. The MSB of the first register is bit_15. The LSB of the second register is bit_16. The MSB of the second register is bit_31, and so on

11 REGISTER DEFINITIONS BANKS ADDRESS (decimal) R / W DATA SIZE R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit R 48bit COEFF. Bank 1 kvar Bank 2 kvar Bank 3 kvar Bank 4 kvar Bank 5 kvar Bank 6 kvar Bank 7 kvar Bank 8 kvar Bank 9 kvar Bank 10 kvar Bank 11 kvar Bank 12 kvar Bank 13 kvar Bank 14 kvar Bank 15 kvar Bank 16 kvar Bank 17 kvar Bank 18 kvar Bank 19 kvar Bank 20 kvar Bank 21 kvar Bank 22 kvar

12 R 48bit R 48bit Bank 23 kvar Bank 24 kvar R 48bit SVC kvar BANKS STRUCTURE ADDRESS (decimal) R / W DATA SIZE COEFF. BASE+0 R 16bit Phase L1 BASE+1 R 16bit Phase L2 BASE+2 R 16bit Phase L3 DATE & TIME ADDRESS (decimal) R / W DATA SIZE COEFF R / W 16bit - Year (0-4095) 8193 R / W 16bit - Month (1-12) 8194 R / W 16bit - Date (1-31) 8195 R 16bit - Day of Week (0-6) 8196 R / W 16bit - Hours (0-23) 8197 R / W 16bit - Minutes (0-59) 8198 R / W 16bit - Seconds (0-59) 8199 R / W 16bit - Year (0-4095) (UTC) 8200 R / W 16bit - Month (1-12) (UTC) 8201 R / W 16bit - Date (1-31) (UTC) 8202 R 16bit - Day of Week (0-6) (UTC) 8203 R / W 16bit - Hours (0-23) (UTC) 8214 R / W 16bit - Minutes (0-59) (UTC) 8215 R / W 16bit - Seconds (0-59) (UTC)

13 COUNTERS ADDRESS (decimal) R / W DATA SIZE COEFF R / W 32bit kwh_1 Import R / W 32bit kwh_1 Export R / W 32bit kvarh_1 Inductive R / W 32bit kvarh_1 Capacitive R / W 32bit Group_1 Hour Counter R / W 32bit kwh_2 Import R / W 32bit kwh_2 Export R / W 32bit kvarh_2 Inductive R / W 32bit kvarh_2 Capacitive R / W 32bit Group_2 Hour Counter DEMAND MIN MAX & PUSHBUTTON SIMULATION ADDRESS (decimal) R / W DATA SIZE COEFF R 32bit Demand I R 32bit Demand I R 32bit Demand I R 32bit Demand In R 32bit 0 Demand kw R 32bit 0 Demand kvar R 32bit Minimum V R 32bit Minimum V R 32bit Minimum V R 32bit Minimum U R 32bit Minimum U R 32bit Minimum U R 32bit Minimum I R 32bit Minimum I R 32bit Minimum I3-13 -

14 12490 R 32bit Minimum In R 32bit 0 Minimum Frequency R 32bit 0 Minimum kw import R 32bit 0 Minimum kw export R 32bit 0 Minimum kvar inductive R 32bit 0 Minimum kvar capacitive R 32bit Maximum V R 32bit Maximum V R 32bit Maximum V R 32bit Maximum U R 32bit Maximum U R 32bit Maximum U R 32bit Maximum I R 32bit Maximum I R 32bit Maximum I R 32bit Maximum In R 32bit 0 Maximum Frequency R 32bit 0 Maximum kw Import R 32bit 0 Maximum kw Export R 32bit 0 Maximum kvar Inductive R 32bit 0 Maximum kvar Capacitive W 16bit - Pushbutton Simulation BIT 0: Simulate Down Arrow Button BIT 1: Simulate Left Arrow Button BIT 2: Simulate Right Arrow Button BIT 3: Simulate Up Arrow Button W 16bit - Return to Factory Settings W 16bit - Reset Counters. (Value should set to 0)

15 MEASUREMENTS ADDRESS (decimal) R / W DATA SIZE COEFF R 32bit Phase L1 Voltage R 32bit Phase L2 Voltage R 32bit Phase L3 Voltage R 32bit Phase L1-L2 Voltage R 32bit Phase L2-L3 Voltage R 32bit Phase L1-L3 Voltage R 32bit Phase L1 Current R 32bit Phase L2 Current R 32bit Phase L3 Current R 32bit Neutral Current R 32bit Phase L1 Active Power R 32bit Phase L2 Active Power R 32bit Phase L3 Active Power R 32bit Total Active Power R 32bit Phase L1 Reactive Power R 32bit Phase L2 Reactive Power R 32bit Phase L3 Reactive Power R 32bit Total Reactive Power R 32bit Phase L1 Apparent Power R 32bit Phase L2 Apparent Power R 32bit Phase L3 Apparent Power R 32bit Total Apparent Power R 16bit 00 Phase L1 Power Factor R 16bit 00 Phase L2 Power Factor R 16bit 00 Phase L3 Power Factor R 16bit 00 Total Power Factor R 16bit 0 Frequency R 16bit Temperature R 16bit Generator Input Voltage

16 R 32bit Average Ph-N Voltage R 32bit Average Ph-Ph Voltage R 32bit Average Current R 16bit Phase L1 Tangent R 16bit Phase L2 Tangent R 16bit Phase L3 Tangent R 16bit Total Tangent ALARM, OUTPUT BITS & STATISTICS ADDRESS (decimal) R / W DATA SIZE COEFF R 16bit - Alarms BIT 0: Not Three Phase BIT 1: First Banks Not Three Phase BIT 2: Current Transformer Error BIT 3: High Voltage BIT 4: Low Voltage BIT 5: High Frequency BIT 6: Low Frequency BIT 8: Low kw BIT 9: High kvar BIT 10: Low kvar BIT 11: High Cos BIT 12: Low Cos BIT 13: High Current BIT 14: High THDV BIT 15: High THDI R 16bit - Alarms BIT 7: High kw BIT 0: Reserved BIT 1: Voltage Unbalance BIT 2: Current Unbalance BIT 3: Reserved BIT 4: Reserved BIT 5: Phase Sequence BIT 6: Capacitor Error BIT 7: High Temp Alarm BIT 8: High Temp Warning BIT 9: Low Temp Alarm BIT 10: Temp Fail Alarm BIT 11: Current Transformer Error BIT 12: Daily Ind/Cap Alarm BIT 13: Monthly Ind/Cap Alarm BIT 14: Internal Alarm BIT 15: SVC Error

17 23340 R 16bit Daily Inductive % R 16bit Daily Capacitive % R 16bit Monthly Inductive % R 16bit Monthly Capacitive % R 16bit - Output States (Out1-Out12) R 16bit - Output States (Out13-Out24) HARMONICS AND WAVEFORM INFORMATION ADDRESS (decimal) R / W DATA SIZE COEFF R 4368bit R 4368bit R 4368bit R 4368bit R 4368bit R 4368bit R 4368bit R 4368bit R 4368bit 27 - Phase L1 voltage, harmonics and waveform buffer - Phase L2 voltage, harmonics and waveform buffer - Phase L3 voltage, harmonics and waveform buffer - Phase L1-2 voltage, harmonics and waveform buffer - Phase L2-3 voltage, harmonics and waveform buffer - Phase L3-1 voltage, harmonics and waveform buffer - Phase L1 current, harmonics and waveform buffer - Phase L2 current, harmonics and waveform buffer - Phase L3 current, harmonics and waveform buffer

18 BUFFER STRUCTURE The buffer consists of 273 x 16 bit registers. The structure is below. ADDRESS (decimal) R / W DATA SIZE COEFF. BASE+0 R 16bit THD of this channel BASE+1 R 256bit 16x16 BASE+17 R 4096bit 256x16 x1 This string of 16 registers carry individual harmonics of the selected channel, staring from H#01 until H#31. The first register represents the fundamental and is always set to 100.0%. Scopemeter dataof the channel. Each register represents one point in the X axis of the scopemeter. The complete waveform is represented with 256 horizontal points. The register value is a signed integer. The sampling rate is 122us. Thus the buffer length is 256x122us, namely 31ms, presenting more than 1 cycle of the waveform. By representing these values in graphical form, a software oscilloscope can be made