Skip to content

Commit 4d069a8

Browse files
Update docs for hosted variant
1 parent 08fd815 commit 4d069a8

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Added
9+
- Add a `hosted` variant intended for SBCs where the whole data transmission needs to be done in a single call
810

911
### Changed
1012
- Increased reset time from ~50μs to ~300μs, to deal with more/newer variants

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ It provides three variants:
2020
spi data.
2121
- Hosted
2222

23-
Intended for device like the raspberry pi or other linux SBCs. Similarly to
23+
Intended for device like the Raspberry Pi or other Linux SBCs. Similarly to
2424
prerendered it creates all the data beforehand, but sends it using a single
2525
call.
26+
2627
## It doesn't work!!!
2728
- Do you use the normal variant? Does your spi run at the right frequency?
2829

src/hosted.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # Use ws2812 leds via spi on linux hosts
1+
//! # Use WS2812 LEDs via SPI on Linux hosts
22
//!
33
//! This dynamically allocates an output buffer and writes out the data in a single call.
44
//! Much better suited for linux or similar environments, but may not always work

0 commit comments

Comments
 (0)