Transcription
SETUP AND USER MANUALVersiCharge ACModBus
VersiCharge AC ModBusIndexContact Information, FCC Compliane, Other Information21. Additional Documentation Links32.Cyber Security43. How to use this guide53.1 Assumptions53.2 What you need54. ModBus Overview64.1 ModBus Background74.2 ModBus Protocol Format84.3 ModBus RTU Connection – All commercial child and parent units84.4 Set ModBus Address for Child Unit104.5 ModBus Polling114.6 Creating a ModBus Function11APPENDIX A – MODBUS MAP13APPENDIX B – GLOSSARY14ENDNOTES15
VersiCharge AC ModBusFiguresFigure 1. Read Serial/Catalog Number6Figure 2. Sample S/N ASCII Conversion7Figure 3. Sample S/N ASCII Conversion7Figure 4 Parent sending data to the child8Figure 5. ModBus RTU Settings9Figure 6. Name Child Unit – Set Child Address10Figure 7. Name Child Unit – Confirm ModBus Device Address10Figure 8. Changing the ModBus function from Pause to Remove Pause11Figure 9. Sample QModMaster Function12
VersiCharge AC ModBusContact InformationSiemens Industry, Inc.Smart Infrastructure Distribution Systems3617 Parkway Ln.Peachtree Corners, GA 30092Phone: om/versichargeFCC ComplianceThis equipment has been tested and found to comply with the limits for a class B digital device, pursuant to part 15 of the FCCRules. These limits are designed to provide reasonable protections against harmful interference in a residential installation.This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with theinstructions, may cause harmful interference to radio communications. However, this is no guarantee that interference willnot occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, whichcan be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one ormore of the following measures: Reorient or relocate the receiving antenna. Increase the separation between the equipment and the receiver. Connect the equipment to an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/TV technician for help. Changes or modifications not expressly approved by theparty responsible for compliance may void the user’s authority to operate the equipment and the warranty on the product.Other InformationProduct information is subject to change without notice. All trademarks are recognized as the property of their respectiveowners. For Siemens VersiCharge Warranty Terms and Conditions, see the Warranty section of this manual. 2021 SiemensIndustry, Inc. All rights reserved.2
VersiCharge AC ModBus1. Additional Documentation LinksTitleDescriptionLinkOCPP ImplementationGuide – Version 1.5Guide to implementation of software linkage tohardwareContact Siemens for more information.VersiCharge Installationand Operations ManualComplete manual and instructions for installation,operation, and maintenanceUL: usa.siemens.com/versichargeRegister VersiChargeVersiCharge registrationUL: Url %2fIEC: C: /109802027VersiChargeConfiguration ToolDownload the VersiCharge Configuration Tool toconnect and configure commercial chargers.Recommended for multiple charger installations:VersiCharge Mobile AppDownload the VersiCharge Mobile App to connectresidential chargers.Recommended for one charger/one account installations:usa.siemens.com/versichargeAndroid - Google Play:http://play.google.com/store/apps/details?id com.siemens.VersiChargeSGiOS - Apple 9897428923
VersiCharge AC ModBus2. Cyber SecuritySiemens VersiCharge is designed to connect with and communicate data upon a secure network. Commercial networks areresponsible for establishing and maintaining appropriate: firewalls, necessary authentications, data encryption, and antivirusprotections. Residential networks must be password protected to properly connect with and operate your VersiCharge.Siemens and its affiliates are not responsible for damage or loss caused by security breaches such as theft, unauthorizedaccess, interference, intrusion, and/or data information leaksSiemens provides product update releases. However, the customer must ensure its security measures are adequate, and thatneither these measures nor system functionality have been compromised. The customer must have its own testing programfor any software updates, including but not limited to code changes, configuration file changes, third-party software updatesor patches, and hardware change outs. This testing program should be designed to ensure the customer’s implementedsecurity measures remain un-compromised and that the system functionality in the customer’s environment operates asexpected.4
VersiCharge AC ModBus3. How to use this guideThis manual coaches the user on how to set up and operate the VersiCharge ModBus functionality including the basic steps toset unit address, understand function codes, and retrieve data from units.3.1AssumptionsThe guide is the cornerstone of the initial ModBus configuration, and is focused on educating the user in the basicunderstanding of ModBus.Customers can use any ModBus software, however, examples in this guide focus on the initial ModBus configuration usingfreeware, QModMaster. This manual is intended to give a basic understanding and instruction to implement VersiChargeModbus communication.The following is assumed: All components are correctly installed Parent devices are calibrated All components are wired to send/receive transmission All chargers have power Charger communications have been tested and the chargers are drawing the correct voltages All chargers are properly grounded For testing registers, QModMaster software has been installed on the communicating computer and is configured tocommunicate locally with VersiCharge chargers.3.2What you needFor ModBus communication to function properly, certain system requirements and components need to be properly set up—components may change depending on specific cases. ModBus network is set up as a daisy chain. NOTE: For testing, avoid responses from multiple devices with the same addressby ensuring that each device is set to a unique address. VersiCharge is connected to a computer network using either Wi-Fi or Ethernet. The PC Configuration Tool (VersiCharge AC series configurator can be found at: usa.siemens.com/versicharge) has beendownloaded/installed the PC Configuration Tool.The VersiCharge(s) have been registered/configured using the PCConfiguration Tool. ModBus software is existing, or the customer may download/install QModMaster freeware to the computer les/. Communication ports have been configured. Programmed MRB/MRM blocks. The ModBus communication has been tested and verified.5
VersiCharge AC ModBus4. ModBus OverviewModbus is a serial communication protocol for use with a programmable logic controller (PLC). It is a method used fortransmitting information over serial lines between electronic devices. The device requesting the information is called theModbus Parent and the devices supplying information are Modbus Children (here Child). In a standard Modbus network, thereis one Parent and up to 247 Children, each Child has a unique Address from 1 to 247. The Parent can also write information tothe Child. Modbus can be used to connect a supervisory computer with a Remote Terminal Unit (RTU) in supervisory controland Supervisory Control and Data Acquisition (SCADA). Versions of the Modbus protocol exist for serial lines (Modbus RTU andModbus ASCII) and for Ethernet and Wi-Fi (Modbus TCP).Using ModBus RTU protocol. VersiCharge makes real-time data available through the ModBus RTU protocol. ModBus Parentdevices connected to the charger can access (read) this data or write data to the charger’s registers, making deviceconfiguration changes and initiating control actions. A Child device will only send a single response to a parent’s data request.The ModBus protocol can be either RTU or TCP/IP. ModBus Parents are configured as a Master Request Block (MRB) and childunits are configured as ModBus Register Maps (MRM). Some charger details , such as the register block 40814 – 40818, alongwith the serial number and catalog number, are stored as hexadecimal values in the Modbus registers, but will need to beconverted into ASCII characters. See the sample table below:Figure 1. Read Serial/Catalog Number16
VersiCharge AC ModBusAlias00820Alias008300Catalog No. (6)(F1) 0x46311Catalog No. (7)(4-) 0x342D2Catalog No. (8)(1G) 0x31473(A1) 0x41314(AA) 0x00005Catalog No. (1)(8E) 0x3845S/N(1)(WB) 0x57426Catalog No. (2)(M1) 0x4D31S/N(2)(AF) 0x41467Catalog No. (3)(31) 0x3331S/N(3)(18) 0x31388Catalog No. (4)(0-) 0x302DS/N(4)(N0) 0x4E309Catalog No. (5)(4C) 0x3443S/N(5)(04) 0x3034Figure 2. Sample S/N ASCII ConversionFigure 3. Sample S/N ASCII Conversion2NOTE: Figures 2 and 3 are examples of Hexadecimal/ ASCII conversion. The customer will need to perform this conversion.4.1ModBus BackgroundSiemens recommends using any software, for example QModMaster as the VersiCharge ModBus interface, to test the ModBusregister prior to integration. QModMaster is a graphical user interface that allows easy communication with ModBus RTU andTCP slaves and includes a bus monitor for examining all traffic on the bus. The software is a free download and can bedownloaded at: s device communications are designated as either ModBus Parent or Child.7
VersiCharge AC ModBusFigure 4 Parent sending data to the child4.2ModBus Protocol FormatModbus messages may be one of two formats: RTU (RTU uses time gaps (3.5 character times) of silence for framing) or TCP/IPwhich provides a stream of octets (bytes) between applications.4.3ModBus RTU Connection – All commercial child and parent unitsVersiCharge ModBus supports both RTU and TCP communication. For detailed installation instructions / Physical ModBusconfiguration see the ModBus Communications Setup in the Installation and Operations Manual for VersiCharge which can befound at usa.siemens.com/versicharge.When connecting VersiCharge chargers using an RS-485 ModBus cable, avoid any branching of the connections (do not use astar or tee (T) configuration). Also, no more than two cables should be connected at any point on the RS-485 daisy chain--thisincludes connection points on instruments, converters, and terminal strips.The ModBus RTU settings are below:NOTE: The default device address is 2, and can be modifed by writing the desired valid value at register 0xA000 (40960).8Connection SetupSettingBaud Rate38400Minimum Timeout Setting2000 msMinimum Poll rate:1000 msData bits8ParityEven ParityStop Bit1 Stop Bit
VersiCharge AC ModBusFigure 5. ModBus RTU SettingsNOTE: The base ADDR should be set to 0 and the Endian should be set to “Big” for QModMaster. Please refer to your driver,plug-in, or software tool manual for the correct settings.For ModBus RTU Implementation Limitations see the table below.Function Codes Supporteda. 0x03(Multiple register read group wise with valid length of the read group)b. 0x10 (Multiple register write, parameter wise),c. 0x11(Broadcast). – Condition is to have a single unit connected on ModBusMax Length of wire4000 ftPolling Rate1000 msException Codes 02, 01, 039
VersiCharge AC ModBus4.4 Set ModBus Address for Child UnitFigure 6. Name Child Unit – Set Child Address3Figure 7. Name Child Unit – Confirm ModBus Device Address4NOTE: If there is no ModBus exception after the operation, attempt to connect to the device with the new address.10
VersiCharge AC ModBus4.5ModBus PollingThe polling interval should be greater than the total time consumed in reading the desired register values of all device(s).4.6Creating a ModBus FunctionThere are four pieces of information that are needed to request data from a Child unit: Child address Function code Data address/Register Number Cyclic Redundancy Check n(CRC) Error CheckChild AddressThe Child address of a Modbus is one byte in length and identifies the device which will respond to the request. Validaddresses range between 1 and 247. A Child device responds to the command/request when it receives a request with anaddress that matches its unique address. The Child response has the same value in the Child address field.Function CodeThe function field is one byte in length and tells the addressed Child which function to perform. The response function fieldtells the Parent what function the Child performed. For function codes supported by chargers acting as Parents, see the DataDescription column in Appendix A - ModBus Map.DataThe length of ModBus data fields is variable, depending on function and contains information the Child requires to performthe requested function, or it contains data being passed back to the Parent.Example:Figure 8. Changing the ModBus function from Pause to Remove Pause511
VersiCharge AC ModBusFigure 9. Sample QModMaster Function6CRC/ChecksumThe CRC field lets the receiving device determine if the response is corrupted. The sending device calculates a 16‐bit valuewhich is inserted into the error check field. The receiving device then performs the same calculation, without the error checkfield, on the response. The resulting value is compared to the error check field. When these two fields are not equal, a transmission error is indicated. The Parent ignores a bad transmission.Exception ResponsesWhen a ModBus Parent sends an invalid request/command to a ModBus Child, or tries to read an invalid holding register, anexception is generated. The data field of an exception response has the exception error code within it.CodeNameMeaning 02Illegal AddressInvalid address for the requested function. 01Illegal FunctionModBus function not supported. 03Illegal ValueThe value in the data field is not allowed for the that register.12
ModBus MapVersiCharge AC ModBususa.siemens.com/versichargeModbus RTUModbus TCPAPPENDIXA – MODBUSMAPBaud Rate: 38400Server Port: 502Minimum TimeoutSetting: 2000 msMinimum TimeoutSetting:TCP2000 msModbusRTUModbusMinimumPollrate:1000 msMinimum Pollrate:1000Port:ms 502BaudRate:38400Server8 Data bits Timeout Setting: 2000 msProtocol: IPv4 Minimum Timeout Setting: 2000 msMinimumMinimumMinimum Pollrate: 1000 msEven Parity Pollrate: 1000 ms8DataBitbitsProtocol: IPv41 StopEven Parity1NOTE:Stop Bit1. The ModBus RTU default device address is 2, and can be modified by writing a new valid value at register 0xA000.NOTE: 1. The ModBus RTU default device address is 2, and can be modified by writing a new valid value at register 0xA000.2. The ModBus TCP communication port supported is 502 and can not be modified.2. The ModBus TCP communication port supported is 502 and can not be modified.Address (External)Address (Hex)DescriptionRead/WriteScaleSize/Bytes40009 - 40010Reserved440016 - 40022Reserved34Data TypeData DescriptionRead 3-phase total/1-phase40033 - 400589C61Read OnlyReserved40059 - 4007340074Read meter data9C8AGet/Set Power level Setting Value52Current - 32-bit Signed1 & 2 amps,Voltage - 32-bit Signed3 & 4 voltagePhase/PF - 32-bit Signed5 & 6 phase/PFActive Power - Watts - 32-bit Signed7 & 8 active powerActive Energy - Watt Hour - 64-bit Signed9, 10, 11 & 12 active energyReactive Powe r- Watts - 32-bit Signed13 & 14 Reactive powerReactive Energy - Watt Hour - 64-bit Signed15, 16, 17 & 18 reactive energyNegative Active Energy - Watt Hour - 64-bit Signed19, 20, 21 & 22 Negative active energyNegative Reactive Energy - Watt Hour - 64-bit Signed23, 24, 25 & 26 Negative Reactive energy30Read/Write216-bit SignedPower level Percent (20-100)0 - 2 Hours delayGet/Set Delay400759C8BNOTE: Ready/write 0 2 hour delay,1 4 hour delay, 2 6 hour delay,3 8 hour delay, 4 no delay.See Data Description column.1 - 4 Hours delayRead/Write216-bit Signed2 - 6 Hours delay3 - 8 Hours delay4 - No delay4007640201 - 402079C8C9D09Get/Set Pause1. Add/remove Admin/user card tomemory.2. Authentication request/response.3. Read UIDRead/WriteRead/Write21416-bit SignedHex/ASCII1 - Pause ON2 - Pause OFFByte 1 1 Add admin card 2 Remove admin card (WO) 3 Add user card (WO) 4 Remove user card (WO) 5 Authentication Request (RO) 6 Authentication Success (WO) 7 Authentication Fail (WO) 8 Read UID of session in progress (RO) 9 last tapped UID information withAuthentication status (RO)Byte 2 1 Not Authenticated (RO) 2 Authenticated Locally (RO) 3 Authenticated Remotely (RO)Byte 3 ReservedByte 4 UID Size (RW)Byte 5 to 14 UID of the RFID card(4, 7 or 10bytes) (RW)40217 - 40300Reserved16840320 - 40799Reserved960408009F60Rated AmpsRead OnlyReserved40801 - 40813216-bit SignedRated (Maximum) Amps value which isconfigured from system configuration (6 to80 Amps)2640814 - 408189F6EFirmware versionRead Only10Hex ASCIIReport Firmware version string408199F73Unit derating valueRead Only216-bit SignedDerated setting Value in Ampere (Based onAmp switch setting) (6 to 80 Amps)Reserved40820 - 408251240826 - 408359F7AGet Catalog No.Read Only20Hex ASCIIGet unit catalog number40836 - 408509F84Get Serial No.Read Only30Hex ASCIIGet unit serial et Device Address166Write Only213
VersiCharge AC ModBusAPPENDIX B – GLOSSARYParent – The use of Parent here refers to the client. PLC, Simulator, External controller, automation system etc. can be theModBus Parent or Client.Child - The use of child here refers to the server. VersiCharge Parent or VersiCharge Child units are considered ModBus Child orServers.QModMaster – a free Qt-based implementation of a ModBus application. This user interface allows communication withModBus client and servers.ModBus Map – The ModBus map above is a detailed list of individual clients/servers and defines where data is stored(Address), what the data is (Data Description), data function (Description) and data types (Data Types).14
VersiCharge AC ModBusENDNOTES1QModMaster, Elbar, 09/07.2019, bid.4Ibid.5Ibid.6Ibid.15
VersiCharge AC ModBusNotes:16
VersiCharge AC ModBusNotes:17
Legal ManufacturerSiemens Industry, Inc.3617 Parkway Ln.Peachtree Corners, GA 30092United States of AmericaTelephone: 1 (800) [email protected] [email protected] doc no: R815083Article No. SIDS-T40157-00-4AUS 2021 by Siemens Industry, Inc.This document contains a general description of available technicaloptions only, and its effectiveness will be subject to specific variablesincluding field conditions and project parameters. Siemens does notmake representations, warranties, or assurances as to the accuracy orcompleteness of the content contained herein. Siemens reserves theright to modify the technology and product specifications in its solediscretion without advance notice.
Customers can use any ModBus software, however, examples in this guide focus on the initial ModBus configuration using freeware, QModMaster. This manual is intended to give a basic understanding and instruction to implement VersiCharge Modbus communication. The foll
