summaryrefslogtreecommitdiff
path: root/digital/avr/modules/motor/blocking_detection/blocking_detection.txt
diff options
context:
space:
mode:
authorNicolas Schodet2011-10-08 11:56:10 +0200
committerNicolas Schodet2012-03-06 23:16:05 +0100
commit928dc853e088849580aac368401999ea596644bb (patch)
tree7970d54f08a9e802f54c7dbbde4f91987ea5982e /digital/avr/modules/motor/blocking_detection/blocking_detection.txt
parent7a1417eb3cecd3b5f5b8a5c1a73e5a89d19de2d4 (diff)
digital/avr/modules/motor: add motor control system
Diffstat (limited to 'digital/avr/modules/motor/blocking_detection/blocking_detection.txt')
-rw-r--r--digital/avr/modules/motor/blocking_detection/blocking_detection.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/digital/avr/modules/motor/blocking_detection/blocking_detection.txt b/digital/avr/modules/motor/blocking_detection/blocking_detection.txt
new file mode 100644
index 00000000..21319126
--- /dev/null
+++ b/digital/avr/modules/motor/blocking_detection/blocking_detection.txt
@@ -0,0 +1,21 @@
+=================================
+ motor/blocking_detection module
+=================================
+:Author: Nicolas Schodet
+
+Introduction
+============
+
+This module try to detect when there is something which blocks a motor. This
+is not meant to protect the motor, its role is to inform upper layer that an
+action must be taken.
+
+Usage
+=====
+
+TODO: about to change.
+
+API
+===
+
+.. include:: blocking_detection.exd