kst_panel.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "gfx.h"
#include "kst_prog.h"
#include "prog_registry.h"
#include "touch_types.h"
#include "ui_keypad.h"
#include "ui_textkey.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define KST_PANEL_STD_MV 6000u
#define KST_PANEL_NAME_TYPED 16
#define KST_PANEL_MSG_LINES 3
#define KST_PANEL_LINE      96

void kst_panel_init(gfx_rect_t area);

void kst_panel_screen_entry(void);

void kst_panel_open(void);
bool kst_panel_is_open(void);

void kst_panel_close(void);

void kst_panel_back(void);

bool kst_panel_holds_port(void);

uint8_t kst_panel_pin(void);

bool kst_panel_safe_at(int x, int y);

extern const prog_page_set_t kst_panel_pages;

void kst_panel_leave(void);

void kst_panel_cancel(void);

void kst_panel_tick(float dt_s);

bool kst_panel_has_press(uint8_t id);

void kst_panel_event(const touch_event_t *evt);
 
void kst_panel_render(gfx_canvas_t *c);

uint32_t kst_panel_revision(void);

uint32_t kst_panel_hold_revision(void);
 
/* --- the control task's side ------------------------------------------------ */

void kst_panel_feed(const kst_prog_feed_t *f);
void kst_panel_set_hv(bool on);
void kst_panel_bench_armed(bool armed);
bool kst_panel_card_look(void);
bool kst_panel_take(kst_prog_cmd_t *out);
void kst_panel_gate(kst_prog_gate_t *g);
bool kst_panel_card_take(kst_prog_card_req_t *out);
void kst_panel_card_done(const kst_prog_card_done_t *done);
size_t kst_panel_file_take(char *out, size_t n);
void kst_panel_file_done(bool ok);
bool kst_panel_file_load(const char *text, size_t len);
bool kst_panel_file_late(const char *text, size_t len);
 
/* --- the limit run's sessions (servo_limrun.h) ------------------------------- */
 
/*
 * A limit run lowers LEFT ANGLE and RIGHT ANGLE through the model the
 * overlay holds, a session at a time: CONNECT with its read, one write,
 * LEAVE.  Each call starts the step and kst_panel_run_poll() says how it
 * ended.  The run's start, held for 2s, is the operator's consent: no
 * warning page is shown and the soft rules a value breaks are confirmed.
 * The rest is the model's: the hard rules, the file the first write of a
 * session saves (none for a later session of the run: kst_prog_run_hold()),
 * the journal, the read back of every write.
 */
 
typedef enum {
    KST_PANEL_RUN_NONE = 0,  
    KST_PANEL_RUN_BUSY,
    KST_PANEL_RUN_OK,        
    KST_PANEL_RUN_FAILED,    
} kst_panel_run_t;

bool kst_panel_run_ready(void);
void kst_panel_run_begin(void);
kst_prog_msg_id_t kst_panel_run_connect(bool supply, uint16_t mv,
                                        uint16_t ma);
kst_prog_msg_id_t kst_panel_run_write(uint16_t left, uint16_t right);
kst_prog_msg_id_t kst_panel_run_pulses(uint16_t lower_dus, uint16_t upper_dus);
kst_prog_msg_id_t kst_panel_run_leave(void);
kst_panel_run_t kst_panel_run_poll(void);
bool kst_panel_run_no_servo(void);
bool kst_panel_run_servo(uint16_t angle[2], uint16_t *lo, uint16_t *hi,
                         bool *reversion, unsigned *type,
                         uint16_t pulse_dus[3]);
const char *kst_panel_run_backup(void);
void kst_panel_run_end(void);
 
/* --- for the tests ------------------------------------------------------------ */
 
kst_prog_t *kst_panel_model(void);

int kst_panel_message_lines(const kst_prog_msg_t *m,
                            char out[KST_PANEL_MSG_LINES][KST_PANEL_LINE]);

int kst_panel_text_rows(const char *s);

const char *kst_panel_rule_text(unsigned rule);
 
/*
 * Where things are, for a test's taps.  Rows by page, row and column.  A
 * coordinate no row has gives an empty rectangle (value, step), false (live)
 * or NULL (button, label).  Every control is UI_TAP_MIN (48px) tall or
 * more and a control at the foot ends 4px above the alert band.
 */
gfx_rect_t kst_panel_tab_rect(int page);
gfx_rect_t kst_panel_close_rect(void);
gfx_rect_t kst_panel_value_rect(int page, int row, int col);
gfx_rect_t kst_panel_step_rect(int page, int row, bool up);
gfx_rect_t kst_panel_choice_rect(int i);
gfx_rect_t kst_panel_choice_cancel_rect(void);
gfx_rect_t kst_panel_apply_rect(void);
gfx_rect_t kst_panel_cancel_rect(void);
ui_keypad_t *kst_panel_keypad(void);
ui_textkey_t *kst_panel_textkey(void);

int kst_panel_editor(void);

int kst_panel_page(void);

const char *kst_panel_warning_line(int i);
int kst_panel_warning_level(int i);
const char *kst_panel_standing_line(int i);
bool kst_panel_row_live(int page, int row, int col);
const char *kst_panel_status_line(int i);
const char *kst_panel_button(int page, int row, int col);
const char *kst_panel_label(int page, int row, int col);
const char *kst_panel_choice_label(int i);
const char *kst_panel_choice_title(void);

int kst_panel_pack_notes(const int *rows, const bool *standing, int count,
                         int room, int *page);

int kst_panel_note_pages(void);

gfx_rect_t kst_panel_notes_rect(void);

int kst_panel_note_page(void);

const char *kst_panel_shown_note(int i);

int kst_panel_shown_message_lines(void);

gfx_rect_t kst_panel_notes_drawn(void);
 
#ifdef __cplusplus
}
#endif