Project

General

Profile

Statistics
| Revision:

root / trunk / code / projects / libdragonfly / bom.c @ 1462

History | View | Annotate | Download (10.8 KB)

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 "dragonfly_defs.h"
37
#include "dio.h"
38
#include "serial.h"
39
#include "analog.h"
40
#include "bom.h"
41

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

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

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

    
61

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

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

71
*/
72

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

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

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

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

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

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

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

    
116
unsigned char bom_initd=0;
117

    
118
static unsigned int bom_val[NUM_BOM_LEDS];
119
static volatile char bom_type = BOM10;
120
static int select_pins[4];
121
static int analog_pin;
122

    
123
/**
124
 * Initializes the BOM.
125
 * Call bom_init before reading bom values or turning bom leds.
126
 *
127
 * @bugs INCOMPLETE - No utilization of BOM1.5 RSSI capability. Probably leave this out
128
 * until Cornell and Pras return
129
 *
130
 * @return 0 if init succesfull, an error code otherwise 
131
 *
132
 * @see bom_refresh, bom_leds_on, bom_leds_off
133
 **/
134
int bom_init(char type) {
135

    
136
    if(bom_initd)
137
      return ERROR_INIT_ALREADY_INITD;
138

    
139

    
140
    bom_type = type;
141
    
142
    switch(bom_type) {
143
    case BOM10:
144
                select_pins[0] = MONK0; 
145
                select_pins[1] = MONK1;
146
                select_pins[2] = MONK2;
147
                select_pins[3] = MONK3;
148
                analog_pin = MONKI;
149
        break;
150
    case BOM15:
151
        //Sets BOM1.5 to normal [BOM] mode
152
        digital_output(BOM_MODE, 0);
153
                select_pins[0] = BOM_S0; 
154
                select_pins[1] = BOM_S1;
155
                select_pins[2] = BOM_S2;
156
                select_pins[3] = BOM_S3;
157
                bom_set_leds(BOM_ALL);
158
                analog_pin = BOM_OUT;
159
        break;
160
    case RBOM:
161
        break;
162
    //default:
163
    }
164

    
165
    bom_initd=1;
166
    return 0;
167
}
168

    
169
/**
170
 * Iterates through each bit in the bit_field. For each set bit, sets the corresponding bom select bits
171
 *    and updates the corresponding bom value with an analog_get8 reading.  analog_init and bom_init
172
 *    must be called for this to work. Must call this before reading BOM values!
173
 *
174
 *
175
 * @param bit_field specifies which elements in bom_val[] should be updated. Use BOM_ALL to refresh all values.
176
 *    Ex. if 0x0003 is passed, bom_val[0] and bom_val[1] will be updated.
177
 *
178
 * @return 0 if init succesfull, an error code otherwise
179
 *
180
 * @see bom_get
181
 **/
182
int bom_refresh(int bit_field) {
183
    int i;
184
    int loop_was_running = 0;
185

    
186
    if(!bom_initd)
187
      return ERROR_LIBRARY_NOT_INITD;
188

    
189
    
190
    //Check analog loop status
191
    if(analog_loop_status() == ADC_LOOP_RUNNING) {
192
      loop_was_running = 1;
193
      analog_stop_loop();
194
    }
195
    
196
    //Read BOM values
197
    for(i = 0; i < NUM_BOM_LEDS; i++) {
198
      if(bit_field & 0x1) {
199
        bom_select(i);
200
        bom_val[i] = analog_get8(analog_pin);
201
      }
202
      bit_field = bit_field >> 1;
203
    }
204
    
205
    //Restore analog loop status
206
    if(loop_was_running)
207
      analog_start_loop();
208

    
209
    return 0;
210
}
211

    
212
/**
213
 * Gets the bom reading from bom_val[which].  Call bom_refresh beforehand to read new bom values.
214
 *
215
 * @pre must call bom refresh first
216
 *
217
 * @param which which bom value to return
218
 *
219
 * @return the bom value, -1 on error
220
 *
221
 * see bom_refresh
222
 **/
223
int bom_get(int which) {
224
    if(!bom_initd)
225
      return -1;
226

    
227
    return bom_val[which];
228
}
229

    
230
/** 
231
 * Compares all the values in bom_val[] and returns the index to the lowest (max) value element.
232
 *
233
 * @pre must call bom refresh
234
 * @return index to the lowest (max) bom value element.  -1 if no value is lower than
235
 *    BOM_VALUE_THRESHOLD, -2 if the bom is not initialized
236
 **/
237
int bom_get_max(void) {
238
    int i, lowest_val, lowest_i;
239

    
240
    if(!bom_initd)
241
      return -2;
242

    
243
    lowest_i = -1;
244
    lowest_val = 255;
245
    for(i = 0; i < NUM_BOM_LEDS; i++) {
246
        if(bom_val[i] < lowest_val) {
247
            lowest_val = bom_val[i];
248
            lowest_i = i;
249
        }
250
    }
251
    
252
    if(lowest_val < BOM_VALUE_THRESHOLD)
253
        return lowest_i;
254
    else
255
        return -1;
256
}
257

    
258
/** 
259
 * Computes the weighted average of all the bom readings to estimate the position (and distance) of another robot.
260
 *
261
 * @pre must call bom refresh
262
 * @param dist  pointer to int in which to return the estimated distance to the other robot
263
 * @return estimated position of the max bom value element as a fixed point value analogous to 10 times the
264
 *        index of the max bom value.  -1 if no value is lower than BOM_VALUE_THRESHOLD, -2 if the bom is not initialized
265
 **/
