@betaflight/api/dist/esm/osd/types.d.ts

A high-level API to read data from betaflight flight controllers

export declare type OSDProfileConfig = {
    count: number;
    selected: number;
};
export declare type OSDTimer = {
    key: number;
    src: OSDTimerSources;
    precision: OSDPrecisionTypes;
    time: number;
};
export declare type OSDAlarm = {
    key: OSDAlarms;
    value: number;
};
export declare type OSDWarning = {
    key: OSDWarnings;
    enabled: boolean;
};
export declare type OSDPosition = {
    x: number;
    y: number;
};
export declare type OSDDisplayItem = {
    key: OSDFields;
    position: OSDPosition;
    visibilityProfiles: boolean[];
};
export declare type OSDStatisticItem = {
    key: OSDStatisticFields;
    enabled: boolean;
};
export declare type OSDFlags = {
    hasOSD: boolean;
    haveMax7456Video: boolean;
    isMax7456Detected: boolean;
    haveOsdFeature: boolean;
    isOsdSlave: boolean;
};
export declare type OSDParameters = {
    cameraFrameWidth: number;
    cameraFrameHeight: number;
    overlayRadioMode: number;
};
export declare type OSDConfig = {
    flags: OSDFlags;
    unitMode: OSDUnitTypes;
    displayItems: OSDDisplayItem[];
    statisticItems: OSDStatisticItem[];
    warnings: OSDWarning[];
    timers: OSDTimer[];
    osdProfiles: OSDProfileConfig;
    videoSystem: OSDVideoTypes;
    alarms: OSDAlarm[];
    parameters: OSDParameters;
};
export declare type OSDOtherData = {
    flags: OSDFlags;
    videoSystem: OSDVideoTypes;
    unitMode: OSDUnitTypes;
    alarms: OSDAlarm[];
    warnings: OSDWarning[];
    osdProfiles: OSDProfileConfig;
    parameters: OSDParameters;
};
export declare enum OSDWarnings {
    ARMING_DISABLED = 0,
    BATTERY_NOT_FULL = 1,
    BATTERY_WARNING = 2,
    BATTERY_CRITICAL = 3,
    VISUAL_BEEPER = 4,
    CRASH_FLIP_MODE = 5,
    ESC_FAIL = 6,
    CORE_TEMPERATURE = 7,
    RC_SMOOTHING_FAILURE = 8,
    FAILSAFE = 9,
    LAUNCH_CONTROL = 10,
    GPS_RESCUE_UNAVAILABLE = 11,
    GPS_RESCUE_DISABLED = 12,
    RSSI = 13,
    LINK_QUALITY = 14,
    RSSI_DBM = 15,
    OVER_CAP = 16,
    UNKNOWN = 17
}
export declare enum OSDTimerSources {
    ON_TIME = 0,
    TOTAL_ARMED_TIME = 1,
    LAST_ARMED_TIME = 2,
    ON_ARM_TIME = 3,
    UNKNOWN = 4
}
export declare enum OSDAlarms {
    RSSI = 0,
    CAP = 1,
    TIME = 2,
    ALT = 3
}
export declare enum OSDVideoTypes {
    AUTO = 0,
    PAL = 1,
    NTSC = 2
}
export declare enum OSDUnitTypes {
    IMPERIAL = 0,
    METRIC = 1
}
export declare enum OSDPrecisionTypes {
    SECOND = 0,
    HUNDREDTH = 1,
    TENTH = 2
}
export declare enum OSDFields {
    RSSI_VALUE = 0,
    MAIN_BATT_VOLTAGE = 1,
    CROSSHAIRS = 2,
    ARTIFICIAL_HORIZON = 3,
    HORIZON_SIDEBARS = 4,
    TIMER = 5,
    THROTTLE_POSITION = 6,
    CPU_LOAD = 7,
    VTX_CHANNEL = 8,
    VOLTAGE_WARNING = 9,
    ARMED = 10,
    DISARMED = 11,
    CURRENT_DRAW = 12,
    MAH_DRAWN = 13,
    CRAFT_NAME = 14,
    ALTITUDE = 15,
    FLYTIME = 16,
    ONTIME = 17,
    TIMER_1 = 18,
    TIMER_2 = 19,
    FLYMODE = 20,
    GPS_SPEED = 21,
    GPS_SATS = 22,
    PID_ROLL = 23,
    PID_PITCH = 24,
    PID_YAW = 25,
    POWER = 26,
    PID_RATE_PROFILE = 27,
    WARNINGS = 28,
    BATTERY_WARNING = 29,
    AVG_CELL_VOLTAGE = 30,
    GPS_LON = 31,
    GPS_LAT = 32,
    DEBUG = 33,
    PITCH_ANGLE = 34,
    ROLL_ANGLE = 35,
    MAIN_BATT_USAGE = 36,
    HOME_DIR = 37,
    HOME_DIST = 38,
    NUMERICAL_HEADING = 39,
    NUMERICAL_VARIO = 40,
    COMPASS_BAR = 41,
    ESC_TEMPERATURE = 42,
    ESC_RPM = 43,
    REMAINING_TIME_ESTIMATE = 44,
    RTC_DATE_TIME = 45,
    ADJUSTMENT_RANGE = 46,
    CORE_TEMPERATURE = 47,
    ANTI_GRAVITY = 48,
    G_FORCE = 49,
    MOTOR_DIAG = 50,
    LOG_STATUS = 51,
    FLIP_ARROW = 52,
    LINK_QUALITY = 53,
    FLIGHT_DIST = 54,
    STICK_OVERLAY_LEFT = 55,
    STICK_OVERLAY_RIGHT = 56,
    DISPLAY_NAME = 57,
    ESC_RPM_FREQ = 58,
    RATE_PROFILE_NAME = 59,
    PID_PROFILE_NAME = 60,
    OSD_PROFILE_NAME = 61,
    RSSI_DBM_VALUE = 62,
    RC_CHANNELS = 63,
    CAMERA_FRAME = 64,
    UNKNOWN = 65
}
export declare enum OSDStatisticFields {
    MAX_SPEED = 0,
    MIN_BATTERY = 1,
    MIN_RSSI = 2,
    MAX_CURRENT = 3,
    USED_MAH = 4,
    MAX_ALTITUDE = 5,
    BLACKBOX = 6,
    END_BATTERY = 7,
    TIMER_1 = 8,
    TIMER_2 = 9,
    MAX_DISTANCE = 10,
    BLACKBOX_LOG_NUMBER = 11,
    RTC_DATE_TIME = 12,
    STAT_BATTERY = 13,
    MAX_G_FORCE = 14,
    MAX_ESC_TEMP = 15,
    MAX_ESC_RPM = 16,
    MIN_LINK_QUALITY = 17,
    FLIGHT_DISTANCE = 18,
    MAX_FFT = 19,
    TOTAL_FLIGHTS = 20,
    TOTAL_FLIGHT_TIME = 21,
    TOTAL_FLIGHT_DIST = 22,
    MIN_RSSI_DBM = 23,
    UNKNOWN = 24
}