diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2017-04-27 15:14:11 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2017-04-27 15:59:33 -0400 |
| commit | c1c0b2dd387670b168ed6ac229f512e3cab1820e (patch) | |
| tree | 0624592873110d73d7d2183451a1fd395ad21669 /docs/Todo.md | |
| parent | d7a11119558834595dc527fb8d4d5c494745825c (diff) | |
| download | kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.tar.gz kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.tar.xz kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.zip | |
docs: Avoid using "firmware" in the documentation
The term "firmware" is ambiguous - it could refer to the entire
project (host and micro-controller software) or to just the
micro-controller software. Avoid the term in the documentation.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Todo.md')
| -rw-r--r-- | docs/Todo.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/Todo.md b/docs/Todo.md index f953c29f..69878ee8 100644 --- a/docs/Todo.md +++ b/docs/Todo.md @@ -31,12 +31,12 @@ Host user interaction Safety features =============== -* Support loading a valid step range into the firmware after - homing. This would provide a sanity check in the firmware that would - reduce the risk of the host commanding a stepper motor past its - valid step range. To maintain high efficiency in the firmware, the - firmware would only need to check periodically (eg, every 100ms) - that the stepper is in range. +* Support loading a valid step range into the micro-controller + software after homing. This would provide a sanity check in the + micro-controller that would reduce the risk of the host commanding a + stepper motor past its valid step range. To maintain high + efficiency, the micro-controller would only need to check + periodically (eg, every 100ms) that the stepper is in range. * Possibly support periodically querying the endstop switches and use multiple step ranges depending on the switch state. This would @@ -52,9 +52,10 @@ Testing features ================ * Complete the host based simulator. It's possible to compile the - firmware for a "host simulator", but that simulator doesn't do - anything currently. It would be useful to expand the code to support - more error checks, kinematic simulations, and improved logging. + micro-controller for a "host simulator", but that simulator doesn't + do anything currently. It would be useful to expand the code to + support more error checks, kinematic simulations, and improved + logging. Documentation ============= @@ -67,7 +68,7 @@ Documentation Hardware features ================= -* Port firmware to more architectures: +* Port to additional micro-controller architectures: * Beagle Bone Black PRU * Smoothieboard / NXP LPC1769 (ARM cortex-M3) * Unix based scheduling; Unix based real-time scheduling |