Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
9 changes: 9 additions & 0 deletions content/en/docs/Knowledge-Base/_index.md
Original file line number Diff line number Diff line change
@@ -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"
---
22 changes: 22 additions & 0 deletions content/en/docs/Knowledge-Base/leds/_index.md
Original file line number Diff line number Diff line change
@@ -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<br>(~1Hz) | | TODO
| Quick flash<br>(>=10Hz) | | TODO
| | 2 blue quick flashes<br>(continuous) | No App (OpenMower) firmware found?
| | 2 green quick flashes<br>(continuous) | App (OpenMower) firmware up and alive?
| | red | TODO
Binary file added content/en/docs/Knowledge-Base/leds/leds.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions content/en/docs/Tutorials/building-stm32-firmware/_index.md
Original file line number Diff line number Diff line change
@@ -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").
5 changes: 3 additions & 2 deletions content/en/docs/Tutorials/flashing-stm32-from-cm4/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down