ui_screen.h

Go to the documentation of this file.

 
#pragma once
 
#include <math.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "gfx.h"
#include "touch_types.h"
#include "ui_layout.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    SCREEN_SPLASH = 0,
    SCREEN_OVERVIEW,
    SCREEN_MOTOR,
    SCREEN_SERVO,
    SCREEN_ANALYSER,
    SCREEN_LOGS,
    SCREEN_SETUP,
    SCREEN_BATTERY,
    SCREEN_BALANCE,
    SCREEN_OUTPUTS,
    SCREEN_PICKER,
    SCREEN_SUPPLY,
    /* Start-up only, and not reachable from the menu: the bus self-test
     * failed and the panel says so before anything else. */
    SCREEN_BUSFAULT,
    /* WI-FI, from LOGS and from SETUP: the panel's Wi-Fi for card
     * downloads and firmware uploads. */
    SCREEN_WIFI,
    /* While the panel writes its own firmware, and not reachable from the
     * menu: nothing on the bench runs, so it carries no band either. */
    SCREEN_UPDATE,
    /* Not reachable from the menu either: the panel opens it to offer the
     * IOmcu an update, and shows the update's progress on it. */
    SCREEN_COPROC_UPDATE,
    /* UPDATES, from SETUP: the check for a newer release on GitHub, the
     * reminder's switch, and the download. */
    SCREEN_UPDATES,
    /* Not reachable from the menu: the panel opens it on OVERVIEW when the
     * start-up check found a newer release. */
    SCREEN_UPD_REMIND,
    /* FILES, from SETUP and from LOGS: the card's folders and files in two
     * panes. */
    SCREEN_FILES,
    SCREEN_COUNT
} ui_screen_id_t;
 
typedef struct {
    const char *title;   
    void (*reset)(void);
    void (*enter)(void);
    void (*leave)(void); 
    void (*tick)(float dt_s);
    void (*event)(const touch_event_t *evt);
    void (*cancel)(void);
    void (*render)(gfx_canvas_t *c, int buffer_index);
    bool (*back)(void);
    bool (*hold)(ui_screen_id_t to);
    bool (*safe_at)(int x, int y);
} ui_screen_t;
 
/*
 * UI_BAND_H, the band the router owns, and UI_ALERT_H and UI_ALERT_Y, the
 * alert band the router draws across the bottom of the panel while an alert
 * shows, are in ui_layout.h.  The alert band takes the touches under it, so a
 * screen puts nothing that acts there -- except a control that stops what the
 * bench drives, whose press the router hands through (ui_screen_t's safe_at).
 */

int ui_router_alert_rows(const char *text);
 
void ui_router_init(void);

void ui_router_goto(ui_screen_id_t id);
 
ui_screen_id_t ui_router_current(void);

ui_screen_id_t ui_router_parent(ui_screen_id_t id);

uint32_t ui_router_navigations(void);

uint32_t ui_router_dispatched(void);
const char *ui_router_title(ui_screen_id_t id);
 
void ui_router_tick(float dt_s);

void ui_router_event(const touch_event_t *evt);

void ui_router_cancel_gestures(void);
void ui_router_render(gfx_canvas_t *c, int buffer_index);

void ui_router_invalidate(void);
 
/* ------------------------------------------------------------ bench state */

#define UI_ARMED_MOTOR 0x01u
#define UI_ARMED_SERVO 0x02u
 
typedef struct {
    bool     link_up;
    bool     armed;
    uint8_t  armed_roles;
    uint16_t faults;        
    uint32_t run_seconds;
    const char *mode;       
    bool simulated;
 
    /*
     * A link_cap_t bitmap from the IOmcu's identity page.  Zero means
     * nothing is fitted or nothing answered; the menu treats both the same.
     */
    uint16_t capabilities;

    uint32_t link_errors;

    uint32_t link_refused;

    float mcu_temp_c;
} ui_bench_status_t;
 
void ui_router_set_status(const ui_bench_status_t *status);

typedef enum {
    UI_BAND_CHIP_NONE = 0,
    UI_BAND_CHIP_LINK,    
    UI_BAND_CHIP_MODE,    
    UI_BAND_CHIP_FAULT,   
    UI_BAND_CHIP_ARMED,   
    UI_BAND_CHIP_CLOCK,   
    UI_BAND_CHIP_COUNT
} ui_band_chip_t;

ui_band_chip_t ui_router_help(void);

bool ui_router_help_rect(gfx_rect_t *out);

bool ui_router_stop_live(void);
const ui_bench_status_t *ui_router_status(void);

bool ui_router_take_stop(void);
 
/* ------------------------------------------------------------------ alert */

#define UI_ALERT_MAX 128

#define UI_ALERT_SHOW_S 30.0f

void ui_router_set_alert(const char *text);

uint32_t ui_router_alert_number(void);

bool ui_router_withdraw_alert(uint32_t number);

void ui_router_hold_alert(const char *text);

const char *ui_router_alert(void);
 
#ifdef __cplusplus
}
#endif