Project

General

Profile

Revision 1527

Added by John Sexton over 14 years ago

Copied code folder from the trunk into the bom_refractor branch.

View differences:

bom.c
1
/**
2
 * Copyright (c) 2007 Colony Project
3
 * 
4
 * Permission is hereby granted, free of charge, to any person
5
 * obtaining a copy of this software and associated documentation
6
 * files (the "Software"), to deal in the Software without
7
 * restriction, including without limitation the rights to use,
8
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the
10
 * Software is furnished to do so, subject to the following
11
 * conditions:
12
 * 
13
 * The above copyright notice and this permission notice shall be
14
 * included in all copies or substantial portions of the Software.
15
 * 
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
 * OTHER DEALINGS IN THE SOFTWARE.
24
 **/
25

  
26

  
27
/**
28
 * @file bom.c
29
 * @brief Implementation for using the BOM
30
 *
31
 * Contains functions for using the Bearing and Orientation Module (BOM)
32
 *
33
 * @author Colony Project, CMU Robotics Club
34
 **/
35

  
36
#include "bom.h"
37
#include "dio.h"
38
#include "serial.h"
39
#include "analog.h"
40

  
41
//On the original BOM1.0, the emmitter angular order does not match the analog mux order
42
//so you need to iterate through the mux index in the following order if you want to get
43
//the detector readings in order:
44
static const char lookup[16] = {7,6,5,0xe,1,4,3,2,0xf,0,0xd,8,0xc,0xb,9,0xa};
45

  
46
// internal function prototypes
47
static void bom_select(char which);
48

  
49
/*
50
 Bk R Y (Analog)
51
---------
52
 Green
53
 Blue
54
 White
55
---------
56
 Blue
57
 White
58
*/
59

  
60

  
61
/*
62
the analog pin definitions from dio.h DO NOT work here,
63
so we must use PF0 from avrgcc (as opposed to _PIN_F0).
64
BUT the dio pin definitions from dio.h must be used (no PE...).
65

  
66
also, _PIN_E2 is initialized to high for some reason,
67
which turns the BOM on when the robot is turned on.
68
WORK-AROUND: call digital_output(_PIN_E2,0) at some point.
69

  
70
*/
71

  
72
#define MONKI PF0         //analog (yellow)
73
//------------------------//
74
#define MONKL _PIN_E2     //green
75
#define MONK1 _PIN_E3     //blue
76
#define MONK0 _PIN_E4     //white
77
//------------------------//
78
#define MONK3 _PIN_E6     //blue
79
#define MONK2 _PIN_E7     //white
80

  
81
#define BOM_VALUE_THRESHOLD 150 //200
82
#define NUM_BOM_LEDS 16
83

  
84
/*
85
  *The following pin definitions are for the BOM v1.5
86
  */
87

  
88
#define BOM_MODE	_PIN_E2	//dio0
89
#define BOM_STROBE	_PIN_E3	//dio1
90

  
91
#define BOM_DATA	_PIN_A0 //servo0
92
#define BOM_CLOCK	_PIN_A1	//servo1
93

  
94
#define BOM_S0		_PIN_E5	//dio3
95
#define BOM_S1		_PIN_E4	//dio2
96
#define BOM_S2		_PIN_E7	//dio4
97
#define BOM_S3		_PIN_E6	//dio5
98
#define BOM_OUT		PF0		//analog(yellow)
99

  
100
/**
101
 * @defgroup bom BOM (Bearing and Orientation Module)
102
 * @brief Functions for dealing with the BOM.
103
 *
104
 * The Bearing and Orientation Module / Barrel of Monkeys / BOM
105
 * is a custom sensor designed and built by the Colony Project.
106
 * It consists of a ring of 16 IR emitters and 16 IR detectors.
107
 * The BOM is most often use to determine the direction of other
108
 * robots. This module contains functions for controlling the BOM.
109
 *
110
 * Include bom.h to access these functions.
111
 *
112
 * @{
113
 **/
114

  
115
static unsigned int bom_val[NUM_BOM_LEDS];
116
static volatile char bom_type = BOM10;
117
static int select_pins[4];
118
static int analog_pin;
119

  
120
/**
121
 * Initializes the BOM.
122
 * Call bom_init before reading bom values or turning bom leds.
123
 *
124
 * @bugs INCOMPLETE - No utilization of BOM1.5 RSSI capability. Probably leave this out
125
 * until Cornell and Pras return
126
 * 
127
 * @see bom_refresh, bom_leds_on, bom_leds_off
128
 **/
129
void bom_init(char type) {
130
    bom_type = type;
131
    
132
    switch(bom_type) {
133
    case BOM10:
134
		select_pins[0] = MONK0; 
135
		select_pins[1] = MONK1;
136
		select_pins[2] = MONK2;
137
		select_pins[3] = MONK3;
138
		analog_pin = MONKI;
139
        break;
140
    case BOM15:
141
        //Sets BOM1.5 to normal [BOM] mode
142
        digital_output(BOM_MODE, 0);
143
		select_pins[0] = BOM_S0; 
144
		select_pins[1] = BOM_S1;
145
		select_pins[2] = BOM_S2;
146
		select_pins[3] = BOM_S3;
147
		bom_set_leds(BOM_ALL);
148
		analog_pin = BOM_OUT;
149
        break;
150
    case RBOM:
151
        break;
152
    //default:
153
    }
154
}
155

  
156
/**
157
 * Iterates through each bit in the bit_field. For each set bit, sets the corresponding bom select bits
158
 *    and updates the corresponding bom value with an analog_get8 reading.  analog_init and bom_init
159
 *    must be called for this to work. Must call this before reading BOM values!
160
 *
161
 *
162
 * @param bit_field specifies which elements in bom_val[] should be updated. Use BOM_ALL to refresh all values.
163
 *    Ex. if 0x0003 is passed, bom_val[0] and bom_val[1] will be updated.
164
 *
165
 * @see bom_get
166
 **/
167
void bom_refresh(int bit_field) {
168
    int i;
169
	int loop_was_running = 0;
170
    
171
	//Check analog loop status
172
    if(analog_loop_status() == ADC_LOOP_RUNNING) {
173
		loop_was_running = 1;
174
		analog_stop_loop();
175
	}
176
    
177
	//Read BOM values
178
    for(i = 0; i < NUM_BOM_LEDS; i++) {
179
        if(bit_field & 0x1) {
180
            bom_select(i);
181
            bom_val[i] = analog_get8(analog_pin);
182
        }
183
        bit_field = bit_field >> 1;
184
    }
185
    
186
	//Restore analog loop status
187
	if(loop_was_running)
188
		analog_start_loop();
189
}
190

  
191
/**
192
 * Gets the bom reading from bom_val[which].  Call bom_refresh beforehand to read new bom values.
193
 *
194
 * @pre must call bom refresh first
195
 *
196
 * @param which which bom value to return
197
 *
198
 * @return the bom value
199
 *
200
 * see bom_refresh
201
 **/
202
int bom_get(int which) {
203
    return bom_val[which];
204
}
205

  
206
/** 
207
 * Compares all the values in bom_val[] and returns the index to the lowest (max) value element.
208
 *
209
 * @pre must call bom refresh
210
 * @return index to the lowest (max) bom value element.  -1 if no value is lower than
211
 *    BOM_VALUE_THRESHOLD
212
 **/
213
int bom_get_max(void) {
214
    int i, lowest_val, lowest_i;
215
    lowest_i = -1;
216
    lowest_val = 255;
217
    for(i = 0; i < NUM_BOM_LEDS; i++) {
218
        if(bom_val[i] < lowest_val) {
219
            lowest_val = bom_val[i];
220
            lowest_i = i;
221
        }
222
    }
223
    
224
    if(lowest_val < BOM_VALUE_THRESHOLD)
225
        return lowest_i;
226
    else
227
        return -1;
228
}
229

  
230
/** 
231
 * Print a histogram which shows the current BOM intensity values for each of the 16 BOM IR
232
 *		sensors. The function will attempt to send the histogram data over USB.
233
 *
234
 * @param curBOMvals  Pointer to an array of the current BOM values. Use this to print values
235
 *		you have already collected. Otherwise pass in NULL and bom_refresh() will be called and
236
 *		the current BOM intensity values will be collected.
237
 **/
238
void bom_print_usb(int* curBOMvals) {
239

  
240
	int i, j, max = -1;
241
	int vals[16];
242

  
243
	if (curBOMvals) {
244

  
245
	}
246

  
247
		/* Refresh and make sure the table is updated */
248
		bom_refresh(BOM_ALL);
249
		delay_ms(100);
250

  
251
		/* Record values into an array */
252
		for (i = 0; i < 16; i++) {
253
			vals[i] = bom_get(i);
254
			if (max < vals[i])
255
				max = vals[i];
256
		}
257

  
258
		/* Display results */
259
		for (i = 0; i < 16; i++) {
260
			
261
			usb_puti(vals[i]);
262
			usb_putc('\t');
263

  
264
			for (j = 0; j < (int)((max - vals[i]) / 5); j++) {
265
				usb_putc('#');
266
			}
267

  
268
			usb_putc('\n');
269

  
270
		}
271

  
272
		usb_puts("Max: ");
273
		usb_puti(bom_get_max());
274
		usb_putc('\n');
275
		usb_putc('\n');
276

  
277
		delay_ms(400);
278

  
279
	}
280

  
281

  
282
}
283

  
284
/** 
285
 * Computes the weighted average of all the bom readings to estimate the position (and distance) of another robot.
286
 *
287
 * @pre must call bom refresh
288
 * @param dist  pointer to int in which to return the estimated distance to the other robot
289
 * @return estimated position of the max bom value element as a fixed point value analogous to 10 times the
290
 *        index of the max bom value.  -1 if no value is lower than BOM_VALUE_THRESHOLD.
291
 **/
292
int bom_get_max10(int *dist) {
293
    int i, max;
294
    long long mean = 0, sum = 0;
295

  
296
    max = bom_get_max();
297
    if (max < 0)
298
    {
299
        if (dist)
300
        {
301
            *dist = -1;
302
        }
303
        return -1;
304
    }
305
    /* Record values into an array */
306
    for (i = 0; i < NUM_BOM_LEDS; i++) {
307
        int idx = ((i + (NUM_BOM_LEDS/2 - max) + NUM_BOM_LEDS) % NUM_BOM_LEDS) - (NUM_BOM_LEDS/2 - max);
308
        int val = 255 - bom_val[i];
309
        mean += idx * val;
310
        sum += val;
311
    }
312
    mean = (mean * 10) / sum;
313
    mean = (mean + NUM_BOM_LEDS*10) % (NUM_BOM_LEDS*10);
314

  
315
    if (dist)
316
    {
317
        *dist = 50 - sum/48;
318
    }
319

  
320
    return mean;
321
}
322

  
323
/**
324
 * Iterates through each bit in the bit_field. If the bit is set, the corresponding emitter will
325
 *    be enabled to turn on when bom_on() is called.
326
 *    bom_init must be called for this to work. Does nothing if a BOM1.0 is installed
327
 *
328
 * @param bit_field specifies which leds should be turned on when bom_on is called.  Use BOM_ALL to turn on all bom leds.
329
 *    Ex. if 0x0005 is passed, leds 0 and 2 will be turned on.
330
 **/
331
void bom_set_leds(int bit_field) {
332
    int i;
333
	unsigned int mask = 1<<(NUM_BOM_LEDS-1);
334
	switch(bom_type) {
335
    case BOM10:
336
        //TODO: put an assert here to alert the user that this should not be called
337
        break;
338
		
339
    case BOM15:
340
	    for(i=NUM_BOM_LEDS; i>0; i--)
341
	    {
342
		    //set the current bit, sending MSB first
343
		    digital_output(BOM_DATA, bit_field&mask);
344
		    //then pulse the clock
345
		    digital_output(BOM_CLOCK, 1);
346
		    digital_output(BOM_CLOCK, 0);
347
			mask = mask>>1;
348
	    }
349
        break;
350
		
351
    case RBOM:
352
        //add rbom code here
353
        break;
354
    }
355
}
356

  
357

  
358
/**
359
 * (DEPRECATED) Returns the direction of the maximum BOM reading,
360
 * as an integer in the range 0-15. 0 indicates to the
361
 * robot's right, while the rest of the sensors are
362
 * numbered counterclockwise. This is useful for determining
363
 * the direction of a robot flashing its BOM, of only one
364
 * robot is currently doing so. analog_init must be called
365
 * before this function can be used.
366
 *
367
 * @return the direction of the maximum BOM reading
368
 *
369
 * @see analog_init
370
 **/
371
int get_max_bom(void) {
372
    bom_refresh(BOM_ALL);
373
    return bom_get_max();
374
}
375

  
376
/**
377
 * Flashes the BOM.  If using a BOM1.5, only the emitters that have been enabled using
378
 * bom_set_leds will turn on.
379
 * 
380
 * @see bom_off, bom_set_leds
381
 **/
382
void bom_on(void)
383
{
384
  switch(bom_type) {
385
  case BOM10:
386
	digital_output(MONKL, 1);
387
	break;
388
  case BOM15:
389
	digital_output(BOM_STROBE, 1);
390
	break;
391
  case RBOM:
392
	break;
393
  }
394
}
395

  
396
/**
397
 * Turns off all bom leds.
398
 * 
399
 * @see bom_on
400
 **/
401
void bom_off(void)
402
{
403
  switch(bom_type) {
404
  case BOM10:
405
	digital_output(MONKL, 0);
406
	break;
407
  case BOM15:
408
	digital_output(BOM_STROBE, 0);
409
	break;
410
  case RBOM:
411
	break;
412
  }
413
}
414

  
415
/** @} **/ //end group
416

  
417
//select a detector to read
418
static void bom_select(char which) {
419
	if(bom_type == BOM10)
420
	  which = lookup[(int)which];
421
	
422
    if (which&8)
423
      digital_output(select_pins[3], 1);
424
    else
425
      digital_output(select_pins[3], 0);
426

  
427
    if (which&4)
428
      digital_output(select_pins[2], 1);
429
    else
430
      digital_output(select_pins[2], 0);
431

  
432
    if (which&2)
433
      digital_output(select_pins[1], 1);
434
    else
435
      digital_output(select_pins[1], 0);
436

  
437
    if (which&1)
438
      digital_output(select_pins[0], 1);
439
    else
440
      digital_output(select_pins[0], 0);
441
	
442
}

Also available in: Unified diff