src/main/io/osd.h

   1 /*
   2  * This file is part of Cleanflight.
   3  *
   4  * Cleanflight 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 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * Cleanflight 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 Cleanflight.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #pragma once
  19
  20 #include "common/time.h"
  21 #include "config/parameter_group.h"
  22
  23 #define OSD_TASK_FREQUENCY_HZ   100
  24
  25 #define VISIBLE_FLAG  0x0800
  26 #define BLINK_FLAG    0x0400
  27 #define VISIBLE(x)    (x & VISIBLE_FLAG)
  28 #define BLINK(x)      ((x & BLINK_FLAG) && blinkState)
  29 #define BLINK_OFF(x)  (x & ~BLINK_FLAG)
  30 #define OSD_POS_MAX   0x3FF
  31 #define OSD_POS_MAX_CLI   (OSD_POS_MAX | VISIBLE_FLAG | BLINK_FLAG)
  32
  33 typedef enum {
  34     OSD_RSSI_VALUE,
  35     OSD_MAIN_BATT_VOLTAGE,
  36     OSD_CROSSHAIRS,
  37     OSD_ARTIFICIAL_HORIZON,
  38     OSD_HORIZON_SIDEBARS,
  39     OSD_ONTIME,
  40     OSD_FLYTIME,
  41     OSD_FLYMODE,
  42     OSD_CRAFT_NAME,
  43     OSD_THROTTLE_POS,
  44     OSD_VTX_CHANNEL,
  45     OSD_CURRENT_DRAW,
  46     OSD_MAH_DRAWN,
  47     OSD_GPS_SPEED,
  48     OSD_GPS_SATS,
  49     OSD_ALTITUDE,
  50     OSD_ROLL_PIDS,
  51     OSD_PITCH_PIDS,
  52     OSD_YAW_PIDS,
  53     OSD_POWER,
  54     OSD_GPS_LON,
  55     OSD_GPS_LAT,
  56     OSD_HOME_DIR,
  57     OSD_HOME_DIST,
  58     OSD_HEADING,
  59     OSD_VARIO,
  60     OSD_VARIO_NUM,
  61     OSD_ITEM_COUNT // MUST BE LAST
  62 } osd_items_e;
  63
  64 typedef enum {
  65     OSD_UNIT_IMPERIAL,
  66     OSD_UNIT_METRIC
  67 } osd_unit_e;
  68
  69 typedef struct osdConfig_s {
  70     uint16_t item_pos[OSD_ITEM_COUNT];
  71
  72     // Alarms
  73     uint8_t rssi_alarm;
  74     uint16_t cap_alarm;
  75     uint16_t time_alarm;
  76     uint16_t alt_alarm;
  77
  78     uint8_t video_system;
  79     uint8_t row_shiftdown;
  80
  81     osd_unit_e units;
  82 } osdConfig_t;
  83
  84 PG_DECLARE(osdConfig_t, osdConfig);
  85
  86 void osdInit(void);
  87 void osdResetAlarms(void);
  88 void osdUpdate(timeUs_t currentTimeUs);