aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-02-07 17:56:39 -0500
committerKevin O'Connor <kevin@koconnor.net>2021-03-13 11:29:41 -0500
commit041692828c66cd291435020f240b243c862177bf (patch)
tree3207ed9d6e5a15ff07be924cec24da9d5acf2705 /docs/Config_Reference.md
parentbabde17c4c804e0a0903481a8f05d713eeabdc3e (diff)
downloadkutter-041692828c66cd291435020f240b243c862177bf.tar.gz
kutter-041692828c66cd291435020f240b243c862177bf.tar.xz
kutter-041692828c66cd291435020f240b243c862177bf.zip
mcu: Add support for connecting to devices on a CAN bus
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 7259d998..c1c09cb7 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -39,9 +39,16 @@ Configuration of the primary micro-controller.
serial:
# The serial port to connect to the MCU. If unsure (or if it
# changes) see the "Where's my serial port?" section of the FAQ.
-# This parameter must be provided.
+# This parameter must be provided when using a serial port.
#baud: 250000
# The baud rate to use. The default is 250000.
+#canbus_uuid:
+# If using a device connected to a CAN bus then this sets the unique
+# chip identifier to connect to. This value must be provided when using
+# CAN bus for communication.
+#canbus_interface:
+# If using a device connected to a CAN bus then this sets the CAN
+# network interface to use. The default is 'can0'.
#pin_map:
# This option may be used to enable Arduino pin name aliases. The
# default is to not enable the aliases.