aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2016-10-14 00:39:16 -0400
committerKevin O'Connor <kevin@koconnor.net>2016-10-19 13:35:49 -0400
commit93bd19a8c2160bd044545c6e5f865172bc056c53 (patch)
tree8d2d863015e59dadece36bea6d45f2c56ffdbc8e
parent98ce7dc465ff73e7c57b040d8d3aa76aeb947bc9 (diff)
downloadkutter-93bd19a8c2160bd044545c6e5f865172bc056c53.tar.gz
kutter-93bd19a8c2160bd044545c6e5f865172bc056c53.tar.xz
kutter-93bd19a8c2160bd044545c6e5f865172bc056c53.zip
docs: Todo updates
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r--docs/Todo.md72
1 files changed, 42 insertions, 30 deletions
diff --git a/docs/Todo.md b/docs/Todo.md
index c69ee03b..73b4cbc0 100644
--- a/docs/Todo.md
+++ b/docs/Todo.md
@@ -17,45 +17,57 @@ Host user interaction
highlight an error (one has to look in the terminal tab to find the
error) and errors written to the log can be non-obvious to a user.
- * Route errors from the host C code to the main log file.
+ * Implement timeouts on homing. The host currently waits forever if
+ an endstop is not hit during a homing operation.
+
+* Improve startup:
+
+ * Provide startup scripts so that Klippy can startup at system
+ bootup.
+
+ * Possibly rework the startup order of Klippy communication with
+ octoprint and the mcu. Currently Klippy only starts communication
+ with Octoprint after it connects with the firmware. However, this
+ limits the ability for Klippy to communicate connection errors to
+ the user. It also makes it difficult for Klippy to reconnect to the
+ firmware and/or restart the firmware if it needs to.
-* Support clearing MCU shutdown events from the host without having to
- restart the firmware.
+ * Support clearing MCU shutdown events from the host without having
+ to restart the firmware.
-* Provide startup scripts so that Klippy can startup at system bootup.
+ * Allow loading of a new config without having to restart the mcu.
-* Support ASCII based commands in addition to common gcode
- commands. It would be useful to support high-level commands such as
- "query_endstops", "pid_autotune", and "help" instead of having to
- invent cryptic gcode commands (eg, "M119" and "M303").
+* Improve gcode interface:
-* Provide a better way to handle print nozzle z offsets. The M206
- command is cryptic to use and it is too easy to set the value
- incorrectly or to forget to set it.
+ * Support ASCII based commands in addition to common gcode
+ commands. It would be useful to support high-level commands such as
+ "query_endstops", "pid_autotune", and "help" instead of having to
+ invent cryptic gcode commands (eg, "M119" and "M303").
-* Provide a way to temporarily disable endstop checks so that a user
- can issue commands that potentially move the head past
- position_min/position_max.
+ * Provide a better way to handle print nozzle z offsets. The M206
+ command is cryptic to use and it is too easy to set the value
+ incorrectly or to forget to set it.
-* Implement timeouts on homing. The host currently waits forever if
- an endstop is not hit during a homing operation.
+ * Provide a way to temporarily disable endstop checks so that a user
+ can issue commands that potentially move the head past
+ position_min/position_max.
-* Allow loading of a new config without having to restart the mcu.
+* Improve logging:
-* Possibly rework the startup order of Klippy communication with
- octoprint and the mcu. Currently Klippy only starts communication
- with Octoprint after it connects with the firmware. However, this
- limits the ability for Klippy to communicate connection errors to
- the user. It also makes it difficult for Klippy to reconnect to the
- firmware and/or restart the firmware if it needs to.
+ * Route errors from the host C code to the main log file.
+
+ * Automatically roll Klippy log files. The default log file should
+ have the current date in the log file name.
-* Automatically roll Klippy log files. The default log file should
- have the current date in the log file name.
+ * Report the Klippy git version in log file. Log the contents of the
+ config file at startup.
-* Report the Klippy git version in log file.
+ * Possibly collate and report the statistics messages in the log in a
+ more friendly way.
-* Possibly collate and report the statistics messages in the log in a
- more friendly way.
+* Possibly support a mechanism for the host to limit maximum velocity
+ so that the mcu is never requested to step at a higher rate than it
+ can support.
Safety features
===============
@@ -77,6 +89,8 @@ Safety features
can be useful to detect a sensor failure (eg, thermistor short) that
could otherwise cause the PID to command excessive heating.
+* Verify the endstop is no longer triggered after retraction.
+
* Possibly implement host based checking on the ratio between extrude
amount and head movement.
* Enforce acceleration and speed limits on extruder stepper motor.
@@ -100,8 +114,6 @@ Documentation
* Document the kinematic formulas in Klippy. Document how acceleration
and jerk limits are enforced.
-* Document the host/firmware communication protocol.
-
* Document how one can tune the pressure advance setting.
Hardware features