Skip to content

Commit 518bfca

Browse files
matthewwmattheww
committed
Initial version, based on rmicrobit 1.0.1.
Differences from rmicrobit 1.0.1: - split out scrolling_statics module - rename ScrollingImages to ScrollingStatics - omit GresycaleImage - use const generic rather than fixed-size buffer for ScrollingBufferedText
0 parents  commit 518bfca

12 files changed

+1020
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
Cargo.lock

‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## microbit-text 0.1.0 (2021-11-22)
2+
3+
* Initial release
4+

‎Cargo.toml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[package]
2+
edition = "2021"
3+
name = "microbit-text"
4+
version = "0.1.0"
5+
authors = ["Matthew Woodcraft <[email protected]>"]
6+
description = "Scrolling text on a 5×5 (micro:bit) display"
7+
readme = "README.md"
8+
keywords = ["microbit"]
9+
categories = ["embedded", "no-std"]
10+
license = "MIT OR Apache-2.0"
11+
repository = "https://github.com/mattheww/microbit-text"
12+
13+
[dependencies]
14+
tiny-led-matrix = "1.0.0"
15+

‎LICENCE.txt

+265
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
microbit-text
2+
-------------
3+
4+
microbit-text, other than the pendolino font, is
5+
Copyright 2019,2021 Matthew Woodcraft.
6+
7+
It is licensed under either of
8+
* Apache Licence, Version 2.0
9+
* MIT licence
10+
at your option.
11+
12+
13+
MIT licence
14+
~~~~~~~~~~~
15+
16+
Permission is hereby granted, free of charge, to any person obtaining a copy
17+
of this software and associated documentation files (the "Software"), to deal
18+
in the Software without restriction, including without limitation the rights
19+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
20+
copies of the Software, and to permit persons to whom the Software is
21+
furnished to do so, subject to the following conditions:
22+
23+
The above copyright notice and this permission notice shall be included in all
24+
copies or substantial portions of the Software.
25+
26+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
31+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32+
SOFTWARE.
33+
34+
35+
36+
Apache licence, Version 2.0
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
39+
Apache License
40+
Version 2.0, January 2004
41+
http://www.apache.org/licenses/
42+
43+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
44+
45+
1. Definitions.
46+
47+
"License" shall mean the terms and conditions for use, reproduction,
48+
and distribution as defined by Sections 1 through 9 of this document.
49+
50+
"Licensor" shall mean the copyright owner or entity authorized by
51+
the copyright owner that is granting the License.
52+
53+
"Legal Entity" shall mean the union of the acting entity and all
54+
other entities that control, are controlled by, or are under common
55+
control with that entity. For the purposes of this definition,
56+
"control" means (i) the power, direct or indirect, to cause the
57+
direction or management of such entity, whether by contract or
58+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
59+
outstanding shares, or (iii) beneficial ownership of such entity.
60+
61+
"You" (or "Your") shall mean an individual or Legal Entity
62+
exercising permissions granted by this License.
63+
64+
"Source" form shall mean the preferred form for making modifications,
65+
including but not limited to software source code, documentation
66+
source, and configuration files.
67+
68+
"Object" form shall mean any form resulting from mechanical
69+
transformation or translation of a Source form, including but
70+
not limited to compiled object code, generated documentation,
71+
and conversions to other media types.
72+
73+
"Work" shall mean the work of authorship, whether in Source or
74+
Object form, made available under the License, as indicated by a
75+
copyright notice that is included in or attached to the work
76+
(an example is provided in the Appendix below).
77+
78+
"Derivative Works" shall mean any work, whether in Source or Object
79+
form, that is based on (or derived from) the Work and for which the
80+
editorial revisions, annotations, elaborations, or other modifications
81+
represent, as a whole, an original work of authorship. For the purposes
82+
of this License, Derivative Works shall not include works that remain
83+
separable from, or merely link (or bind by name) to the interfaces of,
84+
the Work and Derivative Works thereof.
85+
86+
"Contribution" shall mean any work of authorship, including
87+
the original version of the Work and any modifications or additions
88+
to that Work or Derivative Works thereof, that is intentionally
89+
submitted to Licensor for inclusion in the Work by the copyright owner
90+
or by an individual or Legal Entity authorized to submit on behalf of
91+
the copyright owner. For the purposes of this definition, "submitted"
92+
means any form of electronic, verbal, or written communication sent
93+
to the Licensor or its representatives, including but not limited to
94+
communication on electronic mailing lists, source code control systems,
95+
and issue tracking systems that are managed by, or on behalf of, the
96+
Licensor for the purpose of discussing and improving the Work, but
97+
excluding communication that is conspicuously marked or otherwise
98+
designated in writing by the copyright owner as "Not a Contribution."
99+
100+
"Contributor" shall mean Licensor and any individual or Legal Entity
101+
on behalf of whom a Contribution has been received by Licensor and
102+
subsequently incorporated within the Work.
103+
104+
2. Grant of Copyright License. Subject to the terms and conditions of
105+
this License, each Contributor hereby grants to You a perpetual,
106+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
107+
copyright license to reproduce, prepare Derivative Works of,
108+
publicly display, publicly perform, sublicense, and distribute the
109+
Work and such Derivative Works in Source or Object form.
110+
111+
3. Grant of Patent License. Subject to the terms and conditions of
112+
this License, each Contributor hereby grants to You a perpetual,
113+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
114+
(except as stated in this section) patent license to make, have made,
115+
use, offer to sell, sell, import, and otherwise transfer the Work,
116+
where such license applies only to those patent claims licensable
117+
by such Contributor that are necessarily infringed by their
118+
Contribution(s) alone or by combination of their Contribution(s)
119+
with the Work to which such Contribution(s) was submitted. If You
120+
institute patent litigation against any entity (including a
121+
cross-claim or counterclaim in a lawsuit) alleging that the Work
122+
or a Contribution incorporated within the Work constitutes direct
123+
or contributory patent infringement, then any patent licenses
124+
granted to You under this License for that Work shall terminate
125+
as of the date such litigation is filed.
126+
127+
4. Redistribution. You may reproduce and distribute copies of the
128+
Work or Derivative Works thereof in any medium, with or without
129+
modifications, and in Source or Object form, provided that You
130+
meet the following conditions:
131+
132+
(a) You must give any other recipients of the Work or
133+
Derivative Works a copy of this License; and
134+
135+
(b) You must cause any modified files to carry prominent notices
136+
stating that You changed the files; and
137+
138+
(c) You must retain, in the Source form of any Derivative Works
139+
that You distribute, all copyright, patent, trademark, and
140+
attribution notices from the Source form of the Work,
141+
excluding those notices that do not pertain to any part of
142+
the Derivative Works; and
143+
144+
(d) If the Work includes a "NOTICE" text file as part of its
145+
distribution, then any Derivative Works that You distribute must
146+
include a readable copy of the attribution notices contained
147+
within such NOTICE file, excluding those notices that do not
148+
pertain to any part of the Derivative Works, in at least one
149+
of the following places: within a NOTICE text file distributed
150+
as part of the Derivative Works; within the Source form or
151+
documentation, if provided along with the Derivative Works; or,
152+
within a display generated by the Derivative Works, if and
153+
wherever such third-party notices normally appear. The contents
154+
of the NOTICE file are for informational purposes only and
155+
do not modify the License. You may add Your own attribution
156+
notices within Derivative Works that You distribute, alongside
157+
or as an addendum to the NOTICE text from the Work, provided
158+
that such additional attribution notices cannot be construed
159+
as modifying the License.
160+
161+
You may add Your own copyright statement to Your modifications and
162+
may provide additional or different license terms and conditions
163+
for use, reproduction, or distribution of Your modifications, or
164+
for any such Derivative Works as a whole, provided Your use,
165+
reproduction, and distribution of the Work otherwise complies with
166+
the conditions stated in this License.
167+
168+
5. Submission of Contributions. Unless You explicitly state otherwise,
169+
any Contribution intentionally submitted for inclusion in the Work
170+
by You to the Licensor shall be under the terms and conditions of
171+
this License, without any additional terms or conditions.
172+
Notwithstanding the above, nothing herein shall supersede or modify
173+
the terms of any separate license agreement you may have executed
174+
with Licensor regarding such Contributions.
175+
176+
6. Trademarks. This License does not grant permission to use the trade
177+
names, trademarks, service marks, or product names of the Licensor,
178+
except as required for reasonable and customary use in describing the
179+
origin of the Work and reproducing the content of the NOTICE file.
180+
181+
7. Disclaimer of Warranty. Unless required by applicable law or
182+
agreed to in writing, Licensor provides the Work (and each
183+
Contributor provides its Contributions) on an "AS IS" BASIS,
184+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
185+
implied, including, without limitation, any warranties or conditions
186+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
187+
PARTICULAR PURPOSE. You are solely responsible for determining the
188+
appropriateness of using or redistributing the Work and assume any
189+
risks associated with Your exercise of permissions under this License.
190+
191+
8. Limitation of Liability. In no event and under no legal theory,
192+
whether in tort (including negligence), contract, or otherwise,
193+
unless required by applicable law (such as deliberate and grossly
194+
negligent acts) or agreed to in writing, shall any Contributor be
195+
liable to You for damages, including any direct, indirect, special,
196+
incidental, or consequential damages of any character arising as a
197+
result of this License or out of the use or inability to use the
198+
Work (including but not limited to damages for loss of goodwill,
199+
work stoppage, computer failure or malfunction, or any and all
200+
other commercial damages or losses), even if such Contributor
201+
has been advised of the possibility of such damages.
202+
203+
9. Accepting Warranty or Additional Liability. While redistributing
204+
the Work or Derivative Works thereof, You may choose to offer,
205+
and charge a fee for, acceptance of support, warranty, indemnity,
206+
or other liability obligations and/or rights consistent with this
207+
License. However, in accepting such obligations, You may act only
208+
on Your own behalf and on Your sole responsibility, not on behalf
209+
of any other Contributor, and only if You agree to indemnify,
210+
defend, and hold each Contributor harmless for any liability
211+
incurred by, or claims asserted against, such Contributor by reason
212+
of your accepting any such warranty or additional liability.
213+
214+
END OF TERMS AND CONDITIONS
215+
216+
APPENDIX: How to apply the Apache License to your work.
217+
218+
To apply the Apache License to your work, attach the following
219+
boilerplate notice, with the fields enclosed by brackets "[]"
220+
replaced with your own identifying information. (Don't include
221+
the brackets!) The text should be enclosed in the appropriate
222+
comment syntax for the file format. We also recommend that a
223+
file or class name and description of purpose be included on the
224+
same "printed page" as the copyright notice for easier
225+
identification within third-party archives.
226+
227+
Copyright [yyyy] [name of copyright owner]
228+
229+
Licensed under the Apache License, Version 2.0 (the "License");
230+
you may not use this file except in compliance with the License.
231+
You may obtain a copy of the License at
232+
233+
http://www.apache.org/licenses/LICENSE-2.0
234+
235+
Unless required by applicable law or agreed to in writing, software
236+
distributed under the License is distributed on an "AS IS" BASIS,
237+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
238+
See the License for the specific language governing permissions and
239+
limitations under the License.
240+
241+
242+
The pendolino font
243+
------------------
244+
245+
Copyright (c) 2016 British Broadcasting Corporation.
246+
This software is provided by Lancaster University by arrangement with the BBC.
247+
248+
Permission is hereby granted, free of charge, to any person obtaining a
249+
copy of this software and associated documentation files (the "Software"),
250+
to deal in the Software without restriction, including without limitation
251+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
252+
and/or sell copies of the Software, and to permit persons to whom the
253+
Software is furnished to do so, subject to the following conditions:
254+
255+
The above copyright notice and this permission notice shall be included in
256+
all copies or substantial portions of the Software.
257+
258+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
259+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
260+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
261+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
262+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
263+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
264+
DEALINGS IN THE SOFTWARE.
265+

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# microbit-text
2+
3+
A Rust library for scrolling text on a 5×5 monochrome display.
4+
5+
This is designed to support the [micro:bit]'s 5×5
6+
display, though nothing in this crate is strictly specific to the micro:bit.
7+
In practice it should be used with the [`microbit`] crate.
8+
9+
It includes a copy of the 'pendolino' font from the [micro:bit runtime][dal].
10+
11+
12+
## Documentation
13+
14+
https://docs.rs/microbit-text
15+
16+
17+
## Changelog
18+
19+
See [`CHANGELOG.md`](CHANGELOG.md).
20+
21+
22+
## Licence
23+
24+
The Rust code is Copyright 2019,2021 Matthew Woodcraft.
25+
26+
The Pendolino font is Copyright 2016 British Broadcasting Corporation.
27+
28+
See [`LICENCE.txt`](LICENCE.txt).
29+
30+
31+
## Contribution
32+
33+
Unless you explicitly state otherwise, any contribution intentionally
34+
submitted for inclusion in the work by you, as defined in the Apache-2.0
35+
licence, shall be dual licensed as described in LICENCE.txt, without any
36+
additional terms or conditions.
37+
38+
39+
[micro:bit]: https://microbit.org/
40+
[`microbit`]: https://crates.io/crates/microbit
41+
[dal]: https://lancaster-university.github.io/microbit-docs/

