StartupCAN/config.updated.yaml at main · me-systeme/StartupCAN · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# -----------------------------------------------------------------------------
# StartupCAN configuration
# -----------------------------------------------------------------------------
# This file defines:
# - the default CAN settings used for default-mode activation/reset
# - the current device state (`devices.config.current`)
# - the target device state (`devices.config.new`)
# - the CAN baud rate used by the DLL during normal operation
#
# StartupCAN reads this file, validates it, performs the selected workflow,
# and then writes the detected effective device state to `config.updated.yaml`.
#
# If StartupCAN is executed with `--in-place`, this file itself will be updated.
# -----------------------------------------------------------------------------


# -----------------------------------------------------------------------------
# DLL / CAN configuration
# -----------------------------------------------------------------------------
dll:
  # Maximum number of samples the DLL buffer stores per device read cycle.
  # This value is mainly relevant for applications that read measurement data.
  mybuffersize: 300

  # CAN bus baud rate in bits per second used as the normal runtime baud rate.
  # StartupCAN uses this as the target baud rate in normal reconfiguration modes
  # unless devices are explicitly reset to the default baud rate.
  # Integer (Hz)
  # Allowed values:
  #   1000000, 500000, 250000, 125000, 100000, 50000, 25000
  canbaud: 250000


# -----------------------------------------------------------------------------
# Device configuration
# -----------------------------------------------------------------------------
devices:
  config:

    # -------------------------------------------------------------------------
    # Default CAN settings
    # -------------------------------------------------------------------------
    # These values define the shared default endpoint used by devices in
    # default mode and by forced-reset workflows.
    # Used when:
    # - current.default = true
    # - new.default = true (reset mode)
    assign:
      # Default baud rate used when `current.default=true`
      # or when devices are reset back to default settings.
      # Integer (Hz)
      # Same allowed values as dll.canbaud
      default_canbaud: 1000000

      # Default CAN command ID used in default mode.
      # String (hex, 11-bit CAN ID)
      # Format: "0x100" – "0x7FF"
      default_cmd_id: "0x100"

      # Default CAN answer ID used in default mode.
      # String (hex, 11-bit CAN ID)
      # Must be different from default_cmd_id
      default_ans_id: "0x101"

      # Default CAN value ID used in default mode.
      # String (hex, 11-bit CAN ID)
      default_value_id: "0x101"

    # -------------------------------------------------------------------------
    # Current device state
    # -------------------------------------------------------------------------
    current:
      # If true:
      # - StartupCAN ignores `current.ids`
      # - all devices are assumed to start with the shared default endpoint
      #
      # If false:
      # - StartupCAN uses `current.ids` as the current start state
      default: false
      # List of devices (one entry per dev_no)
      #
      # Rules:
      # - dev_no must be unique
      # - cmd_id != answer_id
      # - duplicates across devices are allowed (only one device is connected)
      #
      # Optional fields:
      # - value_id → used for validation
      # - serial   → used for validation
      # - canbaud  → overrides dll.canbaud for activation
      # - unknown  → devices may be marked using unknown: true in current.ids
      #
      # If canbaud is missing → dll.canbaud is used
      #
      ids:
        - dev_no: 1
          serial: 25455437
          cmd_id: '0x102'
          answer_id: '0x103'
          value_id: '0x103'
        - dev_no: 2
          serial: 25455423
          cmd_id: '0x104'
          answer_id: '0x105'
          value_id: '0x105'
        - dev_no: 3
          serial: 25455439
          cmd_id: '0x106'
          answer_id: '0x107'
          value_id: '0x107'
    new:
      # If true:
      # - StartupCAN ignores `new.ids`
      # - all devices are reset to the shared default endpoint
      #
      # If false:
      # - StartupCAN uses `new.ids` as the target configuration
      default: false

      # Required if new.default = false
      #
      # Rules:
      # - dev_no must match current.ids (Case 1)
      # - cmd_id != answer_id
      # - ALL IDs must be globally unique across all devices
      #
      # Optional:
      # - serial → enables mapping by serial instead of dev_no
      #   (if used, ALL entries must contain serial)
      #
      # value_id configures the CAN value frame ID (CV_ID).
      # It may be identical to answer_id, but does not have to be.
      #
      # Rules:
      # - value_id is required if new.default = false
      # - in default modes, assign.default_value_id is used
      ids: []