beeper.h

Go to the documentation of this file.

/*
 * This file is part of Ninjaflight.
 *
 * Ninjaflight is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ninjaflight is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Ninjaflight.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "system_calls.h"
#include "common/pt.h"

#include "utype/cbuf.h"

typedef enum {
    // IMPORTANT: these are in priority order, 0 = Highest
    BEEPER_NONE = 0,             
    BEEPER_GYRO_CALIBRATED,
    BEEPER_RX_LOST_LANDING,         
    BEEPER_RX_LOST,                 
    BEEPER_DISARMING,               
    BEEPER_ARMING,                  
    BEEPER_ARMING_GPS_FIX,          
    BEEPER_BAT_CRIT_LOW,            
    BEEPER_BAT_LOW,                 
    BEEPER_GPS_STATUS,              
    BEEPER_RX_SET,                  
    BEEPER_MULTI_BEEPS,             
    BEEPER_DISARM_REPEAT,           
    BEEPER_ACC_CALIBRATION,         
    BEEPER_ACC_CALIBRATION_FAIL,    
    BEEPER_READY_BEEP,              
    BEEPER_ARMED,                   
    BEEPER_MORSE,                   
} beeper_command_t;

struct beeper_entry {
    uint8_t mode;
    uint8_t priority; // 0 = Highest
    const uint8_t *sequence;
#ifdef BEEPER_NAMES
    const char *name;
#endif
} ;

struct morse_letter;
struct beeper {
    int entry_pos;
    const struct beeper_entry *cur_entry;
    int multibeeps;

    struct pt state;
    struct cbuf buffer;
    char buffer_data[16];

    const struct morse_letter *cur_letter;
    uint8_t part_idx;

    sys_millis_t timeout;
    const struct system_calls *system;
};

void beeper_init(struct beeper *self, const struct system_calls *system);
void beeper_write(struct beeper *self, const char *text);
bool beeper_start(struct beeper *self, beeper_command_t cmd);
void beeper_stop(struct beeper *self);
void beeper_update(struct beeper *self);
/*
uint32_t getArmingBeepTimeMicros(void);
beeperMode_e beeperModeForTableIndex(int idx);
const char *beeperNameForTableIndex(int idx);
int beeperTableEntryCount(void);
*/