Page 2
EATON xChargeIn UDP Programmers Guide V 2.01 Table of contents Introduction ........................ Safety instructions.................... 1.1.1 Representation of safety instructions..........Verification of validity ..................Target group ....................Requirements....................Further documentation and software ............... UDP interface: Guidelines ..................Required command delays ................
Page 3
Fig. 1-1: Schematic overview (example) Safety instructions This document is an extension to the supplied manuals of xChargeIn. You must comply with all instructions and safety instructions in the supplied manuals! EATON xChargeIn, UDP Programmers Guide V 2.01...
Page 4
EATON xChargeIn UDP Programmers Guide V 2.01 1.1.1 Representation of safety instructions At various points in this manual, you will see notes and precautionary warnings regarding possible hazards. The symbols used have the following meaning: DANGER! indicates an imminently hazardous situation, which will result in death or serious bodily injury if the corresponding precautions are not taken.
Page 5
EATON xChargeIn UDP Programmers Guide V 2.01 Requirements The following requirements have to be met in order to use the UDP functionality: ● EATON xChargeIn S-series or M-series with firmware version 3.9.14 or higher ● The UDP interface is enabled by switching the DIP switch DSW1.3 to “ON”...
Page 6
The following time intervals are the minimum required waiting times between UDP commands in general and the scheduled repetition of the same command. Any application communicating with xChargeIn is required to comply with these waiting times. The minimum waiting time between any two UDP commands is defined as follows: ●...
Page 7
The following section provides information regarding the RFID authorization function as well as a method to detect if this function is enabled. All variants of the xChargeIn charging stations save the RFID tags in a whitelist, which can be deleted by performing a special reset or extended by using the master RFID card.
Page 8
Not empty charging Not empty unlocked and charging The following can be concluded for all device types listed as xChargeIn S- series: If the field “AuthON” is set to “0”, then the authorization function is disabled. 2.4.2 xChargeIn M-series xChargeIn M-series features a web interface with a dedicated setting for the authorization function.
Page 9
AC charging stations use a PWM (pulse width modulation) signal to communicate the maximum allowed charging current to the vehicle as specified in IEC 61851-1. All xChargeIn are AC charging stations. The actual current is solely controlled by the vehicle.
Page 10
EATON xChargeIn UDP Programmers Guide V 2.01 UDP commands General information Information When using UDP commands it is strongly recommended to protect your network to prevent unauthorized control. The following section will cover all available UDP commands and categorize them appropriately into commands meant for regular use and commands with specific use cases.
Page 11
If the IP address in the network is known, the use of report 1 as a unicast is recommended. It delivers more information as , but is not designed to be used as a broadcast to search for xChargeIn charging stations in the network. Command structure Command Parameters...
Page 12
EATON xChargeIn UDP Programmers Guide V 2.01 Field Contents Additional Description No backend communication is present. Backend Backend communication is present. Not synced time (for more information see “setdatetime”). Strong synced time (for more information see timeQ “setdatetime”). Weak synced time (for more information see “setdatetime”).
Page 13
EATON xChargeIn UDP Programmers Guide V 2.01 Field Contents Additional Description No cable is plugged. Cable is plugged into charging station. Cable is plugged into charging station and locked. This is the default idle state for all devices with permanently attached cable.
Page 14
EATON xChargeIn UDP Programmers Guide V 2.01 Field Contents Additional Description Timeout in seconds before the current setting uint32 currtime defined by the last command will Tmo CT Possible values: 0; 1 - 860400 be applied. Energy value in 0.1 Wh defined by the last...
Page 15
EATON xChargeIn UDP Programmers Guide V 2.01 Field Contents Additional Description Total energy consumption (persistent, device uint32 related) in 0.1 Wh. E total Possible values: Max. value is 99999999.9 Wh (higher values 0 - 999999999 will cause a counter overflow).
Page 16
EATON xChargeIn UDP Programmers Guide V 2.01 Field Contents Additional Description Maximum current value in mA that can be uint16 supported by the hardware of the device. Curr HW Possible values: This value represents the minimum of the 0; 6000 - 32000 DIP switch settings, cable coding and temperature monitoring function.
Page 17
EATON xChargeIn UDP Programmers Guide V 2.01 Example ● Vehicle is charging. ● report 100 report 101 will contain the same information until a new session is started. 3.2.6 UDP command: currtime The command currtime can be used to control the charging current at any time.
Page 18
EATON xChargeIn UDP Programmers Guide V 2.01 Reply structure Field Contents Additional Description TCH-OK: done Generic confirmation message Example 1 ● Vehicle is charging. ● currtime 7000 20 UDP command was sent (charging current should change to 7 A after 20 s).
Page 19
EATON xChargeIn UDP Programmers Guide V 2.01 Example 2 ● Cable is plugged into charging station and vehicle, furthermore the cable is locked. ● ena 0 Charging is not allowed due to UDP command ● currtime 7500 15 UDP command was sent to start the charging session.
Page 20
EATON xChargeIn UDP Programmers Guide V 2.01 3.2.7 UDP command: setenergy setenergy The command can be used to set an energy limit for an already running or the next charging session. If the energy limit is greater than or equal to the value in the...
Page 21
EATON xChargeIn UDP Programmers Guide V 2.01 Command structure Command Parameters Additional Description Close Open output [n] Pulse output with the specified number of pulses (pulses / kWh) and is stored in the >= 10 EEPROM; reasonably usable up to 150.
Page 22
EATON xChargeIn UDP Programmers Guide V 2.01 Example ● Authorization is set to "ON" ● Charging station and vehicle are ready to start the charging session 3.2.10 UDP command: stop stop The command can be used to deauthorize a charging session if the authorization function is activated.
Page 23
EATON xChargeIn UDP Programmers Guide V 2.01 Reply structure Field Contents Additional Description TCH-OK: done Generic confirmation message Example ● Authorization is set to "ON" ● Charging station and vehicle are ready to start the charging session ● RFID card has been held in front of the RFID reader and the charging session has started ●...
Page 24
“started [s]”. A reason for not setting the time stamp via NTP time sever could be that the charging station has no internet connection. If xChargeIn M-series is used, the time stamp will be provided by the XPU. setdatetime With the UDP command it is possible to set a date and a time for the charging station.
Page 26
EATON xChargeIn UDP Programmers Guide V 2.01 3.2.12 UDP command: display Command structure Command Parameters Additional Description Determines whether default or non-default values are used for the duration [text] is displayed. 0 = default (min duration = 2 sec, max duration = 10 sec, fixed token); 1 = min and max duration can be defined.
Page 27
EATON xChargeIn UDP Programmers Guide V 2.01 Reply structure Field Contents Additional Description TCH-OK: done Generic confirmation message UDP commands with permanent effects The following UPD commands should not be used regularly, especially not with mobile applications, as they change the device`s behavior permanently until they are overwritten or the device gets rebooted.
Page 28
EATON xChargeIn UDP Programmers Guide V 2.01 3.3.2 UDP command: curr curr The command can be used to control the target charging current at any time. This command directly changes the value in the "Curr user" field in port 2 curr .
Page 29
EATON xChargeIn UDP Programmers Guide V 2.01 curr booted. The only option to remove a setting without a restart is to over- currtime currtime write it with a command. When the setting is copied from "Curr timer" to "Curr user" the value from a previous...
Page 30
This function must be used with caution. It should be noted that all xChargeIn charging stations offer multiple ways to set up the device in such a way that electrical overload can be avoided. The hardware switches (DIP switches) allow to configure a limit for the maximum charging current that cannot be increased by UDP commands.
Page 31
Generic confirmation message UDP status messages xChargeIn will send status messages to the source/IP address of the last UDP command it received. That means if there is only one application in the network sending commands to the charging station, the application will get the information about the most important state changes without the need to poll reports.
Page 32
The information contained in the program guide does not create any expressly warranted properties or guaranties. Liability claims against EATON relating to material or immaterial damage caused by the use or non-use of the information contained in the program guide or by the use of incorrect or incomplete information are excluded.
Need help?
Do you have a question about the xChargeIn and is the answer not in the manual?
Questions and answers