Smartcar Shield
Public Member Functions | Public Attributes | List of all members
BrushedMotorPins Struct Reference

Helper class to represent brushed motor pins. More...

#include <BrushedMotor.hpp>

Collaboration diagram for BrushedMotorPins:
Collaboration graph

Public Member Functions

 BrushedMotorPins (uint8_t forwardPin, uint8_t backwardPin, uint8_t enablePin)
 Construct a BrushedMotorPins object. More...
 

Public Attributes

const uint8_t forward
 
const uint8_t backward
 
const uint8_t enable
 

Detailed Description

Helper class to represent brushed motor pins.

Definition at line 20 of file BrushedMotor.hpp.

Constructor & Destructor Documentation

◆ BrushedMotorPins()

BrushedMotorPins::BrushedMotorPins ( uint8_t  forwardPin,
uint8_t  backwardPin,
uint8_t  enablePin 
)
inline

Construct a BrushedMotorPins object.

Parameters
forwardPinThe direction pin that when set to HIGH makes the motor spin forward
backwardPinThe direction pin that when set to HIGH makes the motor spin backward
enablePinThe pin that controls the motor's speed

Definition at line 29 of file BrushedMotor.hpp.

Member Data Documentation

◆ backward

const uint8_t BrushedMotorPins::backward

Definition at line 37 of file BrushedMotor.hpp.

◆ enable

const uint8_t BrushedMotorPins::enable

Definition at line 38 of file BrushedMotor.hpp.

◆ forward

const uint8_t BrushedMotorPins::forward

Definition at line 36 of file BrushedMotor.hpp.


The documentation for this struct was generated from the following file: