background image

EATON xChargeIn UDP Programmers Guide V 2.01 

 

EATON xChargeIn, UDP Programmers Guide V 2.01 

 

© EATON 2018 

 

 

Table of contents

 

 

Introduction ................................................................................................................ 

3

 

1.1 

Safety instructions............................................................................................ 

3

 

1.1.1 

Representation of safety instructions................................................. 

4

 

1.2 

Verification of validity ....................................................................................... 

4

 

1.3 

Target group .................................................................................................... 

4

 

1.4 

Requirements................................................................................................... 

5

 

1.5 

Further documentation and software ............................................................... 

5

 

 

2

 

UDP

 

interface: Guidelines .........................................................................................

 

  6 

 

2.1

 

Required command delays ..............................................................................

 

  6 

 

2.2

 

Addressing and communication port................................................................

 

  6 

 

2.3

 

Recommended communication buildup scheme .............................................

 

  7 

 

2.4

 

RFID authorization ...........................................................................................

 

  7 

 

 

2.4.1 

xChargeIn S-series 

.......................................................................................

 

  7 

 

 

2.4.2 

xChargeIn M-series 

.......................................................................................

 

  8 

 

2.5

 

Current control .................................................................................................

 

  9 

 

UDP commands

 .......................................................................................................................... 

10

 

3.1 

General information

 ......................................................................................................... 

10

 

3.2 

UDP commands intended for regular use

 .................................................................... 

11

 

3.2.1 

UDP command: i

 .............................................................................................. 

11

 

3.2.2 

UDP command: report 1

 ................................................................................. 

11

 

3.2.3 

UDP command: report 2

 ................................................................................. 

12

 

3.2.4 

UDP command: report 3

 ................................................................................. 

14

 

3.2.5 

UDP command: report 1xx (historical log entries)

 ...................................... 

15

 

3.2.6 

UDP command: currtime

 ................................................................................ 

17

 

3.2.7 

UDP command: setenergy

 ............................................................................. 

20

 

3.2.8 

UDP command: output

 ................................................................................... 

20

 

3.2.9 

UDP command: start

 ....................................................................................... 

21

 

3.2.10 

UDP command: stop

 ....................................................................................... 

22

 

3.2.11 

UDP command: setdatetime

 .......................................................................... 

24

 

3.2.12 

UDP command: display

 .................................................................................. 

26

 

3.2.13 

UDP command: unlock

 ................................................................................... 

26

 

3.3 

UDP commands with permanent effects

 ...................................................................... 

27 

3.3.1 

UDP command: ena

 ........................................................................................ 

27

 

3.3.2 

UDP command: curr

 ........................................................................................ 

28

 

3.3.3 

UDP command: failsafe

 .................................................................................. 

30

 

3.4 

UDP status messages

 ..................................................................................................... 

31

 

 

Disclaimer

………………………………………………………………………………………………………………………………

 

32 

 

Содержание xChargeIn

Страница 1: ...xChargeIn UDP Programmers Guide V 2 01 ...

Страница 2: ...es 7 2 4 2 xChargeIn M series 8 2 5 Current control 9 3 UDP commands 10 3 1 General information 10 3 2 UDP commands intended for regular use 11 3 2 1 UDP command i 11 3 2 2 UDP command report 1 11 3 2 3 UDP command report 2 12 3 2 4 UDP command report 3 14 3 2 5 UDP command report 1xx historical log entries 15 3 2 6 UDP command currtime 17 3 2 7 UDP command setenergy 20 3 2 8 UDP command output 20...

Страница 3: ...mation from the charging station or to control the charging station with a UDP client PC software or smartphone app Using UDP the charging station can be integrated into a smart home which allows for example the current power consumption to be regulated in response to a photovoltaic system Fig 1 1 Schematic overview example 1 1 Safety instructions This document is an extension to the supplied manu...

Страница 4: ...rresponding safety measures are not taken a potentially hazardous situation can occur that may result in slight bodily injury Caution means that damage to property can occur if the corresponding safety measures are not taken ESD This symbol reminds you of the possible consequences of touching electro statically sensitive components 1 2 Verification of validity The user of this document is obligate...

