initial commit

Author: nonik0

.github/workflows/build.yml

@@ -0,0 +1,41 @@
+name: build
+
+on:
+  - push
+  - pull_request
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rust:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: dorny/paths-filter@v2
+        id: changes
+        with:
+          filters: |
+            rust:
+              - '**.rs'
+              - 'Cargo.lock'
+              - '.github/workflows/**'
+      - if: steps.changes.outputs.rust == 'true'
+        run: cargo build
+  rustdoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: dorny/paths-filter@v2
+        id: changes
+        with:
+          filters: |
+            rust:
+              - '**.rs'
+              - 'Cargo.lock'
+              - '.github/workflows/**'
+      - if: steps.changes.outputs.rust == 'true'
+        run: cargo doc

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: lint
+
+on:
+  - push
+  - pull_request
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rustfmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: dorny/paths-filter@v2
+        id: changes
+        with:
+          filters: |
+            rust:
+              - '**.rs'
+              - 'rustfmt.toml'
+              - '.github/workflows/**'
+      - if: steps.changes.outputs.rust == 'true'
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          components: rustfmt
+          override: true
+      - if: steps.changes.outputs.rust == 'true'
+        run: cargo fmt --check
+

.gitignore

@@ -0,0 +1,3 @@
+Cargo.lock
+/target/
+**/*.rs.bk

Cargo.toml

@@ -0,0 +1,27 @@
+[package] 
+name = "hcms-29xx"
+version = "0.1.0"
+edition = "2021"
+authors = ["nonik0"]
+categories = ["embedded", "no-std"]
+description = "Driver for HCMS-29XX and HCMS-39XX display ICs"
+license = "MIT"
+repository = "https://github.com/nonik0/hcms-29xx"
+readme = "README.md"
+
+[dependencies]
+embedded-hal = "1.0.0"
+avr-progmem = "0.4.0" # TODO: use as feature
+
+# The latest releases of `proc-macro2` do not support the rust toolchain that
+# we use.  Thus, we must fix this dependency to an older version where our
+# toolchain is still supported.  See https://github.com/Rahix/avr-hal/issues/537
+[build-dependencies.proc-macro2]
+version = "=1.0.79"
+
+#[[example]]
+#name = "arduino-uno"
+
+#[dependencies.arduino-hal]
+#path = "../../arduino-hal/"
+#features = ["arduino-uno"]

README.md

@@ -0,0 +1,28 @@
+# HCMS-29xx Driver
+
+[![Crates.io](https://img.shields.io/crates/v/hcms-29xx)](https://crates.io/crates/hcms-29xx)
+[![Crates.io](https://img.shields.io/crates/d/hcms-29xx)](https://crates.io/crates/hcms-29xx)
+[![docs.rs](https://img.shields.io/docsrs/hcms-29xx)](https://docs.rs/hcms-29xx/latest/hcms-29xx/)
+
+[![lint](https://github.com/gleich/hcms-29xx/actions/workflows/lint.yml/badge.svg)](https://github.com/gleich/hcms-29xx/actions/workflows/lint.yml)
+[![build](https://github.com/gleich/hcms-29xx/actions/workflows/build.yml/badge.svg)](https://github.com/gleich/hcms-29xx/actions/workflows/build.yml)
+
+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.
+
+## Features:
+ * Single dependency on embedded-hal v1.0
+ * Examples for Arduino Uno using avr-hal
+ * TBD
+
+## Install
+
+To install this driver in your project add the following line to your `Cargo.toml`'s `dependencies` table:
+
+```toml
+hcms-29xx = "0.1.0"
+```
+
+## TODO
+- [ ] Arduino Uno sample
+- [ ] Test on other hardware, add feature flags if needed for specific functionality (e.g. progmem for AVR)
+- [ ] Katakana font

examples/arduino-uno.rs

@@ -0,0 +1,49 @@
+#![no_std]
+#![no_main]
+
+use panic_halt as _;
+
+const NUM_CHARS: usize = 8;
+const MESSAGE: &[u8] = b"Hello from Rust on Arduino!";
+
+#[arduino_hal::entry]
+fn main() -> ! {
+    let dp = arduino_hal::Peripherals::take().unwrap();
+    let pins = arduino_hal::pins!(dp);
+
+    // modify pin assignments to match wiring, if optional pins are not specified the logic
+    // level must set as appropriate externally with pull-up/down resistors or other means
+    let mut display = hcms29xx::Hcms29xx::new(
+        NUM_CHARS,                               // Number of characters in the display
+        pins.d0.into_output().downgrade(),       // Data pin
+        pins.d1.into_output().downgrade(),       // Clock pin
+        pins.d2.into_output().downgrade(),       // Chip select pin
+        pins.d3.into_output().downgrade(),       // Reset pin
+        Some(pins.d4.into_output().downgrade()), // Optional: Enable pin
+        Some(pins.d5.into_output().downgrade()), // Optional: Write pin
+        Some(pins.d6.into_output().downgrade()), // Optional: Read pin
+    )
+    .unwrap();
+
+    display.begin().unwrap();
+    display.display_unblank().unwrap();
+
+    display.set_current(1).unwrap(); // set current (0-3) to 1
+    //display.set_brightness(15).unwrap(); // set brightness (0-15) to max
+    //display.set_int_osc().unwrap(); // set internal oscillator (default internal)
+
+    // show a scrolling message, wrapping around at the end
+    let mut cursor: usize = 0;
+    loop {
+        let mut buf = [0; NUM_CHARS];
+
+        for i in 0..NUM_CHARS {
+            let index = (cursor + i as usize) % MESSAGE.len();
+            buf[i as usize] = MESSAGE[index];
+        }
+
+        display.print_c_string(&buf).unwrap();
+        cursor = (cursor + 1) % MESSAGE.len();
+        arduino_hal::delay_ms(30);
+    }
+}

rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "nightly-2024-03-22"
+components = ["rust-src"]
+profile = "minimal"

src copy/main.rs

@@ -0,0 +1,72 @@
+#![no_std]
+#![no_main]
+
+use panic_halt as _;
+
+const NUM_CHARS: usize = 8;
+const MESSAGE: &[u8] = b"Stella and Beau and Stevie and Louie and ";
+
+#[arduino_hal::entry]
+fn main() -> ! {
+    let dp = arduino_hal::Peripherals::take().unwrap();
+    let pins = arduino_hal::pins!(dp);
+
+    let mut led_pin = pins.d13.into_output();
+
+    // high impedance pins
+    pins.sck.into_floating_input();
+    pins.mosi.into_floating_input();
+    pins.d9.into_floating_input();
+    pins.d5.into_floating_input();
+
+    let mut display = hcms29xx::Hcms29xx::new(
+        NUM_CHARS,                                // Number of characters in the display
+        pins.d0.into_output().downgrade(),        // Data pin
+        pins.d1.into_output().downgrade(),        // Clock pin
+        pins.d11.into_output().downgrade(),       // Chip select pin
+        pins.d2.into_output().downgrade(),        // Reset pin
+        Some(pins.d3.into_output().downgrade()),  // Optional: Enable pin
+        Some(pins.d6.into_output().downgrade()),  // Optional: Write pin
+        Some(pins.d10.into_output().downgrade()), // Optional: Read pin
+    )
+    .unwrap();
+    display.begin().unwrap();
+    display.display_unblank().unwrap();
+    display.set_current(1).unwrap();
+    //display.set_int_osc().unwrap(); now default
+
+    // test max current/power draw
+    // display.set_current(crate::hcms29xx::constants::control_word_0::current::MAX_12_8MA).unwrap();
+    // display.set_brightness(crate::hcms29xx::constants::control_word_0::MAX_BRIGHTNESS).unwrap();
+
+    let mut cursor: usize = 0;
+    let mut count: u16 = 0;
+    let mut buf: [u8; NUM_CHARS] = [0; NUM_CHARS];
+    loop {
+        count = (count + 1) % 10000;
+        if (count % 30) == 0 {
+            cursor = (cursor + 1) % MESSAGE.len();
+        }
+        if (count % 500) == 0 {
+            led_pin.toggle();
+        }
+
+        for i in 0..4 {
+            let index = (cursor + i as usize) % MESSAGE.len();
+            buf[i as usize] = MESSAGE[index];
+        }
+
+        let mut count_dec = count;
+        for i in (0..4).rev() {
+            buf[i as usize + 4] = if count_dec > 0 {
+                (count_dec % 10) as u8 + b'0'
+            } else {
+                b' '
+            };
+            count_dec /= 10;
+        }
+
+        display.print_c_string(&buf).unwrap();
+        arduino_hal::delay_ms(1);
+    }
+}

src/constants.rs

@@ -0,0 +1,29 @@
+pub const CHAR_WIDTH: usize = 5;
+pub const CHAR_HEIGHT: usize = 7;
+pub const DEVICE_CHARS: usize = 4;
+
+pub const CONTROL_WORD_SELECT_BIT: u8 = 0b1000_0000; // low: control word 0, high: control word 1
+
+pub mod control_word_0 {
+    pub const BRIGHTNESS_MASK: u8 = 0b0000_1111;
+    pub const CURRENT_MASK: u8 = 0b0011_0000;
+    pub const WAKE_BIT: u8 = 0b0100_0000;
+
+    pub const MAX_BRIGHTNESS: u8 = 15;
+    pub const DEFAULT_BRIGHTNESS: u8 = 12;
+    pub const DEFAULT_CURRENT: u8 = current::MAX_4_0MA;
+
+    pub mod current {
+        pub const MAX_4_0MA: u8 = 0b0010_0000;
+        pub const MAX_6_4MA: u8 = 0b0001_0000;
+        pub const MAX_9_3MA: u8 = 0b0000_0000;
+        pub const MAX_12_8MA: u8 = 0b0011_0000;
+    }
+}
+
+pub mod control_word_1 {
+    pub const DATA_OUT_BIT: u8 = 0b0000_0001; // low: serial, high: simultaneous
+    pub const EXT_OSC_PRESCALER_BIT: u8 = 0b0000_0010; // low: clock/1, clock/8
+
+    pub const DEFAULT_DATA_OUT_MODE: u8 = DATA_OUT_BIT;
+}