JMotor/_j_motor_controller_base_8h_source.html

#ifndef J_MOTOR_CONTROLLER_BASE_H

#define J_MOTOR_CONTROLLER_BASE_H

#include <Arduino.h>


class JMotorControllerBase {

public:

    virtual void setAccelLimit(float _accelLimit) = 0;


    virtual void setVelLimit(float _velLimit) = 0;


    virtual void setVel(float vel, bool _run = true) = 0;


    virtual void setVelTarget(float vel, bool _run = true) = 0;


    virtual float getVelTarget() = 0;


    virtual float getVel() = 0;


    virtual float getDriverSetVal() = 0;


    virtual void run() = 0;


    virtual bool setEnable(bool _enable) = 0;


    virtual bool isDriverInRange() = 0;


    virtual bool enable() = 0;


    virtual bool disable() = 0;


    virtual float getDriverMinRange() = 0;


    virtual float getDriverMaxRange() = 0;


    virtual bool getEnable() = 0;


    virtual float getMaxVel() = 0;


    virtual float getMinVel() = 0;


    virtual void setMaxDriverRangeAmount(float _driverRangeAmount) = 0;


    virtual float getAccelLimit() = 0;


    virtual float getVelLimit() = 0;

};


#include "JMotorControllerBasic.h"

#endif

JMotorControllerBasic.h

JMotorControllerBase
This class defines a common interface for classes which control velocity of a motor controlled by a J...
Definition JMotorControllerBase.h:7

JMotorControllerBase::setAccelLimit
virtual void setAccelLimit(float _accelLimit)=0
set maximum rate that motor speed can be changed at

JMotorControllerBase::setVelTarget
virtual void setVelTarget(float vel, bool _run=true)=0
set target velocity for controller (acceleration limited)

JMotorControllerBase::getVel
virtual float getVel()=0
get current velocity of motor

JMotorControllerBase::getVelTarget
virtual float getVelTarget()=0
get target velocity for controller

JMotorControllerBase::enable
virtual bool enable()=0
enable motor controller

JMotorControllerBase::setVel
virtual void setVel(float vel, bool _run=true)=0
set velocity for controller

JMotorControllerBase::setVelLimit
virtual void setVelLimit(float _velLimit)=0
set maximum motor speed

JMotorControllerBase::disable
virtual bool disable()=0
disable motor controller

JMotorControllerBase::getDriverMaxRange
virtual float getDriverMaxRange()=0
if getDriverSetVal exceeds this, isDriverInRange will go false

JMotorControllerBase::setMaxDriverRangeAmount
virtual void setMaxDriverRangeAmount(float _driverRangeAmount)=0
set what fraction of driverRange can be used

JMotorControllerBase::getDriverMinRange
virtual float getDriverMinRange()=0
if getDriverSetVal goes below this, isDriverInRange will go false

JMotorControllerBase::isDriverInRange
virtual bool isDriverInRange()=0
true if motor driver is being set to within its range, false if driver is at a maximum

JMotorControllerBase::getEnable
virtual bool getEnable()=0
is the controller enabled

JMotorControllerBase::getMaxVel
virtual float getMaxVel()=0
How fast of a motor speed setting would get adjusted to full motor power.

JMotorControllerBase::getVelLimit
virtual float getVelLimit()=0
returns value of velLimit

JMotorControllerBase::getDriverSetVal
virtual float getDriverSetVal()=0
returns the value the motor driver is being set to

JMotorControllerBase::getMinVel
virtual float getMinVel()=0
slowest speed motor can go

JMotorControllerBase::run
virtual void run()=0
update driver

JMotorControllerBase::getAccelLimit
virtual float getAccelLimit()=0
returns value of accelLimit

JMotorControllerBase::setEnable
virtual bool setEnable(bool _enable)=0
change whether motor controller is enabled