diff --git a/README.md b/README.md index 832e009..56adf4f 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,14 @@ Building and running the site locally requires a recent `extended` version of [H You can find out more about how to install Hugo for your environment in our [Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide. -Once you've made your working copy of the site repo, from the repo root folder, run: +Once you've made your working copy of the site repo, change to the repo root folder, install the required modules: + +```bash +npm install --no-bin-links +``` + +and finally run: + ```bash hugo server ``` diff --git a/content/en/docs/Knowledge-Base/_index.md b/content/en/docs/Knowledge-Base/_index.md new file mode 100644 index 0000000..b549c21 --- /dev/null +++ b/content/en/docs/Knowledge-Base/_index.md @@ -0,0 +1,9 @@ +--- +title: "Knowledge Base" +linkTitle: "Knowledge Base" +weight: 110 +description: > + A collection of information that can be useful at times. +resources: +- src: "**.png" +--- diff --git a/content/en/docs/Knowledge-Base/leds/_index.md b/content/en/docs/Knowledge-Base/leds/_index.md new file mode 100644 index 0000000..703236d --- /dev/null +++ b/content/en/docs/Knowledge-Base/leds/_index.md @@ -0,0 +1,22 @@ +--- +title: "Meaning of the LEDs" +linkTitle: "Meaning of the LEDs" +resources: +- src: "**.jpg" + +--- + +{{< imgproc leds Resize 800x />}} + +The meaning of the Raspberry Pi LEDs are public known. If not, please ask your preferred search engine. + +Following a list of the current known/implemented xCore LED meanings: + +| Left "Info" LED | Right "Heartbeat" LED | Meaning +|:---------------------------:|:-------------------------------------:|--------- +| On | | IP assigned? +| Blink
(~1Hz) | | TODO +| Quick flash
(>=10Hz) | | TODO +| | 2 blue quick flashes
(continuous) | No App (OpenMower) firmware found? +| | 2 green quick flashes
(continuous) | App (OpenMower) firmware up and alive? +| | red | TODO diff --git a/content/en/docs/Knowledge-Base/leds/leds.jpg b/content/en/docs/Knowledge-Base/leds/leds.jpg new file mode 100644 index 0000000..c936034 Binary files /dev/null and b/content/en/docs/Knowledge-Base/leds/leds.jpg differ diff --git a/content/en/docs/Tutorials/building-stm32-firmware/_index.md b/content/en/docs/Tutorials/building-stm32-firmware/_index.md new file mode 100644 index 0000000..cd6e982 --- /dev/null +++ b/content/en/docs/Tutorials/building-stm32-firmware/_index.md @@ -0,0 +1,31 @@ +--- +title: "Building STM32 Firmware" +linkTitle: "Building STM32 Firmware" +description: Tutorial for building the STM32 microcontroller firmware. +--- + +The firmware can be build on any host PC (but yet only tested on Linux machine). + +### Step 1: Clone 'fw-openmower-v2' firmware repository + +It's important to clone the 'fw-openmower-v2' repository including it's submodules: +```bash +sudo apt install git docker +git clone --recurse-submodules https://github.com/xtech/fw-openmower-v2.git +``` + +### Step 2: Compile Firmware + +```bash +cd fw-openmower-v2 +./build-binary.sh +``` + +### Step 3: Copy Compiled Firmware to Mower + +Copy the compiled firmware binary (.elf format) to your (V2) mower: +```bash +scp out/openmower.elf openmower@openmower.local:" +``` +The firmware should be copied to your mower where it could be uploaded to the STM32 microcontroller, +see [Flashing STM32 From CM4]({{< ref "flashing-stm32-from-cm4" >}} "Flashing STM32 From CM4"). diff --git a/content/en/docs/Tutorials/flashing-stm32-from-cm4/_index.md b/content/en/docs/Tutorials/flashing-stm32-from-cm4/_index.md index 19abcb5..2d06e79 100644 --- a/content/en/docs/Tutorials/flashing-stm32-from-cm4/_index.md +++ b/content/en/docs/Tutorials/flashing-stm32-from-cm4/_index.md @@ -26,9 +26,10 @@ sudo curl -o /usr/local/share/openocd/scripts/interface/xcore.cfg https://core.x ``` ### Step 3: Upload a binary -Get a binary (.elf format) and upload it to the STM32 like this: +Get binary (see i.e. [Building STM32 Firmware]({{< ref "building-stm32-firmware" >}} "Building STM32 Firmware")) and upload it to the STM32 like this: ```bash -openocd -f interface/xcore.cfg -f target/stm32h7x.cfg -c "program your-binary.elf verify reset exit" +cd ~ +openocd -f interface/xcore.cfg -f target/stm32h7x.cfg -c "program openmower.elf verify reset exit" ``` The firmware should be uploaded and the program should be running.