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

docs: updated library descriptions and sensor names for consistency

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-06-01 15:44:07 -07:00
parent 8965d56c93
commit 14f80e779e
97 changed files with 237 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/stepmotor/stepmotor.h
View File

@ -41,25 +41,25 @@
namespace upm {
/**
* @brief API for the Stepper motor library
*
* This file defines the stepmotor interface
*
* @brief Stepper motor library
* @defgroup stepper libupm-stepper
* @ingroup seeed pwm gpio motor
* @ingroup seeed sparkfun pwm gpio motor
*/
/**
* @library stepper
* @sensor stepper
* @comname Stepper motor
* @comname Stepper Motor
* @altname EasyDriver Stepper Motor Driver
* @type motor
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3
* @man seeed sparkfun
* @web http://www.schmalzhaus.com/EasyDriver/index.html
* @con pwm gpio
*
* @brief API for the Stepper motor library
*
* This file defines the stepmotor interface
* This file defines the StepMotor interface. It is compatible with Stepper
* Motor Drivers that use 2 pins to control the motor, like the EasyDriver
* from Brian Schmalz.
*
* @image html stepmotor.jpg
* @snippet stepmotor.cxx Interesting
@ -67,10 +67,10 @@ namespace upm {
class StepMotor {
public:
/**
* Instanciates a StepMotor object
* Instantiates a StepMotor object
*
* @param dirPin direction GPIO pin
* @param stePin steper pulse PWM pin
* @param stePin stepper pulse PWM pin
*/
StepMotor (int dirPin, int stePin);
@ -89,14 +89,14 @@ class StepMotor {
/**
* Rotate motor forward
*
* @param ticks number of tickes the motor will move
* @param ticks number of ticks the motor will move
*/
mraa_result_t stepForward (int ticks);
/**
* Rotate motor backward
*
* @param ticks number of tickes the motor will move
* @param ticks number of ticks the motor will move
*/
mraa_result_t stepBackwards (int ticks);