src/robofsm/robot.h

   1 /**
   2  * robot.h                      08/04/20
   3  *
   4  * Robot's data structures for the Eurobot 2008.
   5  *
   6  * Copyright: (c) 2008 CTU Dragons
   7  *            CTU FEE - Department of Control Engineering
   8  * License: GNU GPL v.2
   9  */
  10
  11 #ifndef ROBOT_H
  12 #define ROBOT_H
  13
  14 #include <stdint.h>
  15 #include <stdio.h>
  16 #include <trgenconstr.h>
  17 #include <robottype.h>
  18 #include <robottype.h>
  19 #include <roboorte_robottype.h>
  20 #include <robodim.h>
  21 #include <roboevent.h>
  22 #include <fsm.h>
  23 #include <robot_config.h>
  24 //#include <ul_log.h>
  25
  26 //UL_LOG_CUST(ulogd_robot_h); /* Log domain name = ulogd + name of the file */
  27
  28 /**
  29  * Competition parameters
  30  */
  31 enum team_color {
  32         BLUE = 0,
  33         YELLOW
  34 };
  35
  36 enum robot_start_state {
  37         POWER_ON = 0,
  38         START_PLUGGED_IN,
  39         COMPETITION_STARTED,
  40 };
  41
  42 /**
  43  * FSM
  44  */
  45
  46 /* Mapping from FSM ID to field in robot.fsm */
  47 #define ROBOT_FSM_MAIN main
  48 #define ROBOT_FSM_MOTION motion
  49 #define ROBOT_FSM_DISPLAY display
  50 #define ROBOT_FSM_ACT act
  51
  52 #define FSM_GET_BY_ID(fsm_id) (&robot.fsm.ROBOT_FSM_##fsm_id)
  53
  54 /**
  55  * LOCKING MANIPULATION
  56  */
  57
  58 #ifdef CONFIG_LOCK_CHECKING
  59 #define LOCK_CHECK_COUNT 10
  60 struct lock_log {
  61         pthread_mutex_t *locked[LOCK_CHECK_COUNT];
  62         int idx;
  63 };
  64
  65 extern struct lock_log robot_lock_log;
  66
  67 #define __LOCK_CHECK(mutex) robot_lock_log.locked[robot_lock_log.idx++] = mutex;
  68 #define __UNLOCK_CHECK(mutex)                                           \
  69         if (robot_lock_log.locked[--robot_lock_log.idx] != mutex ||     \
  70             robot_lock_log.idx < 0)                                     \
  71                 ul_logerr("!!! Locking error %s:%d\n", __FILE__, __LINE__);
  72 #else
  73 #define __LOCK_CHECK(mutex)
  74 #define __UNLOCK_CHECK(mutex)
  75 #endif
  76 /**
  77  * Locks the robot structure.
  78  * @param var Field in the structure you are going to work with.
  79  */
  80 #define ROBOT_LOCK(var)                                          \
  81         do {                                                     \
  82                 pthread_mutex_lock(&robot.__robot_lock_##var);   \
  83                 __LOCK_CHECK(&robot.__robot_lock_##var);         \
  84         } while(0)
  85
  86 /**
  87  * Unlocks the robot structure.
  88  * @param var Field in the structure, which was locked by ROBOT_LOCK.
  89  */
  90 #define ROBOT_UNLOCK(var)                                               \
  91         do {                                                            \
  92                 __UNLOCK_CHECK(&robot.__robot_lock_##var);              \
  93                 pthread_mutex_unlock(&robot.__robot_lock_##var);        \
  94         } while(0)
  95
  96 /* Mapping of robot structure fields to locks */
  97 //#define __robot_lock_ lock    /* ROBOT_LOCK() */
  98 #define __robot_lock_ref_pos            lock_ref_pos
  99 #define __robot_lock_est_pos_uzv        lock_est_pos_uzv
 100 #define __robot_lock_est_pos_odo        lock_est_pos_odo
 101 #define __robot_lock_est_pos_indep_odo  lock_est_pos_indep_odo
 102 #define __robot_lock_joy_data           lock_joy_data
 103 #define __robot_lock_meas_angles        lock_meas_angles
 104 #define __robot_lock_drives             lock
 105 #define __robot_lock_sharps             lock
 106 #define __robot_lock_hokuyo             lock
 107 #define __robot_lock_cmu                lock
 108 #define __robot_lock_bumper             lock
 109 #define __robot_lock_drives             lock
 110 #define __robot_lock_disp               lock_disp
 111 #define __robot_lock_motion_irc         lock
 112 #define __robot_lock_odo_data           lock
 113 #define __robot_lock_corr_distances     lock
 114 #define __robot_lock_camera_result      lock_camera
 115
 116 enum robot_status {
 117         STATUS_OK,
 118         STATUS_WARNING,
 119         STATUS_FAILED,
 120 };
 121
 122 enum robot_component {
 123         COMPONENT_MOTOR,
 124         COMPONENT_ODOMETRY,
 125         COMPONENT_CAMERA,
 126         COMPONENT_POWER,
 127         COMPONENT_HOKUYO,
 128         COMPONENT_START,
 129         COMPONENT_VIDLE,
 130
 131         ROBOT_COMPONENT_NUMBER
 132 };
 133
 134 /* robot's main data structure */
 135 struct robot {
 136         pthread_mutex_t lock;
 137         pthread_mutex_t lock_ref_pos;
 138         pthread_mutex_t lock_est_pos_uzv;
 139         pthread_mutex_t lock_est_pos_odo;
 140         pthread_mutex_t lock_est_pos_indep_odo;
 141         pthread_mutex_t lock_meas_angles;
 142         pthread_mutex_t lock_joy_data;
 143         pthread_mutex_t lock_disp;
 144         pthread_mutex_t lock_camera;
 145
 146         /* competition parameters */
 147         enum team_color team_color;
 148
 149         /** State variable used for controlling the robot by pluggin
 150          * in and out start connector. */
 151         enum robot_start_state start_state;
 152
 153         /** Temporary storage for new trajectory. After the trajectory creation is
 154          * finished, this trajectory is submitted to fsmmove. */
 155         void *new_trajectory;
 156
 157         unsigned char isTrajectory;
 158         sem_t start;
 159
 160         struct fsm_main_loop main_loop;
 161
 162         /* partial FSMs */
 163         struct {
 164                 struct robo_fsm main;
 165                 struct robo_fsm motion;
 166                 struct robo_fsm act;
 167         } fsm;
 168
 169         /* actual position */
 170         struct robot_pos_type ref_pos;
 171         /* estimated position */
 172         struct robot_pos_type est_pos_uzv;
 173         struct robot_pos_type est_pos_odo;
 174         struct robot_pos_type est_pos_indep_odo;
 175
 176         /** True if localization data arrives correctly and therfore
 177          * localization runs */
 178         bool localization_works;
 179         /** True if est_pos_odo is updated according to reception of motion_irc */
 180         bool odometry_works;
 181         /** True if est_pos_indep_odo is updated according to reception of motion_indep_odo */
 182         bool indep_odometry_works;
 183
 184         bool use_back_switch;
 185         bool use_left_switch;
 186         bool use_right_switch;
 187
 188         /** True iff at least one wheel rotates backward */
 189         bool moves_backward;
 190
 191         /*
 192          * sometimes H8S does not send queried odometry
 193          * following flag has been added for EKF estimator,
 194          * since is has been hardly disturbed by missing measurement
 195          * (taken as sudden zero velocities)
 196          */
 197         bool motion_irc_received;
 198
 199         /* orte */
 200         struct robottype_orte_data orte;
 201
 202         /* sensors */
 203         struct motion_irc_type motion_irc;      /* motor odometry */
 204         struct odo_data_type odo_data;          /* independent odometry */
 205         struct corr_distances_type corr_distances;      /* ultrasound */
 206
 207         struct hokuyo_scan_type hokuyo;
 208         bool ignore_hokuyo;
 209
 210         struct map *map;        /* Map for pathplanning (no locking) */
 211
 212         enum robot_status status[ROBOT_COMPONENT_NUMBER];
 213
 214         char corns_conf_center;
 215         char corns_conf_side;
 216         struct corns_group *corns;
 217
 218         bool obstacle_avoidance_enabled;
 219
 220         /** is set to true in separate thread when there is short time left */
 221         bool short_time_to_end;
 222         bool check_turn_safety;
 223 }; /* robot */
 224
 225 extern struct robot robot;
 226
 227 #ifdef __cplusplus
 228 extern "C" {
 229 #endif
 230
 231 int robot_init() __attribute__ ((warn_unused_result));
 232 int robot_start() __attribute__ ((warn_unused_result));
 233 void robot_exit();
 234 void robot_destroy();
 235
 236 void robot_get_est_pos_trans(double *x, double *y, double *phi);
 237 void robot_get_est_pos(double *x, double *y, double *phi);
 238
 239 /* Hack to easily disable display if it is not configured */
 240 void serial_comm(int status);
 241
 242
 243
 244 FSM_STATE_FULL_DECL(main, init);
 245 FSM_STATE_FULL_DECL(motion, init);
 246 FSM_STATE_FULL_DECL(disp, init);
 247 FSM_STATE_FULL_DECL(act, wait_for_command);
 248
 249 #ifdef __cplusplus
 250 }
 251 #endif
 252
 253 /*Thread priorities*/
 254 #define THREAD_PRIO_TRAJ_FOLLOWER 90    /* As high as possible */
 255 #define THREAD_PRIO_TRAJ_RECLAC 18
 256 #define OBST_FORGETING_PRIO 17  /* Priority of the thread for forgeting detected obstacles. */
 257
 258
 259
 260 #endif  /* ROBOT_H */