Agents User Guide
Agents are automated CAN message transmitters that send configured messages at regular intervals or on demand. Use agents to simulate ECU behavior, test system responses, or control connected devices.
Agents Overview
The Agents page displays all configured agents in a table with the following columns:
| Column | Description |
|---|---|
| Name | Agent identifier |
| Type | Agent type (e.g., tx) |
| Status | Running (green badge with pulse) or Stopped (gray badge) |
| Values | Current signal values showing message name, CAN ID, channel, and signal values |
| Actions | Edit, Trigger, Start, Stop, and Delete buttons |
Toolbar
- Search bar — Filter agents by name or type
- Create button (+) — Open the agent creation wizard
Agent Controls
Each agent row has the following action buttons:
| Button | Icon | Description |
|---|---|---|
| Edit | Pencil | Open the agent editor to modify configuration |
| Trigger | Lightning bolt | Send all agent messages once (manual trigger) |
| Start | Play | Begin periodic message transmission |
| Stop | Stop | Halt transmission |
| Delete | Trash | Remove the agent (with confirmation) |
Creating an Agent
Click the + button to open the agent creation wizard. Two modes are available:
Wizard Mode (Guided Setup)
The wizard walks you through four steps:
Step 1: Agent Configuration
| Field | Description |
|---|---|
| Name | Unique identifier (spaces are replaced with underscores) |
| Period (ms) | Transmission interval in milliseconds (must be > 0) |
| Auto Start | Automatically start when created or on device boot |
Step 2: Messages
Add CAN messages for the agent to transmit:
- Click Add Message to create a blank message
- Click Import DBC to import pre-defined messages from a DBC file
Each message requires:
| Field | Description |
|---|---|
| Name | Descriptive message name |
| CAN ID | Message identifier in hex |
| Channel | CAN channel (1 or 2) |
| Frame Type | Normal, RTR, FD, or FD no BRS (see below) |
| DLC | Data length code |
Frame Type
The Frame Type dropdown selects the CAN frame format for the message:
| Option | Description |
|---|---|
| Normal | Classic CAN frame (up to 8 data bytes) |
| RTR | Remote Transmission Request — requests data from another node without sending a payload |
| FD | CAN FD frame with Bit Rate Switch (BRS) — up to 64 data bytes at a higher data-phase bitrate |
| FD no BRS | CAN FD frame without BRS — up to 64 data bytes at the nominal bitrate |
Note: The RTR option is available in the Agent editor but not in the DBC Editor, since RTR is a transmission property rather than a database attribute.
When importing messages from a DBC file, the frame type is carried over automatically.
Step 3: Signals
Configure signals within each message:
| Field | Description |
|---|---|
| Name | Signal identifier |
| Start Bit | Bit position where the signal begins (0–63) |
| Length | Number of bits the signal occupies |
| Byte Order | Little-endian (Intel) or Big-endian (Motorola) |
| Type | Unsigned, Signed, Float, or Double |
| Factor | Multiplier for physical value scaling |
| Offset | Added to scaled value |
| Min/Max | Valid range for the physical value |
| Unit | Engineering unit (e.g., rpm, °C) |
Step 4: Review
Review all configuration before saving:
- Agent settings (name, period, auto start)
- Message count and signal count
- Per-message details (name, CAN ID, channel, DLC)
- Per-signal details (name, bit range, type, scaling)
Click Create Agent to save.
Direct Editor Mode
The direct editor shows all configuration in a single form:
- All agent, message, and signal fields visible at once
- Collapsible message sections
- Collapse All / Expand All toggle
- Import DBC and Add Message buttons
- Summary bar showing message and signal counts
Switch between modes using the Switch to Direct Editor / Switch to Guided Setup button.
Quick Edit Signal Values
Click any agent row in the table to open the Quick Edit modal:
Configuration Summary
- Period — Transmission interval
- Messages — Number of configured messages
- Auto Update — Toggle to automatically send value changes to the device
Signal Controls
For each signal in each message:
- Label with signal name and unit
- Range indicator showing min–max values
- Number input for direct value entry
- Range slider for visual adjustment
Action Buttons
- Edit — Open full agent editor
- Trigger — Send messages once
- Start — Begin periodic transmission
- Stop — Halt transmission
- Update Values — Send current values (disabled when Auto Update is on)
- Close — Close the modal
When Auto Update is enabled, changing any signal value immediately sends the update without needing to click Update Values.
Importing from DBC
When adding messages (Step 2 of wizard or Direct Editor):
- Click Import DBC
- Select messages from your uploaded DBC files
- Messages are added with pre-configured CAN ID, DLC, and signal definitions
This saves time and reduces configuration errors compared to manual setup.
Dashboard Integration
Agents can be controlled from dashboard widgets:
- Add control widgets (sliders, toggles, knobs) connected to agent signals
- Use the dashboard toolbar's agent control button to start/stop all agents
- Adjust signal values directly from the dashboard
See the Widget Configuration Guide for details on Agent API Writers.
Tips
- Use descriptive names — Name agents clearly (e.g.,
speed_simulator,brake_test) - Set appropriate periods — Common values: 10ms, 20ms, 50ms, 100ms
- Import from DBC — Use DBC import when available for accurate signal definitions
- Use Auto Update in Quick Edit for real-time signal adjustments
- Trigger first — Use the trigger button to test messages before starting periodic transmission
Related Documentation
- Dashboard Guide — Dashboard overview and agent controls
- Widget Configuration Guide — Agent API Writer configuration
- DBC Guide — DBC file management for message import