DBC, dashboard, and rules

A Custom Component can decode CAN traffic, show a page, and raise alerts from its tags, using an optional CAN database (DBC) file, dashboard, and rules file. Which upload field holds each file is on Custom Component files.

DBC file

With a DBC file, the component menu includes Messages and Signals and Edit DBC File. The device's CAN traffic can then be read as named messages and signals, and the dashboard can bind those signals. The component runs with Upload DBC File (Optional) left empty. Rebase DBC and Rebase Address shift the loaded message identifiers onto the base address the device actually uses. Edit DBC File opens the DBC editor once a file is set, and a saved change is picked up automatically. If the file fails to parse, the component stays in the profile and Messages and Signals is left out until the file is fixed. The viewer is documented in CAN bus DBC.

Dashboard

The dashboard YAML is the page the user opens. When Upload Dashboard (Optional) is left empty, Profinity writes a starter file named after the component, and the dashboard editor then replaces it. Layout, elements, and the visual editor are in the Profinity dashboard development guide.

A binding that reads a CAN signal uses the DBC names, and a binding that reads a value the main script published uses a tag path. A relative path has no leading /. Profinity resolves it against the component's place in the tag tree, so the binding follows the component if Tag tree path changes. An absolute path begins with / and names some other place in the tree. Use a relative path in place of the {COMPONENT_NAME} placeholder. Refer to Data binding and Tag tree paths and dashboard binds.

Rules

Rules YAML file is an optional Tag rules document for this component, evaluated when this component's tags change, and alerts raised from those rules appear in Alerts Log. A tag rule can also run an action when a condition fires, which is not a menu action: menu entries are declared in actions.yaml. Refer to Menu actions.