diff --git a/README.md b/README.md index c21cb781f271fd4febfc1a53470377368b8fa3cb..7f1916040e6b806c297710cbde64c11f035925f9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ Eine Klasse zur Ansteuerung von Gleichstrommotoren für unterschiedliche Motortr Getestet mit: -- Arduino Mega Pro + TB6612FNG +- Arduino Mega Pro + TB6612FNG<br /> +<br /> ## **Installation:** @@ -15,6 +16,7 @@ Um diese Klassen verwenden zu können, muss dieses Repository geklont und in das Zur Verwendung siehe zunächst das Beispiel `drive.ino`<br /> <br /> + **Erläuterung zur Klasse** Es wird für jeden Motortreiber nur ein Objekt benötigt, dem beim instanziieren alle benötigten Informationen übergeben wird.<br /> @@ -41,4 +43,13 @@ thk_MotorDriverTB6612FNG motorExample(MOTOR_COUNT, MOTOR_STBY, MOTOR_PWM_A, MOTO - `MOTOR_IN2`: Input Pin 2 vom Gleichstrommotor A. - `MOTOR_PWM_B`: PWM Pin für die Steuerung der Motorgeschwindigkeit vom Gleichstrommotor B. - `MOTOR_IN3`: Input Pin 3 vom Gleichstrommotor B. -- `MOTOR_IN4`: Input Pin 4 vom Gleichstrommotor B. \ No newline at end of file +- `MOTOR_IN4`: Input Pin 4 vom Gleichstrommotor B. + +**Funktionen:** + +```arduino +motorExample.drive(velocity, direction); // Fahren mit definierter Geschwindigkeit (0-255) und mit Angabe der Richtung. 1 = Vorwärts, 0 = Rückwärts +motorExample.drive_forward(velocity); // Vorwärtsfahren mit definierter Geschwindigkeit (0-255) +motorExample.drive_backward(velocity); // Rückwärtsfahren mit definierter Geschwindigkeit (0-255) +motorExample.stop(); // Stoppen des Motors +``` diff --git a/examples/drive/drive.ino b/examples/drive/drive.ino index 2972ccd8ebd4b6b5a171d2ba17798228b4f5e307..538f8893d1fc7f7cec6b3d6bc93daff400214ae1 100644 --- a/examples/drive/drive.ino +++ b/examples/drive/drive.ino @@ -32,13 +32,13 @@ void loop() motor.stop(); delay(1000); - motor.drive_forward(velocity); + motor.drive(velocity, 1); delay(2000); motor.stop(); delay(1000); - motor.drive_backward(velocity); + motor.drive(velocity, 0); delay(2000); motor.stop();