omnipython-iconkit 0.1.0.dev3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- omnipython_iconkit-0.1.0.dev3/LICENSE +21 -0
- omnipython_iconkit-0.1.0.dev3/LICENSE-ICONS +202 -0
- omnipython_iconkit-0.1.0.dev3/PKG-INFO +165 -0
- omnipython_iconkit-0.1.0.dev3/README.md +147 -0
- omnipython_iconkit-0.1.0.dev3/VERSION +1 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/__init__.py +112 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/__init__.pyi +20 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/_a8_24.py +404 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/_a8_48.py +116 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/gfx.py +89 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/gfx.pyi +17 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/icons_24.txt +149 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/icons_48.txt +36 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/lvicons.py +72 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/lvicons.pyi +12 -0
- omnipython_iconkit-0.1.0.dev3/lib/iconkit/py.typed +0 -0
- omnipython_iconkit-0.1.0.dev3/lib/omnipython_iconkit.egg-info/PKG-INFO +165 -0
- omnipython_iconkit-0.1.0.dev3/lib/omnipython_iconkit.egg-info/SOURCES.txt +21 -0
- omnipython_iconkit-0.1.0.dev3/lib/omnipython_iconkit.egg-info/dependency_links.txt +1 -0
- omnipython_iconkit-0.1.0.dev3/lib/omnipython_iconkit.egg-info/top_level.txt +1 -0
- omnipython_iconkit-0.1.0.dev3/pyproject.toml +37 -0
- omnipython_iconkit-0.1.0.dev3/setup.cfg +4 -0
- omnipython_iconkit-0.1.0.dev3/tests/test_iconkit.py +286 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Brad Barnett
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: omnipython-iconkit
|
|
3
|
+
Version: 0.1.0.dev3
|
|
4
|
+
Summary: Material Design icons as flash-resident alpha masks, drawn in LVGL or pygraphics
|
|
5
|
+
Author: Brad Barnett
|
|
6
|
+
License-Expression: MIT AND Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/PyDevices/omnipython/tree/main/packages/iconkit
|
|
8
|
+
Project-URL: Issues, https://github.com/PyDevices/omnipython/issues
|
|
9
|
+
Keywords: icons,material,lvgl,micropython,circuitpython
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: Implementation :: MicroPython
|
|
12
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
13
|
+
Requires-Python: >=3.8
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
License-File: LICENSE
|
|
16
|
+
License-File: LICENSE-ICONS
|
|
17
|
+
Dynamic: license-file
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
# iconkit
|
|
22
|
+
|
|
23
|
+
iconkit is the part of OmniPython that gives a program Material Design icons as
|
|
24
|
+
antialiased 8-bit alpha masks. Frozen into MicroPython-compatible firmware, an
|
|
25
|
+
icon lives in flash and costs no RAM, and it draws in LVGL or in pygraphics on
|
|
26
|
+
MicroPython-compatible boards, CircuitPython-compatible boards and CPython.
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ omnipython-iconkit
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
On a board, freeze it: `include("/path/to/omnipython/packages/iconkit")` from your
|
|
33
|
+
firmware's `manifest.py`. Without freezing, the masks load into RAM when
|
|
34
|
+
imported, so freeze them on a board that is short of it.
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
import iconkit
|
|
38
|
+
|
|
39
|
+
print(len(iconkit.names(24)), "icons at 24 px,", len(iconkit.names(48)), "at 48 px")
|
|
40
|
+
|
|
41
|
+
# A mask is w * h alpha bytes, row by row. Print every other row as text.
|
|
42
|
+
data, w, h = iconkit.mask("home", 24)
|
|
43
|
+
for y in range(0, h, 2):
|
|
44
|
+
row = data[y * w:(y + 1) * w]
|
|
45
|
+
print("".join(" .:#"[a * 4 // 256] for a in row))
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
129 icons at 24 px, 33 at 48 px
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
:##:
|
|
53
|
+
########
|
|
54
|
+
############
|
|
55
|
+
.################.
|
|
56
|
+
##############
|
|
57
|
+
##### #####
|
|
58
|
+
##### #####
|
|
59
|
+
##### #####
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The picture at the top of this page is the 48 px set. Every icon in both sets is
|
|
65
|
+
on the [contact sheets](docs/reference/icons.md).
|
|
66
|
+
|
|
67
|
+
[Docs](docs/reference/icons.md) · [Examples](https://gallery.omnipython.org/pyscript/) · [Roadmap](ROADMAP.md)
|
|
68
|
+
|
|
69
|
+
OmniPython is made by [PyDevices](https://pydevices.com).
|
|
70
|
+
|
|
71
|
+
## The icons
|
|
72
|
+
|
|
73
|
+
Two sets ship, filled style, from Google's
|
|
74
|
+
[Material Design Icons](https://github.com/google/material-design-icons) (Apache
|
|
75
|
+
License 2.0, [LICENSE-ICONS](LICENSE-ICONS)):
|
|
76
|
+
|
|
77
|
+
- 24 px: 129 general-purpose icons (72.6 KB), listed in [icons_24.txt](lib/iconkit/icons_24.txt).
|
|
78
|
+
- 48 px: 33 app-tile icons (74.3 KB), listed in [icons_48.txt](lib/iconkit/icons_48.txt). All 33 are in the 24 px set too.
|
|
79
|
+
|
|
80
|
+
Names are Material's own (`home`, `wifi`, `battery_charging_full`). WiFi
|
|
81
|
+
strength comes as `network_wifi_1_bar`, `network_wifi_2_bar`,
|
|
82
|
+
`network_wifi_3_bar` and `network_wifi`.
|
|
83
|
+
|
|
84
|
+
## Draw an icon
|
|
85
|
+
|
|
86
|
+
In LVGL, an icon is an `lv.image` in the colour you give it:
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
import lvgl as lv
|
|
90
|
+
from iconkit import lvicons
|
|
91
|
+
|
|
92
|
+
lvicons.image(lv.screen_active(), "settings", size=48, color=lv.color_hex(0x40A0FF))
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
In pygraphics, `draw` blends the icon over what the framebuffer already shows.
|
|
96
|
+
It needs a pygraphics with `FrameBuffer.blit_alpha`, and raises without it:
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from iconkit import gfx
|
|
100
|
+
|
|
101
|
+
gfx.draw(display, "home", 10, 10, 0xFFFF)
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
A display with no framebuffer can take the icon blended onto a flat background
|
|
105
|
+
as an RGB565 buffer: `gfx.rgb565("home", color, bg)`. Pass the returned buffer
|
|
106
|
+
back as `buf=` to reuse it.
|
|
107
|
+
|
|
108
|
+
`iconkit.mask("home")` gives the raw `(data, w, h)` for anything else: `data` is
|
|
109
|
+
a memoryview of `w * h` alpha bytes, row by row.
|
|
110
|
+
|
|
111
|
+
An unknown name or size raises `ValueError` and lists what exists.
|
|
112
|
+
|
|
113
|
+
## Your own icons
|
|
114
|
+
|
|
115
|
+
[tools/make_icons.py](tools/make_icons.py) builds a module in the same format from
|
|
116
|
+
any Material icon names. It needs Pillow and a Material Design Icons checkout,
|
|
117
|
+
which you name on the command line:
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
python tools/make_icons.py path/to/material-design-icons --size 24 \
|
|
121
|
+
--names home,wifi,sd_card --out myicons.py
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Put `myicons.py` in your app and register it:
|
|
125
|
+
|
|
126
|
+
```python
|
|
127
|
+
import iconkit
|
|
128
|
+
import myicons
|
|
129
|
+
|
|
130
|
+
iconkit.add(myicons)
|
|
131
|
+
iconkit.mask("sd_card")
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
A name that another module of the same size already has raises `ValueError`.
|
|
135
|
+
`--names-file` takes a list with one name per line and `#` comments, and
|
|
136
|
+
`--budget 72k` fails the run when the masks outgrow a size you set.
|
|
137
|
+
|
|
138
|
+
## Fetch only the icons you need
|
|
139
|
+
|
|
140
|
+
The full repository is several gigabytes. A sparse checkout fetches just the PNGs
|
|
141
|
+
of one size:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
git clone --filter=blob:none --depth 1 --no-checkout https://github.com/google/material-design-icons.git
|
|
145
|
+
cd material-design-icons
|
|
146
|
+
git sparse-checkout set --no-cone /LICENSE '/png/*/*/materialicons/24dp/1x/'
|
|
147
|
+
git checkout
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
Some newer icons, such as `instant_mix`, exist only as Material Symbols. For a
|
|
151
|
+
name with no PNG, the generator draws the filled Outlined symbol's SVG instead,
|
|
152
|
+
which needs `pip install resvg-py`. Add each one to the checkout by name:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
git sparse-checkout add '/symbols/web/instant_mix/materialsymbolsoutlined/'
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
That downloads about 125 MB (git's pack of the file listing, plus the 2,170 icons
|
|
159
|
+
at 24 px, which are 430 KB themselves). Git still writes an index of the whole
|
|
160
|
+
tree, so expect about 800 MB on disk. Each further size is one more pattern, and
|
|
161
|
+
adds 2,170 files and about 0.7 MB:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
git sparse-checkout add '/png/*/*/materialicons/48dp/1x/'
|
|
165
|
+
```
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+

|
|
2
|
+
|
|
3
|
+
# iconkit
|
|
4
|
+
|
|
5
|
+
iconkit is the part of OmniPython that gives a program Material Design icons as
|
|
6
|
+
antialiased 8-bit alpha masks. Frozen into MicroPython-compatible firmware, an
|
|
7
|
+
icon lives in flash and costs no RAM, and it draws in LVGL or in pygraphics on
|
|
8
|
+
MicroPython-compatible boards, CircuitPython-compatible boards and CPython.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ omnipython-iconkit
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
On a board, freeze it: `include("/path/to/omnipython/packages/iconkit")` from your
|
|
15
|
+
firmware's `manifest.py`. Without freezing, the masks load into RAM when
|
|
16
|
+
imported, so freeze them on a board that is short of it.
|
|
17
|
+
|
|
18
|
+
```python
|
|
19
|
+
import iconkit
|
|
20
|
+
|
|
21
|
+
print(len(iconkit.names(24)), "icons at 24 px,", len(iconkit.names(48)), "at 48 px")
|
|
22
|
+
|
|
23
|
+
# A mask is w * h alpha bytes, row by row. Print every other row as text.
|
|
24
|
+
data, w, h = iconkit.mask("home", 24)
|
|
25
|
+
for y in range(0, h, 2):
|
|
26
|
+
row = data[y * w:(y + 1) * w]
|
|
27
|
+
print("".join(" .:#"[a * 4 // 256] for a in row))
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
```text
|
|
31
|
+
129 icons at 24 px, 33 at 48 px
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
:##:
|
|
35
|
+
########
|
|
36
|
+
############
|
|
37
|
+
.################.
|
|
38
|
+
##############
|
|
39
|
+
##### #####
|
|
40
|
+
##### #####
|
|
41
|
+
##### #####
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
The picture at the top of this page is the 48 px set. Every icon in both sets is
|
|
47
|
+
on the [contact sheets](docs/reference/icons.md).
|
|
48
|
+
|
|
49
|
+
[Docs](docs/reference/icons.md) · [Examples](https://gallery.omnipython.org/pyscript/) · [Roadmap](ROADMAP.md)
|
|
50
|
+
|
|
51
|
+
OmniPython is made by [PyDevices](https://pydevices.com).
|
|
52
|
+
|
|
53
|
+
## The icons
|
|
54
|
+
|
|
55
|
+
Two sets ship, filled style, from Google's
|
|
56
|
+
[Material Design Icons](https://github.com/google/material-design-icons) (Apache
|
|
57
|
+
License 2.0, [LICENSE-ICONS](LICENSE-ICONS)):
|
|
58
|
+
|
|
59
|
+
- 24 px: 129 general-purpose icons (72.6 KB), listed in [icons_24.txt](lib/iconkit/icons_24.txt).
|
|
60
|
+
- 48 px: 33 app-tile icons (74.3 KB), listed in [icons_48.txt](lib/iconkit/icons_48.txt). All 33 are in the 24 px set too.
|
|
61
|
+
|
|
62
|
+
Names are Material's own (`home`, `wifi`, `battery_charging_full`). WiFi
|
|
63
|
+
strength comes as `network_wifi_1_bar`, `network_wifi_2_bar`,
|
|
64
|
+
`network_wifi_3_bar` and `network_wifi`.
|
|
65
|
+
|
|
66
|
+
## Draw an icon
|
|
67
|
+
|
|
68
|
+
In LVGL, an icon is an `lv.image` in the colour you give it:
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
import lvgl as lv
|
|
72
|
+
from iconkit import lvicons
|
|
73
|
+
|
|
74
|
+
lvicons.image(lv.screen_active(), "settings", size=48, color=lv.color_hex(0x40A0FF))
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
In pygraphics, `draw` blends the icon over what the framebuffer already shows.
|
|
78
|
+
It needs a pygraphics with `FrameBuffer.blit_alpha`, and raises without it:
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
from iconkit import gfx
|
|
82
|
+
|
|
83
|
+
gfx.draw(display, "home", 10, 10, 0xFFFF)
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
A display with no framebuffer can take the icon blended onto a flat background
|
|
87
|
+
as an RGB565 buffer: `gfx.rgb565("home", color, bg)`. Pass the returned buffer
|
|
88
|
+
back as `buf=` to reuse it.
|
|
89
|
+
|
|
90
|
+
`iconkit.mask("home")` gives the raw `(data, w, h)` for anything else: `data` is
|
|
91
|
+
a memoryview of `w * h` alpha bytes, row by row.
|
|
92
|
+
|
|
93
|
+
An unknown name or size raises `ValueError` and lists what exists.
|
|
94
|
+
|
|
95
|
+
## Your own icons
|
|
96
|
+
|
|
97
|
+
[tools/make_icons.py](tools/make_icons.py) builds a module in the same format from
|
|
98
|
+
any Material icon names. It needs Pillow and a Material Design Icons checkout,
|
|
99
|
+
which you name on the command line:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
python tools/make_icons.py path/to/material-design-icons --size 24 \
|
|
103
|
+
--names home,wifi,sd_card --out myicons.py
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Put `myicons.py` in your app and register it:
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
import iconkit
|
|
110
|
+
import myicons
|
|
111
|
+
|
|
112
|
+
iconkit.add(myicons)
|
|
113
|
+
iconkit.mask("sd_card")
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
A name that another module of the same size already has raises `ValueError`.
|
|
117
|
+
`--names-file` takes a list with one name per line and `#` comments, and
|
|
118
|
+
`--budget 72k` fails the run when the masks outgrow a size you set.
|
|
119
|
+
|
|
120
|
+
## Fetch only the icons you need
|
|
121
|
+
|
|
122
|
+
The full repository is several gigabytes. A sparse checkout fetches just the PNGs
|
|
123
|
+
of one size:
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
git clone --filter=blob:none --depth 1 --no-checkout https://github.com/google/material-design-icons.git
|
|
127
|
+
cd material-design-icons
|
|
128
|
+
git sparse-checkout set --no-cone /LICENSE '/png/*/*/materialicons/24dp/1x/'
|
|
129
|
+
git checkout
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Some newer icons, such as `instant_mix`, exist only as Material Symbols. For a
|
|
133
|
+
name with no PNG, the generator draws the filled Outlined symbol's SVG instead,
|
|
134
|
+
which needs `pip install resvg-py`. Add each one to the checkout by name:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
git sparse-checkout add '/symbols/web/instant_mix/materialsymbolsoutlined/'
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
That downloads about 125 MB (git's pack of the file listing, plus the 2,170 icons
|
|
141
|
+
at 24 px, which are 430 KB themselves). Git still writes an index of the whole
|
|
142
|
+
tree, so expect about 800 MB on disk. Each further size is one more pattern, and
|
|
143
|
+
adds 2,170 files and about 0.7 MB:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
git sparse-checkout add '/png/*/*/materialicons/48dp/1x/'
|
|
147
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
0.1.0.dev3
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2026 Brad Barnett
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: MIT
|
|
4
|
+
"""Material Design icons as 8-bit alpha masks that stay in flash.
|
|
5
|
+
|
|
6
|
+
``mask("home")`` gives the antialiased shape of an icon as a slice of one big
|
|
7
|
+
constant in a frozen module, so an icon costs no RAM. Draw the mask with
|
|
8
|
+
`iconkit.lvicons` in LVGL or `iconkit.gfx` in pygraphics. This module imports
|
|
9
|
+
neither.
|
|
10
|
+
|
|
11
|
+
Two sets ship: 129 icons at 24 px and 33 app-tile icons at 48 px. An app with
|
|
12
|
+
icons of its own builds a module with ``tools/make_icons.py`` and registers it
|
|
13
|
+
with `add`.
|
|
14
|
+
|
|
15
|
+
Example::
|
|
16
|
+
|
|
17
|
+
import iconkit
|
|
18
|
+
view, w, h = iconkit.mask("wifi") # w * h alpha bytes, row by row
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
# Sizes that have a module of their own, ``iconkit._a8_<size>``.
|
|
22
|
+
_BUILTIN = (24, 48)
|
|
23
|
+
|
|
24
|
+
# size -> [module, ...]; the shipped module comes first.
|
|
25
|
+
_mods = {}
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def _modules(size):
|
|
29
|
+
mods = _mods.get(size)
|
|
30
|
+
if mods is None:
|
|
31
|
+
if size not in _BUILTIN:
|
|
32
|
+
raise ValueError(
|
|
33
|
+
"iconkit has no icons at %r px: the shipped sizes are %s. Build a module of your own "
|
|
34
|
+
"with tools/make_icons.py and register it with iconkit.add()." % (size, _BUILTIN)
|
|
35
|
+
)
|
|
36
|
+
mods = _mods[size] = [__import__("iconkit._a8_%d" % size, None, None, ("DATA",))]
|
|
37
|
+
return mods
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
def mask(name, size=24):
|
|
41
|
+
"""The alpha mask of icon *name*.
|
|
42
|
+
|
|
43
|
+
Args:
|
|
44
|
+
name (str): A Material icon name such as ``"home"``.
|
|
45
|
+
size (int): 24 or 48, or the size of a module added with `add`.
|
|
46
|
+
|
|
47
|
+
Returns:
|
|
48
|
+
``(data, w, h)``: a memoryview of ``w * h`` alpha bytes, row by row, and the size.
|
|
49
|
+
|
|
50
|
+
Raises:
|
|
51
|
+
ValueError: *name* isn't in any module of that size, or no module has that size.
|
|
52
|
+
"""
|
|
53
|
+
for m in _modules(size):
|
|
54
|
+
ns = m.NAMES
|
|
55
|
+
if name in ns:
|
|
56
|
+
n = size * size
|
|
57
|
+
i = ns.index(name) * n
|
|
58
|
+
return m.DATA[i : i + n], size, size
|
|
59
|
+
raise ValueError(
|
|
60
|
+
"no icon named %r at %d px; iconkit.names(%d) lists the %d there. Build it into a module "
|
|
61
|
+
"with tools/make_icons.py and register it with iconkit.add()." % (name, size, size, len(_all(size)))
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
def _all(size):
|
|
66
|
+
out = ()
|
|
67
|
+
for m in _modules(size):
|
|
68
|
+
out += tuple(m.NAMES)
|
|
69
|
+
return out
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
def names(size=24):
|
|
73
|
+
"""Every icon name at *size*, in the order of its module(s).
|
|
74
|
+
|
|
75
|
+
Raises:
|
|
76
|
+
ValueError: no module has that size.
|
|
77
|
+
"""
|
|
78
|
+
return _all(size)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
def add(module):
|
|
82
|
+
"""Register an icon module built by ``tools/make_icons.py`` for *module*'s size.
|
|
83
|
+
|
|
84
|
+
Args:
|
|
85
|
+
module: A module with ``SIZE``, ``NAMES`` and ``DATA``.
|
|
86
|
+
|
|
87
|
+
Raises:
|
|
88
|
+
ValueError: A name is already taken at that size, or ``DATA`` isn't
|
|
89
|
+
``len(NAMES) * SIZE * SIZE`` bytes.
|
|
90
|
+
"""
|
|
91
|
+
size = module.SIZE
|
|
92
|
+
if len(module.DATA) != len(module.NAMES) * size * size:
|
|
93
|
+
raise ValueError(
|
|
94
|
+
"icon module has %d bytes of DATA for %d names at %d px; it should have %d. "
|
|
95
|
+
"Rebuild it with tools/make_icons.py." % (len(module.DATA), len(module.NAMES), size, len(module.NAMES) * size * size)
|
|
96
|
+
)
|
|
97
|
+
if size in _BUILTIN:
|
|
98
|
+
mods = _modules(size)
|
|
99
|
+
else:
|
|
100
|
+
mods = _mods.setdefault(size, [])
|
|
101
|
+
if module in mods:
|
|
102
|
+
raise ValueError("icon module %r is already added" % (module,))
|
|
103
|
+
taken = set()
|
|
104
|
+
for m in mods:
|
|
105
|
+
taken.update(m.NAMES)
|
|
106
|
+
clash = [n for n in module.NAMES if n in taken]
|
|
107
|
+
if clash:
|
|
108
|
+
raise ValueError(
|
|
109
|
+
"icon names already taken at %d px: %s. Rename them in your module's list and rebuild it."
|
|
110
|
+
% (size, ", ".join(clash))
|
|
111
|
+
)
|
|
112
|
+
mods.append(module)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2026 Brad Barnett
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: MIT
|
|
4
|
+
"""Material Design icons as 8-bit alpha masks that stay in flash."""
|
|
5
|
+
|
|
6
|
+
from typing import Protocol
|
|
7
|
+
|
|
8
|
+
class _IconModule(Protocol):
|
|
9
|
+
SIZE: int
|
|
10
|
+
NAMES: tuple[str, ...] | list[str]
|
|
11
|
+
DATA: bytes | memoryview
|
|
12
|
+
|
|
13
|
+
def mask(name: str, size: int = 24) -> tuple[memoryview, int, int]:
|
|
14
|
+
"""The alpha mask of icon `name`: `(data, w, h)`, `w * h` alpha bytes row by row."""
|
|
15
|
+
|
|
16
|
+
def names(size: int = 24) -> tuple[str, ...]:
|
|
17
|
+
"""Every icon name at `size`, in the order of its module(s)."""
|
|
18
|
+
|
|
19
|
+
def add(module: _IconModule) -> None:
|
|
20
|
+
"""Register an icon module built by `tools/make_icons.py` for the module's size."""
|