From 0f17a29ca24eede5b0460303528c5abe39f0e433 Mon Sep 17 00:00:00 2001 From: Juan Jimeno Date: Fri, 23 Nov 2018 01:11:42 +0800 Subject: [PATCH] added distance between front and rear wheel argument --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index acbca71..3a569b0 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,11 @@ The library requires the following robot's specification as an input: #### 1. Kinematics::Kinematics(int motor_max_rpm, float wheel_diameter, float base_width, int pwm_bits) Object constructor which requires the robot's specification. - - motor_max_rpm : Maximum RPM of the motor - - wheel_diameter : Robot wheel's diameter expressed in meters - - base_width : Distance between wheels - - pwm_bits : PWM resolution of the Microcontroller. Arduino Uno/Mega, Teensy is 8 bits by default. + - MOTOR_MAX_RPM : Maximum RPM of the motor + - WHEEL_DIAMETER : Robot wheel's diameter expressed in meters + - FR_WHEEL_DISTANCE : Distance between front wheel and rear wheel + - LR_WHEEL_DISTANCE : Distance between left wheel and right wheel + - PWM_BITS : #### 2. output getRPM(float linear_x, float linear_y, float angular_z) Returns a Vector of Motor RPMs from a given linear velocity in x and y axis and angular velocity in z axis using right hand rule. The returned values can be used in a PID controller as "setpoint" vs a wheel encoder's feedback expressed in RPM.