Statistics
| Branch: | Tag: | Revision:

amiro-os / include / amiro / Constants.h @ 0291dfd7

History | View | Annotate | Download (8.9 KB)

1 58fe0e0b Thomas Schöpping
#ifndef AMIRO_CONSTANTS_H_
2
#define AMIRO_CONSTANTS_H_
3
4
/*! \brief Constants regarding the AMiRo platform
5
 *
6
 *  This header contains constant variables
7
 *  regarding the AMiRo platform, which means that
8
 *  these values do not change during runtime.
9
 *  Constants are e.g. physical ones like seconds per minute
10
 *  or geometrical ones like the circumference of wheel.
11
 *  All physical constants (therefore all values with a
12
 *  physical unit) are implicitly in µ iff the variable
13
 *  is of type integer, unless it is explicitly named in
14
 *  the variable.
15
 *  All physical constants (therefore all values with a
16
 *  physical unit) are implicitly without prefix (e.g. µ)
17
 *  iff the variable is of type float, unless it is
18
 *  explicitly named in the variable. The SI prefix is
19
 *  used, iff the variable is of type float and therefor
20
 *  in SI units.
21
 */
22
23
#include <math.h>
24
#include <stdint.h>
25
26
/* CAN_* defines start */
27
28
/** \brief Controller Area Network specific defines
29
 *
30
 * These CAN_* defines are used in ControllerAreaNetworkRx.h
31
 * and ControllerAreaNetworkTx.h
32
 */