266
int bom_get_max10(int *dist) {
267
    int i, max;
268
    long long mean = 0, sum = 0;
269

    
270
    if(!bom_initd)
271
      return ERROR_LIBRARY_NOT_INITD;
272

    
273

    
274
    max = bom_get_max();
275
    if (max < 0)
276
    {
277
        if (dist)
278
        {
279
            *dist = -1;
280
        }
281
        return -1;
282
    }
283
    /* Record values into an array */
284
    for (i = 0; i < NUM_BOM_LEDS; i++) {
285
        int idx = ((i + (NUM_BOM_LEDS/2 - max) + NUM_BOM_LEDS) % NUM_BOM_LEDS) - (NUM_BOM_LEDS/2 - max);
286
        int val = 255 - bom_val[i];
287
        mean += idx * val;
288
        sum += val;
289
    }
290
    mean = (mean * 10) / sum;
291
    mean = (mean + NUM_BOM_LEDS*10) % (NUM_BOM_LEDS*10);
292

    
293
    if (dist)
294
    {
295
        *dist = 50 - sum/48;
296
    }
297

    
298
    return mean;
299
}
300

    
301
/**
302
 * Iterates through each bit in the bit_field. If the bit is set, the corresponding emitter will
303
 *    be enabled to turn on when bom_on() is called.
304
 *    bom_init must be called for this to work. Does nothing if a BOM1.0 is installed
305
 *
306
 * @param bit_field specifies which leds should be turned on when bom_on is called.  Use BOM_ALL to turn on all bom leds.
307
 *    Ex. if 0x0005 is passed, leds 0 and 2 will be turned on.
308
 *
309
 * @return 0 if init succesfull, an error code otherwise
310
 *
311
 **/
312
int bom_set_leds(int bit_field) {
313
    int i;
314
    unsigned int mask = 1<<(NUM_BOM_LEDS-1);
315

    
316
    if(!bom_initd)
317
      return ERROR_LIBRARY_NOT_INITD;
318

    
319
    switch(bom_type) {
320
    case BOM10:
321
        //TODO: put an assert here to alert the user that this should not be called
322
        break;
323
                
324
    case BOM15:
325
            for(i=NUM_BOM_LEDS; i>0; i--)
326
            {
327
                    //set the current bit, sending MSB first
328
                    digital_output(BOM_DATA, bit_field&mask);
329
                    //then pulse the clock
330
                    digital_output(BOM_CLOCK, 1);
331
                    digital_output(BOM_CLOCK, 0);
332
                        mask = mask>>1;
333
            }
334
        break;
335
                
336
    case RBOM:
337
        //add rbom code here
338
        break;
339
    }
340

    
341
    return 0;
342
}
343

    
344

    
345
/**
346
 * (DEPRECATED) Returns the direction of the maximum BOM reading,
347
 * as an integer in the range 0-15. 0 indicates to the
348
 * robot's right, while the rest of the sensors are
349
 * numbered counterclockwise. This is useful for determining
350
 * the direction of a robot flashing its BOM, of only one
351
 * robot is currently doing so. analog_init must be called
352
 * before this function can be used.
353
 *
354
 * @return the direction of the maximum BOM reading
355
 *
356
 * @see analog_init
357
 **/
358
int get_max_bom(void) {
359
    bom_refresh(BOM_ALL);
360
    return bom_get_max();
361
}
362

    
363
/**
364
 * Flashes the BOM.  If using a BOM1.5, only the emitters that have been enabled using
365
 * bom_set_leds will turn on.
366
 * 
367
 * @return 0 if init succesfull, an error code otherwise
368
 *
369
 * @see bom_off, bom_set_leds
370
 **/
371
int bom_on(void)
372
{
373
  if(!bom_initd)
374
    return ERROR_LIBRARY_NOT_INITD;
375

    
376
  switch(bom_type) {
377
  case BOM10:
378
        digital_output(MONKL, 1);
379
        break;
380
  case BOM15:
381
        digital_output(BOM_STROBE, 1);
382
        break;
383
  case RBOM:
384
        break;
385
  }
386

    
387
  return 0;
388
}
389

    
390
/**
391
 * Turns off all bom leds.
392
 * 
393
 * @return 0 if init succesfull, an error code otherwise
394
 *
395
 * @see bom_on
396
 **/
397
int bom_off(void)
398
{
399
  if(!bom_initd)
400
    return ERROR_LIBRARY_NOT_INITD;
401

    
402
  switch(bom_type) {
403
  case BOM10:
404
        digital_output(MONKL, 0);
405
        break;
406
  case BOM15:
407
        digital_output(BOM_STROBE, 0);
408
        break;
409
  case RBOM:
410
        break;
411
  }
412

    
413
  return 0;
414
}
415

    
416
/** @} **/ //end group
417

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

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

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

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