feat: add display UI with splash screen, dashboard, and RSSI sparkline
Implement full SSD1306 OLED display support: - Splash screen on boot (1.5s) with project name, version, board - Dashboard showing radio state, config, counters, RSSI/SNR - RSSI history sparkline (64-sample ring buffer, 2px-wide bars) - DisplayOn/DisplayOff host commands routed via dedicated channel - Pure render functions against generic DrawTarget (no hardware coupling) - Display on/off control bypasses radio task entirely Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
17624 files changed
+4564928
-38
No files matched your search
@@ -0,0 +1 @@
|
||||
{"files":{".cargo_vcs_info.json":"fabefaa871781c80def2d49cc25f1faaabccc8b0386ec695c88bb919fb5efb05",".github/workflows/ci.yml":"f84837881447327266e424aed784730636d24c05fcbd246e75ec1b1ff6055f96",".github/workflows/clippy.yml":"8f814d662079a289db2b6acef8311e59ade60ccae2982e77168ada0d8afb4680",".github/workflows/rustfmt.yml":"32bde2ef4e52e477334d47c175c43433115160a6e91c2d3659d257f2a30cad9a","CHANGELOG.md":"a494c9d960ffb4d892376067fe6c9e03f281781eb62663fba01e6015037e6bf3","Cargo.toml":"0246efddf7980391d3f54886b77a615b5207f0c01f60a28a97bfdff206d08f02","Cargo.toml.orig":"df9bb9a029d8042765f6f6d2b2a9c8dc10921f6ad9dd5b939671ef1f1133cbdb","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"060dbfe1bca2c0ecfc345876655b314eab564a63fa76afd1f6d9782fa6408a95","README.md":"68cde48e751df833472fc938a62ea3b4e48a35c73968a8b1f223702c4e83e510","src/lib.rs":"81d03c3c4fa0164ec09ad6199fae289ff3e65e68d4bb3b2eb26f879806c3ceba","src/prelude.rs":"543846e2cc8a1df24e1e9f530140d3d6a24177d4cd08c9db54c60133baa5a6f9"},"package":"7ba2aab1ef3793e6f7804162debb5ac5edb93b3d650fbcc5aeb72fcd0e6c03a0"}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"git": {
|
||||
"sha1": "b7eb1d0fe4bd995f3dc8d3f5bdccdba4216cc63f"
|
||||
},
|
||||
"path_in_vcs": ""
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
on:
|
||||
push:
|
||||
branches: [ staging, trying, master ]
|
||||
pull_request:
|
||||
|
||||
name: Continuous integration
|
||||
jobs:
|
||||
ci_check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
override: true
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: build
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: build
|
||||
args: --package display-interface-spi
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: build
|
||||
args: --package display-interface-i2c
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: build
|
||||
args: --package display-interface-parallel-gpio
|
||||
@@ -0,0 +1,32 @@
|
||||
on:
|
||||
push:
|
||||
branches: [ staging, trying, master ]
|
||||
pull_request:
|
||||
|
||||
name: Clippy check
|
||||
jobs:
|
||||
clippy_check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
override: true
|
||||
components: clippy
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --package display-interface-spi
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --package display-interface-i2c
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --package display-interface-parallel-gpio
|
||||
@@ -0,0 +1,23 @@
|
||||
on:
|
||||
push:
|
||||
branches: [ staging, trying, master ]
|
||||
pull_request:
|
||||
|
||||
name: Code formatting check
|
||||
|
||||
jobs:
|
||||
fmt:
|
||||
name: Rustfmt
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
override: true
|
||||
components: rustfmt
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: fmt
|
||||
args: --all -- --check
|
||||
+95
@@ -0,0 +1,95 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
||||
and this project adheres to [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## Added
|
||||
|
||||
- Updated to embedded-hal 1.0.0 and embedded-hal-async 1.0.0
|
||||
- New `AsyncWriteOnlyDataCommand` trait.
|
||||
- i2c, spi: `async/await` support.
|
||||
- parallel-gpio: Added `Generic16BitBus`
|
||||
- parallel-gpio: Added `PGPIO16BitInterface`
|
||||
- added `defmt-03` feature
|
||||
|
||||
## Changed
|
||||
|
||||
- **Breaking** raised MSRV to 1.75
|
||||
- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal 1.0.0
|
||||
- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal-async 1.0.0
|
||||
- parallel-gpio: Fixed bug with fallible pins
|
||||
- **Breaking** parallel-gpio: `GenericxBitBus::new` is now infallible
|
||||
|
||||
## [v0.4.1] - 2021-05-10
|
||||
|
||||
### Added
|
||||
|
||||
- New `DisplayError` variant `RSError` to use with problems with the display's reset signal
|
||||
- New `DisplayError` variant `OutOfBoundsError` to use when writing to a non-existing pixel outside the display's bounds
|
||||
- parallel-gpio (0.5.0): New `OutputBus` trait
|
||||
- parallel-gpio (0.5.0): Added `Generic8BitBus`, an implementation of `OutputBus`
|
||||
|
||||
### Changed
|
||||
|
||||
- Return `DCError` instead of `BusWriteError` on errors (de-)asserting the DC signal in 8-bit GPIO interfaces
|
||||
- **Breaking** parallel-gpio (0.5.0): `PGPIO8BitInterface` now uses any 8-bit impementation of `OutputBus` instead of 8 individual pins
|
||||
|
||||
## [v0.4.0] - 2020-05-25
|
||||
|
||||
### Added
|
||||
|
||||
- Support for 8bit and 16bit iterators as data format
|
||||
- Support for 16bit slice data format with target endian
|
||||
- Deconstructors for included display-interface implementations
|
||||
|
||||
### Changed
|
||||
|
||||
- Make enums non-exhaustive and added a DataFormatNotImplemented fallback error
|
||||
|
||||
## [v0.3.0] - 2020-05-11
|
||||
|
||||
### Added
|
||||
|
||||
- 16 bit data width support for 8 bit parallel-gpio and SPI impls
|
||||
|
||||
### Changed
|
||||
|
||||
- Data width is provided via custom enum (breaking change)
|
||||
|
||||
## [v0.2.1] - 2020-04-16
|
||||
|
||||
### Added
|
||||
|
||||
- Added prelude
|
||||
|
||||
## [v0.2.0] - 2020-04-01
|
||||
|
||||
### Changed
|
||||
|
||||
- Made data width generic (breaking change)
|
||||
|
||||
## [v0.1.1] - 2020-03-29
|
||||
|
||||
### Fixed
|
||||
|
||||
- Crate metadata
|
||||
|
||||
### Removed
|
||||
|
||||
- Examples requiring additional driver crates
|
||||
|
||||
## 0.1.0 - 2020-03-29
|
||||
|
||||
First version
|
||||
|
||||
[Unreleased]: https://github.com/therealprof/display-interface/compare/v0.4.1...HEAD
|
||||
[v0.4.1]: https://github.com/therealprof/display-interface/compare/v0.4.0...v0.4.1
|
||||
[v0.4.0]: https://github.com/therealprof/display-interface/compare/v0.3.0...v0.4.0
|
||||
[v0.3.0]: https://github.com/therealprof/display-interface/compare/v0.2.1...v0.3.0
|
||||
[v0.2.1]: https://github.com/therealprof/display-interface/compare/v0.2.0...v0.2.1
|
||||
[v0.2.0]: https://github.com/therealprof/display-interface/compare/v0.1.1...v0.2.0
|
||||
[v0.1.1]: https://github.com/therealprof/display-interface/compare/v0.1.0...v0.1.1
|
||||
Vendored
+40
@@ -0,0 +1,40 @@
|
||||
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
|
||||
#
|
||||
# When uploading crates to the registry Cargo will automatically
|
||||
# "normalize" Cargo.toml files for maximal compatibility
|
||||
# with all versions of Cargo and also rewrite `path` dependencies
|
||||
# to registry (e.g., crates.io) dependencies.
|
||||
#
|
||||
# If you are reading this file be aware that the original Cargo.toml
|
||||
# will likely look very different (and much more reasonable).
|
||||
# See Cargo.toml.orig for the original contents.
|
||||
|
||||
[package]
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
name = "display-interface"
|
||||
version = "0.5.0"
|
||||
authors = ["Daniel Egger <daniel@eggers-club.de>"]
|
||||
exclude = [".gitignore"]
|
||||
description = "Traits for interfaces used to drive displays"
|
||||
documentation = "https://docs.rs/display-interface"
|
||||
readme = "README.md"
|
||||
keywords = [
|
||||
"graphics",
|
||||
"display",
|
||||
"embedded",
|
||||
]
|
||||
categories = ["no-std"]
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://github.com/therealprof/display-interface"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
|
||||
[dependencies.defmt]
|
||||
version = "0.3"
|
||||
optional = true
|
||||
|
||||
[features]
|
||||
default = []
|
||||
defmt-03 = ["dep:defmt"]
|
||||
+201
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
Vendored
+25
@@ -0,0 +1,25 @@
|
||||
Copyright (c) 2018 James Waples
|
||||
|
||||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
Vendored
+28
@@ -0,0 +1,28 @@
|
||||
# Display interface
|
||||
|
||||
This Rust crate contains a `no_std` compatible interface in form of traits to
|
||||
bridge between a bus driver and a display driver. The goal here is to allow
|
||||
display drivers to be written in a hardware interface agnostic way and prevent
|
||||
code duplication and missing implementations.
|
||||
|
||||
## Crate features
|
||||
|
||||
Additional features can be enabled by adding the following features to your Cargo.toml.
|
||||
|
||||
- `defmt-03`: implements `defmt::Format` for `DisplayError`.
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of
|
||||
|
||||
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
|
||||
http://www.apache.org/licenses/LICENSE-2.0)
|
||||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||
|
||||
at your option.
|
||||
|
||||
### Contribution
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
|
||||
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
|
||||
additional terms or conditions.
|
||||
Vendored
+76
@@ -0,0 +1,76 @@
|
||||
//! A generic display interface
|
||||
//!
|
||||
//! This crate contains an error type and traits to implement for bus interface drivers drivers to
|
||||
//! be consumed by display drivers. It abstracts over the different communication methods available
|
||||
//! to drive a display and allows a driver writer to focus on driving the display itself and only
|
||||
//! have to implement a single interface.
|
||||
|
||||
#![no_std]
|
||||
#![allow(async_fn_in_trait)]
|
||||
|
||||
pub mod prelude;
|
||||
|
||||
/// A ubiquitous error type for all kinds of problems which could happen when communicating with a
|
||||
/// display
|
||||
#[derive(Clone, Debug)]
|
||||
#[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
|
||||
#[non_exhaustive]
|
||||
pub enum DisplayError {
|
||||
/// Invalid data format selected for interface selected
|
||||
InvalidFormatError,
|
||||
/// Unable to write to bus
|
||||
BusWriteError,
|
||||
/// Unable to assert or de-assert data/command switching signal
|
||||
DCError,
|
||||
/// Unable to assert chip select signal
|
||||
CSError,
|
||||
/// The requested DataFormat is not implemented by this display interface implementation
|
||||
DataFormatNotImplemented,
|
||||
/// Unable to assert or de-assert reset signal
|
||||
RSError,
|
||||
/// Attempted to write to a non-existing pixel outside the display's bounds
|
||||
OutOfBoundsError,
|
||||
}
|
||||
|
||||
/// DI specific data format wrapper around slices of various widths
|
||||
/// Display drivers need to implement non-trivial conversions (e.g. with padding)
|
||||
/// as the hardware requires.
|
||||
#[non_exhaustive]
|
||||
pub enum DataFormat<'a> {
|
||||
/// Slice of unsigned bytes
|
||||
U8(&'a [u8]),
|
||||
/// Slice of unsigned 16bit values with the same endianness as the system, not recommended
|
||||
U16(&'a [u16]),
|
||||
/// Slice of unsigned 16bit values to be sent in big endian byte order
|
||||
U16BE(&'a mut [u16]),
|
||||
/// Slice of unsigned 16bit values to be sent in little endian byte order
|
||||
U16LE(&'a mut [u16]),
|
||||
/// Iterator over unsigned bytes
|
||||
U8Iter(&'a mut dyn Iterator<Item = u8>),
|
||||
/// Iterator over unsigned 16bit values to be sent in big endian byte order
|
||||
U16BEIter(&'a mut dyn Iterator<Item = u16>),
|
||||
/// Iterator over unsigned 16bit values to be sent in little endian byte order
|
||||
U16LEIter(&'a mut dyn Iterator<Item = u16>),
|
||||
}
|
||||
|
||||
/// This trait implements a write-only interface for a display which has separate data and command
|
||||
/// modes. It is the responsibility of implementations to activate the correct mode in their
|
||||
/// implementation when corresponding method is called.
|
||||
pub trait WriteOnlyDataCommand {
|
||||
/// Send a batch of commands to display
|
||||
fn send_commands(&mut self, cmd: DataFormat<'_>) -> Result<(), DisplayError>;
|
||||
|
||||
/// Send pixel data to display
|
||||
fn send_data(&mut self, buf: DataFormat<'_>) -> Result<(), DisplayError>;
|
||||
}
|
||||
|
||||
/// This trait implements a write-only interface for a display which has separate data and command
|
||||
/// modes. It is the responsibility of implementations to activate the correct mode in their
|
||||
/// implementation when corresponding method is called.
|
||||
pub trait AsyncWriteOnlyDataCommand {
|
||||
/// Send a batch of commands to display
|
||||
async fn send_commands(&mut self, cmd: DataFormat<'_>) -> Result<(), DisplayError>;
|
||||
|
||||
/// Send pixel data to display
|
||||
async fn send_data(&mut self, buf: DataFormat<'_>) -> Result<(), DisplayError>;
|
||||
}
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
pub use crate::AsyncWriteOnlyDataCommand as _display_interface_AsyncWriteOnlyDataCommand;
|
||||
pub use crate::DisplayError as _display_interface_DisplayError;
|
||||
pub use crate::WriteOnlyDataCommand as _display_interface_WriteOnlyDataCommand;
|
||||
Reference in new issue
Block a user