aboutsummaryrefslogtreecommitdiffstats
path: root/config/example.cfg
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2016-09-15 12:19:30 -0400
committerKevin O'Connor <kevin@koconnor.net>2016-09-15 12:19:30 -0400
commit9ff5600421dd38a00f97cc48248096681952081b (patch)
treea41f480e24fefdd04eddb867a64576ba3e7e73f5 /config/example.cfg
parent94272ed07211350dd7c76fd20aeeec28eac35c55 (diff)
downloadkutter-9ff5600421dd38a00f97cc48248096681952081b.tar.gz
kutter-9ff5600421dd38a00f97cc48248096681952081b.tar.xz
kutter-9ff5600421dd38a00f97cc48248096681952081b.zip
docs: Clarification of some installation and config steps
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'config/example.cfg')
-rw-r--r--config/example.cfg11
1 files changed, 5 insertions, 6 deletions
diff --git a/config/example.cfg b/config/example.cfg
index 5614b5fc..090f3653 100644
--- a/config/example.cfg
+++ b/config/example.cfg
@@ -5,10 +5,9 @@
# FIRST. Incorrectly configured parameters may cause damage.
# A note on pin names: pins may be configured with a hardware name
-# (such as PA4) or with a board name (such as ar29). In order to use a
-# board name, the pin_map variable in the mcu section must specify
-# which board definition to use. (See the klippy/pins.py file for the
-# available pin and board names.)
+# (such as "PA4") or with an Arduino alias name (such as "ar29" or
+# "analog3"). In order to use Arduino names, the pin_map variable in
+# the mcu section must be present and have a value of "arduino".
# Pin names may be preceded by an '!' to indicate that a reverse
# polarity should be used (eg, trigger on low instead of high). Input
# pins may be preceded by a '^' to indicate that a hardware pull-up
@@ -173,10 +172,10 @@ kick_start_time: 0.100
[mcu]
serial: /dev/ttyACM0
# The serial port to connect to the MCU
-baud: 115200
+baud: 250000
# The baud rate to use
pin_map: arduino
-# This option may be used to add board specific pin name aliases
+# This option may be used to enable Arduino pin name aliases
custom:
# This option may be used to specify a set of custom
# micro-controller commands to be sent at the start of the