Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://docs.google.com/presentation/d/1YdunABJWzBkTDpxPe_msvbJ8aNUg6d6yUXG5NnosrkI/edit#slide=id.g11d6e2701ee_0_209

...

CAN message definitions (YAML):

all CAN message definitions are within the /libraries/codegen/boards folder, where each controller board YAML defines all messages that originates from that controller board.

The message definition schema is as follows.

Code Block
languageyamlnone
---
  Messages:
    <message name>:
      id: <message id>
      target:
        <target controller board>:
          watchdog: 0
        <target controller board>:
          watchdog: 0
      signals:
        <signal name>:
          length: 8
        <signal name>:
          length: 16
        critical: boolean, optional

...

The watchdog field does things. # TODO(Jarvis) doc this

Autogen

As part of the scons build process, we autogenerate the following files that defines the CAN message structure and provide the interface to interact with CAN message data.

...