Страница 5: ... switch DSW1 3 to ON for details regarding the DIP switches see the installation manual A PC or smartphone for sending the UDP commands This also requires a suitable UDP client software or UDP app The charging station has to be connected via LAN cable or WLAN to the same network as the application 1 5 Further documentation and software Manuals further information and software downloads are availab...

Страница 6: ...e minimum waiting time between the scheduled repetitions of any UPD command is defined as follows t_COM_pause 5 s The minimum waiting time after sending a disable command e g ena 0 is defined as follows t_DIS_pause 2 s 2 2 Addressing and communication port Always use direct addressing for communication This means that each command or UDP session has to contain the IP address of the specific chargi...

Страница 7: ...UDP_pause Now the complete device data and all acquirable information is available to the application 2 4 RFID authorization 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...

Страница 8: ...ch also houses the WiFi components The RFID authorization can be deactivated even though the whitelist of the charging station is not empty xChargeIn M series will behave like xChargeIn S series after a restart until the COM module is ready 5 min after restart The data shown in the following table can be acquired using the command report 2 Whitelist Operating status State Plug AuthON Authreq Empty...

Страница 9: ...fected commands are currtime and curr The request to stop charging via currtime 0 1 will not be delayed and executed as soon as possible When a command either currtime or curr sets a new value for Curr user the device prepares to change the target current within the next 6 7 seconds If another current change is requested via UDP command during this period of time the target current will be overwri...

Страница 10: ...e used because otherwise all charging stations would react The commands are sent to the charging station as simple text commands without end characters such as CR or LF The replies come as data packages with up to 512 bytes and are formatted in JSON standard Fig 3 2 Example of a UDP command and the reply from the charging station 1 UDP command 2 Reply Port information Send port UDP 7090 Receive po...

Страница 11: ...ication buildup should be done by using i Command structure Command Parameters Additional Description i Reply structure Field Contents Additional Description Firmware String 32 chars Firmware version of the device 3 2 2 UDP command report 1 If the IP address in the network is known the use of report 1 as a unicast is recommended It delivers more information as i but is not designed to be used as a...

Страница 12: ...econds from the last startup of the device 3 2 3 UDP command report 2 Command structure Command Parameters Additional Description report 2 Reply structure Field Contents Additional Description ID 2 ID of the report State 0 Startup 1 Not ready for charging Charging station is not connected to a vehicle is locked by the authorization function or another mechanism 2 Ready for charging and waiting for...

Страница 13: ...1 Device is enabled Max curr uint16 Possible values 0 6000 32000 Current value in mA offered to the vehicle via control pilot signalization Signal type PWM Max curr uint16 Possible values 100 533 1000 Duty cycle of the control pilot signal The unit displayed is not but 0 1 which means that the value 1000 stands for a duty cycle of 100 For more information concerning the control pilot refer to IEC ...

Страница 14: ...ate of the system clock in seconds from the last startup of the device 3 2 4 UDP command report 3 Command structure Command Parameters Additional Description report 3 Reply structure Field Contents Additional Description ID 3 ID of the report U1 int 3 digits Measured voltage value on phase 1 in V U2 int 3 digits Measured voltage value on phase 2 in V U3 int 3 digits Measured voltage value on phase...

Страница 15: ...history of the last 30 charging sessions report 100 shows the latest charging session After a reboot the report will deliver all zero values If a new session is started by plugging in the vehicle a new Session ID is created in report 100 and all the available values start time start energy value RFID token code are filled If the session ends the end values end time and end reason will also be adde...

Страница 16: ... the end of the charging session started YYYY MM DD hh mm ss 000 string 23 chars If the device cannot access an NTP time server this field will contain the same data as started s or set with setdatetime ended YYYY MM DD hh mm ss 000 string 23 chars If the device cannot access an NTP time server this field will contain the same data as ended s If the device can access the internet it will try to re...

