From 56ab78ac2334e1aab717db0a18080f7bf69aab66 Mon Sep 17 00:00:00 2001 From: Patrick Wasp Date: Mon, 10 Apr 2017 21:01:02 -0400 Subject: [PATCH] updated docs --- extras/doc/annotated.html | 8 +- extras/doc/classAccelStepper-members.html | 103 +++++++++++----------- extras/doc/classAccelStepper.html | 60 +++++++++---- extras/doc/doxygen.css | 49 ++++++++-- extras/doc/files.html | 8 +- extras/doc/functions.html | 19 ++-- extras/doc/functions_func.html | 9 +- extras/doc/index.html | 16 ++-- 8 files changed, 175 insertions(+), 97 deletions(-) diff --git a/extras/doc/annotated.html b/extras/doc/annotated.html index 2bb3ddd..ca245cd 100644 --- a/extras/doc/annotated.html +++ b/extras/doc/annotated.html @@ -3,7 +3,7 @@ - + AccelStepper: Class List @@ -16,7 +16,7 @@ - @@ -25,7 +25,7 @@
+
AccelStepper
- + - +
Generated by   doxygen - 1.8.8 + 1.8.11
diff --git a/extras/doc/classAccelStepper.html b/extras/doc/classAccelStepper.html index a9e1944..4df6517 100644 --- a/extras/doc/classAccelStepper.html +++ b/extras/doc/classAccelStepper.html @@ -3,7 +3,7 @@ - + AccelStepper: AccelStepper Class Reference @@ -16,7 +16,7 @@ - @@ -25,7 +25,7 @@
+
AccelStepper
- +
AccelStepper Class Reference
@@ -70,8 +71,8 @@ HALF3WIRE = 6, HALF4WIRE = 8
- } - Symbolic names for number of pins. Use this in the pins argument the AccelStepper constructor to provide a symbolic name for the number of pins to use. More...
+ } Symbolic names for number of pins. Use this in the pins argument the AccelStepper constructor to provide a symbolic name for the number of pins to use. More...
+   - + } +

@@ -133,8 +134,8 @@ Protected Types

enum  Direction { DIRECTION_CCW = 0, DIRECTION_CW = 1 - }
 Direction indicator Symbolic names for the direction the motor is turning. More...
 Direction indicator Symbolic names for the direction the motor is turning. More...
 
+

@@ -159,6 +160,11 @@

 
virtual void step8 (long step)
 
+ + +

+Protected Attributes

boolean _direction
 

Detailed Description

Support for stepper motors with acceleration etc.

@@ -296,7 +302,7 @@

Constructor & Destructor Documentation

-

References DIRECTION_CCW, enableOutputs(), and setAcceleration().

+

References _direction, DIRECTION_CCW, enableOutputs(), and setAcceleration().

@@ -331,7 +337,7 @@

Constructor & Destructor Documentation

-

References DIRECTION_CCW, and setAcceleration().

+

References _direction, DIRECTION_CCW, and setAcceleration().

@@ -363,7 +369,7 @@

Member Function Documentation

  • after change to target position (relative or absolute) through move() or moveTo()
    • -

    References DIRECTION_CCW, DIRECTION_CW, and distanceToGo().

    +

    References _direction, DIRECTION_CCW, DIRECTION_CW, and distanceToGo().

    Referenced by moveTo(), run(), setAcceleration(), and setMaxSpeed().

    @@ -579,7 +585,7 @@

    Member Function Documentation

    Poll the motor and step it if a step is due, implementing a constant speed as set by the most recent call to setSpeed(). You must call this as frequently as possible, but at least once per step interval,

    Returns
    true if the motor was stepped.
    -

    References DIRECTION_CW, and step().

    +

    References _direction, DIRECTION_CW, and step().

    Referenced by MultiStepper::run(), run(), and runSpeedToPosition().

    @@ -599,7 +605,7 @@

    Member Function Documentation

    Runs at the currently selected speed until the target position is reached Does not implement accelerations.

    Returns
    true if it stepped
    -

    References DIRECTION_CCW, DIRECTION_CW, and runSpeed().

    +

    References _direction, DIRECTION_CCW, DIRECTION_CW, and runSpeed().

    @@ -907,7 +913,7 @@

    Member Function Documentation

    -

    References DIRECTION_CCW, DIRECTION_CW, and speed().

    +

    References _direction, DIRECTION_CCW, DIRECTION_CW, and speed().

    Referenced by MultiStepper::moveTo().

    @@ -1025,7 +1031,7 @@

    Member Function Documentation

    -

    References setOutputPins().

    +

    References _direction, and setOutputPins().

    Referenced by step().

    @@ -1233,6 +1239,30 @@

    Member Function Documentation

    The most recently set target position.

    Returns
    the target position in steps. Positive is clockwise from the 0 position.
    +
    + +

    Member Data Documentation

    + +
    +
    + + + + + +
    + + + + +
    boolean AccelStepper::_direction
    +     		+protected
    +
    +

    Current direction motor is spinning in Protected because some peoples subclasses need it to be so

    + +

    Referenced by AccelStepper(), computeNewSpeed(), runSpeed(), runSpeedToPosition(), setSpeed(), and step1().

    +
    The documentation for this class was generated from the following files: