1 unstable release
0.0.0 | Jun 2, 2024 |
---|
#76 in #embedded-graphics
210KB
5K
SLoC
embedded-ui
This library is created for personal use, and needs some rework to make it universally-usable. But I want to share it with everyone who is interested in creating complex UI (maybe not so complex) for embedded systems.
One important thing to note, is that mostly all core functionality is a copy of iced-rs as developing UI framework in Rust was a hard thing for me. But don't compare embedded-ui to iced in any way, it's just better to study this library independently
Pros & Cons
The main disadvantages of this library come from that in fact it isn't embedded-ready because of:
core::any
usage for widget states eats performanceBox
is used, so you must have global heap allocatorVec
- again, global heap allocator is required.
I am planning to make an attempt on rewriting the code to use heapless
or even fixed-sized arrays, still keeping Any
but using references instead of the Box
es. I didn't start with it because it would be kinda painful, and I bet I'd never go to any with such requirements.
Pros:
- From the start it was developed to be used with 128x32 monochrome OLED display and yes, you can make UI even on such a small displays with it.
- Almost renderer-agnostic, but aimed towards
embedded_graphics::DrawTarget
- Controls-agnostic. It means, you're able to control the whole UI just with a single encoder
- Color-independent
- Events are customizable
- I made pretty large collections of icons starting from size of 5x5 pixels!
- Auto-sizing and flex layouts are supported
Cons:
- Of course its very-WIP state
- It is somewhat untested 😢
- You may find a lot of overhead in computations and memory usage which is unacceptable in embedded systems
- Only monospaced fonts are supported for now
Icons
To design icons I used free online app called Piskel for pixel-art. It supports exporting as C header file which you can put into repo as icons-input.c
and run node make-icons.js
Node.JS script to convert this header file into src/icons
directory. All you need is to give a name to each icon and its corresponding method.
For convenience, I've added a painting of each icon on top of it in generated file, so you can see what it looks like.
My icon packs are not consistent as catalogs because with such small sizes it is impossible to depict some figures. So bigger the size of the icons wider the catalog. It also means that when picking an icon and don't know the exact limits, it is possible to use a generic icon name and the best size will be chosen automatically.
There's a special trait InternalIconSet
which is implemented for all icon packs (and you can implement for yours) which contains icons used in system widgets, such as arrows for Select
or check sign in Checkbox
.
Length
Length is a universal single-dimension size type, used both for width and height.
There are four options in Length
enum:
Fixed
- fixed length in pixelsShrink
- occupies as least free space as possible giving more space for other elementsFill
- occupies as much free space as possibleDiv(N)
- takesfree / N
space. For example, in 100px container in width, element with width ofDiv(4)
will take 25px.
Flex layout
There's a single container using flex layout -- Linear
. It is a generic element for both row and column.
Flex
Components
Checkbox
FocusInput
Graph
Icon
Image
Knob
TODO:
- Add child element to the center of the knob. For value as text and anything
Linear
ProgressBar
TODO
Radio
Postponed. Use
Select
As I thinkSelect
covers radio button logic soRadio
postponed.
Scroll
Select
Slider
TODO:
- Slider text, to display real value. It should follow the knob not go out of viewport.
- Add min/max if it makes sense
Table
Postponed. Use
Linear
withrow
andcol
macros.
Toggle
Postponed. Use
Checkbox
.
Roadmap
Near plans
Knob
Graph
ProgressBar
Slider
FocusInput
Scroll
- Basic pages and links
Future
- Better navigation and links
- Transformations
- Add animations. This opens the door for not only animations, but new time-based logic too:
- Animated transformations
- Spinners, loaders and other such stuff
- Windows as popups, overlays
- More high-level widgets (most aren't usable for small displays):
- Text inputs
- Toolbar
- Header/Footer (not sure if we need it)
- Accordion
- Badge and chip
- Date/time picker
- Dropdown
- Tree (tree structure representation)
- Complex special effects:
- Image in background, border, etc.
- Shadow (yeah, what about shadows on 128x32 monochrome display lol?)
- Parallax
- Transparency filters
Dependencies
~3.5MB
~44K SLoC