Merge pull request #119 from gabevenberg/led-coordinates-doc

added coordiante system documentation info.
nrf-rs · Oct 31, 2023 · 66a9f3c · 66a9f3c
2 parents 09a5089 + 21b544e
commit 66a9f3c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/microbit-common/src/display/blocking.rs b/microbit-common/src/display/blocking.rs
@@ -35,6 +35,24 @@
 //! }
 //! ```
 //!
+//! The coordiante system is oriented so the 'bottom' (x,4) row is the edge with the edge
+//! connector. That means that
+//!
+//! ```no_run
+//! display.show(
+//!    &mut timer,
+//!    [
+//!        [0, 0, 1, 0, 0],
+//!        [0, 1, 1, 1, 0],
+//!        [1, 0, 1, 0, 1],
+//!        [0, 0, 1, 0, 0],
+//!        [0, 0, 1, 0, 0],
+//!    ],
+//!    1000,
+//!);
+//! ```
+//! Will display an arrow pointing towards the boards usb port.
+//!
 //! For a working example [`examples/display-blocking`](https://github.com/nrf-rs/microbit/tree/main/examples/display-blocking)
 use crate::hal::{
     gpio::{Output, Pin, PushPull},

diff --git a/microbit-common/src/display/nonblocking/mod.rs b/microbit-common/src/display/nonblocking/mod.rs
@@ -62,6 +62,8 @@
 //! (0,4) ... (4,4)
 //! ```
 //!
+//! where the 'bottom' (x,4) of the board is the edge connector.
+//!
 //! ## Greyscale model
 //!
 //! LED brightness levels are described using a scale from 0 (off) to 9