From c3e3fcf502f7294568424e999d2f44483e5eb3bc Mon Sep 17 00:00:00 2001 From: Michael Heimpold Date: Tue, 31 Mar 2026 09:34:07 +0200 Subject: [PATCH] Include latest DBC and re-generate documentation Latest firmware 0.3.0 for Charge SOM supports the DBC version 0.0.4 with support for partnumber reading. To include these messages in our documentation, we also need to enable them in our helper tool. Signed-off-by: Michael Heimpold --- docs/source/safety_protocol.rst | 190 +++++++++++++++++++++++++ docs/source/utils/dbc_to_rst_config.py | 2 +- docs/source/utils/uart_com.dbc | 19 ++- 3 files changed, 207 insertions(+), 4 deletions(-) diff --git a/docs/source/safety_protocol.rst b/docs/source/safety_protocol.rst index 179fd4a..c7f612e 100644 --- a/docs/source/safety_protocol.rst +++ b/docs/source/safety_protocol.rst @@ -829,6 +829,9 @@ InquiryPacket - 0xA = FirmwareVersion - 0xB = GitHash + - 0x14 = PartNumber1 + - 0x15 = PartNumber2 + - 0x16 = ChipInfo **Bitfield Layout** @@ -859,3 +862,190 @@ InquiryPacket +PartNumber1 +^^^^^^^^^^^ + +**ID**: 0x14 (20) + +**Length**: 8 bytes + +**Description**: N/A + +**Senders**: chargeSOM_SafetyController + +.. list-table:: Signals in PartNumber1 + :widths: 30 6 6 10 7 7 7 6 30 + :header-rows: 1 + + * - Name + - Start + - Length + - ByteOrder + - Signed + - Factor + - Offset + - Unit + - Description + * - PartNumber1Signal + - 7 + - 64 + - Big Endian + - No + - 1 + - 0 + - + - *No description available* + +**Bitfield Layout** + +:: + + Bit + + 7 6 5 4 3 2 1 0 + +---+---+---+---+---+---+---+---+ + 0 |<------------------------------| + +---+---+---+---+---+---+---+---+ + 1 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 2 |-------------------------------| + +---+---+---+---+---+---+---+---+ + B 3 |-------------------------------| + y +---+---+---+---+---+---+---+---+ + t 4 |-------------------------------| + e +---+---+---+---+---+---+---+---+ + 5 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 6 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 7 |------------------------------x| + +---+---+---+---+---+---+---+---+ + +-- PartNumber1Signal + + + +PartNumber2 +^^^^^^^^^^^ + +**ID**: 0x15 (21) + +**Length**: 8 bytes + +**Description**: N/A + +**Senders**: chargeSOM_SafetyController + +.. list-table:: Signals in PartNumber2 + :widths: 30 6 6 10 7 7 7 6 30 + :header-rows: 1 + + * - Name + - Start + - Length + - ByteOrder + - Signed + - Factor + - Offset + - Unit + - Description + * - PartNumber2Signal + - 7 + - 64 + - Big Endian + - No + - 1 + - 0 + - + - *No description available* + +**Bitfield Layout** + +:: + + Bit + + 7 6 5 4 3 2 1 0 + +---+---+---+---+---+---+---+---+ + 0 |<------------------------------| + +---+---+---+---+---+---+---+---+ + 1 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 2 |-------------------------------| + +---+---+---+---+---+---+---+---+ + B 3 |-------------------------------| + y +---+---+---+---+---+---+---+---+ + t 4 |-------------------------------| + e +---+---+---+---+---+---+---+---+ + 5 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 6 |-------------------------------| + +---+---+---+---+---+---+---+---+ + 7 |------------------------------x| + +---+---+---+---+---+---+---+---+ + +-- PartNumber2Signal + + + +ChipInfo +^^^^^^^^ + +**ID**: 0x16 (22) + +**Length**: 8 bytes + +**Description**: N/A + +**Senders**: chargeSOM_SafetyController + +.. list-table:: Signals in ChipInfo + :widths: 30 6 6 10 7 7 7 6 30 + :header-rows: 1 + + * - Name + - Start + - Length + - ByteOrder + - Signed + - Factor + - Offset + - Unit + - Description + * - MCUVersion + - 7 + - 8 + - + - No + - 1 + - 0 + - + - *No description available* + +**Bitfield Layout** + +:: + + Bit + + 7 6 5 4 3 2 1 0 + +---+---+---+---+---+---+---+---+ + 0 |<-----------------------------x| + +---+---+---+---+---+---+---+---+ + +-- MCUVersion + +---+---+---+---+---+---+---+---+ + 1 | | | | | | | | | + +---+---+---+---+---+---+---+---+ + B 2 | | | | | | | | | + y +---+---+---+---+---+---+---+---+ + t 3 | | | | | | | | | + e +---+---+---+---+---+---+---+---+ + 4 | | | | | | | | | + +---+---+---+---+---+---+---+---+ + 5 | | | | | | | | | + +---+---+---+---+---+---+---+---+ + 6 | | | | | | | | | + +---+---+---+---+---+---+---+---+ + 7 | | | | | | | | | + +---+---+---+---+---+---+---+---+ + + + diff --git a/docs/source/utils/dbc_to_rst_config.py b/docs/source/utils/dbc_to_rst_config.py index d29b6fd..e9473f5 100644 --- a/docs/source/utils/dbc_to_rst_config.py +++ b/docs/source/utils/dbc_to_rst_config.py @@ -1,5 +1,5 @@ # Messages you want to document -target_msgs = ["ChargeControl1", "ChargeState1", "PT1000State", "FirmwareVersion", "GitHash", "InquiryPacket"] +target_msgs = ["ChargeControl1", "ChargeState1", "PT1000State", "FirmwareVersion", "GitHash", "InquiryPacket", "PartNumber1", "PartNumber2", "ChipInfo"] # Sender name mapping sender_name_map = { diff --git a/docs/source/utils/uart_com.dbc b/docs/source/utils/uart_com.dbc index 07284e9..d3e85b2 100644 --- a/docs/source/utils/uart_com.dbc +++ b/docs/source/utils/uart_com.dbc @@ -1,4 +1,4 @@ -VERSION "0.0.3" +VERSION "0.0.4" NS_ : @@ -77,7 +77,8 @@ BO_ 3 AnalogInput02: 8 chargeSOM_SafetyController SG_ AI_CP_BUFFERED_NEG_ADC : 7|16@0+ (1,0) [0|0] "" chargeSOM_HostController BO_ 19 AnalogInput05: 8 CCY_SafetyController - SG_ AI_HV_READY : 39|16@0+ (1,0) [0|0] "" CCY_HostController + SG_ AI_HV_READY_SW11_SC : 55|16@0+ (1,0) [0|0] "" CCY_HostController + SG_ AI_HV_READY_SW10_SC : 39|16@0+ (1,0) [0|0] "" CCY_HostController SG_ AI_CE_ADC : 23|16@0+ (1,0) [0|0] "" CCY_HostController SG_ AI_ID_ADC : 7|16@0+ (1,0) [0|0] "" CCY_HostController @@ -131,6 +132,15 @@ BO_ 10 FirmwareVersion: 8 chargeSOM_SafetyController BO_ 11 GitHash: 8 chargeSOM_SafetyController SG_ HashSignal : 7|64@0+ (1,0) [0|0] "" chargeSOM_HostController,CCY_HostController + +BO_ 20 PartNumber1: 8 chargeSOM_SafetyController + SG_ PartNumber1Signal : 7|64@0+ (1,0) [0|0] "" chargeSOM_HostController,CCY_HostController + +BO_ 21 PartNumber2: 8 chargeSOM_SafetyController + SG_ PartNumber2Signal : 7|64@0+ (1,0) [0|0] "" chargeSOM_HostController,CCY_HostController + +BO_ 22 ChipInfo: 8 chargeSOM_SafetyController + SG_ MCUVersion : 7|8@0+ (1,0) [0|0] "" chargeSOM_HostController,CCY_HostController BO_ 14 ErrorMessage: 8 chargeSOM_SafetyController SG_ ErrorAddData2 : 55|16@0+ (1,0) [0|0] "" chargeSOM_HostController,CCY_HostController @@ -190,6 +200,9 @@ BO_TX_BU_ 4 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 2 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 10 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 11 : CCY_SafetyController,chargeSOM_SafetyController; +BO_TX_BU_ 20 : CCY_SafetyController,chargeSOM_SafetyController; +BO_TX_BU_ 21 : CCY_SafetyController,chargeSOM_SafetyController; +BO_TX_BU_ 22 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 14 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 8 : CCY_SafetyController,chargeSOM_SafetyController; BO_TX_BU_ 1 : chargeSOM_SafetyController,CCY_SafetyController; @@ -244,7 +257,7 @@ BA_DEF_ "BusType" STRING ; BA_DEF_DEF_ "MultiplexExtEnabled" "No"; BA_DEF_DEF_ "BusType" ""; BA_ "BusType" "J1708"; -VAL_ 255 PacketId 10 "FirmwareVersion" 11 "GitHash" ; +VAL_ 255 PacketId 10 "FirmwareVersion" 11 "GitHash" 20 "PartNumber1" 21 "PartNumber2" 22 "ChipInfo" ; VAL_ 17 CC_CCSReady 2 "CCS_EmergencyStop" 1 "CCS_Ready" 0 "CCS_NotReady" ; VAL_ 16 CS_SafeStateActive 3 "SNA" 1 "SafeState" 0 "NormalState" ; VAL_ 16 CS_EStop_Reason 14 "EmergencyInput" 13 "HVReady_Malfunction" 12 "CE_Malfunction" 11 "ID_Malfunction" 10 "Temp4_Overtemp" 9 "Temp3_Overtemp" 8 "Temp2_Overtemp" 7 "Temp1_Overtemp" 6 "Temp4_Malfunction" 5 "Temp3_Malfunction" 4 "Temp2_Malfunction" 3 "Temp1_Malfunction" 2 "ComTimeout" 1 "InternalError" 0 "NoStop" ;