Statistics
| Branch: | Tag: | Revision:

amiro-os / include / amiro / Constants.h @ ab2f0120

History | View | Annotate | Download (8.66 KB)

1
#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
namespace CAN {
39

    
40
  // const uint32_t UPDATE_PERIOD        = US2ST(62500);  // 16 Hz
41
  // const uint32_t UPDATE_PERIOD        = US2ST(15625);  // 64 Hz
42
  const uint32_t UPDATE_PERIOD        = US2ST(10000);  // 100 Hz
43
  // const uint32_t UPDATE_PERIOD        = US2ST(8000);  // 125 Hz
44

    
45
  const uint32_t PERIODIC_TIMER_ID         = 1;
46
  const uint32_t RECEIVED_ID               = 2;
47

    
48
  const uint32_t BOARD_ID_SHIFT            = 0x00u;
49
  const uint32_t BOARD_ID_MASK             = 0x07u;
50
  const uint32_t DEVICE_ID_SHIFT           = 0x03u;
51
  const uint32_t DEVICE_ID_MASK            = 0xFFu;
52
  const uint32_t INDEX_ID_SHIFT            = 0x03u;
53
  const uint32_t INDEX_ID_MASK             = 0x07u;
54

    
55
  const uint32_t DI_WHEEL_DRIVE_ID         = 1;
56
  const uint32_t POWER_MANAGEMENT_ID       = 2;
57
  const uint32_t LIGHT_RING_ID             = 3;
58
  const uint32_t COGNITION                 = 4;
59

    
60
  const uint32_t MAGNETOMETER_X_ID         = 0x54;
61
  const uint32_t MAGNETOMETER_Y_ID         = 0x55;
62
  const uint32_t MAGNETOMETER_Z_ID         = 0x56;
63
  const uint32_t GYROSCOPE_ID              = 0x58;
64
  const uint32_t PROXIMITY_FLOOR_ID        = 0x51;
65
  const uint32_t ODOMETRY_ID               = 0x50;
66
  const uint32_t BRIGHTNESS_ID             = 0x40;
67
  inline constexpr uint32_t COLOR_ID(uint32_t index)             {return 0x38 | ((index) & 0x7);}
68
  inline constexpr uint32_t PROXIMITY_RING_ID(uint32_t index)    {return 0x30 | ((index) & 0x7);}
69
  const uint32_t SET_LINE_FOLLOW_STRATEGY  = 0x24;
70
  const uint32_t SET_LINE_FOLLOW_SPEED     = 0x23;
71
  const uint32_t SET_KINEMATIC_CONST_ID    = 0x22;
72
  const uint32_t TARGET_POSITION_ID        = 0x21;
73
  const uint32_t ACTUAL_SPEED_ID           = 0x20;
74
  const uint32_t SET_ODOMETRY_ID           = 0x12;
75
  const uint32_t TARGET_RPM_ID             = 0x11;
76
  const uint32_t TARGET_SPEED_ID           = 0x10;
77
  const uint32_t POWER_STATUS_ID           = 0x60;
78
  const uint32_t ROBOT_ID                  = 0x48;
79
  inline constexpr uint32_t SHELL_QUERY_ID(uint8_t index)        {return 0x70 | ((index) & 0x7);}
80
  inline constexpr uint32_t SHELL_REPLY_ID(uint8_t index)        {return 0x78 | ((index) & 0x7);}
81
  const uint32_t BROADCAST_SHUTDOWN        = 0x80u;
82

    
83
  const uint32_t CALIBRATE_PROXIMITY_FLOOR = 0x81u;
84
  const uint32_t CALIBRATE_PROXIMITY_RING  = 0x82u;
85

    
86
  const uint32_t SHUTDOWN_MAGIC            = 0xAA55u;
87
}
88

    
89
namespace constants {
90

    
91
  /** \brief Amount of seconds per minute */
92
  const int32_t secondsPerMinute = 60;
93

    
94
  /** \brief Amount of minutes per hour */
95
  const int32_t minutesPerHour = 60;
96

    
97
  /** \brief Amount of milliseconds per second */
98
  const int32_t millisecondsPerSecond = 1000;
99

    
100
  /* Several definitions of PI */
101
  constexpr float    PI   = float(M_PI);                /**< PI approximated with single precision floating point */
102
  constexpr uint32_t PIe9 = (M_PI * 1000000000) + 0.5f; /**< PI approximated with 32-bit integer and multiplied by factor 1e9 */
103
  constexpr uint32_t PIe6 = (M_PI * 1000000) + 0.5f;    /**< PI approximated with 32-bit integer and multiplied by factor 1e6 */
104
  constexpr uint16_t PIe3 = (M_PI * 1000) + 0.5f;       /**< PI approximated with 16-bit integer and multiplied by factor 1e3 */
105
  constexpr uint16_t PIe2 = (M_PI * 100) + 0.5f;        /**< PI approximated with 16-bit integer and multiplied by factor 1e2 */
106
  constexpr uint8_t  PIe1 = (M_PI * 10) + 0.5f;         /**< PI approximated with 8-bit integer and multiplied by factor 1e1 */
107
  constexpr uint8_t  PIe0 = (M_PI * 1) + 0.5f;          /**< PI approximated with 8-bit integer and multiplied by factor 1e0 */
108

    
109
namespace LightRing {
110

    
111
  /** \brief Index of the top LEDs
112
   *
113
   * Top view of the AMiRo top LEDs and their indices:
114
   *   _______
115
   *  / 7 F 0 \
116
   * |6       1|
117
   * |5       2|
118
   *  \_4_B_3_/
119
   */
120
  enum ledIndex : uint8_t {
121
    LED_BL = 4, LED_BACK_LEFT = 4, LED_SSW = 4, LED_SOUTH_SOUTHWEST = 4,
122
    LED_LB = 5, LED_LEFT_BACK = 5, LED_WSW = 5, LED_WEST_SOUTHWEST = 5,
123
    LED_LF = 6, LED_LEFT_FRONT = 6, LED_WNW = 6, LED_WEST_NORTHWEST = 6,
124
    LED_FL = 7, LED_FRONT_LEFT = 7, LED_NNW = 7, LED_NORTH_NORTHWEST = 7,
125
    LED_FR = 0, LED_FRONT_RIGHT = 0, LED_NNE = 0, LED_NORTH_NORTHEAST = 0,
126
    LED_RF = 1, LED_RIGHT_FRONT = 1, LED_ENE = 1, LED_EAST_NORTHEAST = 1,
127
    LED_RB = 2, LED_RIGHT_BACK = 2, LED_ESE = 2, LED_EAST_SOUTHEAST = 2,
128
    LED_BR = 3, LED_BACK_RIGHT = 3, LED_SSE = 3, LED_SOUTH_SOUTHEAST = 3
129
  };
130
}
131

    
132
namespace DiWheelDrive {
133

    
134
  /** \brief Distance between wheels in meter */
135
  const float wheelBaseDistanceSI = 0.069f;
136

    
137
  /** \brief Distance between wheels in micrometer */
138
  const int32_t wheelBaseDistance = wheelBaseDistanceSI * 1e6;
139

    
140
  /** \brief Wheel diameter in meter */
141
  const float wheelDiameterSI = 0.05571f;
142

    
143
  /** \brief Wheel diameter */
144
  const int32_t wheelDiameter = wheelDiameterSI * 1e6;
145

    
146
  /** \brief Wheel circumference in meter */
147
  const float wheelCircumferenceSI = M_PI * wheelDiameterSI;
148

    
149
  /** \brief Wheel circumference in micrometer */
150
  const int32_t wheelCircumference = wheelCircumferenceSI * 1e6;
151

    
152
  /** \brief Wheel error in meter (topview left:0, right:1) */
153
  const float wheelErrorSI[2] = {0.1, 0.1};
154

    
155
  /** \brief Wheel error in meter (topview left:0, right:1) */
156
  const int32_t wheelError[2] = {(int32_t) (wheelErrorSI[0] * 1e6), (int32_t) (wheelErrorSI[1] * 1e6)};
157

    
158
  /** \brief Motor increments per revolution
159
   *
160
   *  The increments are produced by 2 channels á 16
161
   *  pulses per revolution with respect to the rising
162
   *  and falling signal => 2*2*16 pulses/revolution.
163
   *  The gearbox is 22:1 => 2*2*16*22 pulses/revolution
164
   */
165
  const int32_t incrementsPerRevolution = 2 * 2 * 16 * 22;
166

    
167
  /** \brief Index of the proximity sensors
168
   *
169
   * Bottom view of the AMiRo sensors and their indices (F:Front, B:Back):
170
   *  _____
171
   * / 0F3 \
172
   * |1   2|
173
   * \__B__/
174
   */
175
  enum proximitySensorIdx : uint8_t {
176
    PROX_WL = 2, PROX_LW = 2, PROX_WHEEL_LEFT = 2, PROX_LEFT_WHEEL = 2,
177
    PROX_FL = 3, PROX_LF = 3, PROX_FRONT_LEFT = 3, PROX_LEFT_FRONT = 3,
178
    PROX_FR = 0, PROX_RF = 0, PROX_FRONT_RIGHT = 0, PROX_RIGHT_FRONT = 0,
179
    PROX_WR = 1, PROX_RW = 1, PROX_WHEEL_RIGHT = 1, PROX_RIGHT_WHEEL = 1,
180
  };
181

    
182
  /** \brief Index of the wheels
183
   *
184
   * Top view of the AMiRo wheels and their indices (F:Front, B:Back):
185
   *   ____
186
   * /| F |\
187
   * |0   1|
188
   * \|_B_|/
189
   */
190
  enum wheelIdx : uint8_t {
191
    WHEEL_L = 0, WHEEL_LEFT = 0, LEFT_WHEEL = 0,
192
    WHEEL_R = 1, WHEEL_RIGHT = 1, RIGHT_WHEEL = 1,
193
  };
194
}
195

    
196
namespace PowerManagement {
197

    
198
  /** \brief Index of the proximity sensors
199
   *
200
   * Top view of the AMiRo sensors and their indices:
201
   *   _______
202
   *  / 3 F 4 \
203
   * |2       5|
204
   * |1       6|
205
   *  \_0_B_7_/
206
   */
207
  enum proximitySensorIdx : uint8_t {
208
    PROX_BL = 0, PROX_BACK_LEFT = 0, PROX_SSW = 0, PROX_SOUTH_SOUTHWEST = 0,
209
    PROX_LB = 1, PROX_LEFT_BACK = 1, PROX_WSW = 1, PROX_WEST_SOUTHWEST = 1,
210
    PROX_LF = 2, PROX_LEFT_FRONT = 2, PROX_WNW = 2, PROX_WEST_NORTHWEST = 2,
211
    PROX_FL = 3, PROX_FRONT_LEFT = 3, PROX_NNW = 3, PROX_NORTH_NORTHWEST = 3,
212
    PROX_FR = 4, PROX_FRONT_RIGHT = 4, PROX_NNE = 4, PROX_NORTH_NORTHEAST = 4,
213
    PROX_RF = 5, PROX_RIGHT_FRONT = 5, PROX_ENE = 5, PROX_EAST_NORTHEAST = 5,
214
    PROX_RB = 6, PROX_RIGHT_BACK = 6, PROX_ESE = 6, PROX_EAST_SOUTHEAST = 6,
215
    PROX_BR = 7, PROX_BACK_RIGHT = 7, PROX_SSE = 7, PROX_SOUTH_SOUTHEAST = 7
216
  };
217

    
218
  /** \brief Index of the batteries.
219
   *
220
   * The port names are printed on the PCB.
221
   */
222
  enum batteryPortIdx : uint8_t {
223
    BAT_P7 = 0, BAT_A = 0,
224
    BAT_P8 = 1, BAT_B = 1
225
  };
226

    
227
  /** \brief Index of the power monitors.
228
   */
229
  enum powerMonitorIdx : uint8_t {
230
    INA_VDD = 0,
231
    INA_VIO18 = 1,
232
    INA_VIO33 = 2,
233
    INA_VIO42 = 3,
234
    INA_VIO50 = 4
235
  };
236
}
237

    
238
}
239

    
240
}
241

    
242
#endif /* AMIRO_CONSTANTS_H_ */