cleanup

Author: nonik0

Cargo.toml

@@ -11,19 +11,11 @@ authors = ["Nick Brown <nick@altonimb.us>"]
 categories = ["embedded", "no-std"]
 description = "Platform agnostic driver for HCMS-29XX and HCMS-39XX display ICs"
 keywords = ["embedded-hal-driver", "no-std"]
-license = "MIT"
+license = "MIT OR Apache-2.0"
 repository = "https://github.com/nonik0/hcms-29xx"
 readme = "README.md"
 autobins = false # needed to override for examples with own manifest files
 
 [dependencies]
 embedded-hal = "1.0.0"
-avr-progmem = { version = "0.4.0", optional = true }
-
-#[[example]]
-#name = "arduino-uno"
-#path = "examples/arduino-uno/src/main.rs"
-
-[[example]]
-name = "esp32-s3"
-path = "examples/esp32-s3/src/bin/main.rs"   
+avr-progmem = { version = "0.4.0", optional = true }

README.md

@@ -7,7 +7,7 @@
 [![lint](https://github.com/nonik0/hcms-29xx/actions/workflows/lint.yml/badge.svg)](https://github.com/nonik0/hcms-29xx/actions/workflows/lint.yml)
 [![build](https://github.com/nonik0/hcms-29xx/actions/workflows/build.yml/badge.svg)](https://github.com/nonik0/hcms-29xx/actions/workflows/build.yml)
 
-Platform agnostic driver for [HCMS-29XX](https://docs.broadcom.com/doc/HCMS-29xx-Series-High-Performance-CMOS-5-x-7-Alphanumeric-Displays) and [HCMS-39XX](https://docs.broadcom.com/doc/AV02-0868EN) display ICs.  Many thanks for @Andy4495's existing [HCMS39XX](https://github.com/Andy4495/HCMS39xx) Arduino/C++ library, which I used for a reference implementation as well as for the font data.
+A platform agnostic driver for [HCMS-29XX](https://docs.broadcom.com/doc/HCMS-29xx-Series-High-Performance-CMOS-5-x-7-Alphanumeric-Displays) and [HCMS-39XX](https://docs.broadcom.com/doc/AV02-0868EN) display ICs. Many thanks to @Andy4495's existing [HCMS39xx](https://github.com/Andy4495/HCMS39xx) Arduino/C++ library, which I used as a reference implementation as well as for the font data.
 
 ## Features:
  * Single dependency on embedded-hal v1.0
@@ -17,7 +17,7 @@ Platform agnostic driver for [HCMS-29XX](https://docs.broadcom.com/doc/HCMS-29xx
      * ESP32-S3 using [esp-hal](https://github.com/esp-rs/esp-hal)
 
 ## Install
-To install this driver in your project add the following line to your `Cargo.toml`'s `dependencies` table:
+To install this driver in your project, add the following line to your `Cargo.toml`'s `dependencies` table:
 
 ```toml
 hcms-29xx = "0.1.0"
@@ -26,7 +26,68 @@ hcms-29xx = "0.1.0"
 For AVR targets:
 
 ```toml
-hcms-29xx { "0.1.0", features=["avr-progmem"] }
+hcms-29xx = { "0.1.0", features=["avr-progmem"] }
+```
+
+## How to Use
+
+The HCMS-29xx/HCMS-39xx displays require a minimum of four pins to control: Data (Din), Register Select (RS), Clock (CLK), and Chip Enable (CE). The other pins, Blank (BL), Oscillator Select (SEL), and Reset (RST), are optional. If not given, the optional pins' logic levels must be set appropriately, typically BL low, SEL high, and RST high.
+
+Specifying only required pins:
+
+```rust
+const NUM_CHARS: usize = 8;
+
+let mut display = hcms_29xx::Hcms29xx::<NUM_CHARS, _, _, _, _>::new(
+    HalOutputPin1,   // Data pin
+    HalOutputPin2,   // RS pin
+    HalOutputPin3,   // Clock pin
+    HalOutputPin4,   // CE pin
+    UnconfiguredPin, // Optional: Blank pin
+    UnconfiguredPin, // Optional: OscSel pin
+    UnconfiguredPin, // Optional: Reset pin
+)
+.unwrap();
+
+display.begin().unwrap();
+display.display_unblank().unwrap();
+display
+    .set_peak_current(hcms_29xx::PeakCurrent::Max12_8Ma)
+    .unwrap();
+display.set_brightness(15).unwrap();
+display.print_ascii_bytes(b"hello!").unwrap();
+```
+
+Specifying all pins:
+
+```rust
+const NUM_CHARS: usize = 8;
+
+let mut display = hcms_29xx::Hcms29xx::<NUM_CHARS, _, _, _, _, _, _, _>::new(
+    HalOutputPin1, // Data pin
+    HalOutputPin2, // RS pin
+    HalOutputPin3, // Clock pin
+    HalOutputPin4, // CE pin
+    HalOutputPin5, // Optional: Blank pin
+    HalOutputPin6, // Optional: OscSel pin
+    HalOutputPin7, // Optional: Reset pin
+)
+.unwrap();
+
+display.begin().unwrap();
+display.display_unblank().unwrap();
+display.print_ascii_bytes(b"goodbye!").unwrap();
+```
+
+## Examples
+
+There are currently two included examples:
+- [Arduino Uno](examples/arduino-uno/), based on [avr-hal](https://github.com/Rahix/avr-hal/)
+- [ESP32-S3](examples/esp32-s3/), based on [esp-hal](https://github.com/esp-rs/esp-hal).
+
+Follow the appropriate documentation for each HAL for the prerequisite set up and then simply use cargo to build and/or run each.
 
 ## TODO
+- [ ] Improve generic type interface, e.g. UnconfiguredPin improvements, better constructor, etc.
+- [ ] Improve function signatures, e.g. generic implementation for integer print functions
 - [ ] Katakana font

examples/esp32-s3/Cargo.toml

@@ -6,7 +6,6 @@ edition = "2021"
 
 [[bin]]
 name = "esp32-s3"
-path = "src/bin/main.rs"
 
 [dependencies]
 critical-section = "1.2.0"