bom.h File Reference

Definitions for using the BOM. More...

Go to the source code of this file.

Defines
#define	BOM_ALL   0xFFFF
	Include all elements in the 16-bit bitfield.
#define	BOM   0
	Original BOM - No Range, No Individual LED control.
#define	BOM15   1
	BOM 1.5 - No Range, Individual LED control.
#define	RBOM   2
	RBOM - Range, Individual LED control.
Functions
void	bom_init (char type)
	Initialize the bom according to bom type.
void	bom_refresh (int bit_field)
	Refresh bom_val[] with new values from analog8. analog_init and bom_init must be called for this to work.
int	bom_get (int which)
	Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values.
int	bom_get_max (void)
	Compares all the values in bom_val[] and returns the index to the highest value element.
void	bom_leds_on (int bit_field)
	Turns on the selected bom leds. Only works with BOM_ALL if using the original bom.
void	bom_leds_off (int bit_field)
	Turns off the selected bom leds. Only works with BOM_ALL if using the original bom.
int	get_max_bom (void)
	(DEPRECATED) Wrapper function. See bom_refresh and bom_get_max
void	bom_on (void)
	(DEPRECATED) Wrapper function. See bom_leds_on.
void	bom_off (void)
	(DEPRECATED) Wrapper function. See bom_leds_off.

---

Detailed Description

Definitions for using the BOM.

Copyright (c) 2007 Colony Project

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This file contains definitions for using the Bearing and Orientation Module (BOM).

Author:

Colony Project, CMU Robotics Club