alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
src/l298/l298.h
View File

@ -34,7 +34,7 @@
namespace upm {
/**
* @brief L298 dual H-bridge motor driver library
* @brief L298 Dual H-Bridge Motor Driver library
* @defgroup l298 libupm-l298
* @ingroup seeed sparkfun gpio pwm motor
*/
@ -48,16 +48,16 @@ namespace upm {
* @web https://www.sparkfun.com/products/9670
* @con gpio pwm
*
* @brief API for the L298 Dual H-Bridge module
* @brief API for the L298 Dual H-Bridge Motor Driver
*
* It was developed using the RobotBase Dual H-Bridge module.
*
* This module can support 2 DC motors, or 1 2-phase stepper motor.
* It requires 3 pins per DC motor (or h-bridge), or 4 pins for
* the stepper (uses both h-bridges).
* This module can support 2 DC motors, or one 2-phase stepper motor.
* It requires 3 pins per DC motor (or H-bridge), or 4 pins for
* the stepper motor (uses both H-bridges).
*
* @image html l298.jpg
* <br><em>L298 Dual H-Bridge Motor Driver image provided by SparkFun under
* <br><em>L298 Dual H-Bridge Motor Driver image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
@ -81,77 +81,77 @@ namespace upm {
/**
* L298 constructor for DC motor(s) connected.
*
* @param pwm digital pin to use for DC motor - must be PWM capable
* @param dir1 digital pin to use for motor direction pin 1
* @param dir2 digital pin to use for motor direction pin 2
* @param pwm Digital pin to use for a DC motor - must be PWM-capable
* @param dir1 Digital pin to use for motor direction pin 1
* @param dir2 Digital pin to use for motor direction pin 2
*/
L298(int pwm, int dir1, int dir2);
/**
* L298 constructor for 4-wire stepper motor
* L298 constructor for a 4-wire stepper motor
*
* @param stepsPerRev number of steps per full revolution
* @param en enable pin
* @param i1 digital pin to use for stepper input 1
* @param i2 digital pin to use for stepper input 2
* @param i3 digital pin to use for stepper input 3
* @param i4 digital pin to use for stepper input 4
* @param stepsPerRev Number of steps per full revolution
* @param en Enables the pin
* @param i1 Digital pin to use for stepper input 1
* @param i2 Digital pin to use for stepper input 2
* @param i3 Digital pin to use for stepper input 3
* @param i4 Digital pin to use for stepper input 4
*/
L298(int stepsPerRev, int en, int i1, int i2, int i3, int i4);
/**
* L298 Destructor
* L298 destructor
*/
~L298();
/**
* Return the number of milliseconds elapsed since initClock()
* Returns the number of milliseconds elapsed since initClock()
* was last called.
*
* @return elapsed milliseconds
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Reset the Clock
* Resets the clock
*
*/
void initClock();
/**
* set the period in milliseconds
* Sets the period in milliseconds
*
* @param ms period in milliseconds
* @param ms Period in milliseconds
*/
void setPeriodMS(int ms);
/**
* enable PWM output for a motor
* Enables the PWM output for a motor
*
* @param enable enable PWM output if true, disable if false
* @param enable Enables the PWM output if true, disables if false
*/
void enable(bool enable);
/**
* set the speed of a DC or stepp motor. For a DC motor, Values
* can range from 0 (off) to 100 (full speed). For a stepper
* Sets the speed of a DC or stepper motor. For a DC motor, values
* can range from 0 (off) to 100 (full speed). For a stepper
* motor, specify the desired RPM.
*
* @param speed speed to set the motor to
* @param speed Speed to set the motor to
*/
void setSpeed(int speed);
/**
* set the direction of the motor, clockwise or counter clockwise
* Sets the direction of the motor, clockwise or counterclockwise
*
* @param dir direction to set the motor to
* @param dir Direction to set the motor to
*/
void setDirection(L298_DIRECTION_T dir);
/**
* step the stepper motor a specified number of steps
* Steps the stepper motor a specified number of steps
*
* @param steps number of steps to move the stepper motor
* @param steps Number of steps to move the stepper motor
*/
void stepperSteps(unsigned int steps);
@ -181,12 +181,12 @@ namespace upm {
uint32_t m_stepDelay;
/**
* step the motor one tick
* Steps the motor one tick
*
*/
void stepperStep();
// step direction - 1 = forward, -1 = backward
// step direction: - 1 = forward, -1 = backward
int m_stepDirection;
};
}