Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added waveshare-rp2040-lcd-1-69 #88

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ Cargo.lock
.vscode
*.orig
*.raw
.DS_Store
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ members = [
"boards/waveshare-rp2040-zero",
"boards/waveshare-rp2040-lcd-0-96",
"boards/waveshare-rp2040-lcd-1-28",
"boards/waveshare-rp2040-lcd-1-69",
]

[workspace.dependencies]
Expand Down Expand Up @@ -64,3 +65,4 @@ usbd-hid = "0.7.0"
usbd-serial = "0.2.1"
ws2812-pio = "0.8.0"
gc9a01a_driver = "0.1.3"
st7789v2_driver = "0.1.0"
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,29 @@ RP2040 chip according to how it is connected up on the board.
[Waveshare RP2040 LCD 0.96"]: https://www.waveshare.com/wiki/RP2040-LCD-0.96
[waveshare-rp2040-lcd-0_96]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-0-96

### [waveshare-rp2040-lcd-1-28] - Board Support for the [Waveshare RP2040 LCD 1.28"]

You should include this crate if you are writing code that you want to run on
an [Waveshare RP2040 LCD 1.28"] - a very small RP2040 breakout board with USB-C,
a 65K IPS LCD 160x80, 16MBit Flash and 1A battery charger from Waveshare.

This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the board.

[Waveshare RP2040 LCD 1.28"]: https://www.waveshare.com/wiki/RP2040-LCD-1.28
[waveshare-rp2040-lcd-1-28]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-1-28

### [waveshare-rp2040-lcd-1-69] - Board Support for the [Waveshare RP2040 LCD 1.69"]

You should include this crate if you are writing code that you want to run on
an [Waveshare RP2040 LCD 1.69"] - a very small RP2040 breakout board with USB-C,
a 65K IPS LCD 160x80, 16MBit Flash and 1A battery charger from Waveshare.

This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the board.

[Waveshare RP2040 LCD 1.69"]: https://www.waveshare.com/wiki/RP2040-Touch-LCD-1.69
[waveshare-rp2040-lcd-1-69]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-1-69
<!-- PROGRAMMING -->
## Programming

Expand Down
17 changes: 17 additions & 0 deletions boards/waveshare-rp2040-lcd-1-69/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

## 0.1.0 - 2024-09-24

### Changed

- Inital release
- Copied from waveshare-rp2040-lcd-1.28
- Update board name

51 changes: 51 additions & 0 deletions boards/waveshare-rp2040-lcd-1-69/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
[package]
name = "waveshare-rp2040-lcd-1-69"
version = "0.1.0"
authors = ["René van Dorst <[email protected]>", "Andrea Nall <[email protected]>", "TilCreator <[email protected]>", "The rp-rs Developers", "GordonCox"]
edition = "2018"
homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-1-69"
description = "Board Support Package for the Waveshare RP2040 LCD 1.69 inch"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rp-rs/rp-hal-boards.git"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
cortex-m-rt = { workspace = true, optional = true }
rp2040-boot2 = { workspace = true, optional = true }
rp2040-hal.workspace = true

[dev-dependencies]
cortex-m.workspace = true
panic-halt.workspace = true
embedded-hal.workspace = true
fugit.workspace = true
nb.workspace = true
embedded-graphics.workspace = true
st7789v2_driver = { workspace = true }

[features]
# This is the set of features we enable by default
default = ["boot2", "rt", "critical-section-impl", "rom-func-cache"]

# critical section that is safe for multicore use
critical-section-impl = ["rp2040-hal/critical-section-impl"]

# 2nd stage bootloaders for rp2040
boot2 = ["rp2040-boot2"]

# Minimal startup / runtime for Cortex-M microcontrollers
rt = ["cortex-m-rt","rp2040-hal/rt"]

# This enables a fix for USB errata 5: USB device fails to exit RESET state on busy USB bus.
# Only required for RP2040 B0 and RP2040 B1, but it doesn't hurt to enable it
rp2040-e5 = ["rp2040-hal/rp2040-e5"]

# Memoize(cache) ROM function pointers on first use to improve performance
rom-func-cache = ["rp2040-hal/rom-func-cache"]

# Disable automatic mapping of language features (like floating point math) to ROM functions
disable-intrinsics = ["rp2040-hal/disable-intrinsics"]

# This enables ROM functions for f64 math that were not present in the earliest RP2040s
rom-v2-intrinsics = ["rp2040-hal/rom-v2-intrinsics"]
97 changes: 97 additions & 0 deletions boards/waveshare-rp2040-lcd-1-69/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# [waveshare-rp2040-lcd-1-69] - Board Support for the [Waveshare RP2040 LCD 1.69]

You should include this crate if you are writing code that you want to run on
an [Waveshare RP2040 LCD 1.69] - a very small RP2040 breakout board with USB-C,
a 65K IPS LCD 240x240, 16MBit Flash and 1A battery charger from Waveshare.

This crate includes the [rp2040-hal], but also configures each pin of the
RP2040 chip according to how it is connected up on the Feather.

[Waveshare RP2040 LCD 1.69]: https://www.waveshare.com/wiki/RP2040-Touch-LCD-1.69
[waveshare-rp2040-lcd-1-69]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-1-69
[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/

## Using

To use this crate, your `Cargo.toml` file should contain:

```toml
waveshare_rp2040_lcd_1_69 = "0.1.0"
```

In your program, you will need to call `waveshare_rp2040_lcd_1_69::Pins::new` to create
a new `Pins` structure. This will set up all the GPIOs for any on-board
devices. See the [examples](./examples) folder for more details.

## Examples

### General Instructions

To compile an example, clone the _rp-hal-boards_ repository and run:

```console
rp-hal-boards/boards/waveshare-rp2040-lcd-1-69 $ cargo build --release --example <name>
```

You will get an ELF file called
`./target/thumbv6m-none-eabi/release/examples/<name>`, where the `target`
folder is located at the top of the _rp-hal-boards_ repository checkout. Normally
you would also need to specify `--target=thumbv6m-none-eabi` but when
building examples from this git repository, that is set as the default.

If you want to convert the ELF file to a UF2 and automatically copy it to the
USB drive exported by the RP2040 bootloader, simply boot your board into
bootloader mode and run:

```console
rp-hal-boards/boards/waveshare-rp2040-lcd-1-69 $ cargo run --release --example <name>
```

If you get an error about not being able to find `elf2uf2-rs`, try:

```console
$ cargo install elf2uf2-rs, then repeating the `cargo run` command above.
```

### [waveshare_rp2040_lcd_demo_1_69](./examples/waveshare_rp2040_lcd_demo_1_69.rs)

Draws a red and green line with a blue regtangle.
After that is fills the screen line for line, that end it starts over with an
other colour, RED, GREEN and BLUE.

## Contributing

Contributions are what make the open source community such an amazing place to
be, learn, inspire, and create. Any contributions you make are **greatly
appreciated**.

The steps are:

1. Fork the Project by clicking the 'Fork' button at the top of the page.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Make some changes to the code or documentation.
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal-boards/pulls)
7. An admin will review the Pull Request and discuss any changes that may be required.
8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!

## Code of Conduct

Contribution to this crate is organized under the terms of the [Rust Code of
Conduct][CoC], and the maintainer of this crate, the [rp-rs team], promises
to intervene to uphold that code of conduct.

[CoC]: CODE_OF_CONDUCT.md
[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs

## License

The contents of this repository are dual-licensed under the _MIT OR Apache
2.0_ License. That means you can choose either the MIT license or the
Apache-2.0 license when you re-use this code. See `MIT` or `APACHE2.0` for more
information on each specific license.

Any submissions to this project (e.g. as Pull Requests) must be made available
under these terms.
Loading
Loading