vt100: include pgmspace.h as we use PROGMEM macro
[aversive.git] / mainboard / strat_db.h
1 /*
2  *  Copyright Droids, Microb Technology (2010)
3  *
4  *  This program is free software; you can redistribute it and/or modify
5  *  it under the terms of the GNU General Public License as published by
6  *  the Free Software Foundation; either version 2 of the License, or
7  *  (at your option) any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; if not, write to the Free Software
16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  *
18  *  Revision : $Id: strat.c,v 1.6 2009-11-08 17:24:33 zer0 Exp $
19  *
20  *  Olivier MATZ <zer0@droids-corp.org>
21  */
22
23 #define WAYPOINTS_NBX 13
24 #define WAYPOINTS_NBY 8
25
26 struct corn_db {
27         /* I2C_COB_UNKNOWN, I2C_COB_WHITE, I2C_COB_BLACK */
28         uint8_t color:2;
29         uint8_t reserved:6;
30
31         /* index in corn table */
32         uint8_t idx;
33 };
34
35 struct tomato_db {
36         /* nothing for now */
37 };
38
39 /* structure describing the status of a waypoint */
40 struct waypoint_db {
41         /* type of the waypoint */
42 #define WP_TYPE_WAYPOINT 0 /* no object on it */
43 #define WP_TYPE_OBSTACLE 1 /* cannot reach this point */
44 #define WP_TYPE_TOMATO   2 /* place for a tomato */
45 #define WP_TYPE_CORN     3 /* place for a corn */
46         uint8_t type:2;
47
48         /* true if point is near the border */
49         uint8_t dangerous:1;
50
51         /* true if element is present */
52         uint8_t present:1;
53
54         /* visited by opponent */
55         uint8_t opp_visited:1;
56
57         uint8_t reserved:3;
58
59         /* absolute position of the waypoint */
60 /*      int16_t x; */
61 /*      int16_t y; */
62
63         union {
64                 struct corn_db corn;
65                 struct tomato_db tomato;
66         };
67 };
68
69 /* database reflecting the status of objects on area */
70 struct strat_db {
71         uint8_t dump_enabled;
72
73         /* table of waypoints */
74         struct waypoint_db wp_table[WAYPOINTS_NBX][WAYPOINTS_NBY];
75
76         /* corn_table: pointers to waypoints */
77         struct waypoint_db *corn_table[CORN_NB];
78
79         /* tomato_table: pointers to waypoints */
80         struct waypoint_db *tomato_table[TOMATO_NB];
81
82         /* number of oranges remaining */
83         uint8_t our_oranges_count;
84         uint8_t opp_oranges_count;
85 };
86
87 /* global structure storing the database */
88 extern struct strat_db strat_db;
89
90 /* convert i,j coords to x,y coords */
91 int8_t ijcoord_to_xycoord(uint8_t i, uint8_t j, int16_t *x, int16_t *y);
92
93 /* return the index of a corn given its i,j coords. */
94 int8_t ijcoord_to_corn_idx(uint8_t i, uint8_t j);
95
96 /* return the i,j coords of a corn given its index */
97 int8_t corn_idx_to_ijcoord(uint8_t idx, uint8_t *i, uint8_t *j);
98
99 /* return the index of a corn given its x,y coords. */
100 int8_t corn_idx_to_xycoord(uint8_t idx, int16_t *x, int16_t *y);
101
102 /* return the index of the closest corn at these coordinates. If the
103  * corn is really too far (~20cm), return NULL. The x and y pointer are
104  * updated with the real position of the corn */
105 struct waypoint_db *xycoord_to_corn_idx(int16_t *x, int16_t *y);
106
107 /* set color of a corn
108  * type is I2C_COB_BLACK, I2C_COB_WHITE, I2C_COB_UNKNOWN
109  * it will update the symetric corn if != UNKOWN
110  * it will also deduct color of some other cobs */
111 void corn_set_color(struct waypoint_db *wp, uint8_t color);
112
113 /* return the idx of the symetric corn */
114 int8_t corn_get_sym_idx(int8_t i);
115
116 /*********** TOMATO */
117
118 /* return the index of a tomato given its i,j coords. */
119 int8_t ijcoord_to_tomato_idx(uint8_t i, uint8_t j);
120
121 /* return the i,j coords of a tomato given its index */
122 int8_t tomato_idx_to_ijcoord(uint8_t idx, uint8_t *i, uint8_t *j);
123
124 /* return the index of a tomato given its x,y coords. */
125 int8_t tomato_idx_to_xycoord(uint8_t idx, int16_t *x, int16_t *y);
126
127 /* return the index of the closest tomato at these coordinates. If the
128  * tomato is really too far (~20cm), return NULL. The x and y pointer are
129  * updated with the real position of the tomato */
130 struct waypoint_db *xycoord_to_tomato_idx(int16_t *x, int16_t *y);
131
132 /*
133  * Init internal database. The initialization is done with UNKNOWN
134  * corn with all objects present
135  */
136 void strat_db_init(void);
137
138 /* dump infos about area and objects */
139 void strat_db_dump(const char *caller);