33
34
/* CAN_* defines end */
35
36
namespace amiro {
37
38 0291dfd7 galberding
  enum msg_content : uint8_t{
39
      MSG_STOP = 0, 
40
      MSG_START = 1,
41
      MSG_EDGE_LEFT = 2,
42
      MSG_EDGE_RIGHT = 3,
43
      MSG_FUZZY = 4,
44
      MSG_DOCK = 5,
45
      MSG_UNDOCK = 6,
46
      MSG_CHARGE = 7,
47
      MSG_RESET_ODOMETRY = 8,
48
      MSG_CALIBRATE_BLACK = 9,
49
      MSG_CALIBRATE_WHITE = 10
50
    };
51 19a69797 galberding
52 58fe0e0b Thomas Schöpping
namespace CAN {
53
54 dd47d655 galberding
  const uint32_t UPDATE_PERIOD        = US2ST(10000);  // 100 Hz
55 58fe0e0b Thomas Schöpping
56
  const uint32_t PERIODIC_TIMER_ID         = 1;
57
  const uint32_t RECEIVED_ID               = 2;
58
59
  const uint32_t BOARD_ID_SHIFT            = 0x00u;
60
  const uint32_t BOARD_ID_MASK             = 0x07u;
61
  const uint32_t DEVICE_ID_SHIFT           = 0x03u;
62
  const uint32_t DEVICE_ID_MASK            = 0xFFu;
63
  const uint32_t INDEX_ID_SHIFT            = 0x03u;
64
  const uint32_t INDEX_ID_MASK             = 0x07u;
65
66
  const uint32_t DI_WHEEL_DRIVE_ID         = 1;
67
  const uint32_t POWER_MANAGEMENT_ID       = 2;
68
  const uint32_t LIGHT_RING_ID             = 3;
69
  const uint32_t COGNITION                 = 4;
70
71 b4885314 Thomas Schöpping
  const uint32_t MAGNETOMETER_X_ID         = 0x54;
72
  const uint32_t MAGNETOMETER_Y_ID         = 0x55;
73
  const uint32_t MAGNETOMETER_Z_ID         = 0x56;
74
  const uint32_t GYROSCOPE_ID              = 0x58;
75 58fe0e0b Thomas Schöpping
  const uint32_t PROXIMITY_FLOOR_ID        = 0x51;
76
  const uint32_t ODOMETRY_ID               = 0x50;
77
  const uint32_t BRIGHTNESS_ID             = 0x40;
78
  inline constexpr uint32_t COLOR_ID(uint32_t index)             {return 0x38 | ((index) & 0x7);}
79
  inline constexpr uint32_t PROXIMITY_RING_ID(uint32_t index)    {return 0x30 | ((index) & 0x7);}
80 beb4f137 galberding
  // Charging
81
  const uint32_t REQUEST_CHARGING_OVER_PIN = 0x25;
82
83
  // Line following
84 98e7c69b galberding
  const uint32_t TRANSMIT_LINE_FOLLOW_STATE= 0x19;
85 f3972840 galberding
  const uint32_t SET_LINE_FOLLOW_MSG       = 0x24;
86 25388c2f Georg Alberding
  const uint32_t SET_LINE_FOLLOW_SPEED     = 0x23;
87 58fe0e0b Thomas Schöpping
  const uint32_t SET_KINEMATIC_CONST_ID    = 0x22;
88
  const uint32_t TARGET_POSITION_ID        = 0x21;
89
  const uint32_t ACTUAL_SPEED_ID           = 0x20;
90
  const uint32_t SET_ODOMETRY_ID           = 0x12;
91
  const uint32_t TARGET_RPM_ID             = 0x11;
92
  const uint32_t TARGET_SPEED_ID           = 0x10;
93
  const uint32_t POWER_STATUS_ID           = 0x60;
94
  const uint32_t ROBOT_ID                  = 0x48;
95
  inline constexpr uint32_t SHELL_QUERY_ID(uint8_t index)        {return 0x70 | ((index) & 0x7);}
96
  inline constexpr uint32_t SHELL_REPLY_ID(uint8_t index)        {return 0x78 | ((index) & 0x7);}
97
  const uint32_t BROADCAST_SHUTDOWN        = 0x80u;
98
99
  const uint32_t CALIBRATE_PROXIMITY_FLOOR = 0x81u;
100
  const uint32_t CALIBRATE_PROXIMITY_RING  = 0x82u;
101
102
  const uint32_t SHUTDOWN_MAGIC            = 0xAA55u;
103
}
104
105
namespace constants {
106
107
  /** \brief Amount of seconds per minute */
108
  const int32_t secondsPerMinute = 60;
109
110
  /** \brief Amount of minutes per hour */
111
  const int32_t minutesPerHour = 60;
112
113
  /** \brief Amount of milliseconds per second */
114
  const int32_t millisecondsPerSecond = 1000;
115
116
  /* Several definitions of PI */
117
  constexpr float    PI   = float(M_PI);                /**< PI approximated with single precision floating point */
118
  constexpr uint32_t PIe9 = (M_PI * 1000000000) + 0.5f; /**< PI approximated with 32-bit integer and multiplied by factor 1e9 */
119
  constexpr uint32_t PIe6 = (M_PI * 1000000) + 0.5f;    /**< PI approximated with 32-bit integer and multiplied by factor 1e6 */
120
  constexpr uint16_t PIe3 = (M_PI * 1000) + 0.5f;       /**< PI approximated with 16-bit integer and multiplied by factor 1e3 */
121
  constexpr uint16_t PIe2 = (M_PI * 100) + 0.5f;        /**< PI approximated with 16-bit integer and multiplied by factor 1e2 */
122
  constexpr uint8_t  PIe1 = (M_PI * 10) + 0.5f;         /**< PI approximated with 8-bit integer and multiplied by factor 1e1 */
123
  constexpr uint8_t  PIe0 = (M_PI * 1) + 0.5f;          /**< PI approximated with 8-bit integer and multiplied by factor 1e0 */
124
125
namespace LightRing {
126
127
  /** \brief Index of the top LEDs
128
   *
129
   * Top view of the AMiRo top LEDs and their indices:
130
   *   _______
131
   *  / 7 F 0 \
132
   * |6       1|
133
   * |5       2|
134
   *  \_4_B_3_/
135
   */
136
  enum ledIndex : uint8_t {
137
    LED_BL = 4, LED_BACK_LEFT = 4, LED_SSW = 4, LED_SOUTH_SOUTHWEST = 4,
138
    LED_LB = 5, LED_LEFT_BACK = 5, LED_WSW = 5, LED_WEST_SOUTHWEST = 5,
139
    LED_LF = 6, LED_LEFT_FRONT = 6, LED_WNW = 6, LED_WEST_NORTHWEST = 6,
140
    LED_FL = 7, LED_FRONT_LEFT = 7, LED_NNW = 7, LED_NORTH_NORTHWEST = 7,
141
    LED_FR = 0, LED_FRONT_RIGHT = 0, LED_NNE = 0, LED_NORTH_NORTHEAST = 0,
142
    LED_RF = 1, LED_RIGHT_FRONT = 1, LED_ENE = 1, LED_EAST_NORTHEAST = 1,
143
    LED_RB = 2, LED_RIGHT_BACK = 2, LED_ESE = 2, LED_EAST_SOUTHEAST = 2,
144
    LED_BR = 3, LED_BACK_RIGHT = 3, LED_SSE = 3, LED_SOUTH_SOUTHEAST = 3
145
  };
146
}
147
148
namespace DiWheelDrive {
149
150
  /** \brief Distance between wheels in meter */
151
  const float wheelBaseDistanceSI = 0.069f;
152
153
  /** \brief Distance between wheels in micrometer */
154
  const int32_t wheelBaseDistance = wheelBaseDistanceSI * 1e6;
155
156
  /** \brief Wheel diameter in meter */
157
  const float wheelDiameterSI = 0.05571f;
158
159
  /** \brief Wheel diameter */
160
  const int32_t wheelDiameter = wheelDiameterSI * 1e6;
161
162
  /** \brief Wheel circumference in meter */
163
  const float wheelCircumferenceSI = M_PI * wheelDiameterSI;
164
165
  /** \brief Wheel circumference in micrometer */
166
  const int32_t wheelCircumference = wheelCircumferenceSI * 1e6;
167
168
  /** \brief Wheel error in meter (topview left:0, right:1) */
169
  const float wheelErrorSI[2] = {0.1, 0.1};
170
171
  /** \brief Wheel error in meter (topview left:0, right:1) */
172
  const int32_t wheelError[2] = {(int32_t) (wheelErrorSI[0] * 1e6), (int32_t) (wheelErrorSI[1] * 1e6)};
173
174
  /** \brief Motor increments per revolution
175
   *
176
   *  The increments are produced by 2 channels á 16
177
   *  pulses per revolution with respect to the rising
178
   *  and falling signal => 2*2*16 pulses/revolution.
179
   *  The gearbox is 22:1 => 2*2*16*22 pulses/revolution
180
   */
181
  const int32_t incrementsPerRevolution = 2 * 2 * 16 * 22;
182
183
  /** \brief Index of the proximity sensors
184
   *
185
   * Bottom view of the AMiRo sensors and their indices (F:Front, B:Back):
186
   *  _____
187
   * / 0F3 \
188
   * |1   2|
189
   * \__B__/
190
   */
191
  enum proximitySensorIdx : uint8_t {
192
    PROX_WL = 2, PROX_LW = 2, PROX_WHEEL_LEFT = 2, PROX_LEFT_WHEEL = 2,
193
    PROX_FL = 3, PROX_LF = 3, PROX_FRONT_LEFT = 3, PROX_LEFT_FRONT = 3,
194
    PROX_FR = 0, PROX_RF = 0, PROX_FRONT_RIGHT = 0, PROX_RIGHT_FRONT = 0,
195
    PROX_WR = 1, PROX_RW = 1, PROX_WHEEL_RIGHT = 1, PROX_RIGHT_WHEEL = 1,
196
  };
197
198
  /** \brief Index of the wheels
199
   *
200
   * Top view of the AMiRo wheels and their indices (F:Front, B:Back):
201
   *   ____
202
   * /| F |\
203
   * |0   1|
204
   * \|_B_|/
205
   */
206
  enum wheelIdx : uint8_t {
207
    WHEEL_L = 0, WHEEL_LEFT = 0, LEFT_WHEEL = 0,
208
    WHEEL_R = 1, WHEEL_RIGHT = 1, RIGHT_WHEEL = 1,
209
  };
210 19a69797 galberding
211
212 58fe0e0b Thomas Schöpping
}
213
214 19a69797 galberding
215
216 58fe0e0b Thomas Schöpping
namespace PowerManagement {
217
218
  /** \brief Index of the proximity sensors
219
   *
220
   * Top view of the AMiRo sensors and their indices:
221
   *   _______
222
   *  / 3 F 4 \
223
   * |2       5|
224
   * |1       6|
225
   *  \_0_B_7_/
226
   */
227
  enum proximitySensorIdx : uint8_t {
228
    PROX_BL = 0, PROX_BACK_LEFT = 0, PROX_SSW = 0, PROX_SOUTH_SOUTHWEST = 0,
229
    PROX_LB = 1, PROX_LEFT_BACK = 1, PROX_WSW = 1, PROX_WEST_SOUTHWEST = 1,
230
    PROX_LF = 2, PROX_LEFT_FRONT = 2, PROX_WNW = 2, PROX_WEST_NORTHWEST = 2,
231
    PROX_FL = 3, PROX_FRONT_LEFT = 3, PROX_NNW = 3, PROX_NORTH_NORTHWEST = 3,
232
    PROX_FR = 4, PROX_FRONT_RIGHT = 4, PROX_NNE = 4, PROX_NORTH_NORTHEAST = 4,
233
    PROX_RF = 5, PROX_RIGHT_FRONT = 5, PROX_ENE = 5, PROX_EAST_NORTHEAST = 5,
234
    PROX_RB = 6, PROX_RIGHT_BACK = 6, PROX_ESE = 6, PROX_EAST_SOUTHEAST = 6,
235
    PROX_BR = 7, PROX_BACK_RIGHT = 7, PROX_SSE = 7, PROX_SOUTH_SOUTHEAST = 7
236
  };
237
238
  /** \brief Index of the batteries.
239
   *
240
   * The port names are printed on the PCB.
241
   */
242
  enum batteryPortIdx : uint8_t {
243
    BAT_P7 = 0, BAT_A = 0,
244
    BAT_P8 = 1, BAT_B = 1
245
  };
246
247
  /** \brief Index of the power monitors.
248
   */
249
  enum powerMonitorIdx : uint8_t {
250
    INA_VDD = 0,
251
    INA_VIO18 = 1,
252
    INA_VIO33 = 2,
253
    INA_VIO42 = 3,
254
    INA_VIO50 = 4
255
  };
256
}
257
258
}
259
260
}
261
262 f3972840 galberding
#endif /* AMIRO_CONSTANTS_H_ */