DOC: message

squadracorsepolito · May 18, 2024 · 51f0968 · 51f0968
1 parent 422cf1a
commit 51f0968
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 64 deletions.
diff --git a/examples/markdown/SC24.md b/examples/markdown/SC24.md
@@ -5,7 +5,7 @@
 ## Main CAN Bus
 Baudrate: -
 
-### BMS_LV/int0
+### BMS_LV
 The battery-management-system low-voltage.
 
 Node ID: **0**
@@ -17,7 +17,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                Description                |
 |-----------------|-----------|------|-----|-----|--------|-------|------|-------------------------------------------|
@@ -32,7 +32,7 @@ Size: **8** bytes
 
 Cycle Time: **100** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |       Name        | Start Bit | Size | Min |   Max   | Offset | Scale | Unit |                  Description                   |
 |-------------------|-----------|------|-----|---------|--------|-------|------|------------------------------------------------|
@@ -48,7 +48,7 @@ Size: **6** bytes
 
 Cycle Time: **100** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |       Name        | Start Bit | Size | Min |   Max   | Offset | Scale | Unit |                  Description                   |
 |-------------------|-----------|------|-----|---------|--------|-------|------|------------------------------------------------|
@@ -63,7 +63,7 @@ Size: **6** bytes
 
 Cycle Time: **100** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min |    Max    | Offset | Scale | Unit |                                            Description                                            |
 |---------------------------|-----------|------|-----|-----------|--------|-------|------|---------------------------------------------------------------------------------------------------|
@@ -78,7 +78,7 @@ Size: **4** bytes
 
 Cycle Time: **100** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |         Name         | Start Bit | Size | Min | Max | Offset | Scale | Unit |                                  Description                                   |
 |----------------------|-----------|------|-----|-----|--------|-------|------|--------------------------------------------------------------------------------|
@@ -117,7 +117,7 @@ Size: **8** bytes
 
 Cycle Time: **2000** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min |   Max    | Offset | Scale | Unit |                            Description                             |
 |---------------------------|-----------|------|-----|----------|--------|-------|------|--------------------------------------------------------------------|
@@ -135,7 +135,7 @@ Size: **8** bytes
 
 Cycle Time: **2000** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min |   Max    | Offset | Scale | Unit |                             Description                             |
 |---------------------------|-----------|------|-----|----------|--------|-------|------|---------------------------------------------------------------------|
