Merge pull request #721 from andrewdavidmackenzie/prerequisites

Prerequisites

Author: andrewdavidmackenzie

BUILDING.md

@@ -1,5 +1,15 @@
 # Building Piggui and Piglet from source
 
+## Pre requisites
+- You'll need git to clone the repo (I chose `brew install git` so that needs `homebrew` first...). On a 
+Mac, that will also install Xcode command line tools for you.
+- a rust toolchain, recommended to install with [rust](https://rustup.rs/)
+- `cargo binstall` is pretty handy to install pre-build binaries. You can use `cargo install` instead if you prefer.
+- `cross` for cross compiling to armv7 and aarch64 (install with `cargo binstall/install cross`)
+- `make` but you will probably have that installed already
+- `probe-rs`if you are working with the Pi Pico `porky`app (`cargo binstall probe-rs-tools`)
+
+## General
 NOTE: For details on building `porky` the embedded binary for Pi Pico W devices,
 see [porky/BUILDING.md](porky/BUILDING.md)
 
@@ -21,7 +31,7 @@ below to build from source.
 make
 ```
 
-This will run clippy, build, and run tests, generating these binaries:
+This will run clip, build, and run tests, generating these binaries:
 
 - `target/debug/piggui` - GUI with a GPIO backend and ability to connect to remote `piglet` and `porky` devices
 - `target/debug/piglet` - CLI with a GPIO backend
@@ -50,7 +60,7 @@ real GPIO hardware present.
 NOTE: For this option you will need a working rust toolchain installed on your Raspberry Pi. Also, these builds make
 take a very long time. Large intermediate files are also generated and can fill-up the storage of your Pi.
 
-On your Raspberry Pi, use `make` to build and `make run` (etc) as above.
+On your Raspberry Pi, use `make` to build and `make run` as above.
 
 ## Building for Pi on another host
 

porky/src/flash.rs

@@ -89,7 +89,7 @@ pub fn get_flash<'a>(flash_pin: FLASH) -> Flash<'a, FLASH, Blocking, FLASH_SIZE>
 
 pub async fn db_init(
     flash: Flash<'static, FLASH, Blocking, FLASH_SIZE>,
-) -> Database<DbFlash<Flash<FLASH, Blocking, FLASH_SIZE>>, NoopRawMutex> {
+) -> Database<DbFlash<Flash<'static, FLASH, Blocking, FLASH_SIZE>>, NoopRawMutex> {
     let flash: DbFlash<Flash<_, _, FLASH_SIZE>> = DbFlash {
         flash,
         start: unsafe { &__config_start as *const u32 as usize },

porky/src/gpio.rs

@@ -5,7 +5,7 @@ use crate::hw_definition::config::HardwareConfigMessage::{
 use crate::hw_definition::config::InputPull;
 use crate::hw_definition::config::{HardwareConfig, LevelChange};
 use crate::hw_definition::pin_function::PinFunction;
-use crate::hw_definition::pin_function::PinFunction::Output;
+use crate::hw_definition::pin_function::PinFunction::{Input, Output};
 use crate::hw_definition::{BCMPinNumber, PinLevel};
 use crate::HARDWARE_EVENT_CHANNEL;
 #[cfg(feature = "wifi")]
@@ -95,7 +95,7 @@ async fn set_output_level<'a>(
         bcm_pin_number, pin_level
     );
 
-    // GPIO 0 and 1 are connected via cyw43 wifi chip
+    // GPIO 0 and 1 are connected via cyw43 Wi-Fi chip
     unsafe {
         match GPIO_PINS.get_mut(&bcm_pin_number) {
             #[cfg(feature = "wifi")]
@@ -148,7 +148,7 @@ async fn apply_pin_config<'a>(
             info!("Pin #{} - Set as Available", bcm_pin_number);
         }
 
-        PinFunction::Input(pull) => {
+        Input(pull) => {
             info!("Setting new pin function to: Input");
             match flex_pin {
                 Some(mut flex) => {
@@ -180,7 +180,7 @@ async fn apply_pin_config<'a>(
                 None => {
                     #[cfg(feature = "wifi")]
                     {
-                        // Must be GPIO 2 is connected via cyw43 wifi chip
+                        // Must be GPIO 2 is connected via cyw43 Wi-Fi chip
                         unsafe {
                             let _ = GPIO_PINS.insert(bcm_pin_number, GPIOPin::CYW43Input);
                         }
@@ -190,7 +190,7 @@ async fn apply_pin_config<'a>(
             }
         }
 
-        PinFunction::Output(pin_level) => {
+        Output(pin_level) => {
             match flex_pin {
                 Some(mut flex) => {
                     if let Some(l) = pin_level {
@@ -208,7 +208,7 @@ async fn apply_pin_config<'a>(
                 None => {
                     #[cfg(feature = "wifi")]
                     {
-                        // Must be GPIO 0 and 1 are connected via cyw43 wifi chip
+                        // Must be GPIO 0 and 1 are connected via cyw43 Wi-Fi chip
                         info!("Pin #{} cyw43 pin used as Output ", bcm_pin_number);
 
                         if let Some(l) = pin_level {

src/hw/pin_descriptions.rs

@@ -23,7 +23,7 @@ use std::borrow::Cow;
 /// each with two hardware chip selects. These extra SPI buses are available via alternate function
 /// assignments on certain GPIO pins. For more information, see the BCM2711 Arm peripherals
 /// datasheet."
-
+/// Pin 1 is just a 3.3V power pin
 const PIN_1: PinDescription = PinDescription {
     bpn: 1,
     bcm: None,

src/widgets/circle.rs

@@ -62,7 +62,7 @@ where
     }
 }
 
-impl<'a, Message, Theme, Renderer> From<Circle> for Element<'a, Message, Theme, Renderer>
+impl<Message, Theme, Renderer> From<Circle> for Element<'_, Message, Theme, Renderer>
 where
     Renderer: renderer::Renderer,
 {

src/widgets/led.rs

@@ -71,7 +71,7 @@ where
     }
 }
 
-impl<'a, Message, Theme, Renderer> From<Led> for Element<'a, Message, Theme, Renderer>
+impl<Message, Theme, Renderer> From<Led> for Element<'_, Message, Theme, Renderer>
 where
     Renderer: renderer::Renderer,
 {

src/widgets/line.rs

@@ -59,7 +59,7 @@ where
     }
 }
 
-impl<'a, Message, Theme, Renderer> From<Line> for Element<'a, Message, Theme, Renderer>
+impl<Message, Theme, Renderer> From<Line> for Element<'_, Message, Theme, Renderer>
 where
     Renderer: renderer::Renderer,
 {

src/widgets/spinner/circular.rs

@@ -86,7 +86,7 @@ where
     }
 }
 
-impl<'a, Theme> Default for Circular<'a, Theme>
+impl<Theme> Default for Circular<'_, Theme>
 where
     Theme: StyleSheet,
 {

src/widgets/toast.rs

@@ -115,7 +115,7 @@ where
     }
 }
 
-impl<'a, Message> Widget<Message, Theme, Renderer> for Manager<'a, Message> {
+impl<Message> Widget<Message, Theme, Renderer> for Manager<'_, Message> {
     fn size(&self) -> Size<Length> {
         self.content.as_widget().size()
     }
@@ -289,7 +289,7 @@ struct Overlay<'a, 'b, Message> {
     timeout_secs: u64,
 }
 
-impl<'a, 'b, Message> overlay::Overlay<Message, Theme, Renderer> for Overlay<'a, 'b, Message> {
+impl<Message> overlay::Overlay<Message, Theme, Renderer> for Overlay<'_, '_, Message> {
     fn layout(&mut self, renderer: &Renderer, bounds: Size) -> layout::Node {
         let limits = layout::Limits::new(Size::ZERO, bounds);
 
@@ -308,6 +308,47 @@ impl<'a, 'b, Message> overlay::Overlay<Message, Theme, Renderer> for Overlay<'a,
         .translate(Vector::new(self.position.x, self.position.y))
     }
 
+    fn draw(
+        &self,
+        renderer: &mut Renderer,
+        theme: &Theme,
+        style: &renderer::Style,
+        layout: Layout<'_>,
+        cursor: mouse::Cursor,
+    ) {
+        let viewport = layout.bounds();
+
+        for ((child, state), layout) in self
+            .toasts
+            .iter()
+            .zip(self.state.iter())
+            .zip(layout.children())
+        {
+            child
+                .as_widget()
+                .draw(state, renderer, theme, style, layout, cursor, &viewport);
+        }
+    }
+
+    fn operate(
+        &mut self,
+        layout: Layout<'_>,
+        renderer: &Renderer,
+        operation: &mut dyn widget::Operation,
+    ) {
+        operation.container(None, layout.bounds(), &mut |operation| {
+            self.toasts
+                .iter()
+                .zip(self.state.iter_mut())
+                .zip(layout.children())
+                .for_each(|((child, state), layout)| {
+                    child
+                        .as_widget()
+                        .operate(state, layout, renderer, operation);
+                });
+        });
+    }
+
     fn on_event(
         &mut self,
         event: Event,
@@ -379,47 +420,6 @@ impl<'a, 'b, Message> overlay::Overlay<Message, Theme, Renderer> for Overlay<'a,
             .fold(event::Status::Ignored, event::Status::merge)
     }
 
-    fn draw(
-        &self,
-        renderer: &mut Renderer,
-        theme: &Theme,
-        style: &renderer::Style,
-        layout: Layout<'_>,
-        cursor: mouse::Cursor,
-    ) {
-        let viewport = layout.bounds();
-
-        for ((child, state), layout) in self
-            .toasts
-            .iter()
-            .zip(self.state.iter())
-            .zip(layout.children())
-        {
-            child
-                .as_widget()
-                .draw(state, renderer, theme, style, layout, cursor, &viewport);
-        }
-    }
-
-    fn operate(
-        &mut self,
-        layout: Layout<'_>,
-        renderer: &Renderer,
-        operation: &mut dyn widget::Operation,
-    ) {
-        operation.container(None, layout.bounds(), &mut |operation| {
-            self.toasts
-                .iter()
-                .zip(self.state.iter_mut())
-                .zip(layout.children())
-                .for_each(|((child, state), layout)| {
-                    child
-                        .as_widget()
-                        .operate(state, layout, renderer, operation);
-                });
-        });
-    }
-
     fn mouse_interaction(
         &self,
         layout: Layout<'_>,