src/main/cms/cms_menu_firmware.c

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 //
  22 // Firmware related menu contents and support functions
  23 //
  24
  25 #include <ctype.h>
  26
  27 #include <stdbool.h>
  28 #include <string.h>
  29
  30 #include "platform.h"
  31
  32 #ifdef USE_CMS
  33
  34 #include "build/version.h"
  35
  36 #include "cms/cms.h"
  37 #include "cms/cms_types.h"
  38
  39 #include "common/printf.h"
  40
  41 #include "config/config.h"
  42
  43 #include "drivers/system.h"
  44
  45 #include "fc/board_info.h"
  46 #include "fc/runtime_config.h"
  47
  48 #include "pg/board.h"
  49
  50 #include "sensors/acceleration.h"
  51 #include "sensors/barometer.h"
  52 #include "sensors/gyro.h"
  53
  54 #include "cms_menu_firmware.h"
  55
  56
  57 // Calibration
  58
  59 #define CALIBRATION_STATUS_MAX_LENGTH 6
  60
  61 #define CALIBRATION_STATUS_OFF " --- "
  62 #define CALIBRATION_STATUS_NOK " NOK "
  63 #define CALIBRATION_STATUS_WAIT "WAIT "
  64 #define CALIBRATION_STATUS_OK "  OK "
  65
  66 static char gyroCalibrationStatus[CALIBRATION_STATUS_MAX_LENGTH];
  67 #if defined(USE_ACC)
  68 static char accCalibrationStatus[CALIBRATION_STATUS_MAX_LENGTH];
  69 #endif
  70 #if defined(USE_BARO)
  71 static char baroCalibrationStatus[CALIBRATION_STATUS_MAX_LENGTH];
  72 #endif
  73
  74 static const void *cmsx_CalibrationOnDisplayUpdate(displayPort_t *pDisp, const OSD_Entry *selected)
  75 {
  76     UNUSED(pDisp);
  77     UNUSED(selected);
  78
  79     tfp_sprintf(gyroCalibrationStatus, sensors(SENSOR_GYRO) ? gyroIsCalibrationComplete() ? CALIBRATION_STATUS_OK : CALIBRATION_STATUS_WAIT: CALIBRATION_STATUS_OFF);
  80 #if defined(USE_ACC)
  81     tfp_sprintf(accCalibrationStatus, sensors(SENSOR_ACC) ? accIsCalibrationComplete() ? accHasBeenCalibrated() ? CALIBRATION_STATUS_OK : CALIBRATION_STATUS_NOK : CALIBRATION_STATUS_WAIT: CALIBRATION_STATUS_OFF);
  82 #endif
  83 #if defined(USE_BARO)
  84     tfp_sprintf(baroCalibrationStatus, sensors(SENSOR_BARO) ? baroIsCalibrationComplete() ? CALIBRATION_STATUS_OK : CALIBRATION_STATUS_WAIT: CALIBRATION_STATUS_OFF);
  85 #endif
  86
  87     return NULL;
  88 }
  89
  90 static const void *cmsCalibrateGyro(displayPort_t *pDisp, const void *self)
  91 {
  92     UNUSED(pDisp);
  93     UNUSED(self);
  94
  95     if (sensors(SENSOR_GYRO)) {
  96         gyroStartCalibration(false);
  97     }
  98
  99     return NULL;
 100 }
 101
 102 #if defined(USE_ACC)
 103 static const void *cmsCalibrateAcc(displayPort_t *pDisp, const void *self)
 104 {
 105     UNUSED(pDisp);
 106     UNUSED(self);
 107
 108     if (sensors(SENSOR_ACC)) {
 109         accStartCalibration();
 110     }
 111
 112     return MENU_CHAIN_BACK;
 113 }
 114 #endif
 115
 116 #if defined(USE_BARO)
 117 static const void *cmsCalibrateBaro(displayPort_t *pDisp, const void *self)
 118 {
 119     UNUSED(pDisp);
 120     UNUSED(self);
 121
 122     if (sensors(SENSOR_BARO)) {
 123         baroStartCalibration();
 124     }
 125
 126     return NULL;
 127 }
 128 #endif
 129
 130 #if defined(USE_ACC)
 131 static const OSD_Entry menuCalibrateAccEntries[] = {
 132     { "--- CALIBRATE ACC ---", OME_Label, NULL, NULL, 0 },
 133     { "PLACE ON A LEVEL SURFACE", OME_Label, NULL, NULL, 0},
 134     { "MAKE SURE CRAFT IS STILL", OME_Label, NULL, NULL, 0},
 135     { " ", OME_Label, NULL, NULL, 0},
 136     { "START CALIBRATION",  OME_Funcall, cmsCalibrateAcc, NULL, 0 },
 137     { "BACK", OME_Back, NULL, NULL, 0 },
 138     { NULL, OME_END, NULL, NULL, 0 }
 139 };
 140
 141 CMS_Menu cmsx_menuCalibrateAcc = {
 142 #ifdef CMS_MENU_DEBUG
 143     .GUARD_text = "ACCCALIBRATION",
 144     .GUARD_type = OME_MENU,
 145 #endif
 146     .onEnter = NULL,
 147     .onExit = NULL,
 148     .onDisplayUpdate = NULL,
 149     .entries = menuCalibrateAccEntries
 150 };
 151
 152 const void *cmsCalibrateAccMenu(displayPort_t *pDisp, const void *self)
 153 {
 154     UNUSED(self);
 155
 156     if (sensors(SENSOR_ACC)) {
 157         cmsMenuChange(pDisp, &cmsx_menuCalibrateAcc);
 158     }
 159
 160     return NULL;
 161 }
 162
 163 #endif
 164
 165 static const OSD_Entry menuCalibrationEntries[] = {
 166     { "--- CALIBRATE ---", OME_Label, NULL, NULL, 0 },
 167     { "GYRO", OME_Funcall, cmsCalibrateGyro, gyroCalibrationStatus, DYNAMIC },
 168 #if defined(USE_ACC)
 169     { "ACC",  OME_Funcall, cmsCalibrateAccMenu, accCalibrationStatus, DYNAMIC },
 170 #endif
 171 #if defined(USE_BARO)
 172     { "BARO", OME_Funcall, cmsCalibrateBaro, baroCalibrationStatus, DYNAMIC },
 173 #endif
 174     { "BACK", OME_Back, NULL, NULL, 0 },
 175     { NULL, OME_END, NULL, NULL, 0 }
 176 };
 177
 178 static CMS_Menu cmsx_menuCalibration = {
 179 #ifdef CMS_MENU_DEBUG
 180     .GUARD_text = "MENUCALIBRATION",
 181     .GUARD_type = OME_MENU,
 182 #endif
 183     .onEnter = NULL,
 184     .onExit = NULL,
 185     .onDisplayUpdate = cmsx_CalibrationOnDisplayUpdate,
 186     .entries = menuCalibrationEntries
 187 };
 188
 189 // Info
 190
 191 #if defined(USE_BOARD_INFO)
 192 static char manufacturerId[MAX_MANUFACTURER_ID_LENGTH + 1];
 193 static char boardName[MAX_BOARD_NAME_LENGTH + 1];
 194
 195 static const void *cmsx_FirmwareInit(displayPort_t *pDisp)
 196 {
 197     UNUSED(pDisp);
 198
 199     strncpy(manufacturerId, getManufacturerId(), MAX_MANUFACTURER_ID_LENGTH + 1);
 200     strncpy(boardName, getBoardName(), MAX_BOARD_NAME_LENGTH + 1);
 201
 202     return NULL;
 203 }
 204 #endif
 205
 206 static const OSD_Entry menuFirmwareEntries[] = {
 207     { "--- INFO ---", OME_Label, NULL, NULL, 0 },
 208     { "FWID", OME_String, NULL, FC_FIRMWARE_IDENTIFIER, 0 },
 209     { "FWVER", OME_String, NULL, FC_VERSION_STRING, 0 },
 210     { "GITREV", OME_String, NULL, __REVISION__, 0 },
 211     { "TARGET", OME_String, NULL, __TARGET__, 0 },
 212 #if defined(USE_BOARD_INFO)
 213     { "MFR", OME_String, NULL, manufacturerId, 0 },
 214     { "BOARD", OME_String, NULL, boardName, 0 },
 215 #endif
 216     { "--- SETUP ---", OME_Label, NULL, NULL, 0 },
 217     { "CALIBRATE",     OME_Submenu, cmsMenuChange, &cmsx_menuCalibration, 0},
 218     { "BACK", OME_Back, NULL, NULL, 0 },
 219     { NULL, OME_END, NULL, NULL, 0 }
 220 };
 221
 222 CMS_Menu cmsx_menuFirmware = {
 223 #ifdef CMS_MENU_DEBUG
 224     .GUARD_text = "MENUFIRMWARE",
 225     .GUARD_type = OME_MENU,
 226 #endif
 227 #if defined(USE_BOARD_INFO)
 228     .onEnter = cmsx_FirmwareInit,
 229 #else
 230     .onEnter = NULL,
 231 #endif
 232     .onExit = NULL,
 233     .onDisplayUpdate = NULL,
 234     .entries = menuFirmwareEntries
 235 };
 236 #endif