‎src/font.rs

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
//! A 5×5 ascii font.
2+
//!
3+
//! This is a copy of the 'pendolino' font from the [micro:bit runtime][dal].
4+
//!
5+
//! [dal]: https://lancaster-university.github.io/microbit-docs/
6+
7+
mod pendolino;
8+
9+
use crate::image::BitImage;
10+
11+
/// Index of the first character in the standard font
12+
pub const PRINTABLE_START: usize = 32;
13+
14+
/// Number of characters in the standard font
15+
pub const PRINTABLE_COUNT: usize = 95;
16+
17+
const UNKNOWN: BitImage = BitImage::new(&[
18+
[1, 1, 1, 1, 1],
19+
[1, 0, 0, 0, 1],
20+
[1, 0, 0, 0, 1],
21+
[1, 0, 0, 0, 1],
22+
[1, 1, 1, 1, 1],
23+
]);
24+
25+
26+
/// Returns an image representing the requested ascii character.
27+
///
28+
/// If the requested character isn't printable, returns a 'hollow square' image.
29+
///
30+
/// # Example
31+
///
32+
/// `font::character(b'x')`
33+
pub fn character(index: u8) -> &'static BitImage {
34+
let index = index as usize;
35+
if !(PRINTABLE_START..PRINTABLE_START + PRINTABLE_COUNT).contains(&index) {
36+
return &UNKNOWN;
37+
}
38+
&self::pendolino::PENDOLINO3[index - PRINTABLE_START]
39+
}
40+
41+
const fn font_entry(data: [u8; 5]) -> BitImage {
42+
// Note the data in the pendolino font uses the opposite column numbering
43+
// system to BitImage.
44+
const fn row_bits(byte: u8) -> [u8; 5] {[
45+
((byte & 1<<4) != 0) as u8,
46+
((byte & 1<<3) != 0) as u8,
47+
((byte & 1<<2) != 0) as u8,
48+
((byte & 1<<1) != 0) as u8,
49+
((byte & 1<<0) != 0) as u8,
50+
]}
51+
BitImage::new(&[
52+
row_bits(data[0]),
53+
row_bits(data[1]),
54+
row_bits(data[2]),
55+
row_bits(data[3]),
56+
row_bits(data[4]),
57+
])
58+
}
59+

0 commit comments

Comments
 (0)