Skip to content

Commit 2439852

Browse files
mheimhei
committed
Update DBC and generated UART frame documentation
Signed-off-by: Michael Heimpold <michael.heimpold@chargebyte.com>
1 parent 8751f06 commit 2439852

2 files changed

Lines changed: 258 additions & 176 deletions

File tree

‎docs/source/safety_protocol.rst‎

Lines changed: 95 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ChargeControl1
77

88
**Description**: This message shall be sent from the host processor to the safety controller to control the peripherals connected to the safety controller.
99

10-
**Senders**: Default_HostController
10+
**Senders**: chargeSOM_HostController
1111

1212
.. list-table:: Signals in ChargeControl1
1313
:widths: 30 6 6 10 7 7 7 6 30
@@ -58,6 +58,15 @@ ChargeControl1
5858
- 0
5959
-
6060
- Request to close the contactor state. A value of 0 means open contactor, a value of 1 means closed contactor. The contactors are only closed if the system has no errors and is in state C.
61+
* - CC_Contactor3State
62+
- 18
63+
- 1
64+
-
65+
- No
66+
- 1
67+
- 0
68+
-
69+
- Request to close the contactor state. A value of 0 means open contactor, a value of 1 means closed contactor. The contactors are only closed if the system has no errors and is in state C.
6170

6271
**Bitfield Layout**
6372

@@ -70,7 +79,7 @@ ChargeControl1
7079
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
7180
1| | | | | | | | |
7281
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
73-
2| | | | | | | CC_Contactor2State | CC_Contactor1State |
82+
2| | | | | | CC_Contactor3State | CC_Contactor2State | CC_Contactor1State |
7483
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
7584
3| | | | | | | | |
7685
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
@@ -92,7 +101,7 @@ ChargeState1
92101

93102
**Description**: This message shall be sent from safety controller to host processor for indicating the state of the charging session as well as the state of connected peripherals.
94103

95-
**Senders**: Safety Controller
104+
**Senders**: chargeSOM_SafetyController
96105

97106
.. list-table:: Signals in ChargeState1
98107
:widths: 30 6 6 10 7 7 7 6 30
@@ -116,6 +125,15 @@ ChargeState1
116125
- 0
117126
- %
118127
- The current duty cycle between 0.0% and 100.0%. If the PWM is not aczive this signal is 0
128+
* - CS_SafeStateActive
129+
- 3
130+
- 2
131+
-
132+
- No
133+
- 1
134+
- 0
135+
-
136+
- This signal reports, if the controller is in safeState or not.
119137
* - CS_PWM_Active
120138
- 7
121139
- 1
@@ -169,34 +187,25 @@ ChargeState1
169187
- 1
170188
- 0
171189
-
172-
- Is set when the contactor is closed
173-
* - CS_Contactor1Error
174-
- 34
175-
- 1
176-
-
177-
- No
178-
- 1
179-
- 0
180-
-
181-
- Is set when an error in the contactor is detected
190+
- State of contactor 1
182191
* - CS_Contactor2State
183-
- 36
192+
- 35
184193
- 2
185194
-
186195
- No
187196
- 1
188197
- 0
189198
-
190-
- Is set when the contactor is closed
191-
* - CS_Contactor2Error
199+
- State of contactor 2
200+
* - CS_Contactor3State
192201
- 37
193-
- 1
202+
- 2
194203
-
195204
- No
196205
- 1
197206
- 0
198207
-
199-
- Is set when an error in the contactor is detected
208+
- State of contactor 3
200209
* - CS_HV_Ready
201210
- 38
202211
- 1
@@ -233,9 +242,24 @@ ChargeState1
233242
- 0
234243
-
235244
- *No description available*
245+
* - CS_SafeStateReason
246+
- 55
247+
- 8
248+
-
249+
- No
250+
- 1
251+
- 0
252+
-
253+
- This signal describes in which module a fault was detected, why the controller went into safeState
236254

237255
**Value Descriptions**
238256

257+
- **CS_SafeStateActive**
258+
259+
- 0x0 = NormalState
260+
- 0x1 = SafeState
261+
- 0x3 = SNA
262+
239263
- **CS_CurrentCpState**
240264

241265
- 0x0 = Unknown
@@ -260,14 +284,23 @@ ChargeState1
260284

261285
- **CS_Contactor1State**
262286

263-
- 0x0 = OPEN
264-
- 0x1 = CLOSE
287+
- 0x0 = UNDEFINED
288+
- 0x1 = OPEN
289+
- 0x2 = CLOSE
265290
- 0x3 = NotConfigured
266291

267292
- **CS_Contactor2State**
268293

269-
- 0x0 = OPEN
270-
- 0x1 = CLOSE
294+
- 0x0 = UNDEFINED
295+
- 0x1 = OPEN
296+
- 0x2 = CLOSE
297+
- 0x3 = NotConfigured
298+
299+
- **CS_Contactor3State**
300+
301+
- 0x0 = UNDEFINED
302+
- 0x1 = OPEN
303+
- 0x2 = CLOSE
271304
- 0x3 = NotConfigured
272305

