ui_band.h File Reference

The status band: the bench state on every screen, and the STOP control that works from every screen. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "gfx.h"
#include "ui_screen.h"

Go to the source code of this file.

Functions
gfx_rect_t	ui_band_stop_rect (void)
const char *	ui_band_mode (bool link_up)
const char *	ui_band_mode_inject (void)
const char *	ui_band_armed_label (uint8_t roles)
bool	ui_link_refused_label (const ui_bench_status_t *st, char *out, size_t n)
bool	ui_band_chip_rect (const ui_bench_status_t *st, ui_band_chip_t chip, gfx_rect_t *out)
ui_band_chip_t	ui_band_chip_at (const ui_bench_status_t *st, int x, int y)
	The chip a touch lands on.
bool	ui_band_help_rect (const ui_bench_status_t *st, ui_band_chip_t chip, gfx_rect_t *out)
void	ui_band_help_render (gfx_canvas_t *c, const ui_bench_status_t *st, ui_band_chip_t chip)
bool	ui_band_chip_colors (const ui_bench_status_t *st, ui_band_chip_t chip, gfx_color_t *fill, gfx_color_t *ink)
	The fill and the text colour ui_band_render() draws chip in for st, in the theme in force.
uint32_t	ui_band_key (const char *title, bool show_home, const ui_bench_status_t *st, bool stop_pressed, bool home_pressed)
	A number for what ui_band_render() draws from the same arguments: the title, the home tag's and STOP's presses, the theme, and every chip's place, label and colours. Two calls that return the same number draw the same band, so the router repaints a buffer's band only when the number moves (ui_router_render()).
void	ui_band_render (gfx_canvas_t *c, const char *title, bool show_home, const ui_bench_status_t *st, bool stop_pressed, bool home_pressed)

Detailed Description

The status band: the bench state on every screen, and the STOP control that works from every screen.

SPDX-License-Identifier: MIT

Function Documentation

ui_band_armed_label()

const char * ui_band_armed_label

(

uint8_t

roles

)

The armed chip's label for roles, UI_ARMED_* bits: ARMED MOTOR, ARMED SERVO, or ARMED for both and for none. English in every language, as STOP and the other controls are.

ui_band_chip_at()

ui_band_chip_t ui_band_chip_at	(	const ui_bench_status_t *	st,
		int	x,
		int	y )

The chip a touch lands on.

A chip is hit across the band's whole height and 3px either side, half the gap to the next one; STOP and the home tag are not chips.

Parameters

st	The bench status the band shows.
x	The touch's panel x.
y	The touch's panel y.

Returns

The chip, or UI_BAND_CHIP_NONE.

ui_band_chip_colors()

bool ui_band_chip_colors	(	const ui_bench_status_t *	st,
		ui_band_chip_t	chip,
		gfx_color_t *	fill,
		gfx_color_t *	ink )

The fill and the text colour ui_band_render() draws chip in for st, in the theme in force.

The armed badge and the FAULT chip draw the dark text of the buttons on bright fills; the other chips draw the theme's text on its sunk panel.

Parameters

st	The bench status the band shows.
chip	The chip.
fill	The chip's fill, or NULL.
ink	The chip's text colour, or NULL.

Returns

False, with both untouched, for st NULL or a chip that is not one of the band's.

ui_band_chip_rect()

bool ui_band_chip_rect	(	const ui_bench_status_t *	st,
		ui_band_chip_t	chip,
		gfx_rect_t *	out )

Where chip is drawn for st, in panel coordinates, into out (which may be NULL). False when st draws no such chip: no FAULT chip while the bitmap is 0, no clock before a run, no mode chip without a mode.

ui_band_help_rect()

bool ui_band_help_rect	(	const ui_bench_status_t *	st,
		ui_band_chip_t	chip,
		gfx_rect_t *	out )

The help bubble of chip for st, in panel coordinates: under the band, at the chip's left edge, moved left as far as the panel's right edge needs, and as tall as its text. FAULT's spans the panel, so a line per bit has room. False when the chip is not drawn.

ui_band_help_render()

void ui_band_help_render	(	gfx_canvas_t *	c,
		const ui_bench_status_t *	st,
		ui_band_chip_t	chip )

Draw the help bubble of chip for st: the chip's label as its title, then what the state means for the bench and what to do about it, in the language showing. Built from st each time, so it follows the state.

ui_band_key()

uint32_t ui_band_key	(	const char *	title,
		bool	show_home,
		const ui_bench_status_t *	st,
		bool	stop_pressed,
		bool	home_pressed )

A number for what ui_band_render() draws from the same arguments: the title, the home tag's and STOP's presses, the theme, and every chip's place, label and colours. Two calls that return the same number draw the same band, so the router repaints a buffer's band only when the number moves (ui_router_render()).

Parameters

title	the current screen's title, or NULL
show_home	whether the title is the home tag
st	the bench's status, or NULL
stop_pressed	STOP is pressed
home_pressed	the home tag is pressed

Returns

the number, a 32-bit FNV-1a hash

ui_band_mode()

const char * ui_band_mode

(

bool

link_up

)

The mode the band names: BENCH while the link is up and the panel drives the IOmcu's outputs, SIM while it runs on its own models. Mode names, so English in every language.

ui_band_mode_inject()

const char * ui_band_mode_inject

(

void

)

INJECT: the mode a panel built with RCBENCH_TOUCH_INJECTOR names in place of BENCH and SIM while a touch injector (testbench/touch-injector) is attached. A mode name, so English in every language. A build with RCBENCH_TOUCH_INJECTOR=OFF has neither this nor INJECT's bubble text.

ui_band_render()

void ui_band_render	(	gfx_canvas_t *	c,
		const char *	title,
		bool	show_home,
		const ui_bench_status_t *	st,
		bool	stop_pressed,
		bool	home_pressed )

Draw the band. title is the current screen's title, or NULL on the splash, which has no home tag and no bench status.

ui_band_stop_rect()

gfx_rect_t ui_band_stop_rect

(

void

)

Where STOP is, in panel coordinates. The router hit-tests it.

ui_link_refused_label()

bool ui_link_refused_label	(	const ui_bench_status_t *	st,
		char *	out,
		size_t	n )

The label for the IOmcu's refused link frames, "Rejected link frames: N" in the language in force, into out of n bytes: the one place it is built. MOTOR & ESC shows it in its header strip. False, with out empty, while the link is down or the count (st->link_refused) is 0, so an IOmcu older than 4.21, which sends no count, shows no label.