@@ -147,7 +147,7 @@ Receivers: [DSPACE/int0](#DSPACE/int0)
 | LV_CELL_NTC_11_resistance |        50 |   10 |   0 | 31968.75 |   1000 | 31.25 | Ohm  | The resistance of the NTC #11 in the battery pack expressed in Ohm. |
 
 ---
-### DASH/int0
+### DASH
 The dashboard ECU.
 
 Node ID: **1**
@@ -159,7 +159,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                 Description                  |
 |-----------------|-----------|------|-----|-----|--------|-------|------|----------------------------------------------|
@@ -174,7 +174,7 @@ Size: **1** bytes
 
 Cycle Time: **500** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |  Name   | Start Bit | Size | Min | Max | Offset | Scale | Unit |   Description    |
 |---------|-----------|------|-----|-----|--------|-------|------|------------------|
@@ -187,7 +187,7 @@ Size: **1** bytes
 
 Cycle Time: -
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |     Name      | Start Bit | Size | Min | Max | Offset | Scale | Unit |                 Description                 |
 |---------------|-----------|------|-----|-----|--------|-------|------|---------------------------------------------|
@@ -197,7 +197,7 @@ Receivers: [DSPACE/int0](#DSPACE/int0)
 | MOTOR_RR_isON |         3 |    1 |   0 |   1 |      0 |     1 | -    | States whether the rear right motor is ON.  |
 
 ---
-### DSPACE/int0
+### DSPACE
 An automotive ECU.
 
 Node ID: **2**
@@ -209,7 +209,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                Description                |
 |-----------------|-----------|------|-----|-----|--------|-------|------|-------------------------------------------|
@@ -224,7 +224,7 @@ Size: **1** bytes
 
 Cycle Time: -
 
-Receivers: [DASH/int0](#DASH/int0)
+Receivers: [DASH](#DASH)
 
 |     Name      | Start Bit | Size | Min | Max | Offset | Scale | Unit | Description |
 |---------------|-----------|------|-----|-----|--------|-------|------|-------------|
@@ -237,7 +237,7 @@ Size: **2** bytes
 
 Cycle Time: -
 
-Receivers: [BMS_LV/int0](#BMS_LV/int0)
+Receivers: [BMS_LV](#BMS_LV)
 
 |    Name     | Start Bit | Size | Min |  Max  | Offset | Scale | Unit | Description |
 |-------------|-----------|------|-----|-------|--------|-------|------|-------------|
@@ -251,7 +251,7 @@ Size: **3** bytes
 
 Cycle Time: -
 
-Receivers: [DASH/int0](#DASH/int0)
+Receivers: [DASH](#DASH)
 
 |       Name        | Start Bit | Size | Min | Max | Offset | Scale | Unit | Description |
 |-------------------|-----------|------|-----|-----|--------|-------|------|-------------|
@@ -260,7 +260,7 @@ Receivers: [DASH/int0](#DASH/int0)
 | BattHVFan_CTRL    |        16 |    8 |   0 | 255 |      0 |     1 | -    | -           |
 
 ---
-### SB_FRONT/int0
+### SB_FRONT
 The sensorboard front ECU.
 
 Node ID: **3**
@@ -272,7 +272,7 @@ Size: **8** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min |  Max  | Offset | Scale | Unit |                           Description                           |
 |---------------------------|-----------|------|-----|-------|--------|-------|------|-----------------------------------------------------------------|
@@ -288,7 +288,7 @@ Size: **4** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |          Name           | Start Bit | Size | Min |  Max  | Offset | Scale | Unit |                                      Description                                      |
 |-------------------------|-----------|------|-----|-------|--------|-------|------|---------------------------------------------------------------------------------------|
@@ -302,7 +302,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                     Description                      |
 |-----------------|-----------|------|-----|-----|--------|-------|------|------------------------------------------------------|
@@ -317,7 +317,7 @@ Size: **1** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min | Max | Offset | Scale | Unit |                        Description                         |
 |---------------------------|-----------|------|-----|-----|--------|-------|------|------------------------------------------------------------|
@@ -333,7 +333,7 @@ Size: **8** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |            Name            | Start Bit | Size | Min |   Max    | Offset | Scale | Unit |                          Description                           |
 |----------------------------|-----------|------|-----|----------|--------|-------|------|----------------------------------------------------------------|
@@ -345,7 +345,7 @@ Receivers: [DSPACE/int0](#DSPACE/int0)
 | SPARE_NTC_1_resistance     |        50 |   10 |   0 | 31968.75 |   1000 | 31.25 | Ohm  | The resistance of the spare NTC #1 expressed in Ohm.           |
 
 ---
-### SB_REAR/int0
+### SB_REAR
 The sensorboard rear ECU.
 
 Node ID: **4**
@@ -357,7 +357,7 @@ Size: **4** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |          Name           | Start Bit | Size | Min |  Max  | Offset | Scale | Unit |                                     Description                                      |
 |-------------------------|-----------|------|-----|-------|--------|-------|------|--------------------------------------------------------------------------------------|
@@ -371,7 +371,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                     Description                     |
 |-----------------|-----------|------|-----|-----|--------|-------|------|-----------------------------------------------------|
@@ -386,7 +386,7 @@ Size: **1** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |            Name            | Start Bit | Size | Min | Max | Offset | Scale | Unit |                             Description                              |
 |----------------------------|-----------|------|-----|-----|--------|-------|------|----------------------------------------------------------------------|
@@ -403,7 +403,7 @@ Size: **1** bytes
 
 Cycle Time: -
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |       Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |              Description              |
 |------------------|-----------|------|-----|-----|--------|-------|------|---------------------------------------|
@@ -416,7 +416,7 @@ Size: **8** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name            | Start Bit | Size | Min |   Max    | Offset | Scale | Unit |                             Description                             |
 |---------------------------|-----------|------|-----|----------|--------|-------|------|---------------------------------------------------------------------|
@@ -434,7 +434,7 @@ Size: **6** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |           Name           | Start Bit | Size | Min |  Max  | Offset | Scale | Unit |                            Description                            |
 |--------------------------|-----------|------|-----|-------|--------|-------|------|-------------------------------------------------------------------|
@@ -443,7 +443,7 @@ Receivers: [DSPACE/int0](#DSPACE/int0)
 | BRAKE_PRESS_REAR_voltage |        32 |   16 |   0 | 65535 |      0 |     1 | mV   | The voltage of the rear brake pressure sensor expressed in mV.    |
 
 ---
-### TLB_BAT/int0
+### TLB_BAT
 The tsal-latch-board battery ECU.
 
 Node ID: **5**
@@ -455,7 +455,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |               Name               | Start Bit | Size | Min | Max | Offset | Scale | Unit | Description |
 |----------------------------------|-----------|------|-----|-----|--------|-------|------|-------------|
@@ -476,7 +476,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |              Name               | Start Bit | Size | Min | Max | Offset | Scale | Unit | Description |
 |---------------------------------|-----------|------|-----|-----|--------|-------|------|-------------|
@@ -505,7 +505,7 @@ Size: **3** bytes
 
 Cycle Time: **10** ms
 
-Receivers: [DSPACE/int0](#DSPACE/int0)
+Receivers: [DSPACE](#DSPACE)
 
 |      Name       | Start Bit | Size | Min | Max | Offset | Scale | Unit |                  Description                   |
 |-----------------|-----------|------|-----|-----|--------|-------|------|------------------------------------------------|

diff --git a/md_exporter.go b/md_exporter.go
@@ -67,7 +67,7 @@ func (e *mdExporter) exportBus(bus *Bus) {
 }
 
 func (e *mdExporter) exportNode(node *NodeInterface) {
-	e.w.H3(node.Name())
+	e.w.H3(node.node.name)
 
 	if len(node.node.desc) > 0 {
 		e.w.PlainText(node.node.desc).LF()
@@ -99,8 +99,8 @@ func (e *mdExporter) exportMessage(msg *Message) {
 	e.w.PlainTextf("Cycle Time: %s", cycleTimeStr).LF()
 
 	recStr := "Receivers: "
-	for idx, rec := range msg.Receivers() {
-		recLink := e.getLink(rec.Name())
+	for idx, recInt := range msg.Receivers() {
+		recLink := e.getLink(recInt.node.name)
 
 		if idx == 0 {
 			recStr += recLink