273306
- **CS_Estop1ChargingAbort**
@@ -288,26 +321,48 @@ ChargeState1
288321
- 0x1 = TRUE
289322
- 0x3 = NotConfigured
290323

324+
- **CS_SafeStateReason**
325+
326+
- 0x0 = NoStop
327+
- 0x1 = InternalError
328+
- 0x2 = ComTimeout
329+
- 0x3 = Temp1_Malfunction
330+
- 0x4 = Temp2_Malfunction
331+
- 0x5 = Temp3_Malfunction
332+
- 0x6 = Temp4_Malfunction
333+
- 0x7 = Temp1_Overtemp
334+
- 0x8 = Temp2_Overtemp
335+
- 0x9 = Temp3_Overtemp
336+
- 0xA = Temp4_Overtemp
337+
- 0xB = PP_Malfunction
338+
- 0xC = CP_Malfunction
339+
- 0xD = CP_ShortCircuit
340+
- 0xE = CP_DiodeFault
341+
- 0xF = HVSW_Malfunction
342+
- 0x10 = EmergencyInput1
343+
- 0x11 = EmergencyInput2
344+
- 0x12 = EmergencyInput3
345+
291346
**Bitfield Layout**
292347

293348
::
294349

295350
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
296351
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
297352
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
298-
0| CS_PWM_Active | | | | | |CS_CurrentDutyCycle | |
353+
0| CS_PWM_Active | | | | CS_SafeStateActive | |CS_CurrentDutyCycle | |
299354
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
300355
1| | | | | | | | |
301356
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
302357
2| | | | CS_DiodeFault | CS_CpShortCircuit | CS_CurrentCpState | | |
303358
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
304359
3| | | | | | CS_CurrentPpState | | |
305360
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
306-
4| | CS_HV_Ready | CS_Contactor2Error | CS_Contactor2State | | CS_Contactor1Error | CS_Contactor1State | |
361+
4| | CS_HV_Ready | CS_Contactor3State | | CS_Contactor2State | | CS_Contactor1State | |
307362
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
308363
5| | |CS_Estop3ChargingAbo| |CS_Estop2ChargingAbo| |CS_Estop1ChargingAbo| |
309364
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
310-
6| | | | | | | | |
365+
6| CS_SafeStateReason | | | | | | | |
311366
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
312367
7| | | | | | | | |
313368
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
@@ -321,7 +376,7 @@ PT1000State
321376

322377
**Description**: This message shall be sent from safety controller to host processor for indicating the state of the connected temperature sensors
323378

324-
**Senders**: Safety Controller
379+
**Senders**: chargeSOM_SafetyController
325380

326381
.. list-table:: Signals in PT1000State
327382
:widths: 30 6 6 10 7 7 7 6 30
@@ -496,7 +551,7 @@ FirmwareVersion
496551

497552
**Description**: This message provides information about the type and version of the flashed firmware
498553

499-
**Senders**: Safety Controller
554+
**Senders**: chargeSOM_SafetyController
500555

501556
.. list-table:: Signals in FirmwareVersion
502557
:widths: 30 6 6 10 7 7 7 6 30
@@ -556,6 +611,15 @@ FirmwareVersion
556611
- 0
557612
-
558613
- The type of firmware. See possible values below
614+
* - ParameterVersion
615+
- 47
616+
- 16
617+
- Big Endian
618+
- No
619+
- 1
620+
- 0
621+
-
622+
- Version of the parameter file
559623

560624
**Value Descriptions**
561625

@@ -585,9 +649,9 @@ FirmwareVersion
585649
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
586650
3| PlatformType | | | | | | | |
587651
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
588-
4| ApplicationType | | | | | | | |
652+
4| ParameterVersion | | | | | | | |
589653
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
590-
5| | | | | | | | |
654+
5| ParameterVersion | | | | | | | |
591655
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
592656
6| | | | | | | | |
593657
+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+--------------------+
@@ -603,7 +667,7 @@ GitHash
603667

604668
**Description**: This message provides information about the GIT hash, written in the firmware
605669

606-
**Senders**: Safety Controller
670+
**Senders**: chargeSOM_SafetyController
607671

608672
.. list-table:: Signals in GitHash
609673
:widths: 30 6 6 10 7 7 7 6 30
@@ -661,7 +725,7 @@ InquiryPacket
661725

662726
**Description**: This packet is used to request a special message from the safety controller
663727

664-
**Senders**: Default_HostController, CCY_HostController
728+
**Senders**: chargeSOM_HostController, CCY_HostController
665729

666730
.. list-table:: Signals in InquiryPacket
667731
:widths: 30 6 6 10 7 7 7 6 30

0 commit comments

Comments
 (0)