Skip to content

Commit

Permalink
ws2812-spi-rs适配embedded_hal 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
LittleGuest committed May 10, 2024
1 parent f4608d1 commit 5c57f4f
Show file tree
Hide file tree
Showing 14 changed files with 760 additions and 2 deletions.
2 changes: 1 addition & 1 deletion cube/src/buzzer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ impl<'d> Buzzer<'d> {
return;
}

unimplemented!()
// unimplemented!()
// let mut channel0 = self.ledc.get_channel(
// channel::Number::Channel0,
// io.pins.gpio8.into_push_pull_output(),
Expand Down
1 change: 0 additions & 1 deletion ws2812-spi-rs
Submodule ws2812-spi-rs deleted from 4780d0
8 changes: 8 additions & 0 deletions ws2812-spi-rs/.cargo/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[target.thumbv6m-none-eabi]
runner = 'arm-none-eabi-gdb'
rustflags = [
"-C", "link-arg=-Tlink.x",
]

[build]
target = "thumbv6m-none-eabi"
3 changes: 3 additions & 0 deletions ws2812-spi-rs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/target
**/*.rs.bk
Cargo.lock
12 changes: 12 additions & 0 deletions ws2812-spi-rs/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
language: rust
rust:
- stable
- nightly
cache: cargo
matrix:
allow_failures:
- rust: nightly
fast_finish: true
script:
- rustup target add thumbv6m-none-eabi
- cargo build --examples --release
30 changes: 30 additions & 0 deletions ws2812-spi-rs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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]

### Changed
- Increased reset time from ~50μs to ~300μs, to deal with more/newer variants
- Add error checking (especially for the length) in the `prerendered` variant

## [0.4.0] - 2020-12-02
### Added
- SK812w support for the `prerendered` variant

### Changed
- Modify `FullDuplex` FIFO handling to be more resilient
- Switch `prerendered` to use the same bit patterns as the normal variant

This removes the ability to use custom frequencies, but makes the whole code a
*lot* simpler & more like the normal variant.

## [0.3.0] - 2020-02-09
### Added
- SK6812w support

### Changed
- Switched to a more efficient pattern generation, with 4 spi bits per ws2812
bit instead of 3
20 changes: 20 additions & 0 deletions ws2812-spi-rs/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[package]
name = "ws2812-spi"
version = "0.4.0"
authors = ["David Sawatzke <[email protected]>"]
edition = "2018"
categories = ["embedded", "no-std", "hardware-support"]
keywords = ["smart-leds", "ws2812"]
description = "SPI-based driver for ws2812 leds"
documentation = "https://docs.rs/crate/ws2812-spi"
license = "MIT OR Apache-2.0"
readme = "README.md"
repository = "https://github.com/smart-leds-rs/ws2812-spi-rs"

[dependencies]
nb = "1.1.0"
smart-leds-trait = "0.3.0"
embedded-hal = "1.0.0"

[features]
mosi_idle_high = []
201 changes: 201 additions & 0 deletions ws2812-spi-rs/LICENSE-APACHE
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 25 additions & 0 deletions ws2812-spi-rs/LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Copyright (c) 2017 David Sawatzke

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.
76 changes: 76 additions & 0 deletions ws2812-spi-rs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Ws2812 driver for embedded-hal spi traits

For usage with the [smart-leds](https://github.com/smart-leds-rs/smart-leds)
crate.

An embedded-hal driver for ws2812 leds using spi as the timing provider.

![rainbow on stm32f0](./stm32f0_ws2812_spi_rainbow.gif)

It provides two variants:
- The normal usage

Your spi peripheral has to run betwee 2MHz and 3.8MHz & the SPI data is created on-the-fly.
This means that your core has to be reasonably fast (48 MHz should suffice).
- Prerendered

If your core is too slow (for example, the AVR family), you
may want to use this. It creates all the data beforehand & then sends it. This
means that you have to provide a data array that's large enough for all the
spi data.

## It doesn't work!!!
- Do you use the normal variant? Does your spi run at the right frequency?

Your CPU might be too slow, but this can also depend on the HAL implementation
& your Iterator chain. Using the `prerendered` variant might help. For many
SPI peripherals, the clock generations is way less sophisticated than e.g.
the UART peripheral. You should verify it runs at an acceptable frequency, by
either studying the datasheet & the hal code or using a logic analyzer. An
fx2 based one, commonly available under $10 works great for this.

- If the first led is always on, no matter what data you put in, your spi is
probably not setting the mosi line to low on idle (You can check with a multimeter).
It may also be a timing issue with the first bit being sent, this is the case
on the stm32f030 with 2MHz.

You could try using the `mosi_idle_high` feature, it might help.

- Is your device fast enough? Is your iterator fast enough? Taking too long may
completely screw up the timings for the normal version. Try the prerendered variant.

- Is everything white? This may stem from an spi peripheral that's too slow or
one that takes too much time in-between bytes

- Is your first LED the wrong brightness/color while the rest of your LED's do what you expect?
This is due to low voltage of data line, or too much of a voltage difference between Vin and Din
voltages, making some "high" bits read as "low" bits to the chip. Due to the chips circuitry, these
voltages are regulated as they are passed on to the next LED in the line, which is why the other LED's
perform as expected. (For more on exactly what is going on here, see [Hackaday | Cheating at 5V WS2812 Control to Use 3.3V Data](https://hackaday.com/2017/01/20/cheating-at-5v-ws2812-control-to-use-a-3-3v-data-line/))

- Are you using the `--release` compiler flag?

The timing of each byte passed over SPI is very sensitive, and running code compiled
without full optimizations can throw off your timing. Always use either `--release`
flag with your `cargo <command>`, or alternatively set `[profile.dev] opt-level = "3"`
To ensure timing matches what your programmed. A dead giveaway of this is when all
pixels go full brightness for every color.

When opening an issue about wrong/strange data, it would help if you include
your code (of course) and a capture of MOSI & SCK from an oscilloscope/a logic
analyzer.

## 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.
Loading

0 comments on commit 5c57f4f

Please sign in to comment.