Open Network Protocol – Intra-networking...2= TcpIp Major Version 6 1 Protocol major version Minor...
Transcript of Open Network Protocol – Intra-networking...2= TcpIp Major Version 6 1 Protocol major version Minor...
Open Network Protocol – Intra-networking
Revision 1.1.49
January 30, 2018
This document is made available under the *Creative Commons Attribution-NoDerivatives 4.0 International Public License*(https://creativecommons.org/licenses/by-nd/4.0/legalcode).
2
3
Message List ............................................................................................................................................ 7
Caption ................................................................................................................ Erreur ! Signet non défini.
Notes with respect to message formatting ................................................................................................ 9
Message encapsulation for TCP/IP protocol .............................................................................................. 10
Configuration Management ................................................................................................................... 12
Message List .................................................................................................................................................... 12
Opcode 0x66 – Date and time update ............................................................................................................ 18
Opcode 0x94 – Update request for date and time ......................................................................................... 19
Opcode 0x7F - Request to read for complete configuration .......................................................................... 20
Opcode 0x7C - Sending of configuration page ................................................................................................ 21
Opcode 0x70 - Request to write configuration ............................................................................................... 24
Opcode 0x80 - Request to read card............................................................................................................... 27
Opcode 0x7D - Sending of card page .............................................................................................................. 28
Opcode 0x71 - Request to write cards ............................................................................................................ 29
Opcode 0x81 - Request to read display pages ................................................................................................ 30
Opcode 0x82 – Request to perform operation on cards ................................................................................ 31
Opcode 0x7E - Sending of display page .......................................................................................................... 34
Opcode 0x7E - Request to write a display page .............................................................................................. 36
Opcode 0x6D - Request to delete configuration data .................................................................................... 38
Opcode 0x6E - Request to delete pre-configured cards ................................................................................. 39
Opcode 0x7D - Request to delete display pages ............................................................................................. 40
Opcode 0x63 – Request to install configuration on station ............................................................................ 41
Opcode 0x67 – Request to delete configuration ............................................................................................ 43
Opcode 0x58 – Request to install language on station ................................................................................... 44
Status Management ............................................................................................................................... 45
Message List .................................................................................................................................................... 45
Opcode 0x96 – Sending of extended periodic statuses .................................................................................. 47
Information specific to the family of old level-2 stations ........................................................................... 56
Information specific to the family of new level-2 stations ......................................................................... 58
Information specific to the family of level-3 stations ................................................................................. 60
Information specific to the SmartHOME station ......................................................................................... 62
Opcode 0x9A – Station connection event ....................................................................................................... 68
Opcode 0x9B - Station disconnection event ................................................................................................... 69
Opcode 0x95 – Fast status request with frequency ........................................................................................ 70
4
Session Management ............................................................................................................................. 71
Message List .................................................................................................................................................... 71
Opcode 0x01 - Authentication request by station .......................................................................................... 73
Opcode 0x01 - Sending of authentication result by CSNMS ........................................................................... 74
Opcode 0x08 - Request for periodic authentication check by station ............................................................ 76
Opcode 0x73 - Starting a remote session ....................................................................................................... 77
Opcode 0x91 – Starting a remote session with modulated rate .................................................................... 78
Opcode 0x72 - Request to terminate an ongoing session .............................................................................. 80
Opcode 0x77 - Request to terminate an ongoing session with reason .......................................................... 81
Opcode 0x78 - Request for usage session line ................................................................................................ 82
Opcode 0x79 - Sending of a usage session line ............................................................................................... 83
Opcode 0x7B - Request for last line of usage session ..................................................................................... 88
Opcode 0x75 - Request to erase usage session log ........................................................................................ 89
Opcode 0x7A - Request for recharge session line ........................................................................................... 90
Opcode 0x7B - Sending recharge session line ................................................................................................. 91
Opcode 0x7C - Request for last line of recharge session ................................................................................ 96
Opcode 0x74 - Request to erase recharge session log ................................................................................... 97
Opcode 0x90 - Sending end-of-recharge notification ..................................................................................... 98
Opcode 0x09 – Station connection notification ............................................................................................101
Station Control .................................................................................................................................... 103
Opcode 0x64 - Request for activation / deactivation ...................................................................................105
Opcode 0x65 - Request for gain calibration ..................................................................................................106
Opcode 0xFE - Request for current calibration .............................................................................................107
Opcode 0x6A - Request for changing maximum power ...............................................................................108
Opcode 0x97 – Request to read current limits .............................................................................................109
Opcode 0x98 – Sending of current limits ......................................................................................................110
Opcode 0x6F - Request to reboot station .....................................................................................................111
Opcode 0x89 - Request to reset the station .................................................................................................112
Opcode 0x93 – Notification of station or gateway reboot ...........................................................................113
Opcode 0x92 – Request for station visual identification ..............................................................................114
Opcode 0x99 - Request to send property value............................................................................................117
Opcode 0x56 - Status of request sent to station ..........................................................................................118
Opcode 0x59 – Request to reset alarms .......................................................................................................119
Opcode 0x57 – Change status of power restrictions ....................................................................................120
5
Diagnostics .......................................................................................................................................... 121
Opcode 0xB0 - Request to read log v1 ..........................................................................................................123
Opcode 0xB0 - Sending a log fragment v1 ....................................................................................................125
Opcode 0xB1 – Erasing a log v1 ....................................................................................................................126
Opcode 0xB2 - Request to read log v2 ..........................................................................................................127
Opcode 0xB3 - Sending a log fragment v2 ....................................................................................................129
Opcode 0xB4 – Ping Server ...........................................................................................................................131
Opcode 0xB6 – Log Notification ....................................................................................................................132
Opcode 0xB7 – Log Notification Acknowledgement .....................................................................................132
Maintenance ....................................................................................................................................... 135
Opcode 0xA0 - Request to establish R-HTTP connection ..............................................................................137
Opcode 0xA1 - Request to close R-HTTP connection ....................................................................................138
Opcode 0xA2 - Request to reboot gateway ..................................................................................................139
Opcode 0xA3 - Sending of keep-alive message.............................................................................................140
Opcode 0xA4 – CSNMS ready to accept messages .......................................................................................141
Power Control...................................................................................................................................... 142
Opcode 0xC0 – Sending power instruction to station ..................................................................................144
Opcode 0xC1 – Sending acknowledgment of power instruction to station..................................................147
Opcode 0xC2 – Sending of pilot signal transition by a station (power sharing mode only) .........................150
Opcode 0xC3 – Request to read configuration of site power control ..........................................................152
Opcode 0xC4 – Sending configuration of site power control .......................................................................153
Opcode 0xC5 – Writing configuration of site power control ........................................................................154
Opcode 0xC6 – Status request to site controller ..........................................................................................155
Opcode 0xC7 – Sending statuses to site controller.......................................................................................156
Opcode 0xC8 – Reboot request to controller site.........................................................................................157
Opcode 0xC9 – Request to hold power distribution .....................................................................................158
Opcode 0xCA – Request to reactivate power distribution............................................................................159
Opcode 0xCB – Periodic dispatch of site global status .................................................................................160
Updates ............................................................................................................................................... 162
Opcode 0x60 – Sending of expected firmware version ................................................................................166
Opcode 0x61 – Request of firmware fragment for udpate ...........................................................................167
Opcode 0x62 – Sending of firmware fragment for update ...........................................................................168
Opcode 0x68 - Request to erase the zone for new firmware .......................................................................169
Opcode 0x69 - Request to register firmware fragment ................................................................................170
6
Resource Transfer ................................................................................................................................ 171
Opcode 0x51 – Resource request ..................................................................................................................173
Opcode 0x52 – Resource ready to be sent ....................................................................................................175
Opcode 0x53 – Request for resource fragment ............................................................................................176
Opcode 0x54 – Sending of resource fragment..............................................................................................177
Opcode 0x55 – Acknowledgment of complete reception of resource .........................................................180
Protocol Multicast................................................................................................................................ 181
"Power Sharing" .................................................................................................................................. 182
Opcode 0x01 – Configuration of station power ............................................................................................183
Opcode 0x02 – Response to message 0x01 (Configuration of station power) .............................................184
Managing configuration and surrounding of the station ........................................................................ 186
Message List ..................................................................................................................................................186
Opcode 0x11 – Request to identify station ...................................................................................................187
Opcode 0xA1 – MAC address of station ........................................................................................................187
Opcode 0x12 – Request to write MAC address and serial number ..............................................................189
Opcode 0x13 – Station status request ..........................................................................................................189
Opcode 0xA3 – Sending of station status .....................................................................................................191
Opcode 0x14 – Request for station visual identification ..............................................................................192
Opcode 0x15 – Request for station audio identification ..............................................................................193
Opcode 0x16 – Request for station GPIO control .........................................................................................194
Opcode 0xA0 - Status of request sent to station ..........................................................................................194
Opcode 0x17 – Request to reboot station ....................................................................................................196
Opcode 0x18 - Request to reset the station .................................................................................................197
Opcode 0x19 – Request to write station default configuration....................................................................197
7
Message List
Opcode 0x01 - Authentication request by station .................................................................................................................... 70 Opcode 0x08 - Request for periodic authentication check by station ........................................................................................ 73 Opcode 0x65 - Request for gain calibration ........................................................................................................................... 103 Opcode 0x68 - Request to erase the zone for new firmware .................................................................................................. 164 Opcode 0x69 - Request to register firmware fragment ........................................................................................................... 165 Opcode 0x6A - Request for changing maximum power .......................................................................................................... 105 Opcode 0x6B - Fast status request .......................................................................................................................................... 66 Opcode 0x6D - Request to delete configuration data ............................................................................................................... 35 Opcode 0x6E - Request to delete pre-configured cards ............................................................................................................ 36 Opcode 0x6F - Request to reboot station............................................................................................................................... 108 Opcode 0x71 - Request to write cards ..................................................................................................................................... 26 Opcode 0x72 - Request to terminate an ongoing session ......................................................................................................... 77 Opcode 0x73 - Starting a remote session ................................................................................................................................. 74 Opcode 0x74 - Request to erase recharge session log .............................................................................................................. 94 Opcode 0x75 - Request to erase usage session log ................................................................................................................... 86 Opcode 0x77 - Request to terminate an ongoing session with reason ...................................................................................... 78 Opcode 0x78 - Request for usage session line .......................................................................................................................... 79 Opcode 0x7A - Request for recharge session line ..................................................................................................................... 87 Opcode 0x7B - Request for last line of usage session ............................................................................................................... 85 Opcode 0x7C - Request for last line of recharge session ........................................................................................................... 93 Opcode 0x7D - Request to delete display pages ....................................................................................................................... 37 Opcode 0x7D - Sending of card page ....................................................................................................................................... 25 Opcode 0x7E - Request to write a display page ............................................................ 33, 178, 179, 182, 184, 187, 188, 189, 191 Opcode 0x7E – Request to write a display page ..................................................................................................................... 184 Opcode 0x7E – Request to write a display page ..................................................................................................................... 192 Opcode 0x7E - Sending of display page .............................................................................................................................. 28, 31 Opcode 0x7F - Request to read for complete configuration...................................................................................................... 17 Opcode 0x80 - Request to read card ........................................................................................................................................ 24 Opcode 0x81 - Request to read display pages .......................................................................................................................... 27 Opcode 0x91 – Starting a remote session with modulated rate ................................................................................................ 75 Opcode 0x92 – Request for station visual identification ......................................................................................................... 111 Opcode 0x93 – Notification of station reboot ........................................................................................................................ 110 Opcode 0x94 – Update request for date and time.................................................................................................................... 16 Opcode 0x95 – Fast status request with frequency .................................................................................................................. 67 Opcode 0x97 – Request to read current limits ....................................................................................................................... 106 Opcode 0x98 – Sending of current limits ............................................................................................................................... 107 Opcode 0xA0 - Request to establish R-HTTP connection......................................................................................................... 134 Opcode 0xA1 - Request to close R-HTTP connection .............................................................................................................. 135 Opcode 0xA2 - Request to reboot gateway ............................................................................................................................ 136 Opcode 0xA3 - Sending of keep-alive message....................................................................................................................... 137 Opcode 0xA4 - CSNMS ready to accept messages .................................................................................................................. 138 Opcode 0xB0 - Request to read log v1 ................................................................................................................................... 120 Opcode 0xB0 - Sending a log fragment v1 .............................................................................................................................. 122 Opcode 0xB1 – Erasing a log v1 ............................................................................................................................................. 123 Opcode 0xB2 - Request to read log v2 ................................................................................................................................... 124 Opcode 0xB3 - Sending a log fragment v2 ............................................................................................................... 126, 128, 129 Opcode 0xB3 - Sending of log fragment v2 ............................................................................................................................ 129 Opcode 0xC0 – Sending power instruction to station ............................................................................................................. 141 Opcode 0xC1 – Sending acknowledgment of power instruction to station .............................................................................. 144
8
Opcode 0xC3 – Request to read configuration of site power control ...................................................................................... 149 Opcode 0xC4 – Sending configuration of site power control................................................................................................... 150 Opcode 0xC5 – Writing configuration of site power control ................................................................................................... 151 Opcode 0xC6 – Status request to site controller .................................................................................................................... 152 Opcode 0xC7 – Sending statuses to site controller ................................................................................................................. 153 Opcode 0xC8 – Reboot request to controller site .................................................................................................... 154, 155, 156 Opcode 0xCB – Periodic dispatch of site global status ............................................................................................................ 157 Opcode 0xFE - Request for current calibration ................................................................................................ 104, 109, 114, 192
9
Description
This document describes AddEnergie’s Open Network Protocol – Intra-networking interface, which is used to communicate between its Charging Station Network Management System (CSNMS) and AddEnergie’s Charging Stations.
This document is made available under the *Creative Commons Attribution-NoDerivatives 4.0 International Public License*(https://creativecommons.org/licenses/by-nd/4.0/legalcode).
10
Notes with respect to message formatting
All data shown in this protocol is in Big-Endian (Most-Significant-Byte first) format. The only exception is the message returning content of the new event log (message 0xB3). The data part of this message is in little-endian format.
Message encapsulation for TCP/IP protocol
CSNMS's basic protocol was built to run on a zigbee network for which communication is based on frame sending (one per message). Because the TCP/IP protocol needs to be directly supported from the stations, messages need to be encapsulated into TCP/IP "frames". This section provides details regarding this encapsulation. Only the TCP/IP protocol is affected by these changes: the protocol used at the zigbee level remains unchanged.
The following structure presents the transportation layer for sent messages. This frame can contain one or several messages (complete).
Fields
Offset
Length
Description
Signature 0 4 Signature to indicate the beginning of a message batch
Protocol Family 4 2 Communication Protocol
2= TcpIp
Major Version 6 1 Protocol major version
Minor Version 7 1 Protocol minor version
Content Length 8 4 Message content length (without header)
Content 12 Dynamic Content length is determined by the previous field
A message content is encapsulated as follows:
Fields
Offset
Length
Description
Signature 0 4 Signature to indicate the beginning of a message
Content Length 4 4 Message content length (including this header)
Content 8 Dynamic The content length of a message is determined by the previous field.
11
In the CSNMS message format, the message's first byte will always be the message opcode (type).
12
Configuration Management
Message List
13
Opcode 0x66 – Date and time update
Opcode 0x94 – Update request for date and time
Opcode 0x7F - Request to read for complete configuration Opcode 0x7C - Sending of configuration page Opcode 0x70 - Request to write configuration Opcode 0x80 - Request to read card Opcode 0x7D - Sending of card page Opcode 0x81 - Request to read display pages Opcode 0x7D - Sending of card page
Opcode 0x82 – Request to perform operation on cards
Opcode = 0x82
Length: 24 bytes
CSNMS_REQUEST_CARDS_OPERATION
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Descriptions
Request ID 1 2 Request Unique ID
Request Type
3
1
1: Add 1 card
2: Add N cards
3: Remove 1 card
4: Remove N cards
5: Replace cards
6: Delete cards
Number of cards
4
4
Number of cards to process
14
GUID card 8 16 Guide of the card to be added or removed
If the request is of type 2, 4 or 5, the GUID is {00000000-0000-0000-0000000000000000}
Note:
Once the request is received, the station sends message 0x51 (see Resource Transfer section), which triggers a resource sharing mechanism. Once the resource is entirely received, the station performs the requested operation and sends an execution status in message 0x56.
15
16
Opcode 0x7E - Sending of display page Opcode 0x7E - Request to write a display page Opcode 0x6D - Request to delete configuration data Opcode 0x6E - Request to delete pre-configured cards Opcode 0x7D - Request to delete display pages
17
18
Opcode 0x66 – Date and time update
Opcode = 0x66
Length: 7 bytes
CSNMS_DATE_AND_TIME
Sent by CSNMS
No response required
Fields
Offset
Length
Description
Year 1 1 Year minus 2000
Month 2 1 Month of the year (1-12)
Day of the month
3 1 Day of the month (1-31)
Hours 4 1 Hour of the day (0-23)
Minutes 5 1 Minutes in the hour (0-59)
Seconds 6 1 Seconds in the hour (0-59)
• Also sent by CSNMS to the gateway to set gateway's date and time.
19
Opcode 0x94 – Update request for date and time
Opcode = 0x94
Length: 1 byte
STATION_REQUEST_PROVIDE_DATE_AND_TIME
Sent by station
Reply expected
(CSNMS must send a date and time update message 0x66)
• Also used by site controller to set gateway's date and time.
20
Opcode 0x7F - Request to read for complete configuration
Opcode = 0x7F
Length: 1 byte
CSNMS_REQUEST_GET_CONFIGURATION_DATA
Sent by CSNMS
Response required
21
Opcode 0x7C - Sending of configuration page
Opcode = 0x7C
Length: 66 bytes
STATION_REPLY_CONFIGURATION_DATA
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number 1 1 Always 0x00
2 2 Time interval of status transmission
4
2
Communication Timeout (seconds) This value represents the time spent by a station waiting for a response from CSNMS during an authentication request resulting from a card being held before the reader.
6
2
Grace period - Default of 60 seconds. This value represents the period during which the connector can be disconnected from the vehicle and put back into the vehicle without the recharge authorization being denied.
8 2 Authorize cards if no response from CSNMS. Default (1-Yes, 0-No)
10 2 1.1.43 : Station's default language (1-English, 2-French, 3-Bilingual)
12 2 End-of-session mode (1=Door closed, 2=Lock detected*)
*Note: the lock detected status rather seems to work as door closed.
14 2 Price (unit = 1 cent)
16 2 Fee structure (0=Flat rate, 1=Hourly)
22
Configuration data
18 2 Authorize access with credit card (1=Yes, other value=No)
20 2 Authorize no-authentication and no-lock mode (1=Yes, other value=No)
22
2
End-of-recharge notification sending mode:
0: A single notification is sent by session
1: One notification sent by recharging session
Default value is 0.
24 2 Maximum current limit (A)
The 0xFFFF value indicates that there is no limit.
26
2
Maximum recharging time (minutes)
Default: 0xffff (unlimited time)
When recharging time reaches this time (in minutes), the session ends automatically. An end-of-recharge notification is then sent to the user, indicating that the maximum recharging time was reached.
28
2
Number of trials to detect locked door. After that number of trials, the station no longer tries to lock the door periodically (default value: 0xFFFF indicates there is no limit)
30
2
Flag indicating whether the station is a demo station.
Default value: 0xFFFF indicates the station is not a demo station.
1 indicates that the station is a demo station.
32
2
Flag for power-sharing mode:
• 0x0000: Deactivate power-sharing mode • 0x0001: Activate power-sharing mode • 0xffff: Use position of DIP switch to determine
whether the station is in power-sharing mode or not
34
2
Flag for contingency behavior:
• 0xffff: Regular behavior Power-sharing: instruction at 6A Power-limiting: instruction at 30A
23
• 0x0001: Instruction at 0A (in every situation)
36
2
Station nominal voltage
If value is 0xffff, the station must use the 240V value for a level-2 station.
38
2
Flag indicating whether local cards are fee-based or not
1: local cards are fee-based
0 or 0xff: local cards are not fee-based
40 14 Station Name
Character string in ISO-8859-1 format
Reserved for future use 54 12 Space available for new configuration settings (default value: 0xff)
24
Opcode 0x70 - Request to write configuration
Opcode = 0x70
Length: 66 bytes
CSNMS_REQUEST_SET_CONFIGURATION_DATA
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number 1 1 Always 0x00
Configuration data
2 2 Time interval of status transmission in seconds.
4
2
Communication Timeout (seconds) This value represents the time spent by a station waiting for an answer from CSNMS during an authentication request resulting from a card being held before the reader.
Default: 10 seconds.
6
2
Grace period - Default 60 seconds This value represents the period during which the connector can be disconnected from the vehicle and put back into the vehicle without the recharge authorization being denied. It is also the time period before ending a session when the nozzle is removed from the connector.
8 2 Authorize cards if no response from CSNMS. Values: (1-Yes, 0-No).
10 2 1.1.43: Station default language (1-English, 2-French, 3-Bilingual).
12 2 End-of-session mode (1=Door closed, 2=Lock detected*).
*Note: the lock detected status rather seems to work as door closed.
14 2 Price (unit = 1 cent)
25
16 2 Fee structure (0=Flat rate, 1=Hourly)
18 2 Authorize access with credit card (1=Yes, other value=No)
20 2 Authorize no-authentication and no-lock mode (1=Yes, other value=No)
22
2
End-of-recharge notification sending mode:
0: A single notification is sent by session
1: One notification sent by recharging session
Default value is 0.
24 2 Maximum current limit (A)
The 0xFFFF value indicates that there is no limit.
26
2
Maximum recharging time (minutes)
Default: 0xffff (unlimited time)
When recharging time reaches this time (in minutes), the session ends automatically. An end-of-recharge notification is then sent to the user, indicating that the maximum recharging time was reached.
28
2
Number of trials to detect locked door. After that number of trials, the station no longer tries to lock the door periodically (default value: 0xFFFF indicates there is no limit)
30
2
Flag indicating whether the station is a demo station.
Default value: 0xFFFF indicates the station is not a demo station.
1 indicates that the station is a demo station.
32
2
Flag for power-sharing mode:
• 0x0000: Deactivate power-sharing mode • 0x0001: Activate power-sharing mode • 0xffff: Use position of DIP switch to determine
whether the station is in power-sharing mode or not
34 2 Flag for contingency behavior:
26
• 0xffff: Regular behavior Power-sharing: instruction at 6A Power-limiting: instruction at 30A
• 0x0001: Instruction at 0A (in every situation)
36
2
Station nominal voltage
If value is 0xffff, the station must use the 240V value for a level-2 station.
38
2
Flag indicating whether local cards are fee-based or not
1: local cards are fee-based
0 or 0xff: local cards are not fee-based
40 14 Station Name
Character string in ISO-8859-1 format
Reserved for future use 54 12 Space available for new configuration settings (default value: 0xff)
27
Opcode 0x80 - Request to read card
Opcode = 0x80
Length: 1 byte
CSNMS_REQUEST_GET_CARDS
Sent by CSNMS
Response required
28
Opcode 0x7D - Sending of card page
Opcode = 0x7D
Length: 52 bytes
STATION_REPLY_CARDS
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number
1
1
Each card page contains 10 cards. Identifies which card page is returned:
0 to send cards 0 to 9
1 to send cards 10 to 19
etc.
0 to 49 limit
10-card block
2
50
Card number #1 (5 bytes)
.
.
.
Card number #10 (5 bytes)
29
Opcode 0x71 - Request to write cards
Opcode = 0x71
Length: 52 bytes
CSNMS_REQUEST_WRITE_CARDS
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number
1
1
Each card page contains 10 cards. Identifies which card page is written:
0 to send cards 0 to 9
1 to send cards 10 to 19
etc.
0 to 49 limit
10-card block
2
50
Card number #1 (5 bytes)
.
.
.
Card number #10 (5 bytes)
30
Opcode 0x81 - Request to read display pages
Opcode = 0x81
Length: 1 byte
CSNMS_REQUEST_GET_DISPLAY_PAGES
Sent by CSNMS
Response required
31
Opcode 0x82 – Request to perform operation on cards
Opcode = 0x82
Length: 24 bytes
CSNMS_REQUEST_CARDS_OPERATION
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Descriptions
Request ID 1 2 Request Unique ID
Request Type
3
1
1: Add 1 card
2: Add N cards
3: Remove 1 card
4: Remove N cards
5: Replace cards
6: Delete cards
Number of cards
4
4
Number of cards to process
GUID card 8 16 Guide of the card to be added or removed
If the request is of type 2, 4 or 5, the GUID is {00000000-0000-0000-0000000000000000}
Note:
Once the request is received, the station sends message 0x51 (see Resource Transfer section), which triggers a resource sharing mechanism. Once the resource is entirely received, the station performs the requested operation and sends an execution status in message 0x56.
32
33
34
Opcode 0x7E - Sending of display page
Opcode = 0x7E
Length: 43 bytes
STATION_REPLY_DISPLAY_PAGE
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number
1
1
Identifies which page is returned:
0: Welcome Message (FR)
1: Welcome Message (EN)
2: Rate Message (FR)
3: Rate Message (EN)
4: Customizable Message (FR)
5: Customizable Message (EN)
Display Delay
2
1
In seconds. 0 to deactivate
First line content
3
20
Text displayed
Second line content
23
20
Text displayed
35
36
Opcode 0x7E - Request to write a display page
Opcode = 0x7E
Length: 43 bytes
CSNMS_REQUEST_SET_DISPLAY_PAGE
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Page Number
1
1
Identifies which page is returned:
0: Welcome Message (FR)
1: Welcome Message (EN)
2: Rate Message (FR)
3: Rate Message (EN)
4: Customizable Message (FR)
5: Customizable Message (EN)
Display Delay
2
1
In seconds. 0 to deactivate
First line content
3
20
Text to be displayed
Second line content
23
20
Text to be displayed
37
38
Opcode 0x6D - Request to delete configuration data
Opcode = 0x6D
Length: 1 byte
CSNMS_REQUEST_RESET_CONFIGURATION_DATA
Sent by CSNMS
No response required
39
Opcode 0x6E - Request to delete pre-configured cards
Opcode = 0x6E
Length: 1 byte
CSNMS_REQUEST_DELETE_ALL_DISPLAY_PAGES
Sent by CSNMS
No response required
40
Opcode 0x7D - Request to delete display pages
Opcode = 0x7D
Length: 1 byte
CSNMS_REQUEST_DELETE_ALL_DISPLAY_PAGES
Sent by CSNMS
No response required
41
Opcode 0x63 – Request to install configuration on station
Opcode = 0x63
Length: dynamic
CSNMS_REQUEST_INSTALL_CONFIGURATION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
Name Length 3 1 Length of configuration name
Configuration Name 4 Dynamic Name of configuration (maximum 64 characters)
Configuration Size 4 Size of configuration file
Number of properties 4 Number of properties within the configuration
Configuration Checksum 2 Checksum of configuration file
Request for installation 1 Details of the request to install configuration:
1 – Request to install configuration into the station without applying it.
2 – Request to install and apply configuration into the station
4 – Request to install or to install/apply configuration into the station even though the existing configuration checksum (already into the station) is the same as that of the new configuration (Force Install & Apply)
42
Note:
Once the request is received, the station sets the transfer routine of the configuration file following the protocol described in the Resource Transfer section.
The configuration file is a list of properties with their value(s). Each property has the following structure in the file:
Property 1
Header
Signature ("PROP") 4 bytes
Component ID 4 bytes
Property ID 4 bytes
Number of values for the property 2 bytes
Total size of values for the property 2 bytes
Size of value 1 2 bytes
Value 1 of the property Varied
….. ….
Size of value N 2 bytes
Value N of the property Varied
………………….
Property M
Header
Signature ("PROP") 4 bytes
Component ID 4 bytes
Property ID 4 bytes
Number of values for the property 2 bytes
Total size of values for the property 2 bytes
Size of value 1 2 bytes
Value 1 of the property Varied
….. ….
Size of value N 2 bytes
Value N of the property Varied
43
Opcode 0x67 – Request to delete configuration
Opcode = 0x67
Length: dynamic
CSNMS_REQUEST_DELETE_CONFIGURATION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Name Length
1
1
Length of configuration name
Configuration Name
2
Dynamic
Name of configuration (maximum 64 characters)
44
Opcode 0x58 – Request to install language on station
Opcode = 0x58
Length: 14 bytes
CSNMS_REQUEST_INSTALL_LANGUAGE
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
ID of language to install 3 1 User Language 1: French 2: English 3: Bilingual (when user language is unknown) 4: Spanish 5: Portuguese 6: Chinese 7: Arabic 8: Russian
Configuration Size 4 4 Size of configuration file
Number of properties 8 4 Number of properties in language configuration
Configuration Checksum 12 2 Checksum of configuration file
45
Status Management
Message List
Opcode 0x96 – Sending of extended periodic statuses
Opcode 0x95 – Fast status request with frequency
46
47
Opcode 0x96 – Sending of extended periodic statuses
New: Voltage is in one-tenth of volts.
Opcode = 0x96
Length: 80 bytes if the length of the variable part is implied (10 bytes)
Length: 70 + n bytes if the length of the variable part is explicitly defined
STATION_STATUS_EXTENDED
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Protocol Version Number
1
1
Part 1.X.Y of protocol version number
Protocol Version Number
2
1
Part X.1.Y of protocol version number
Protocol Version Number
3
1
Part X.Y.1 of protocol version number
Identifies the protocol's sub-family (controls how the specific part of the status message is structured)
0: Old generation of level-2 stations (SmartTWO v2)
48
Protocol Family
4
1
1: New generation of level-2 stations (SmartTWO v3, v4, CoRe+)
2: Level-3 stations
(SmartDC)
3: GFCI stations, generation 3
Identification of station model
5
1
Identification of station model
0: SmartTWO v2
1: SmartTWO v3
2: SmartTWO v4
3: CoRe+ v1
4: SmartDC v1
5: AeroVironment EVSE RS (L2)
6: AeroVironment EV50 PS (L3)
7: CoRe+ v2
8: SmartDC v2
9: SmartHOME v1
10+: Reserved for future use
Internal version at the station
(Major)
6 1 Part 1.X of the station's firmware version
Internal version on the station
(Minor)
7 1 Part 1.X of the station's firmware version
Version of ZigBee firmware 8 2 Identification of the zigbee firmware version within the station
Year (station time)
10
1
Year minus 2000.
49
Month (station time)
11 1 Month in the year (1-12)
Day of the month (station time)
12
1
Day in the month (1-31)
Hours
(station time)
13
1
Hour in the day (0-23)
Minutes
(station time)
14
1
Minutes in the hour (0-59)
Seconds
(station time)
15
1
Seconds in the minute (0-59)
UpTime
16
4
Number of seconds elapsed since station startup
Number of pre-configured cards
20
2
Number of pre-configured cards in the station
Configuration Checksum 22 2 Checksum of configuration settings
Card Checksum 24 2 Card Checksum
Display Page Checksum
26 2 Display page checksum or language configuration checksum on SmartCORE stations
ID of last line for recharge session
28
2 0xFFFF indicates there is nothing to read
ID of last line for recharge session
30
2 0xFFFF indicates there is nothing to read
50
Length of the variable part 32
2
If this field value is 0, the variable part has a fixed length of 10 bytes (implied definition); otherwise this field value is the explicit length of the variable part.
Reserved for future use 34 1 Reserved for future use. Must contain value of 0 and beyond.
Internal version on the station (Review)
35 1 Part 1.X rev Z of station firmware version
Index of firmware next writing
36
4
The firmware update is performed through successive sending of fragments. After a while, CSNMS verifies the last fragment received by the station. In case of a missing fragment, CSNMS can resume at the same point as the station.
Temperature 40 1 Station internal temperature Signed value on a byte (-128 degC to 127 degC)
ZigBee signal level 41 1 Strength of the last HOP ZigBee in –dbm.
Common statuses
42
2
Bit 0 (0x0001): Station on (1) (0=deactivated)
Bit 1 (0x0002): Door detected as closed (1)
Bit 2 (0x0004): Connector detected in the station (1)
Bit 3 (0x0008): Contactor ON (1)
Bit 4 (0x0010): Connection to vehicle detected (1)
Bit 5 (0x0020): Reserved for future use
Bit 6 (0x0040): Reserved for future use
Bit 7 (0x0080): Reserved for future use
Bit 8 (0x0100): Reserved for future use
Bit 9 (0x0200): Reserved for future use
Statuses of firmware update
Bit 10 (0x0400): Update ongoing (1)
Bit 11 (0x0800): Reception complete and valid (1)
Bit 12 (0x1000): Incorrect checksum detected (1)
Bit 13 (0x2000): Flash occupied during writing (1)
51
Bit 14 (0x4000): Fragment loss detected (1)
Bit 15 (0x8000): Unsolicited fragment received (1)
Common Alarms
44
1
Station common alarms:
Bit 0 (0x01): Station in major error state
Bit 1 (0x02): GMI error ongoing
Bit 2 (0x04): Fatal GMI error
Bit 3 (0x08): Connector out of station
Bit 4 (0x10): Connector connected without authentication
Bit 5 (0x20): Contactor fatal error
Bit 6 (0x40): Voltage fatal error
Bit 7 (0x80): Station in minor error state
Session Status
45
1
Session status:
Bit 0 (0x01): Authentication ongoing (1)
While waiting for response after a card was waved
Bit 1 (0x02): Session being established (1)
When session is open (authenticated) but
connector is not yet connected
Bit 2 (0x04): Session ongoing (1)
When connector is connected and session
has begun
Bit 3 (0x08): Vehicle being charged (1)
Bit 4 (0x10): Recharge complete (1)
Bit 5 (0x20): Reserved for future use
Bit 6 (0x40): Reserved for future use
Bit 7 (0x80): Reserved for future use
Reason causing recharge termination. Same values as notification message:
0: Cause unknown
1: Recharge completed
2: Recharge interrupted due to disconnected wire
52
Cause for recharge termination
46
1
3: Recharge interrupted due to grace period exceeded
4: Recharge interrupted by CSNMS
5: Recharge interrupted due to station error (GFCI - GROUND FAULT)
6: Recharge interrupted due to station error (GMI - GROUND LOSS)
7: Recharge interrupted due to station deactivation
8: Recharge interrupted due to error detected during interaction with vehicle
9: Recharge interrupted due to maximum recharge time reached
10: Recharge interrupted due to maximum recharge cost reached
11: Recharge interrupted due to failure to comply with instruction
12: Recharge stopped by user (stop button)
13: Recharge on hold (following a descent to zero in power control)
14: Recharge was stopped due to unsupported request (ventilation)
15: Recharge was stopped due to vehicle error
16: Recharge was stopped due to error during a relay test
17: Recharge was stopped due to access denial
18: Recharge was stopped due to hardware error (micro-electronic)
19: Recharge was stopped due to leakage current into the ground during the first seconds
20: Recharge was stopped due to internal error
21: Recharge was stopped due to leakage current into the ground on multiple occasions
22: Recharge was stopped due to failure to detect battery
23: Recharge was stopped due to failure to detect vehicle
53
24: Recharge was stopped due to error during precharging test
25: Recharge was stopped due to absence of EV authorization signal
26: Recharge was stopped due to nozzle locking error
27: Recharge was stopped due to battery voltage too low
28: Recharge was stopped due to timeout of current request
29: Recharge was stopped due to current too high
30: Recharge was stopped due to battery voltage threshold exceeded
31: Recharge was stopped due to vehicle request
32: Recharge was stopped due to error during precharging test
33: Recharge was stopped due to timeout of EV authentication
34: Recharge was stopped due to invalid status of pilot signal
35: Recharge was stopped due to communication error of a power module (Gen1)
36: Recharge was stopped due to error during insulation test (Gen1)
37: Recharge was stopped due to error of a power module (Gen1)
38: Recharge was stopped due to battery temperature too high
39: Recharge was stopped due to emergency stop
40: Recharge was stopped for security reasons
41: Recharge was stopped due to internal error
42: Reserved for future use
43: Reserved for future use
44: Reserved for future use
45: Reserved for future use
54
46: Reserved for future use
47: Reserved for future use
48: Reserved for future use
49: Recharge was stopped due to loss of connection with grounding wire on multiple occasions
50: Recharge was stopped due to ADC error
51: Recharge was stopped due to relay error
52: Recharge was stopped due to failure to close a relay
53: Recharge was stopped due to internal error of GFCI circuit
54: Recharge was stopped due to error in UCT logs
55: Recharge was stopped due to RAM memory error
56: Recharge was stopped due to internal clock error
57: Recharge was stopped due to internal auxiliary clock error
58: Recharge was stopped due to CRC disparity in configuration
59: Recharge was stopped due to instruction counter error
60: Recharge was stopped due to internal failure of vehicle interface controller
61: Recharge was stopped due to communication problem with vehicle interface controller
62: Recharge was stopped due to flash memory error
63: Recharge was stopped due to excessive internal temperature within the station
ID Session
47
2
ID of open session as provided by the station to CSNMS upon authentication.
0xFFFF if no session open
ID of card currently in an open session
49 8 ID of the card in an open session
All 0xFF when station is off
For IDs of cards of less than 8 bytes, MSBs must contain 0.
55
Actual duration of session
57 4 Actual duration of session in seconds
0 if no session ongoing
Actual cost of session 61 2 Cost of session in cents up to now
An 0xFFFF value indicates unknown cost.
Voltage (V)
63
2
Actual vehicle voltage in tenth of volts. Example: 240 = 2400V.
Current (A)
65
2
Actual vehicle current in tenth of amperes. Example: 32 = 3.2A
Energy (Wh)
67
3
Energy in Wh transferred during session. Example: 1500 = 1500Wh.
Note: On 24 bits
Information specific to each protocol family
70
n
This field contains various information based on the protocol family used.
56
Information specific to the family of old level-2 stations
Information specific to old generation of level-2 stations (SmartTWO v2)
Fields
Offset
(bytes)
Length
(bytes)
Description
Pilot Signal
70
1
Pilot Signal Status
• Undefined=0 • A=1 • B=2 • C=3 • D=4 • E=5 • F=6
Specific Statuses
71
1
Digital Entry Statuses
Bit 0 (0x01): GFCI COIL (1)
Bit 1 (0x02): GFCI TRANS (1)
Bit 2 (0x04): GFCI B1 (1)
Bit 3 (0x08): GFCI B2 (1)
Bit 4 (0x10): Fan Detection (1)
Bit 5-7: Reserved for future use
Specific Alarms
72
1
Specific Alarm Statuses
Bit 0 (0x01): Total GM Alarm (1)
Bit 1 (0x02): Total GA Alarm (1)
Bit 2 (0x04): Total GD Alarm (1)
Bit 3 (0x08): Total GC Alarm (1)
Bit 4 (0x10): Double GM Alarm (1)
Bit 5 (0x20): Double GA Alarm (1)
57
Bit 6 (0x40): Double GD Alarm (1)
Bit 7 (0x80): Double GC Alarm (1)
GM Status 73 1 Active status number for GRAFCET Master (GM)
GA Status 74 1 Active status number for GRAFCET Authentification (GA)
GD Status 75 1 Active status number for GRAFCET Start-up (GD)
GC Status 76 1 Active status number for GRAFCET Charge (GC)
CPLD Status 77 1 CPLD status number
3.3V Power Supply 78 1 Reading of the 3.3V power supply
33 = 3.3V
5V Power Supply 79 1 Reading of the 5V power supply
51 = 5.1V
58
Information specific to the family of new level-2 stations
Information specific to the new generation of level-2 stations (SmartTWO v3, v4, CoRe+ v1, v2)
Fields
Offset
(bytes)
Length
(bytes)
Description
Pilot Signal
70
1
Pilot Signal Status
• Undefined=0 • A=1 • B=2 • C=3 • D=4 • E=5 • F=6
Specific Statuses
71
2
Bit 0 (0x0001): Bad test current (1=detected, 0=OK) Bit 1 (0x0002): Reserved for future use Bit 2 (0x0004): Reserved for future use Bit 3 (0x0008): Reserved for future use Bit 4 (0x0010): Reserved for future use Bit 5 (0x0020): Charge denial due to absence of ventilation Bit 6 (0x0040): Screen heating status Bit 7 (0x0080): Back after power failure Bit 8 (0x0100): Reserved for future use Bit 9 (0x0200): Voltage too low Bit 10 (0x0400): Voltage at 0 Bit 11 (0x0800): Reserved for future use Bit 12 (0x1000): Current too high Bit 13 (0x2000): Reserved for future use Bit 14 (0x4000): A SAG occurred Bit 15 (0x8000): Current too low (creep)
Last cause of major error 73 1 This value indicates the last cause of major error.
Reserved for future use 74 1 Number of resets performed on the power-meter since station startup. When the threshold limit of this field is reached (255), it must not be brought back to 0.
Reserved for future use 75 5
59
60
Information specific to the family of level-3 stations
Information specific to the family of level-3 stations (SmartDC)
Fields
Offset
(bytes)
Length
(bytes)
Description
State of charge (SOC)
70
1
State of charge of vehicle battery in %
Example: 0 = 0%, 80=80%
An 0xff value indicates an unknown status.
Specific Statuses
71
2
Bit 0 (0x0001): Reserved for future use Bit 1 (0x0002): Reserved for future use Bit 2 (0x0004): Reserved for future use Bit 3 (0x0008): Reserved for future use Bit 4 (0x0010): Reserved for future use Bit 5 (0x0020): Reserved for future use Bit 6 (0x0040): Screen heating status Bit 7 (0x0080): Back after power failure Bit 8 (0x0100): Recharge port used (0=CHAdeMO, 1=SAE) Bit 9 (0x0200): Reserved for future use Bit 10 (0x0400): Reserved for future use Bit 11 (0x0800): Reserved for future use Bit 12 (0x1000): Reserved for future use Bit 13 (0x2000): Reserved for future use Bit 14 (0x4000): Reserved for future use Bit 15 (0x8000): Reserved for future use
Last cause of major error 73 1 This value indicates the last cause of major error.
Temperature of Power Module #1
74 1 Module internal temperature in degrees Celsius. The given value must be -128 if this information is not available.
Temperature of Power Module #2
75 1 Module internal temperature in degrees Celsius. The given value must be -128 if this information is not available.
Temperature of Power Module #3
76 1 Module internal temperature in degrees Celsius. The given value must be -128 if this information is not available.
61
Temperature of Power Module #4
77 1 Module internal temperature in degrees Celsius. The given value must be -128 if this information is not available.
Reserved for future use 78 2
62
Information specific to the SmartHOME station
Information specific to the SmartHOME station from GFCI
Fields
Offset
(bytes)
Type
Description
External I/O externalIoInput1 70 uint8 External I/O #1
externalIoInput2 71 uint8 External I/O #2
Version Information
gfciMajorVersion 72 uint8 GFCI major version
gfciMinorVersion 73 uint8 GFCI minor version
gfciPatchNumber 74 uint8 GFCI patch number
gfciBuildNumber 75 uint8 GFCI build version
boardSerialNumber 76 uint16 GFCI board serial number
gfciFirmwareId 78 uint8 GFCI firmware ID
• GFCI-3G = 2 Configuration Information
boardConfiguration 79 uint8 • GFCI simple = 0 • GFCI double = 1
• GFCI double + power sharing = 2
adcSequenceNumber 80 uint32 ADC sequence number
outputVoltageSequenceNumber 84 uint32 Output voltage sequence number
gmiSequenceNumber 88 uint32 GMI sequence number
pilotSequenceNumber 92 uint32 Pilot signal sequence number
pilotSignalVoltage 96 float Pilot signal voltage
pilotSignalMinVoltage 100 float Pilot signal minimum voltage
gmiMeasure 104 float GMI ground continuity measure Measure of ground continuity; the closer to 1 the better the ground.
currentGain 108 float Gain for current
voltageGain 112 float Gain for voltage
currentOffset 116 float Offset for current
voltageOffset 120 float Offset for voltage
63
Channel A
activeEnergyGain 124 float Gain for active energy
pwmValue 128 float PWM value
outputVoltagePeak 132 float Peak output voltage
outputVoltageRms 136 float Output voltage (rms)
inputVoltagePeriod 140 float Utility voltage period
powerFactor 144 float Power factor
state 148 uint8 Channel state
• Uninitialized = 0 App not Initialized.
• WaitBooting = 1 Waiting for the system to boot up before starting (~2s).
• Init = 2 Setting pins, checking if GFCI circuit is working.
• WaitingForVehicle = 3 Waiting for a car to connect.
• Connected = 4 Vehicle connected PWM on.
• GFCITest = 5 Testing GFCI and power meter.
• InitialPowerON = 6 Initial power on go to permanent fault if gfci fault in this state.
• PowerON = 7 Power ON Normal.
• WaitForGround = 8 No ground waiting for ground return.
• IntermediateShutDown = 9 When charging is disabled from external close PWM for ~15s before opening relay.
• GFCIFaultWait15min = 10 GFCI fault wait for 15 min before test.
• PermanentSafeState = 11 Major fault permanent safe state.
• PilotState_D = 12 Pilot Signal in state D.
• PilotState_E = 13 Pilot Signal in state E.
• ChannelOFF = 14 Channel was not initialized at boot up because board is single.
majorFaultState 149 uint8 Channel fault
64
• NoError = 0 No error module not in safe mode
• FaultDuringInitial = 1 GFCI fault during initial power on state
• MaxRetryReach = 2 Maximum number of retries reach
• ADCDefect = 3 The ADC is not working properly
• RelaysVout = 4 Interrupter relays failed voltage at output
• RelaysNoVout = 5 Interrupter didnt close no voltage output
• GFCICircuit = 6 Failure in the GFCI circuit
• CPUResgisterFailure = 7 CPU Registers failure
• RAMFailure = 8 RAM failure
• FlashFailure = 9 Flash failure
• CLockFailure = 10 Clock failure
• AuxCLockFailure = 11 Auxiliary Clock failure
• ConfigCRC = 12 Configuration CRC did not match
• ProgramCounter = 13 Program counter register in the CPI failed test
• Error = 14 Error
pilotSignal
150
uint8
Pilot signal state
State of signal pilote
• Undefined=0 • A=1 • B=2 • C=3 • D=4 • E=5 • F=6 (invalid) • Unknown=7
sagCount 151 uint8 SAG count
gfciUptime 152 uint32 GFCI uptime (ms) Time in millisecond since bootup
gfciMaxStack 156 uint16 GFCI maximum stack usage Maximum stack use in bytes
65
Statistics
gfciMaxLoopTime 158 uint16 GFCI maximum cycle duration Maximum time use to process one background loop in milliseconds
gfciSentPackets 160 uint32 GFCI sent packets count
gfciReceivedPackets 164 uint32 GFCI received packets count
gfciCrcErrors 168 uint8 GFCI CRC errors
gfciResets 169 uint8 GFCI resets
numEventOverflows 170 uint8 GFCI event overflows
numSessionOverflows 171 uint8 GFCI session overflows
Maximum current
configuration
maxCurrentFactoryConfiguration 172 float Maximum current the station is allowed to offer as configured at the factory
maxCurrentDetectedForPS 176 float Maximum current the station is allowed to offer as detected in a Power Sharing configuration.
ADC
adcAverageVcc 180 float ADC average VCC Measure of analog input which is the same as the Dvcc and is used to verify that the ADC is working.
adcLowValue 184 int16 ADC low value
Sampling
info
pilotSignalHitCount 186 uint16 Pilot signal hit count Number of times an ADC sample hits the state
outputVoltageHitCountPlus 188 uint16 Output voltage hit count +threshold Number of samples higher than positive threshold.
outputVoltageHitCountMinus 190 uint16 Output voltage hit count -threshold Number of samples lower than negative threshold.
adcHitCount 192 uint16 ADC hit count
Flags
gmiIsGroundOK 194 uint8 GMI Ground is OK
adcIsOK 195 uint8 ADC is OK
hasOutputVoltage 196 uint8 Output voltage present
accessGranted 197 uint8 Access granted flag • 0: not allowed • 1: allowed
isCharging 198 uint8 Is charging flag
Gfci general state 199 uint8 Communication status • 0: Default value • 1: Gfci communication fault
66
Information specific to the SmartHOME station from main application
Fields
Offset
(bytes)
Type
Description
Station status LED
RED intensity 200 uint8 Intensity of the color red (from 0 to 100%)
GREEN intensity 201 uint8 Intensity of the color green (from 0 to 100%)
BLUE intensity 202 uint8 Intensity of the color blue (from 0 to 100%)
Modulation state 203 uint8 Modulation state: 0 – LED is OFF 1 – LED is ON, without modulation 2 – Low frequency modulation 3 – High frequency modulation
Information
on power restriction
Reasons for power restriction 204 uint8 Reasons for power restriction (bit field): 0 – No restriction 1 – Voltage drop recovery 2 – Power sharing 4 – Demand Response 8 – Power restriction schedule
Active reason for power restriction
205 uint8 Active reason for power restriction (which sets power provided to minimum value): 0 – No restriction 1 – Voltage drop recovery 2 – Power sharing 4 – Demand Response 8 – Power restriction schedule
Duration of active main restriction
206 uint16 Remaining time, in minutes, for active power restriction. If 65535, the duration is for ongoing session.
Power restrictions removed (opt-out)
208 uint8 Removed power restrictions (bit field): 0 – No restriction 1 – Voltage drop recovery 2 – Power sharing 4 – Demand Response 8 – Power restriction schedule
67
Duration of restriction removals
209 uint16 Remaining time, in minutes, of last request for restriction removal received (opcode 0x57)
68
Opcode 0x9A – Station connection event
Opcode = 0x9A
Length: 9 bytes
STATION_CONNECTED
From station to CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Firmware Version
1
4
Station firmware version
Configuration Checksum 5 2 Active configuration checksum
Language configuration checksum
7 2 Checksum of station language configurations
(Sum of crc16 of available configurations)
69
Opcode 0x9B - Station disconnection event
Opcode = 0x9B
Length: 1 byte
STATION_DISCONNECTED
From CSNMS to CSNMS
No response required
70
Opcode 0x95 – Fast status request with frequency
Opcode = 0x95
Length: 5 bytes
CSNMS_REQUEST_ENABLE_FAST_UPDATES_AT_FREQUENCY
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Update Period
1
2
Number of seconds between each update.
Fast updates duration
3
2
Duration, in seconds, of fast updates.
71
Session Management
Message List
Opcode 0x01 - Sending of authentication result by CSNMS
Opcode 0x73 - Starting a remote session
Opcode 0x91 – Starting a remote session with modulated rate
Opcode 0x72 - Request to terminate an ongoing session
Opcode 0x77 - Request to terminate an ongoing session with reason
Opcode 0x78 - Request for usage session line
Opcode 0x79 - Sending of a usage session line
Opcode 0x7B - Sending recharge session line
Opcode 0x75 - Request to erase usage session log
Opcode 0x7A - Request for recharge session line
Opcode 0x7B - Sending recharge session line
Opcode 0x7C - Request for last line of recharge session
Opcode 0x74 - Request to erase recharge session log
Opcode 0x90 - Sending end-of-recharge notification
Opcode 0x90 - Sending end-of-recharge notification
72
73
Opcode 0x01 - Authentication request by station
Opcode = 0x01
Length: 12 bytes
STATION_REQUEST_AUTHENTICATE
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Unused 1 2
Card Number 3 5 Card ID
Session ID 8 2 Before 1.1.45: Unused
1.1.45: Unique ID for session as generated by station
Local ID 10 2 This ID is incremented at each request. CSNMS must answer with same ID.
74
Opcode 0x01 - Sending of authentication result by CSNMS
Opcode = 0x01
Length: 55 bytes
CSNMS_REPLY_AUTHENTICATION_RESULT
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Access denied
1 1 Indicates whether access is granted or denied
0: Access granted
1: Access denied
Session Priority
2
1
Session Priority
0: Undefined (normal priority by default)
1: Normal priority
2: High Priority
3: Absolute Priority
Flag for pricing 3 1 Flag indicating whether pricing needs to be applied for local cards:
0: Pricing must not be applied for received card
1: Pricing must be applied for received card
Local ID at the station 4 2 ID of the original authentication request CSNMS must indicate the same number as local ID in order for the authentication response to be considered.
Language
6
1
User Language
1: French
2: English
3: Bilingual (when user language is unknown)
4: Spanish
75
5: Portuguese
6: Chinese
7: Arabic
8: Russian
Free
7
4
Free for future use
1.1.44: Length of denial cause message
11
4
0: indicates there is no denial cause message available (always the case when access is granted).
40 : indicates that denial cause message is present (always 40 bytes in length, message sent for languages 1 and 2)
1.1.44: Denial cause message (Language 1 = FR)
15
20
Denial reason in language 1. Indicates why access is denied.
If the message is less than 20 bytes in length, it is completed with spaces.
1.1.44: Denial cause message (Language 2 = EN)
15
20
Denial reason in language 2. Indicates why access is denied.
If the message is less than 20 bytes in length, it is completed with spaces.
76
Opcode 0x08 - Request for periodic authentication check by station
Opcode = 0x08
Length: 6 bytes
STATION_REQUEST_PERIODIC_AUTHENTICATION
Sent by SMART2
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Card Number 1 5 Card ID
When a user session is open, the station periodically transmits the user's card number. This way, CSNMS can control the use of the station. For example, if the user opened a session when the communication with CSNMS was disrupted, it is possible that when communication is restored, CSNMS decides to end the session.
77
Opcode 0x73 - Starting a remote session
Opcode = 0x73
Length: 6 bytes
CSNMS_REQUEST_START_REMOTE_SESSION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Card Number 1 5 Card ID
78
Opcode 0x91 – Starting a remote session with modulated rate
Opcode = 0x91
Length: 16 bytes
CSNMS_REQUEST_START_REMOTE_SESSION_EXTENDED
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Card Number 1 5 Card ID
Price mark-up
6
2
% of price mark-up: 200 = 2x, 100 = 1x, 50 = 0.5x
This mark-up is applied on final cost before the basic amount, i.e.
Final cost = cost* mark-up + basic amount
Basic amount added 8 2 Basic amount added to total cost (in cents).
200 = $2
Maximum amount
10
2
Maximum amount for session (in cents). Recharge must stop as soon as cost reaches that amount. The reason for recharge termination must indicate that the maximum amount was reached.
100 = $1
A 0 value indicates there is no maximum amount.
Maximum Duration
12
4
Maximum recharge duration in seconds. As soon as the recharge reaches this duration, it must stop. The reason for recharge termination must indicate that the maximum duration was reached.
79
A 0 value indicates there is no maximum duration. In this case, the station configuration prevails.
Note: If the maximum duration specified in the configuration is lower than this value, then that of the configuration prevails.
80
Opcode 0x72 - Request to terminate an ongoing session
Opcode = 0x72
Length: 1 byte
CSNMS_REQUEST_TERMINATE_SESSION
1.1.44: This message is no longer used. It was replaced with Opcode 0x77 (request to terminate an ongoing session with reason)
81
Opcode 0x77 - Request to terminate an ongoing session with reason
1.1.44: Opcode = 0x77
Length: 41 bytes
CSNMS_REQUEST_TERMINATE_SESSION_WITH_REASON
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Reason for session termination (language 1 = FR)
1
20
Message in language 1 indicating why session was terminated.
Reason for session termination (language 2 = EN)
21
20
Message in language 2 indicating why session was terminated.
82
Opcode 0x78 - Request for usage session line
Opcode = 0x78
Length: 3 bytes
CSNMS_REQUEST_GET_USAGE_SESSION_LINE
Sent by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Line requested 1 2 ID of requested line
83
Opcode 0x79 - Sending of a usage session line
Opcode = 0x79
Length: 1.1.44: 37 bytes
1.1.45: 41 bytes
1.1.46: 41 or 45 bytes
STATION_REPLY_USAGE_SESSION_LINE
Sent by SMART2
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Duration 1 4 Session duration in seconds
Energy 5 4 Energy in Wh
Total Cost
9
4
Total cost of session (unit = 1 cent). Regular cost for a session.
Under 1.1.45: plus additional cost indicated in remote startup with modulated rate.
Start date and time 13 7 See DS3234 (RTC) data sheet for format.
End date and time 20 7 See DS3234 (RTC) data sheet for format.
Type
27
1
This value is a bit-field that contains the following information:
• 0xFF if nothing available
Otherwise the following bits indicate:
• 0x02 if OK • 0x10 No authorization granted • 0x20 Pre-configured card • 0x80 Regular cost present
(otherwise ignore regular cost)
84
Line number 28 2 ID of requested line number
Card Number 30 5 Card ID
Unique session number generated by station
35 2 Can be used to synchronize usage or recharge sessions.
Regular Cost
37
4
1.1.45: Regular cost of session (unit = 1 cent). This regular cost is to be stocked into usage session lines
See Type field for more information.
Optional Part
Connector used
41
1
Type of connector used:
0: J1772
1: CHAdeMO
2: SAE
State of Charge (SOC) at beginning
42
1 Percentage of State of Charge at beginning of recharge: between 0 and 100 (%)
A 0xff value indicates that the value is unknown
State of Charge (SOC) at the end
43
1 Percentage of State of Charge at the end of recharge: between 0 and 100 (%)
A 0xff value indicates that the value is unknown
Reason for recharge termination
44
1
Reason causing recharge termination. Same values as notification message:
0: Cause unknown
1: Recharge completed
2: Recharge interrupted by unplugged cable
3: Recharge interrupted due to period of grace exceeded
4: Recharge interrupted by CSNMS
5: Recharge interrupted by station failure (GFCI - GROUND FAULT)
6: Recharge interrupted by station failure (GMI - GROUND LOSS)
7: Recharge interrupted by station deactivation
85
8: Recharge interrupted due to failure detected during interaction with vehicle
9: Recharge interrupted due to maximum recharge duration reached
10: Recharge interrupted due to maximum recharge cost reached
11: Recharge interrupted due to failure to respect instruction
12: Recharge stopped by user (stop button)
13: Recharge on hold (following descent to zero in power control)
14: Recharge was stopped due to unsupported request (ventilation)
15: Recharge was stopped due to vehicle failure
16: Recharge was stopped due to failure during relay test
17: Recharge was stopped due to access denial
18: Recharge was stopped due to hardware failure (micro-electronic)
19: Recharge was stopped due to current leakage to the ground during first seconds
20: Recharge was stopped due to internal error
21: Recharge was stopped due to current leakage to the ground on multiple occasions
22: Recharge was stopped due to battery undetected
23: Recharge was stopped due to vehicle undetected
24: Recharge was stopped due to error during pre-charging test
25: Recharge was stopped due to absence of EV authorization signal
26: Recharge was stopped due to nozzle locking error
27: Recharge was stopped due to battery voltage too low
28: Recharge was stopped due to timeout of current request
86
29: Recharge was stopped due to current too high
30: Recharge was stopped due to exceeding battery voltage threshold
31: Recharge was stopped due to vehicle request
32: Recharge was stopped due to error during pre-charging test
33: Recharge was stopped due to timeout of EV authentication
34: Recharge was stopped due to invalid status of pilot signal
35: Recharge was stopped due to communication error of a power module (Gen1)
36: Recharge was stopped due to an error during insulation test (Gen1)
37: Recharge was stopped due to error of a power module (Gen1)
38: Recharge was stopped due to battery temperature too high
39: Recharge was stopped due to emergency stop
40: Recharge was stopped for security reasons
41: Recharge was stopped due to internal error
42: Reserved for future use
43: Reserved for future use
44: Reserved for future use
45: Reserved for future use
46: Reserved for future use
47: Reserved for future use
48: Reserved for future use
49: Recharge was stopped due to loss of connection with grounding wire on multiple occasions
50: Recharge was stopped due to ADC failure
51: Recharge was stopped due to relay failure
52: Recharge was stopped due to failure to close relay
87
53: Recharge was stopped due to internal failure of GFCI circuit
54: Recharge was stopped due to error in UCT logs
55: Recharge was stopped due to RAM memory error
56: Recharge was stopped due to internal clock failure
57: Recharge was stopped due to internal auxiliary clock failure
58: Recharge was stopped due to CRC disparity in configuration
59: Recharge was stopped due to error in instruction counter
60: Recharge was stopped due to internal failure of vehicle controller interface
61: Recharge was stopped due to communication problem with vehicle controller interface
62: Recharge was stopped due to flash memory error
63: Recharge was stopped due to excessive internal temperature in the station
Note
In the absence of the optional part, CSNMS assumes the following values for these fields:
• Connector used: J1772 • State of Charge at beginning: 0xff (unknown) • State of Charge at the end: 0xff (unknown) • Reason for recharge termination: Unknown
88
Opcode 0x7B - Request for last line of usage session
Opcode = 0x7B
Length: 1 byte
CSNMS_REQUEST_GET_LAST_USAGE_SESSION_LINE
Sent by CSNMS
Response required
89
Opcode 0x75 - Request to erase usage session log
Opcode = 0x75
Length: 1 byte
CSNMS_REQUEST_ERASE_USAGE_SESSIONS_LOG
Sent by CSNMS
No response required
90
Opcode 0x7A - Request for recharge session line
Opcode = 0x7A
Length: 3 bytes
CSNMS_REQUEST_GET_RECHARGE_SESSION_LINE
Sent by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Line requested 1 2 ID of requested line
91
Opcode 0x7B - Sending recharge session line
Opcode = 0x7B
Length: before 1.1.46 : 37 bytes
1.1.46: 37 or 41 bytes
STATION_REPLY_RECHARGE_SESSION_LINE
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Duration 1 4 Session duration in seconds
Energy 5 4 Energy in Wh
To be ignored 9 4 Ignore value in this field
Start date and time 13 7 See DS3234 (RTC) data sheet for format.
End date and time 20 7 See DS3234 (RTC) data sheet for format.
Type
27
1
0x01 if OK, 0xFF if nothing available
0x10 No authorization granted
0x20 Pre-configured card
Line Number 28 2 ID of requested line number
Card Number 30 5 Card ID
Unique session number generated by station
35 2 Can be used to synchronize usage or recharge sessions.
Optional Part
Connector used
37
1
Type of connector used:
0: J1772
1: CHAdeMO
2: SAE
State of Charge (SOC) at beginning
38 1 Percentage of State of Charge at beginning of recharge: between 0 and 100 (%)
92
A 0xff value indicates that the value is unknown
State of Charge (SOC) at the end
39 1 Percentage of State of Charge at the end of recharge: between 0 and 100 (%)
A 0xff value indicates that the value is unknown
Reason for recharge termination
40
1
Reason causing recharge termination. Same values as notification message:
0: Unknown cause
1: Recharge completed
2: Recharge interrupted due to disconnected wire
3: Recharge interrupted due to grace period exceeded
4: Recharge interrupted by CSNMS
5: Recharge interrupted due to station error (GFCI - GROUND FAULT)
6: Recharge interrupted due to station error (GMI - GROUND LOSS)
7: Recharge interrupted due to station deactivation
8: Recharge interrupted due to error detected during interaction with vehicle
9: Recharge interrupted due to maximum recharge time reached
10: Recharge interrupted due to maximum recharge cost reached
11: Recharge interrupted due to failure to comply with instruction
12: Recharge stopped by user (stop button)
13: Recharge on hold (following a descent to zero in power control)
14: Recharge was stopped due to unsupported request (ventilation)
15: Recharge was stopped due to vehicle error
16: Recharge was stopped due to error during a relay test
17: Recharge was stopped due to access denial
93
18: Recharge was stopped due to hardware error (micro-electronic)
19: Recharge was stopped due to leakage current into the ground during the first seconds
20: Recharge was stopped due to internal error
21: Recharge was stopped due to leakage current into the ground on multiple occasions
22: Recharge was stopped due to failure to detect battery
23: Recharge was stopped due to failure to detect vehicle
24: Recharge was stopped due to error during precharging test
25: Recharge was stopped due to absence of EV authorization signal
26: Recharge was stopped due to nozzle locking error
27: Recharge was stopped due to battery voltage too low
28: Recharge was stopped due to timeout of current request
29: Recharge was stopped due to current too high
30: Recharge was stopped due to battery voltage threshold exceeded
31: Recharge was stopped due to vehicle request
32: Recharge was stopped due to error during precharging test
33: Recharge was stopped due to timeout of EV authentication
34: Recharge was stopped due to invalid status of pilot signal
35: Recharge was stopped due to communication error of a power module (Gen1)
36: Recharge was stopped due to error during insulation test (Gen1)
94
37: Recharge was stopped due to error of a power module (Gen1)
38: Recharge was stopped due to battery temperature too high
39: Recharge was stopped due to emergency stop
40: Recharge was stopped for security reasons
41: Recharge was stopped due to internal error
42: Reserved for future use
43: Reserved for future use
44: Reserved for future use
45: Reserved for future use
46: Reserved for future use
47: Reserved for future use
48: Reserved for future use
49: Recharge was stopped due to loss of connection with grounding wire on multiple occasions
50: Recharge was stopped due to ADC error
51: Recharge was stopped due to relay error
52: Recharge was stopped due to failure to close a relay
53: Recharge was stopped due to internal error of GFCI circuit
54: Recharge was stopped due to error in UCT logs
55: Recharge was stopped due to RAM memory error
56: Recharge was stopped due to internal clock error
57: Recharge was stopped due to internal auxiliary clock error
58: Recharge was stopped due to CRC disparity in configuration
59: Recharge was stopped due to instruction counter error
60: Recharge was stopped due to internal failure of vehicle interface controller
95
61: Recharge was stopped due to communication problem with vehicle interface controller
62: Recharge was stopped due to flash memory error
63: Recharge was stopped due to excessive internal temperature within the station
Note
In the absence of the optional part, CSNMS assumes the following values for these fields:
• Connector used: J1772 • State of Charge at beginning: 0xff (unknown) • State of Charge at the end: 0xff (unknown)
Reason for recharge termination: Unknown
96
Opcode 0x7C - Request for last line of recharge session
Opcode = 0x7C
Length: 1 byte
CSNMS_REQUEST_GET_LAST_RECHARGE_SESSION_LINE
Sent by CSNMS
Response required
97
Opcode 0x74 - Request to erase recharge session log
Opcode = 0x74
Length: 1 byte
CSNMS_REQUEST_ERASE_RECHARGE_SESSIONS_LOG
Sent by CSNMS
No response required
98
Opcode 0x90 - Sending end-of-recharge notification
1.1.44: Opcode = 0x90
Length: 54 bytes
STATION_END_OF_RECHARGE_NOTIFICATION
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Reason for termination
1
1
Reason causing recharge termination:
0: Cause unknown
1: Recharge completed
2: Recharge interrupted due to disconnected wire
3: Recharge interrupted due to grace period exceeded
4: Recharge interrupted by CSNMS
5: Recharge interrupted due to station error (GFCI - GROUND FAULT)
6: Recharge interrupted due to station error (GMI - GROUND LOSS)
7: Recharge interrupted due to station deactivation
8: Recharge interrupted due to error detected during interaction with vehicle
9: Recharge interrupted due to maximum recharge time reached
10: Recharge interrupted due to maximum recharge cost reached
11: Recharge interrupted due to failure to comply with instruction
12: Recharge stopped by user (stop button)
99
13: Recharge on hold (following a descent to zero in power control)
14: Recharge was stopped due to unsupported request (ventilation)
15: Recharge was stopped due to vehicle error
16: Recharge was stopped due to error during a relay test
17: Recharge was stopped due to access denial
18: Recharge was stopped due to hardware error (micro-electronic)
19: Recharge was stopped due to leakage current into the ground during the first seconds
20: Recharge was stopped due to internal error
21: Recharge was stopped due to leakage current into the ground on multiple occasions
22: Recharge was stopped due to failure to detect battery
23: Recharge was stopped due to failure to detect vehicle
24: Recharge was stopped due to error during precharging test
25: Recharge was stopped due to absence of EV authorization signal
26: Recharge was stopped due to nozzle locking error
27: Recharge was stopped due to battery voltage too low
28: Recharge was stopped due to timeout of current request
29: Recharge was stopped due to current too high
30: Recharge was stopped due to battery voltage threshold exceeded
31: Recharge was stopped due to vehicle request
32: Recharge was stopped due to error during precharging test
100
33: Recharge was stopped due to timeout of EV authentication
34: Recharge was stopped due to invalid status of pilot signal
35: Recharge was stopped due to communication error of a power module (Gen1)
36: Recharge was stopped due to error during insulation test (Gen1)
37: Recharge was stopped due to error of a power module (Gen1)
38: Recharge was stopped due to battery temperature too high
39: Recharge was stopped due to emergency stop
40: Recharge was stopped for security reasons
41: Recharge was stopped due to internal error
42: Reserved for future use
43: Reserved for future use
44: Reserved for future use
45: Reserved for future use
46: Reserved for future use
47: Reserved for future use
48: Reserved for future use
49: Recharge was stopped due to loss of connection with grounding wire on multiple occasions
50: Recharge was stopped due to ADC error
51: Recharge was stopped due to relay error
52: Recharge was stopped due to failure to close a relay
53: Recharge was stopped due to internal error of GFCI circuit
54: Recharge was stopped due to error in UCT logs
55: Recharge was stopped due to RAM memory error
56: Recharge was stopped due to internal clock error
101
57: Recharge was stopped due to internal auxiliary clock error
58: Recharge was stopped due to CRC disparity in configuration
59: Recharge was stopped due to instruction counter error
60: Recharge was stopped due to internal failure of vehicle interface controller
61: Recharge was stopped due to communication problem with vehicle interface controller
62: Recharge was stopped due to flash memory error
63: Recharge was stopped due to excessive internal temperature within the station
Card Number
2 5 Number of the card for which a notification is sent
Recharge end date and time
7
7
See DS3234 (RTC) data sheet for format.
Reason for interruption
Language 1 = FR
14
20
Message indicating the reason for interruption in language 1.
This message is provided by CSNMS when requesting session termination (see Opcode 0x77).
Reason for interruption
Language 2 = EN
34
20
Message indicating the reason for interruption in language 2.
This message is provided by CSNMS when requesting session termination (see Opcode 0x77).
On SmartDC stations, the full charge notification must be sent as soon as State Of Charge (SOC) reaches or exceeds 80%. This notification must be sent only once per recharge session in that case.
On other station types, the current behavior remains unchanged.
Opcode 0x09 – Station connection notification
102
Opcode = 0x09
Length: 2 byte
STATION_CABLE_CONNECTION_TRANSITION
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Cable Status
1
1
Service mode requested:
0: Cable disconnected from EV
1: Cable connected to EV
103
Station Control
Message List
Opcode 0x65 - Request for gain calibration
Opcode 0xFE - Request for current calibration
Opcode 0x6A - Request for changing maximum power
Opcode 0x97 – Request to read current limits
Opcode 0x98 – Sending of current limits
Opcode 0x93 – Notification of station or gateway
Opcode 0x92 – Request for station visual identification
Opcode 0x92 – Request for station visual identification
104
105
Opcode 0x64 - Request for activation / deactivation
Opcode = 0x64
Length: 2 bytes
CSNMS_REQUEST_SET_SERVICE_MODE
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Mode requested
1
1
Service mode requested:
0: Station deactivation
1: Station activation
Note:
From 1.1.46, a station deactivation must be persistent; if station is reactivated (or following a power failure), the station must remain deactivated.
106
Opcode 0x65 - Request for gain calibration
Opcode = 0x65
Length: 3 bytes
CSNMS_REQUEST_CALIBRATE_GAIN
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Voltage
1
2
24012 for 240.12V
107
Opcode 0xFE - Request for current calibration
Opcode = 0xFE
Length: 3 bytes
CSNMS_REQUEST_CALIBRATE_CURRENT
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Energy
1
2
50012 for 500.12 Wh
108
Opcode 0x6A - Request for changing maximum power
Opcode = 0x6A
Length: 7 bytes
CSNMS_REQUEST_SET_MAXIMUM_POWER
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Maximum Power 1 2 0 to 65536 W
Limit Duration 3 4 Duration of limit application in seconds. A duration of 0 sec. indicates to stop immediately the last limit implemented.
This order sends a power limit instruction to the station. The station uses the specified duration for the contingency counter. Once this time is elapsed, the station returns to the default limit (6A in power-sharing mode, or 30A or the limit set in the station in power-limiting mode).
Notes:
• The specified duration must be respected even if the born is rebooted (daily reboot). For example, if duration is 86400 * 3 days, the remaining time must be adjusted each time the station is ready to reboot.
109
Opcode 0x97 – Request to read current limits
Opcode = 0x97
Length: 1 byte
CSNMS_REQUEST_GET_CURRENT_LIMITS
Sent by CSNMS
Response required
110
Opcode 0x98 – Sending of current limits
Opcode = 0x98
Length: 5 bytes
STATION_REPLY_CURRENT_LIMITS
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Minimum Current
1
2
Minimum value (A) for authorized current range to control current limit. For example, a 6A value indicates that the station cannot limit current under 6A.
Maximum Current
1
2
Maximum value (A) for authorized current range to control current limit. For example, a 30A value indicates that the station cannot limit current above 30A.
111
Opcode 0x6F - Request to reboot station
Opcode = 0x6F
Length: 1 byte
CSNMS_REQUEST_REBOOT_STATION
Sent by CSNMS
No response required
112
Opcode 0x89 - Request to reset the station
Opcode = 0x89
Length: 5 bytes
CSNMS_REQUEST_STATION_INITIALIZATION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request Type
1
4
1: Erase LOG from messages
2: Erase LOG from usage sessions
4: Erase LOG from recharge phases
8: Erase persistent properties file
16: Erase station configurations
32: Erase internal ZigBee buffer
113
Opcode 0x93 – Notification of station or gateway reboot
Opcode = 0x93
Length: 1 byte
STATION_REBOOT_NOTIFICATION
Sent by station
No response required
*Also used by gateway to notify CSNMS it has rebooted.
114
Opcode 0x92 – Request for station visual identification
Opcode = 0x92
Length: 5 bytes
CSNMS_REQUEST_FLASH_LEDS
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Duration of a bit
1
1
Duration of a bit from pattern in tenth of seconds
Acceptable values: 1 to 15
Number of cycles to be performed
2
1
Number of times pattern is repeated
Acceptable values: 1 to 255
Flash Pattern
3
2
Flashing pattern (on 16 bits):
Bit 0: LEDs off
Bit 1: LEDs on
Example: 0000000001010101 results in 4 consecutives flashes followed by a pause
Pattern always starts on LSB (right to left)
115
LEDs flash using white color.
116
117
Opcode 0x99 - Request to send property value
Opcode = 0x99
Length: 5 bytes
CSNMS_PROPRIETY_VALUE_REQUEST
Sent by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Component ID
1
4
Component ID
The 0 value is used as a "wildcard" - request for all properties of all components of the station (in this case the value of property ID is not considered)
Property ID
1
4
Property ID
The 0 value is used as a "wildcard" - request for all properties of a selected component.
118
Opcode 0x56 - Status of request sent to station
Opcode = 0x56
Length: 6
STATION_REQUEST_ACK
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request Type
1
1
Request Opcode
Request ID 2 2 Request Unique ID
Request Status 4 1 Status:
0. Ongoing 1. Completed with error (failed) 2. Successfully completed 3. On hold 4. Canceled
Percentage of completion 5 1 0 to 100
119
Opcode 0x59 – Request to reset alarms
Opcode = 0x59
Length: 1
STATION_REQUEST_ACK
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
120
Opcode 0x57 – Change status of power restrictions
Opcode = 0x57
Length: 5
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Constraint Type 1 1 Constraint type (bit field):
0 – None
1 – Demand Response
2 – Power Schedule
Duration of restrictions inactivation
2 2 Duration of inactivation in minutes. If 65535, the duration is for ongoing session. Only applies in case of inactivation command (see Offset 1)
Note: This command is used to deactivate one or several restriction(s) currently active on the station.
Example: If Demand Response and Power Schedule are active and that this command is sent with the Demand Reponse constraint type, it will be deactivated, but the Power Schedule restriction will remain active.
To cancel restriction deactivations, the constraint type 0 (None) must be sent, which will reset all active restrictions.
121
Diagnostics
Message List
Opcode 0xB0 - Sending a log fragment
Opcode 0xB1 – Erasing a log
122
123
Opcode 0xB0 - Request to read log v1
Opcode = 0xB0
Length: 24 bytes
CSNMS_REQUEST_GET_EVENT_LOG_ENTRIES
Sent by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID
1
2
Unique ID for the request. This supports more than one concurrent log reading without collision when data is returned.
Entries requested
3
1
Type:
0: All entries in the ECE
1: Only error ECE entries
2: All entries in the internal log of recharge data entry
Start date and time
4
6
Year minus 2000
Month of the year (1-12)
Day of the month (1-31)
Hour of the day (0-23)
Minutes in the hour (0-59)
Seconds in the hour (0-59)
End date and time
10
6
Year minus 2000
Month of the year (1-12)
Day of the month (1-31)
Hour of the day (0-23)
Minutes in the hour (0-59)
Seconds in the hour (0-59)
124
Offset
16
4
Offset where reading must start
Length in bytes to be returned
20
4
Maximum amount of entries to be returned (bytes)
125
Opcode 0xB0 - Sending a log fragment v1
Opcode = 0xB0
Length: 143 bytes
STATION_REPLY_EVENT_LOG_ENTRIES
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID
1
2
Initial request ID.
Block
3
128
Block content. Text bounded by CR.
Offset
131
4
Offset of block content.
Content Length
135
4
Length of content returned.
Total Length
139
4
Total length of response (bytes)
126
Opcode 0xB1 – Erasing a log v1
Opcode = 0xB1
Length: 2 bytes
STATION_CLEAR_LOG_ENTRIES
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Targeted Entries
1
1
Type:
0: ECE Log
2: Log of recharge data entry
127
Opcode 0xB2 - Request to read log v2
Opcode = 0xB2
Length: 49 bytes
CSNMS_REQUEST_GET_DETAILED_EVENT_LOG_ENTRIES
Sent by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID
1
2
Unique ID for the request. This supports more than one concurrent log reading without collision when data is returned.
Level
3
2
Message Level:
1: INFO
2: DEBUG
3: WARNING
4: SYS_ERROR
5: CRITICAL_ERROR
6: FATAL_ERROR
Note: The passed scope level will include lower levels. E.g. 3 :Warning will include INFO, DEBUG and WARNING
Scope 5 4 1: SYSTEM
2: USER
4: SERVICE
8: DEVELOPER
Note: More than one value can be passed (bit field)
ComponentId 9 4 Software component ID for which you want to receive log entries
128
MessageId 13 4 ID for the log message you want to receive
Start date and time 17 8 Date and time (in milliseconds since Epoch) of beginning of log entries to be retrieved
End date and time 25 8 Date and time (in milliseconds since Epoch) of beginning of log entries to be retrieved
Max. number of messages 33 4 Max. number of message occurrences
Offset 37 4 Offset of messages to be received
Maximum Length 41 4 Response maximum length
Frame Length 45 4 Length of response frame
Note: Zigee = 128 bytes, TcpIp = 1 MB
129
Opcode 0xB3 - Sending a log fragment v2
Opcode = 0xB3
Length: Dynamic
STATION_REPLY_DETAILED_EVENT_LOG_ENTRIES
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Firmware Version
1
4
Version of firmware installed on station.
Request ID
5
2
Initial request ID.
Offset
7
4
Offset of block content.
Content Length
11
4
Length of returned content of current message. This is log data, and it excludes message header (20 first bytes)
Total Length
15
4
Total response length in bytes. This is log data, and it excludes message header (20 first bytes)
Request Status 19 1 Request Status
1- Complete Result 2- Too many results
Sent Data
20
Dynamic
130
Block content. Length determined by the value of "Content Length".
131
Opcode 0xB4 – Ping Server
Opcode = 0xB4
Length: 37
STATION_PING_SERVER_ENTRIES
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
DeviceId
1
36
Station Id (ZigbeeId or deviceId).
132
Opcode 0xB6 – Log Notification
Opcode = 0xB6
Length: 13
STATION_LOG_NOTIFICATION
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Message index
1
8
Index of log item
Scope 9 4 Message Scope
Opcode 0xB7 – Log Notification Acknowledgement
Opcode = 0xB7
Length: 13
CSNMS_SERVER_LOG_NOTIFICATION_ACK
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Message index
1
8
Index of log item
133
Scope 9 4 Message Scope
134
135
Maintenance
Message List
136
Opcode 0xA0 - Request to establish R-HTTP connection Opcode 0xA1 - Request to close R-HTTP connection
Opcode 0xA2 - Request to reboot gateway
Opcode 0xA3 - Sending of keep-alive message
Opcode 0xA4 – CSNMS ready to accept messages
137
Opcode 0xA0 - Request to establish R-HTTP connection
Opcode = 0xA0
Length: 29 bytes
CSNMS_REQUEST_ESTABLISH_HTTP_REDIRECTOR_CONNECTION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
CSNMS Redirector IP Address
1
4
IP address of CSNMS Redirector endpoint
CSNMS Redirector IP Port
5
2
Port number of CSNMS Redirector endpoint
Gateway IP Address
7
4
IP address of Gateway device endpoint
Gateway IP Port
11
2
Port number of Gateway device endpoint
Gateway Certificate
13
16
Certificate for gateway connection to CSNMS Redirector
138
Opcode 0xA1 - Request to close R-HTTP connection
Opcode = 0xA1
Length: 3 bytes
CSNMS_REQUEST_CLOSE_HTTP_REDIRECTOR_CONNECTION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Gateway IP Port
7
2
Port number of Gateway device endpoint
139
Opcode 0xA2 - Request to reboot gateway
Opcode = 0xA2
Length: 5 bytes
CSNMS_REQUEST_REBOOT_GATEWAY
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Reboot signature
1
4
Must contain 0x188db007 value
140
Opcode 0xA3 - Sending of keep-alive message
Opcode = 0xA3
Length: 5 bytes
GATEWAY_KEEP_ALIVE_MESSAGE
Sent by gateway
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request signature
1
4
Must contain 0xdeadbeef value
141
Opcode 0xA4 – CSNMS ready to accept messages
Opcode = 0xA4
Length: 1 byte
READY_TO_ACCEPT_PACKET_MESSAGE
Sent by CSNMS
No response required
142
Power Control
Message List
Opcode 0xC0 – Sending power instruction to station
Opcode 0xC1 – Sending acknowledgment of power instruction to station
Opcode 0xC2 – Sending of pilot signal transition by a station
Opcode 0xC3 – Request to read configuration of site power control Opcode 0xC4 – Sending configuration of site power control
Opcode 0xC5 – Writing configuration of site power control
Opcode 0xC6 – Status request to site controller
Opcode 0xC7 – Sending statuses to controller site
Opcode 0xC8 – Reboot request to controller site
Opcode 0xC9 – Request to hold power distribution
Opcode 0xCA – Request to reactivate power distribution
Opcode 0xCB – Periodic dispatch of site global status
Opcode 0xCC – Reserved for future use
Opcode 0xCD – Reserved for future use
Opcode 0xCE – Reserved for future use
Opcode 0xCF – Reserved for future use
143
144
Opcode 0xC0 – Sending power instruction to station
Opcode = 0xC0
Length: 13 bytes
SITECTRL_REQUEST_SET_POWER_LIMIT
Sent by site controller
Acknowledgment required
CSNMS does not send or receive this message
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Request number
1
4
Request sequential number
Maximum power
5
4
Power instruction in watts.
The 0xFFFFFFFF value indicates not to change the current limit. This allows to retrieve information contained in the confirmation message without changing the current instruction.
Pilot transition acknowledgement
9
2
Sequence number of pilot signal transition confirmed (or 0 if no confirmation). This field is set back to 0 is station is considered in contingency.
Number of unsent requests. If this field value is other than 0, indicates the number of unsent requests since the last request. Allows the station not to consider the received request sequential number as invalid.
145
Skip count
11
1
The station must always accept as valid a sequential number considering that the expected one becomes:
Request number = last request number + 1 + skip count
If received sequential number does not match this value, the error recovery logic applies.
Response delay
12
1
Delay to meet before sending the STATION_REPLY_POWER_USAGE_REPORT corresponding to this instruction.
Value is in tenth of seconds:
• A value of 0 indicates to send a response immediately
• The 255 value corresponds to a delay of 25.5 seconds.
When the station receives this message, it must:
1. Check whether this message sequential number is the one expected. Here is how the station must react:
o If the received number matches the one expected, the message is processed and acknowledged.
o If the received number is equal to or lower than the sequential number of the last message received, the station must increment the counter of out-of-sequence messages received (problem in the protocol). The message is ignored and unacknowledged.
o If the received number is higher than the expected number, the station must increment the counter of lost messages. The message is processed and acknowledged.
o If the station did not receive a valid message during twice the period of communication loss detection (2𝑝), it must accept the next one, no matter its sequence number. The counter of resynchronizations made by the station is then incremented. The message is processed and acknowledged.
2. The station must then configure itself to use the indicated power instruction. 3. To acknowledge a message, the station must transmit acknowledgment of this request (message
PowerUsageReport) and include its currently used power in this acknowledgment. 4. Please note that the station must ensure that the vehicle complies with the instruction after the 5-
second delay defined by J1772 is elapsed. After this delay, when the station detects that the vehicle does not comply with the new instruction, it must terminate the ongoing session by opening the
146
contactor and sending a session interruption notification due to failure to comply with the instruction to CSNMS. During the 5 second period of transition towards the new instruction, the station must ensure that the vehicle does not exceed the following value:
𝑚𝑎𝑥𝑖𝑚𝑢𝑚𝑝𝑜𝑤𝑒𝑟𝑡𝑜𝑣𝑒ℎ𝑖𝑐𝑙𝑒 = max(𝑜𝑙𝑑𝑖𝑛𝑠𝑡𝑟𝑢𝑐𝑡𝑖𝑜𝑛, 𝑛𝑒𝑤𝑖𝑛𝑠𝑡𝑟𝑢𝑐𝑡𝑖𝑜𝑛)
147
Opcode 0xC1 – Sending acknowledgment of power instruction to station
Opcode = 0xC1
Length: 35 bytes
STATION_REPLY_POWER_USAGE_REPORT
Sent by a station
to site controller
No response required
CSNMS does not send or receive this message
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Request number 1 4 Sequential number of the confirmed request.
ID Session 5 2 ID of current session into the station, as provided by the station.
Session priority
7
1
Priority associated with the session
• Absolute Priority (3) • High Priority (2) • Normal Priority (1) or (0)
Operating mode
and pilot signal
8
1
Operating mode
4 MSBs:
• 0: FREE_RUNNING_MODE • 1: POWER_SHARING_MODE
Pilot Signal
4 LSBs:
• A = 0 • B = 1 • C = 2
148
• D = 3 • E = 4 • F = 5
Last Pilot Report Number
9
2
Value of pilot report number in the last transition message of sent pilot signal. The 0 value is sent if no transition message of pilot signal was sent by the station up until now.
Alarms 11 1 Alarms
• Failure to comply with power instruction Minimum power usage 12 4 Minimum of usable power by the station in watts (for
example 6A * V)
Maximum power usage 16 4 Maximum of usable power by the station in watts (for example 30A * V)
Current power usage 20 4 Power currently used by the station in watts
Lost requests count
24
2
Number of request messages detected as lost. This occurs if the sequence number of the received message is higher than the one expected.
Requests out of sequence count
26
2
Number of request messages out of frequency Out-of-frequency messages are ignored (and unacknowledged).
Resynchronization count
28
2
Number of times the station resynchronized on a sequence number that was not the one expected. Messages that cause station resynchronization are processed and confirmed.
Response delay
30
1
Value of the delay as received by the power instruction for which this confirmation is sent.
The value must be identical to the one received.
Voltage
31
2
Recharge Voltage
Current
33
2
Amperage of the recharge in tenth of amperes. A value of 32 indicates an amperage of 3.2 A
This message is sent by the station to the site controller as acknowledgment of power instruction.
149
150
Opcode 0xC2 – Sending of pilot signal transition by a station (power sharing mode only)
Opcode = 0xC2
Length: 5 bytes
STATION_PILOT_TRANSITION_REPORT
Sent by station
Acknowledgment through power instruction
CSNMS does not send or receive this message
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Pilot report number
1
2
Report number of pilot signal.
• The first report for the pilot signal starts with value 1.
• The 0 value is reserved to indicate that no acknowledgment of pilot signal transition is made by site controller when sending instructions.
Pilot transition
3
1
Previous state of pilot signal (A/B/C) on the 4 MSBs (Most Significant Bits)
• A = 0 • B = 1 • C = 2 • D = 3 • E = 4 • F = 5
New state of pilot signal (A/B/C) on the 4 LSBs (Least Signifiant Bits)
• A = 0 • B = 1
151
• C = 2 • D = 3 • E = 4 • F = 5
Operating mode
4
1
• 0: FREE_RUNNING_MODE • 1: POWER_SHARING_MODE
This message is sent by the station to the site controller when it detects a transition of its pilot signal:
• A to B (connection) • If required: B to C (beginning of recharge session) • If required: C to B (end of recharge session) • If required: C or B to A (disconnection)
The station repeats this message every second until it receives an instruction message acknowledging reception of this transition information. In the case where a new transition arrives before acknowledgment by the site controller, the last transition replaces the previous one. For each new transition, the report number (pilotReportNumber) is incremented.
The station stops repeating this message if it falls into contingency (out of communication).
152
Opcode 0xC3 – Request to read configuration of site power control
Opcode = 0xC3
Length: 1 byte
CSNMS_REQUEST_GET_SITE_CONFIGURATION
Sent by CSNMS
Acknowledgment through sending site configuration
153
Opcode 0xC4 – Sending configuration of site power control
Opcode = 0xC4
Length: variable
SITECTRL_REPLY_SITE_CONFIGURATION
Sent by site controller to CSNMS
No confirmation required
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Checksum
1
32
MD5 of configuration in 32-byte format encoded in UTF-8
Configuration
5
n bytes
Configuration Information In JSon format.
Note: Status information format is specific to the site controller version used. For more information on this format, please consult the Solution Volet-Employeur – Architecture document.
154
Opcode 0xC5 – Writing configuration of site power control
Opcode = 0xC5
Length: variable
CSNMS_REQUEST_SET_CONFIGURATION
Sent to CSNMS to a site controller
No confirmation required
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Configuration Length
1
4
Length of configuration information in bytes.
Configuration
5
n bytes
Configuration Information
Note: Status information format is specific to the site controller version used. For more information on this format, please consult the Solution Volet-Employeur – Architecture document.
155
Opcode 0xC6 – Status request to site controller
Opcode = 0xC6
Length: 1 byte
CSNMS_REQUEST_GET_SITE_STATUS
Sent by CSNMS to a site controller
Acknowledgment through sending of site status
156
Opcode 0xC7 – Sending statuses to site controller
Opcode = 0xC7
Length: variable
SITECTRL_REPLY_SITE_STATUS
Sent by site controller to CSNMS
No acknowledgment required
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Status length
1
4
Length of status information in bytes.
Statuses
5
n bytes
Status Information
Note: Status information format is specific to the site controller version used. For more information on this format, please consult the Solution Volet-Employeur – Architecture document.
Note 2: Status is automatically sent at the next minute if any pilot transition was detected between two cycles of the site controller. This is synchronized with periodical status. Only one of the two statuses (complete or periodical) is sent. The complete status is also sent upon gateway startup. Upon CSNMS startup, CSNMS requests complete status only once after receiving a periodic status.
157
Opcode 0xC8 – Reboot request to controller site
Opcode = 0xC8
Length: 1 byte
CSNMS_REQUEST_RESTART_SITE_CONTROLLER
Sent to CSNMS to a site controller
No acknowledgment required
158
Opcode 0xC9 – Request to hold power distribution
Opcode = 0xC9
Length: 1 byte
CSNMS_REQUEST_RESTART_SITE_CONTROLLER
Sent to CSNMS to a site controller
No acknowledgment required
This order holds power distribution by stopping the sending of power instructions and calculation of power distribution. However, statuses must always be sent to CSNMS. Moreover, following this command, the site controller will trigger a minor alarm indicating that site controller is on hold.
159
Opcode 0xCA – Request to reactivate power distribution
Opcode = 0xCA
Length: 1 byte
CSNMS_REQUEST_RESTART_SITE_CONTROLLER
Sent to CSNMS to a site controller
No acknowledgment required
160
Opcode 0xCB – Periodic dispatch of site global status
Opcode = 0xCB
Length: 19 bytes
SITECTRL_STATUS
Sent by the site controller
No acknowledgment required
Fields
Offset
(bytes)
Length
(bytes)
Big-endian
Description
Site GUID
1
16
GUID of site sending the status.
Alarms
17
2
Bit field containing active alarms. The 0 value indicates that no alarm is active.
Major Alarm
0: STATION_POWER_LIMIT_EXCEEDED
1: STATION_POWER_MODE_CONFIG_ERROR
2: CIRCUIT_POWER_LIMIT_EXCEEDED
3: SITECTRL_OVERRUN_CONDITION
4: SITECTRL_EXCESSIVE_PILOT_TRANSITIONS
5: SITECTRL_BMS_COMM_TIMEOUT
6: CONFIG_CHECKSUM_FAILED
7: RESERVED for future use
Minor Alarms
161
8: STATION_MINIMUM_NOT_MET
9: STATION_COMM_TIMEOUT
10: SITECTRL_BMS_POWER_LIMIT_EXCEEDED
11: SITECTRL_PAUSED
12: RESERVED for future use
13: RESERVED for future use
14: RESERVED for future use
15: RESERVED for future use
Request number 19 4 Sequential number of last power instruction. Also indicates the number of power control cycles.
Site configuration indicates at which frequency the message must be sent.
162
Updates
Message List
Opcode 0x60 – Sending of expected firmware version
Opcode = 0x60
Length: 5 bytes
CSNMS_EXPECTED_FIRMWARE_VERSION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Expected firmware version 1 4 Firmware version the station should have
Bit 31 (0x80000000): Forces firmware version
validation (1=Forces validation)
163
Opcode 0x61 – Request of firmware fragment for udpate
Opcode = 0x61
Length: 14 bytes
STATION_FIRMWARE_FRAGMENT_REQUEST
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Station Model 1 1 Station Model
Firmware Version
2
4
Version of firmware to be installed on the station.
Offset 6
4
Offset from which firmware data must be returned
Fragment Length 10
4
Length in bytes of requested fragment
164
Opcode 0x62 – Sending of firmware fragment for update
Opcode = 0x62
Length: dynamic
CSNMS_FIRMWARE_FRAGMENT_RESPONSE
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Fragment Length 1 4 Length of fragment sent
Total file length 5 4 Total length of firmware file in bytes
Content 9
Dynamic
Firmware Content
165
Opcode 0x68 - Request to erase the zone for new firmware Opcode 0x69 - Request to register firmware fragment
166
Opcode 0x60 – Sending of expected firmware version
Opcode = 0x60
Length: 5 bytes
CSNMS_EXPECTED_FIRMWARE_VERSION
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Expected firmware version 1 4 Firmware version the station should have
Bit 31 (0x80000000): Forces firmware version
validation (1=Forces validation)
167
Opcode 0x61 – Request of firmware fragment for udpate
Opcode = 0x61
Length: 14 bytes
STATION_FIRMWARE_FRAGMENT_REQUEST
Sent by station
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Station Model 1 1 Station Model
Firmware Version
2
4
Version of firmware to be installed on the station.
Offset 6
4
Offset from which firmware data must be returned
Fragment Length 10
4
Length in bytes of requested fragment
168
Opcode 0x62 – Sending of firmware fragment for update
Opcode = 0x62
Length: dynamic
CSNMS_FIRMWARE_FRAGMENT_RESPONSE
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Fragment Length 1 4 Length of fragment sent
Total file length 5 4 Total length of firmware file in bytes
Content 9
Dynamic
Firmware Content
169
Opcode 0x68 - Request to erase the zone for new firmware
Opcode = 0x68
Length: 11 bytes
CSNMS_REQUEST_CLEAR_FIRMWARE_CONTENT
Sent by CSNMS
No response required
However, you must wait a little while before starting to send firmware fragments.
Fields
Offset
(bytes)
Length
(bytes)
Description
Local Number 1
2
This is the number sent by the station to CSNMS. In a distant future, this number will no longer be necessary.
Total Size 3
4
Size of the .txt file containing the firmware - 25.
Checksum 7
4
Sum of all characters (except the first 25).
170
Opcode 0x69 - Request to register firmware fragment
Opcode = 0x69
Length: variable
CSNMS_REQUEST_WRITE_FIRMWARE_CONTENT
Sent by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Local Number 1
2
This is the number sent by the station to CSNMS. In a distant future, this number will no longer be necessary.
Offset 3
4
Offset of fragment in the file - 25.
Number of bytes contained in the fragment
7
2
Fragment
9
n
Fragment Content
171
Resource Transfer
The messages represent a resource transfer protocol (files) from the station to CSNMS or from CSNMS to the station. The station and CSNMS must have two services: Resource Client; Resource Server. The station's resource client interacts with CNMS's resource server; CSNMS's resource client interacts with the station's resource server using the following message sequence:
Resource Client Directions Resource Server
1 Message 0x51 →
2 ← Message 0x52
3 Message 0x53 →
4 ← Message 0x54
5 ← Message 0x54
6 ← Message 0x54
…
I Message 0x53 (if a fragment is missing)
→
I+1 ← Message 0x54
…. ….
N-1 ← Message 0x54
N Message 0x55 →
Message List
Opcode 0x51 – Resource request
Opcode 0x52 – Resource ready to be sent
Opcode 0x53 – Request for resource fragment
Opcode 0x54 – Sending of resource fragment
Opcode 0x55 – Acknowledgment of complete reception of resource
172
173
Opcode 0x51 – Resource request
Opcode = 0x51
Length: dynamic
RESOURCE_CLIENT_ENQUIRY
Sent by the station or by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
Length of query string
3
1
Length of query string. Length must not exceed 128 bytes for Zigbee stations.
Query string
4
Dynamic
Query string
Note:
If resource client does not receive the 0x52 response to message 0x51 after 30 seconds, it will repeat message 0x51. After 5 trials, the requester sees that the requested resource is not available.
The "Query string" has the following structure:
"/namespace?parameter1=value1¶meter2=value2 … parameterN=valueN"
Examples:
Resource Type Query string
Configuration /configurations?n=Config1
n – name
Firmware /firmwares?n=SmartHomeFirmware
n – name
174
Property /properties?cid=234567&pid=34578
cid – component ID
pid – property ID
Note: If the "pid" parameter equals 0, all properties of the selected component are requested. If the "cid" parameter equals 0, all properties of all components are requested.
Event Log /logs?cid=0x01234567&mid=0x01234567&lev=1&sc=1&ts=0x0123456701234567&
te=0x0123456701234567&mn=100000&is=12&ie15
cid – component ID
mid – message ID
lev – level
sc – scope
ts – time start
te – time end
mn – number of messages
is - Index start
ie – Index end
Values are in hex.
Cards /cards?cmd=get&rid=123
cmd – command
rid – request ID received in CSNMS_REQUEST_CARDS_OPERATION
Language configuration
/language?n=en
n – name of language configuration according to ISO 639-1 (2 letters)
175
Opcode 0x52 – Resource ready to be sent
Opcode = 0x52
Length: 14 bytes
RESOURCE_SERVER_RTS
Sent by the station or by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Unique ID of the request (same as in the message 0x51)
Resource Status 3 1 1. Resource unavailable
2. Resource available
Suggested fragment length 4 4 Length of fragments suggested by the server. If no suggestion, value is 0
Total file length 8 4 Total length of file in bytes
File Checksum 12 2 File CheckSum
Note:
The file checksum is CRC16-CCITT: initial value 0xFFFF, polynomial 0x1021.
176
Opcode 0x53 – Request for resource fragment
Opcode = 0x53
Length: 11 bytes
RESOURCE_CLIENT_FRAGMENT_REQUEST
Sent by the station or by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Unique ID of the request (same as in the message 0x51)
Offset 3
4
Offset from which resource data must be returned
Fragment Length 7
4
Length in bytes of requested fragment
177
Opcode 0x54 – Sending of resource fragment
Opcode = 0x54
Length: dynamic
RESOURCE_SERVER_FRAGMENT_RESPONSE
Sent by the station or by CSNMS
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Unique ID of the request (same as in message 0x51)
Resource Status 3 1 1. Resource unavailable
2. Resource available
Fragment Length 4 4 Length of fragment sent
Offset 8
4
Offset from which data must be sent
Total Length 12 4 Total length of file in bytes
Content 16
Dynamic
Content
Note:
If the resource requester does not receive the response 0x54 to the message 0x53 after 30 seconds, it repeats message 0x53. After 5 trials, the requester sees that the resource is no longer available.
178
Resource of "Configuration" type is a list of properties with their values. In the case where the resource is sent from the station to CSNMS, the first 4 bytes represent the version of the firmware in which the configuration was created.
Firmware Version Version of the firmware installed on the station
iMajor * 1000000 + iMinor * 1000 + iRelease
4 bytes
Property 1
Header
Signature ("PROP") 4 bytes
Component ID 4 bytes
Property ID 4 bytes
Number of values for the property 2 bytes
Total size of values for the property 2 bytes
Size of value 1 2 bytes
Value 1 of the property Varied
….. ….
Size of value N 2 bytes
Value N of the property Varied
………………….
Property M
Header
Signature ("PROP") 4 bytes
Component ID 4 bytes
Property ID 4 bytes
Number of values for the property 2 bytes
Total size of values for the property 2 bytes
Size of value 1 2 bytes
Value 1 of the property Varied
….. ….
Size of value N 2 bytes
Value N of the property Varied
179
180
Opcode 0x55 – Acknowledgment of complete reception of resource
Opcode = 0x55
Length: 3 bytes
RESOURCE_CLIENT_ACK
Sent by the station or by CSNMS
Response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Unique ID of the request (same as in message 0x51)
Note:
Once the resource is entirely received, the requester verifies its checksum. If the checksum is correct, the requester sends message 0x55. This message can be used by the server to free the resource right away. If the server does not receive this message or message 0x53 during resource transmission, after 1 minute the server frees the resource.
181
Protocol Multicast
Multicast is used for communication:
- Between stations. These are messages that are not sent to CSNMS, but from a station to other stations installed on the same power grid. The goal of these messages is to broadcast certain information (for example for the "Power Sharing" feature).
- Between the station and a service application. These are messages sent to configure the station (for example a MAC address) or to perform certain tests (for example LED or GPIO testing)
182
"Power Sharing"
Message List
Opcode 0x01 – Configuration of station power
Opcode 0x02 – Response to opcode 0x01
183
Opcode 0x01 – Configuration of station power
Opcode = 0x01
Length: 25 bytes
STATION_POWER_CONFIGURATION
Request sent by the station to other stations
Response 0x02 required
Fields
Offset
(bytes)
Length
(bytes)
Description
MAC address
1
8
MAC address of the station
Sation up-time
9
8
In milliseconds, as accurate as possible.
Maximum acceptable current of the station
17
4
Maximum current of the station in tenth of amperes.
Example: 32 = 3.2A
Message ID
21
4
Message ID that increments at each new message
184
Opcode 0x02 – Response to message 0x01 (Configuration of station power)
Opcode = 0x02
Length: 37 bytes
STATION_POWER_CONFIGURATION_REPLY
Sent by the station to another station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
MAC address of the responding station
1
8
MAC address of the responding station
Up-time of the responding station
9
8
In milliseconds, as accurate as possible.
MAC address of the requesting station
17
8
MAC address of the requesting station (the one received in message 0x01)
Up-time of the requesting station
25
8
Up-time of the requesting station (the one received in message 0x01)
Message ID
33
4
ID of message 0x01 of the requesting station (the one received in message 0x01)
185
186
Managing configuration and surrounding of the station
Message List
Opcode 0x11 – Request to read MAC address
Opcode 0xA1 – MAC address of station
Opcode 0x12 – Request to write MAC address
Opcode 0x13 – Station status request
Opcode 0xA3 – Sending of station status
Opcode 0x14 – Request for station visual identification
Opcode 0x15 – Request for station audio identification
Opcode 0x15 – Request for station GPIO control
Opcode 0xA0 – Status of request made to the station
187
Opcode 0x11 – Request to identify station
Opcode = 0x11
Length: 3 bytes
REQUEST_STATION_IDENTIFICATION
Sent by service application
Response 0xA1 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
Opcode 0xA1 – MAC address of station
Opcode = 0xA1
Length: 19 bytes
STATION_IDENTIFICATION
Sent by station
Response not required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station
188
Serial number 11 8 Serial number
189
Opcode 0x12 – Request to write MAC address and serial number
Opcode = 0x12
Length: 27 bytes
REQUEST_UPDATE_STATION_IDENTIFICATION
Sent by service application
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
MAC address to write
11
8
New MAC address of station
Serial number to write 19 8 New serial number of station
Opcode 0x13 – Station status request
Opcode = 0x13
Length: 11 bytes
REQUEST_STATION_STATUS
Sent by service application
Response 0xA3 required
Fields
Offset
(bytes)
Length
(bytes)
Description
190
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
191
Opcode 0xA3 – Sending of station status
Opcode = 0xA3
Length: dynamic
STATION_STATUS
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address 3 8 MAC address of the station
Extended station statuses 11 Content of message 0x96
192
Opcode 0x14 – Request for station visual identification
Opcode = 0x14
Length: 16 bytes
REQUEST_SET_STATION_LED_STATE
Sent by service application
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
Identifier ID 11 1 Identifier ID:
0 – Status LED
0 – PLC LED
Red Intensity 12 1 Intensity of the color red (0 to 255)
Red Intensity 13 1 Intensity of the color red (0 to 255)
Red Intensity 14 1 Intensity of the color red (0 to 255)
Modulation 15 1 Modulation:
0 – LED is not ON
1 – LED is ON, but no modulation
2 – Slow Modulation
3 – Rapid Modulation
193
Opcode 0x15 – Request for station audio identification
Opcode = 0x15
Length: 12 bytes
REQUEST_SET_STATION_BUZZER_STATE
Sent by service application
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
Audio feedback request 11 1 Audio Feedback:
0 – silence
1 — 1 short bip
2 — 1 long bip
3 — 2 short bips
4 — 2 long bips
5 — 3 short bips
6 — 3 long bips
194
Opcode 0x16 – Request for station GPIO control
Opcode = 0x16
Length: 16 bytes
REQUEST_SET_STATION_GPIO
Sent by service application
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
GPIO Address 11 4 GPIO Address
GPIO Value 15 1 GPIO Value
Opcode 0xA0 - Status of request sent to station
Opcode = 0xA0
Length: 13
STATION_REQUEST_ACK
Sent by station
No response required
Fields
Offset
(bytes)
Length
(bytes)
Description
195
Request ID 1 2 Request Unique ID
MAC address 3 8 MAC address of the station
Request Status 11 1 Status:
0. Ongoing 1. Completed with error (failed) 2. Successfully completed 3. On hold 4. Canceled
Percentage of completion 12 1 0 to 100
196
Opcode 0x17 – Request to reboot station
Opcode = 0x17
Length: 11 bytes
REQUEST_REBOOT_STATION
Sent by service application
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
197
Opcode 0x18 - Request to reset the station
Opcode = 0x18
Length: 15 bytes
REQUEST_STATION_RESET
Sent by CSNMS
Response 0xA0 required
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
Request Type
11
4
1: Erase LOG from messages
2: Erase LOG from user sessions
4: Erase LOG from recharge phases
8: Erase persistent properties file
16: Erase station configurations
Opcode 0x19 – Request to write station default configuration
Opcode = 0x12
Length: 77 bytes
REQUEST_STATION_CONFIGURATION_UPDATE
Sent by service application
Response 0xA0 required
198
Fields
Offset
(bytes)
Length
(bytes)
Description
Request ID 1 2 Request Unique ID
MAC address
3
8
MAC address of the station to which the request is made
Configuration Version 11 2 Configuration Version
Default Server Address
13
64
Address of default server (null terminated)