Skip to content

Commit

Permalink
add references to install.openbikesensor.org, add manual on command-l…
Browse files Browse the repository at this point in the history
…ine flashing using platformio.
  • Loading branch information
gluap committed Dec 16, 2023
1 parent 7c1d2a5 commit 3bfe2b6
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 8 deletions.
4 changes: 4 additions & 0 deletions content/docs/firmware/_index.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ eingespielt werden. Hierfür gibt es entsprechende Menüpunkte im Hauptmenü. Ei
Auseinanderbauen des Geräts und der Anschluss an einen Computer sind dafür
nicht mehr nötig.

GGF musst du zunächst das "Flashtool" (über die OpenBikeSensor Oberfläche) installieren.
Danach kannst du, wenn dein OpenBikeSensor in einem internetfähigen WLAN eingebucht
ist über das Wlan-Menü deines OpenBikeSensors Firmwareupdates anstoßen.

## Bauen und Flashen der Firmware aus dem gihub-Repository

### mit VisualStudio Code und PlatformIO
Expand Down
20 changes: 14 additions & 6 deletions content/docs/firmware/flash-linux.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ title: Flashen unter Linux
weight: 10
---

## Vorbereitung
## Alternative 1: Installation via Browser
Der einfachste Weg, deinen OpenBikeSensor zu flashen, ist den [webinstaller](https://install.openbikesensor.org) in Google Chrome oder Chromium zu öffnen und der Schritt-Für-Schritt Anleitung dort zu folgen. Funktioniert das für dich nicht, probiere eine der anderen Alternativen.

## Alternative 2:
In der [Allgemeinen Installationsanleitung]({{< ref "/docs/firmware" >}}) wird der betriebssystemunabhängige Weg über Visual Studio Code und Platformio geschildert.

## Alternative 3: Installation mit esptool

### Vorbereitung

Lade das [neueste Release-Archiv](https://github.com/openbikesensor/OpenBikeSensorFirmware/releases)
der OBS-Firmware von GitHub herunter.
Expand All @@ -12,20 +20,20 @@ Du benötigst die ZIP-Datei mit dem Namen `obs-v9.9.9.9999-initial-flash.zip` (`
Entpacke die Dateien in einem temporären Verzeichnis, sie heißen `0x??????.bin`. Die Zahlen sind die Basisadresse, an die
die Daten geflasht werden sollen.

## Installation
### Installation

Installiere das Programm `esptool`, falls es noch nicht installiert ist. Es ist in den
meisten Linux-Distributionen verfügbar.

### Debian GNU/Linux, Ubuntu
#### Debian GNU/Linux, Ubuntu

und davon abgeleitete Distributionen, wie z.&nbsp;B. Linux Mint

```shell
sudo apt install esptool
```

### Fedora
#### Fedora

```shell
sudo dnf install esptool
Expand Down Expand Up @@ -55,7 +63,7 @@ esptool.py v3.2
3.2
```

## Gerätenamen herausfinden
### Gerätenamen herausfinden

Stelle sicher, dass du den Gerätenamen für das USB-Gerät kennst. Sehr wahrscheinlich wird es `/dev/ttyUSB0` sein --
dieser Name wird auch im weiteren Beispiel verwendet.
Expand Down Expand Up @@ -84,7 +92,7 @@ ls -1d /dev/ttyUSB*
```


## Flashen
### Flashen

Führe **im selben Verzeichnis**, in das du die ZIP-Datei entpackt hast, folgenden Befehl aus:

Expand Down
3 changes: 3 additions & 0 deletions content/docs/firmware/flash-macos.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Flashen unter macOS
weight: 12
---

## Installation via Browser
Der einfachste Weg, deinen OpenBikeSensor zu flashen, ist den [webinstaller](https://install.openbikesensor.org) in Google Chrome zu öffnen und der Schritt-Für-Schritt anleitung dort zu folgen. Funktioniert das für dich nicht, folge den Schritten unten.

## Vorbereitung

Lade das [neueste
Expand Down
29 changes: 29 additions & 0 deletions content/docs/firmware/flash-python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Flashen mit platformio
weight: 10
---

Hast du ``git`` und ``python3`` installiert, kannst du mit folgenden Kommandos die OpenBikeSensor Firmware bauen und flashen.

## Vorbereiten des Firmwareverzeichnisses:
```
# Git-Repo klonen
git clone https://github.com/openbikesensor/OpenBikeSensorFirmware.git
cd OpenBikeSensorFirmware
# Platformio in einem virtuellen Python Environment installieren
python3 -m venv venv
venv/bin/pip install platformio
```

## Flashen
Nun kannst du den ESP (nicht den OpenBikeSensor) per USB-Kabel mit deinem Rechner verbinden und mit folgendem Kommando die Firmware flashen. (je nach systemkonfiguration benötigtst du dafür evtl. root-rechte). GGF ist es dafür nötig den **boot**-Knopf am ESP zu drücken.
```
platformio run -t upload
```

## Nach dem Flashen
Es empfiehlt sich, dich in den [Konfigurationsmodus]({{< ref "/docs/user-guide/configuration">}}) zu begeben, um
- Dein internetfähiges WLAN im OpenBikeSensor zu konfigurieren.
- Das Flashtool zu installieren.
- Noch einmal ein Firmwareupdate aus dem Internet zu installieren.
- Deinen API-Key für Datenuploads einzurichten.
4 changes: 2 additions & 2 deletions content/docs/firmware/flash-windows/_index.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Flashen unter Windows
weight: 11
---

So flasht du eine neue Firmware auf deinen ESP32, wenn du einen
Windows-Computer benutzt.
## Installation via Browser
Der einfachste Weg, deinen OpenBikeSensor zu flashen, ist den [webinstaller](https://install.openbikesensor.org) in Google chrome zu öffnen und der Schritt-Für-Schritt anleitung dort zu folgen. Funktioniert das für dich nicht, folge den Schritten unten.

## Firmware herunterladen

Expand Down

0 comments on commit 3bfe2b6

Please sign in to comment.