Страница 17: ...na 0 The charging station will display a blue main LED bar Charging will be refused until the setting is overwritten by a new currtime command or one of the aforementioned reset conditions is met The execution of this command will take approximately 1 second If currtime 0 1 is used then no other command should be sent for 2 seconds to ensure an undisturbed execution of the disable command currtime...

Страница 18: ...Guide V 2 01 18 EATON 2018 Reply structure Field Contents Additional Description TCH OK done Generic confirmation message Example 1 Vehicle is charging UDP command currtime 7000 20 was sent charging current should change to 7 A after 20 s After 20 seconds the current is changed ...

Страница 19: ...geIn UDP Programmers Guide V 2 01 19 EATON 2018 Example 2 Cable is plugged into charging station and vehicle furthermore the cable is locked Charging is not allowed due to UDP command ena 0 UDP command currtime 7500 15 was sent to start the charging session ...

Страница 20: ...he charging station if the value defined by setenergy is smaller than the energy transferred during the last charging session One variant of the setenergy command must be highlighted setenergy 0 A previously set energy limit is deactivated Command structure Command Parameters Additional Description setenergy e e Energy value Energy value in 0 1 Wh e g setenergy 100000 specifies 10 kWh Possible val...

Страница 21: ...start The command start can be used to authorize a charging session if the authorization function is activated The effect is the same as holding an RFID card in front of the RFID reader The command needs a valid RFID tag from the whitelist of the charging station The token tag and the classifier are hexadecimal strings as in report 100 Command structure Command Parameters Additional Description St...

Страница 22: ... effect is the same as holding an RFID card in front of the RFID reader during a running charging session The deauthorization will only work correctly if the RFID tag used is the same as the one used to start the charging session Command structure Command Parameters Additional Description stop id id RFID tag 8 byte hex string identifier of RFID card Authorization is set to ON Charging station and ...

Страница 23: ...s 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 The charging session is stopped using the UDP command stop and the RFID tag ...

Страница 24: ...mp was set it can be distinguished between how trustworthy the time stamp is Strong synced time time was synced within 4320 minutes 3 days via NTP time was synced within 4320 minutes 3 days via OCPP time was synced within 4320 minutes 3 days via PROXY Weak synced time time was synced via web interface time was synced via UDP time was not synced within 4320 minutes 3 days via NTP time was not synce...

Страница 25: ...EATON xChargeIn UDP Programmers Guide V 2 01 EATON xChargeIn UDP Programmers Guide V 2 01 25 EATON 2018 ...

Страница 26: ...display command will be processed internal MID metering relevant information may overrule this max Defines the duration in seconds how long the text is displayed if no additional display command follows tk Token for internal use only text Text shown on the display A maximum of 23 ASCII characters can be used Note will be replaced by a blank space will be replaced by a Σ Reply structure Field Conte...

Страница 27: ...e parameter 0 After receiving ena 0 the device will be disabled until it is rebooted or ena 1 or currtime are used The execution of ena 0 will take approximately 1 second If ena 0 is used then no other command should be sent for 2 seconds to ensure an undisturbed execution of the disable command Command structure Command Parameters Additional Description ena m m modifier Modifier for the ena comma...

Страница 28: ...mmers Guide V 2 01 28 EATON 2018 3 3 2 UDP command curr The command curr can be used to control the target charging current at any time This command directly changes the value in the Curr user field in re port 2 All changes made by curr are permanent until the device is re ...

Страница 29: ...tion command currtime In general it is not recommended to use the curr command since the current can be easily controlled via the non permanent currtime If the charging current of the charging station needs to be lowered permanently a reconfiguration of the DIP switch settings is recommended see installation manual Command structure Command Parameters Additional Description curr c c Current settin...

Страница 30: ...ions 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 The charging station also offers a monitoring function of the electrical connection of the household in conjunction with an appropriate meter preventing overload si...

Страница 31: ...l the device is restarted 1 The failsafe function is active and saves the settings into the EEPROM The failsafe function will still be active after a reboot Reply structure Field Contents Additional Description TCH OK done Generic confirmation message 3 4 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...

Страница 32: ...s However the information in this program guide will be checked regularly and corrections will be made in the next edition 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...

Отзывы: