Craig Evans / m3pi

Library for Pololu m3pi line-following robot. Implements the serial slave commands.

Dependents:   3pi_Example_2 3pi_Lab1_Task2_Example1 3pi_Lab2_Task1_Example1 3pi_Line_Follow ... more

m3pi.cpp@4:0abe81f5d9fd, 2017-06-26 (annotated)

Committer:
eencae
Date:
Mon Jun 26 11:09:40 2017 +0000
Revision:
4:0abe81f5d9fd
Parent:
3:5015bc2d1cf8
Child:
5:847e6cbd458b
Added bar graph for sensor values.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
eencae 0:56320ef879a6 1 #include "m3pi.h"
eencae 0:56320ef879a6 2
eencae 0:56320ef879a6 3 ////////////////////////// constructor/destructor //////////////////////////////
eencae 0:56320ef879a6 4
eencae 0:56320ef879a6 5
eencae 0:56320ef879a6 6 m3pi::m3pi()
eencae 0:56320ef879a6 7 {
eencae 0:56320ef879a6 8 _serial = new Serial(p9,p10);
eencae 3:5015bc2d1cf8 9 _reset = new DigitalOut(p8);
eencae 2:26bf14f4dc84 10 _last_line_position = 0.0;
eencae 4:0abe81f5d9fd 11
eencae 4:0abe81f5d9fd 12 _bar_graph[0] = ' ';
eencae 4:0abe81f5d9fd 13 for (int i = 0; i < 6; i++) {
eencae 4:0abe81f5d9fd 14 _bar_graph[i+1] = i;
eencae 4:0abe81f5d9fd 15 }
eencae 0:56320ef879a6 16 }
eencae 0:56320ef879a6 17
eencae 0:56320ef879a6 18 m3pi::~m3pi()
eencae 0:56320ef879a6 19 {
eencae 0:56320ef879a6 20 delete _serial;
eencae 0:56320ef879a6 21 delete _reset;
eencae 3:5015bc2d1cf8 22
eencae 0:56320ef879a6 23 }
eencae 0:56320ef879a6 24
eencae 0:56320ef879a6 25 /////////////////////////////// public methods /////////////////////////////////
eencae 0:56320ef879a6 26
eencae 0:56320ef879a6 27 void m3pi::init()
eencae 0:56320ef879a6 28 {
eencae 0:56320ef879a6 29 _serial->baud(115200);
eencae 0:56320ef879a6 30 reset(); // hard rest of 3pi
eencae 0:56320ef879a6 31 stop(); // stop motors
eencae 0:56320ef879a6 32 lcd_clear(); // clear LCD
eencae 0:56320ef879a6 33 }
eencae 0:56320ef879a6 34
eencae 2:26bf14f4dc84 35 /////////////////////////////// serial slave commands ////////////////////////////////
eencae 2:26bf14f4dc84 36
eencae 2:26bf14f4dc84 37
eencae 0:56320ef879a6 38 void m3pi::get_signature(char *signature)
eencae 0:56320ef879a6 39 {
eencae 0:56320ef879a6 40 _serial->putc(0x81);
eencae 0:56320ef879a6 41 _serial->gets(signature,7);
eencae 0:56320ef879a6 42 }
eencae 0:56320ef879a6 43
eencae 0:56320ef879a6 44 void m3pi::get_raw_values(unsigned int *values)
eencae 0:56320ef879a6 45 {
eencae 1:5523d6d1feec 46 char vals[10]; // array to receive 10 byte return message
eencae 1:5523d6d1feec 47 _serial->putc(0x86); // send command
eencae 0:56320ef879a6 48
eencae 1:5523d6d1feec 49 int n=0;
eencae 1:5523d6d1feec 50 while ( _serial->readable() ) { // keep looping while data on rx line
eencae 1:5523d6d1feec 51 vals[n] = _serial->getc(); // read into array
eencae 1:5523d6d1feec 52 n++; // increment index
eencae 1:5523d6d1feec 53 }
eencae 1:5523d6d1feec 54
eencae 1:5523d6d1feec 55 for(int i=0; i<5; i++) { // construct the 2-byte values
eencae 1:5523d6d1feec 56 values[i] = (vals[2*i+1] << 8) | vals[2*i];
eencae 0:56320ef879a6 57 }
eencae 0:56320ef879a6 58 }
eencae 0:56320ef879a6 59
eencae 0:56320ef879a6 60 void m3pi::get_calibrated_values(unsigned int *values)
eencae 0:56320ef879a6 61 {
eencae 1:5523d6d1feec 62 char vals[10]; // array to receive 10 byte return message
eencae 1:5523d6d1feec 63 _serial->putc(0x87); // send command
eencae 0:56320ef879a6 64
eencae 1:5523d6d1feec 65 int n=0;
eencae 1:5523d6d1feec 66 while ( _serial->readable() ) { // keep looping while data on rx line
eencae 1:5523d6d1feec 67 vals[n] = _serial->getc(); // read into array
eencae 1:5523d6d1feec 68 n++; // increment index
eencae 0:56320ef879a6 69 }
eencae 0:56320ef879a6 70
eencae 1:5523d6d1feec 71 for(int i=0; i<5; i++) { // construct the 2-byte values
eencae 1:5523d6d1feec 72 values[i] = (vals[2*i+1] << 8) | vals[2*i];
eencae 1:5523d6d1feec 73 }
eencae 2:26bf14f4dc84 74
eencae 0:56320ef879a6 75 }
eencae 0:56320ef879a6 76
eencae 0:56320ef879a6 77 float m3pi::get_trimpot_value()
eencae 0:56320ef879a6 78 {
eencae 0:56320ef879a6 79 _serial->putc(0xB0);
eencae 0:56320ef879a6 80 char lsb = _serial->getc();
eencae 0:56320ef879a6 81 char msb = _serial->getc();
eencae 0:56320ef879a6 82 // trimpot value in the range 0 - 1023
eencae 0:56320ef879a6 83 float value = ( msb<<8 | lsb ) / 1023.0;
eencae 0:56320ef879a6 84 return value;
eencae 0:56320ef879a6 85 }
eencae 0:56320ef879a6 86
eencae 0:56320ef879a6 87
eencae 0:56320ef879a6 88 float m3pi::get_battery_voltage()
eencae 0:56320ef879a6 89 {
eencae 0:56320ef879a6 90 _serial->putc(0xB1);
eencae 0:56320ef879a6 91 char lsb = _serial->getc();
eencae 0:56320ef879a6 92 char msb = _serial->getc();
eencae 0:56320ef879a6 93 // Battery in mV so convert to volts
eencae 0:56320ef879a6 94 float voltage = ( msb<<8 | lsb ) / 1000.0;
eencae 0:56320ef879a6 95 return voltage;
eencae 0:56320ef879a6 96 }
eencae 0:56320ef879a6 97
eencae 0:56320ef879a6 98 void m3pi::play_music(const char notes[],int length)
eencae 0:56320ef879a6 99 {
eencae 0:56320ef879a6 100 length = length < 0 ? 0 : length;
eencae 0:56320ef879a6 101 length = length > 100 ? 100 : length;
eencae 0:56320ef879a6 102
eencae 0:56320ef879a6 103 _serial->putc(0xB3);
eencae 0:56320ef879a6 104 _serial->putc(length);
eencae 0:56320ef879a6 105
eencae 0:56320ef879a6 106 for (int i = 0 ; i < length ; i++) {
eencae 0:56320ef879a6 107 _serial->putc(notes[i]);
eencae 0:56320ef879a6 108 }
eencae 0:56320ef879a6 109 }
eencae 0:56320ef879a6 110
eencae 0:56320ef879a6 111
eencae 0:56320ef879a6 112 void m3pi::calibrate()
eencae 0:56320ef879a6 113 {
eencae 3:5015bc2d1cf8 114 _serial->putc(0xB4);
eencae 0:56320ef879a6 115 }
eencae 0:56320ef879a6 116
eencae 0:56320ef879a6 117 void m3pi::reset_calibration()
eencae 0:56320ef879a6 118 {
eencae 0:56320ef879a6 119 _serial->putc(0xB5);
eencae 0:56320ef879a6 120 }
eencae 0:56320ef879a6 121
eencae 2:26bf14f4dc84 122 float m3pi::get_line_position()
eencae 0:56320ef879a6 123 {
eencae 0:56320ef879a6 124 _serial->putc(0xB6);
eencae 0:56320ef879a6 125
eencae 0:56320ef879a6 126 char lsb = _serial->getc();
eencae 0:56320ef879a6 127 char msb = _serial->getc();
eencae 0:56320ef879a6 128 int position = (msb<<8 | lsb);
eencae 0:56320ef879a6 129
eencae 2:26bf14f4dc84 130 return float(position - 2000)/2000.0;
eencae 0:56320ef879a6 131 }
eencae 0:56320ef879a6 132
eencae 0:56320ef879a6 133 void m3pi::lcd_clear()
eencae 0:56320ef879a6 134 {
eencae 0:56320ef879a6 135 _serial->putc(0xB7);
eencae 0:56320ef879a6 136 }
eencae 0:56320ef879a6 137
eencae 0:56320ef879a6 138 void m3pi::lcd_print(char text[],int length)
eencae 0:56320ef879a6 139 {
eencae 0:56320ef879a6 140 length = length < 0 ? 0 : length;
eencae 0:56320ef879a6 141 length = length > 8 ? 8 : length;
eencae 0:56320ef879a6 142
eencae 0:56320ef879a6 143 _serial->putc(0xB8);
eencae 0:56320ef879a6 144 _serial->putc(length);
eencae 0:56320ef879a6 145
eencae 0:56320ef879a6 146 for (int i = 0 ; i < length ; i++) {
eencae 0:56320ef879a6 147 _serial->putc(text[i]);
eencae 0:56320ef879a6 148 }
eencae 0:56320ef879a6 149 }
eencae 0:56320ef879a6 150
eencae 0:56320ef879a6 151 void m3pi::lcd_goto_xy(int x, int y)
eencae 0:56320ef879a6 152 {
eencae 0:56320ef879a6 153 _serial->putc(0xB9);
eencae 0:56320ef879a6 154 _serial->putc(x);
eencae 0:56320ef879a6 155 _serial->putc(y);
eencae 0:56320ef879a6 156 }
eencae 0:56320ef879a6 157
eencae 0:56320ef879a6 158 void m3pi::auto_calibrate()
eencae 0:56320ef879a6 159 {
eencae 0:56320ef879a6 160 _serial->putc(0xBA);
eencae 3:5015bc2d1cf8 161
eencae 3:5015bc2d1cf8 162 while(1) { // wait for serial response
eencae 0:56320ef879a6 163 if (_serial->readable()) {
eencae 0:56320ef879a6 164 break;
eencae 0:56320ef879a6 165 }
eencae 0:56320ef879a6 166 }
eencae 0:56320ef879a6 167 }
eencae 0:56320ef879a6 168
eencae 2:26bf14f4dc84 169 /////////////////////////////// motor methods ////////////////////////////////
eencae 2:26bf14f4dc84 170
eencae 0:56320ef879a6 171 void m3pi::left_motor(float speed)
eencae 0:56320ef879a6 172 {
eencae 0:56320ef879a6 173 // check within bounds
eencae 0:56320ef879a6 174 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 175 speed = speed < -1.0 ? -1.0 : speed;
eencae 0:56320ef879a6 176
eencae 0:56320ef879a6 177 if (speed > 0.0) { // forward
eencae 0:56320ef879a6 178 _serial->putc(0xC1);
eencae 0:56320ef879a6 179 char s = char(127.0*speed);
eencae 0:56320ef879a6 180 _serial->putc(s);
eencae 0:56320ef879a6 181 } else { // backward - speed is negative
eencae 0:56320ef879a6 182 _serial->putc(0xC2);
eencae 0:56320ef879a6 183 char s = char(-127.0*speed);
eencae 0:56320ef879a6 184 _serial->putc(s);
eencae 0:56320ef879a6 185 }
eencae 0:56320ef879a6 186
eencae 0:56320ef879a6 187 }
eencae 0:56320ef879a6 188
eencae 0:56320ef879a6 189 void m3pi::right_motor(float speed)
eencae 0:56320ef879a6 190 {
eencae 0:56320ef879a6 191 // check within bounds
eencae 0:56320ef879a6 192 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 193 speed = speed < -1.0 ? -1.0 : speed;
eencae 0:56320ef879a6 194
eencae 0:56320ef879a6 195 if (speed > 0.0) { // forward
eencae 0:56320ef879a6 196 _serial->putc(0xC5);
eencae 0:56320ef879a6 197 char s = char(127.0*speed);
eencae 0:56320ef879a6 198 _serial->putc(s);
eencae 0:56320ef879a6 199 } else { // backward - speed is negative
eencae 0:56320ef879a6 200 _serial->putc(0xC6);
eencae 0:56320ef879a6 201 char s = char(-127.0*speed);
eencae 0:56320ef879a6 202 _serial->putc(s);
eencae 0:56320ef879a6 203 }
eencae 0:56320ef879a6 204
eencae 0:56320ef879a6 205 }
eencae 0:56320ef879a6 206
eencae 0:56320ef879a6 207 // speeds from -1.0 to 1.0 (0 is stop)
eencae 0:56320ef879a6 208 void m3pi::motors(float left_speed,float right_speed)
eencae 0:56320ef879a6 209 {
eencae 0:56320ef879a6 210 left_motor(left_speed);
eencae 0:56320ef879a6 211 right_motor(right_speed);
eencae 0:56320ef879a6 212 }
eencae 0:56320ef879a6 213
eencae 0:56320ef879a6 214 void m3pi::stop()
eencae 0:56320ef879a6 215 {
eencae 0:56320ef879a6 216 left_motor(0.0);
eencae 0:56320ef879a6 217 right_motor(0.0);
eencae 0:56320ef879a6 218 }
eencae 0:56320ef879a6 219
eencae 0:56320ef879a6 220 // speed in range 0.0 to 1.0
eencae 0:56320ef879a6 221 void m3pi::forward(float speed)
eencae 0:56320ef879a6 222 {
eencae 0:56320ef879a6 223 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 224 speed = speed < 0.0 ? 0.0 : speed;
eencae 0:56320ef879a6 225
eencae 0:56320ef879a6 226 left_motor(speed);
eencae 0:56320ef879a6 227 right_motor(speed);
eencae 0:56320ef879a6 228 }
eencae 0:56320ef879a6 229
eencae 0:56320ef879a6 230 // speed in range 0 to 1.0
eencae 0:56320ef879a6 231 void m3pi::reverse(float speed)
eencae 0:56320ef879a6 232 {
eencae 0:56320ef879a6 233 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 234 speed = speed < 0.0 ? 0.0 : speed;
eencae 0:56320ef879a6 235
eencae 0:56320ef879a6 236 left_motor(-speed);
eencae 0:56320ef879a6 237 right_motor(-speed);
eencae 0:56320ef879a6 238 }
eencae 0:56320ef879a6 239
eencae 0:56320ef879a6 240 void m3pi::spin_right(float speed)
eencae 0:56320ef879a6 241 {
eencae 0:56320ef879a6 242 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 243 speed = speed < 0.0 ? 0.0 : speed;
eencae 0:56320ef879a6 244
eencae 0:56320ef879a6 245 left_motor(speed);
eencae 0:56320ef879a6 246 right_motor(-speed);
eencae 0:56320ef879a6 247 }
eencae 0:56320ef879a6 248
eencae 0:56320ef879a6 249 void m3pi::spin_left(float speed)
eencae 0:56320ef879a6 250 {
eencae 0:56320ef879a6 251 speed = speed > 1.0 ? 1.0 : speed;
eencae 0:56320ef879a6 252 speed = speed < 0.0 ? 0.0 : speed;
eencae 0:56320ef879a6 253
eencae 0:56320ef879a6 254 left_motor(-speed);
eencae 0:56320ef879a6 255 right_motor(speed);
eencae 0:56320ef879a6 256 }
eencae 0:56320ef879a6 257
eencae 2:26bf14f4dc84 258 ////////////////////////////////////////////////////////////////////////////////
eencae 2:26bf14f4dc84 259
eencae 0:56320ef879a6 260 void m3pi::display_battery_voltage(int x,int y)
eencae 0:56320ef879a6 261 {
eencae 0:56320ef879a6 262 float voltage = get_battery_voltage();
eencae 0:56320ef879a6 263
eencae 0:56320ef879a6 264 char buffer[8];
eencae 0:56320ef879a6 265 sprintf(buffer,"%3.1f V",voltage);
eencae 0:56320ef879a6 266
eencae 0:56320ef879a6 267 lcd_goto_xy(x,y);
eencae 0:56320ef879a6 268 lcd_print(buffer,5);
eencae 0:56320ef879a6 269 }
eencae 0:56320ef879a6 270
eencae 0:56320ef879a6 271 void m3pi::display_signature(int x,int y)
eencae 0:56320ef879a6 272 {
eencae 0:56320ef879a6 273 _serial->putc(0x81);
eencae 0:56320ef879a6 274 char buffer[7]; // including NULL terminator
eencae 0:56320ef879a6 275 _serial->gets(buffer,7);
eencae 0:56320ef879a6 276
eencae 0:56320ef879a6 277 lcd_goto_xy(x,y);
eencae 0:56320ef879a6 278 lcd_print(buffer,6);
eencae 0:56320ef879a6 279 }
eencae 0:56320ef879a6 280
eencae 2:26bf14f4dc84 281 void m3pi::display_sensor_values(unsigned int values[],int y)
eencae 2:26bf14f4dc84 282 {
eencae 2:26bf14f4dc84 283 // initialise array to ASCII '0'
eencae 4:0abe81f5d9fd 284 lcd_goto_xy(1,y);
eencae 4:0abe81f5d9fd 285
eencae 4:0abe81f5d9fd 286 char sensor_values[5];
eencae 4:0abe81f5d9fd 287
eencae 4:0abe81f5d9fd 288 // loop through sensor
eencae 4:0abe81f5d9fd 289 for (int sensor = 0 ; sensor < 5 ; sensor++) {
eencae 4:0abe81f5d9fd 290 // get the value and put it in the correct bin
eencae 4:0abe81f5d9fd 291 // (7 bins in the range 0 to 1000
eencae 4:0abe81f5d9fd 292 char value = char(values[sensor]/(1000.0/7.0));
eencae 4:0abe81f5d9fd 293 // use the bin to select the bar graph icon to display
eencae 4:0abe81f5d9fd 294 sensor_values[sensor] = _bar_graph[value];
eencae 4:0abe81f5d9fd 295 }
eencae 4:0abe81f5d9fd 296
eencae 4:0abe81f5d9fd 297 lcd_print(sensor_values,5);
eencae 2:26bf14f4dc84 298
eencae 2:26bf14f4dc84 299 }
eencae 2:26bf14f4dc84 300
eencae 2:26bf14f4dc84 301 unsigned int m3pi::get_sensor_array_value(unsigned int values[])
eencae 2:26bf14f4dc84 302 {
eencae 2:26bf14f4dc84 303 unsigned int value = 0;
eencae 2:26bf14f4dc84 304
eencae 2:26bf14f4dc84 305 // loop through each bit, starting from PC4
eencae 2:26bf14f4dc84 306 for (int i = 4; i >= 0; i--) {
eencae 2:26bf14f4dc84 307
eencae 2:26bf14f4dc84 308 unsigned int weight = pow(2.0,4-i);
eencae 2:26bf14f4dc84 309
eencae 2:26bf14f4dc84 310 // check if over threshold
eencae 2:26bf14f4dc84 311 if (values[i] > 500) {
eencae 2:26bf14f4dc84 312 // add equivalent binary weight to value
eencae 2:26bf14f4dc84 313 value += weight;
eencae 2:26bf14f4dc84 314 }
eencae 2:26bf14f4dc84 315
eencae 2:26bf14f4dc84 316 }
eencae 2:26bf14f4dc84 317
eencae 2:26bf14f4dc84 318 return value;
eencae 2:26bf14f4dc84 319 }
eencae 2:26bf14f4dc84 320
eencae 2:26bf14f4dc84 321 float m3pi::calc_line_position(unsigned int values[])
eencae 2:26bf14f4dc84 322 {
eencae 2:26bf14f4dc84 323 // calculate weighted average
eencae 2:26bf14f4dc84 324 unsigned int value =
eencae 2:26bf14f4dc84 325 (0*values[0]+1e3*values[1]+2e3*values[2]+3e3*values[3]+4e3*values[4])/
eencae 2:26bf14f4dc84 326 (values[0]+values[1]+values[2]+values[3]+values[4]);
eencae 2:26bf14f4dc84 327
eencae 2:26bf14f4dc84 328 // scale to between -1.0 and 1.0
eencae 2:26bf14f4dc84 329 float position = (int(value) - 2000)/2000.0;
eencae 2:26bf14f4dc84 330
eencae 2:26bf14f4dc84 331 float is_on_line = false;
eencae 2:26bf14f4dc84 332
eencae 2:26bf14f4dc84 333 // loop through and check if any sensor reading is above the threshold
eencae 2:26bf14f4dc84 334 for (int i = 0; i<5; i++) {
eencae 2:26bf14f4dc84 335 if (values[i] > 500) {
eencae 2:26bf14f4dc84 336 is_on_line = true;
eencae 2:26bf14f4dc84 337 }
eencae 2:26bf14f4dc84 338 }
eencae 2:26bf14f4dc84 339
eencae 2:26bf14f4dc84 340 // update last line position if over line
eencae 2:26bf14f4dc84 341 if (is_on_line) {
eencae 2:26bf14f4dc84 342 _last_line_position = position;
eencae 2:26bf14f4dc84 343 }
eencae 2:26bf14f4dc84 344
eencae 2:26bf14f4dc84 345 // if not on line then the last line position will have the last value when over line
eencae 2:26bf14f4dc84 346 return _last_line_position;
eencae 2:26bf14f4dc84 347 }
eencae 2:26bf14f4dc84 348
eencae 0:56320ef879a6 349 /////////////////////////////// private methods ////////////////////////////////
eencae 0:56320ef879a6 350
eencae 0:56320ef879a6 351 void m3pi::reset()
eencae 0:56320ef879a6 352 {
eencae 0:56320ef879a6 353 // pulse the reset line (active-high)
eencae 3:5015bc2d1cf8 354 _reset->write(1);
eencae 3:5015bc2d1cf8 355 wait_ms(100);
eencae 0:56320ef879a6 356 _reset->write(0);
eencae 0:56320ef879a6 357 wait_ms(100);
eencae 0:56320ef879a6 358 }