Skip to content

Commit 86d7d79

Browse files
committed
update README.md
1 parent e5a0377 commit 86d7d79

1 file changed

Lines changed: 42 additions & 18 deletions

File tree

README.md

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@ https://github.com/hishizuka/pizero_bikecomputer
3636

3737
# Abstract
3838

39-
Pi Zero Bikecomputer is a GPS and ANT+ bike computer based on Raspberry Pi Zero(W, WH, 2 W). This is the first DIY project in the world integrated with necessary hardwares and software for modern bike computer. It measures and records position(GPS), ANT+ sensor(speed/cadence/power) and I2C sensor(pressure/temperature/accelerometer, etc). It also displays these values, even maps and courses in real-time. In addition, it write out log into .fit format file.
39+
Pi Zero Bikecomputer is a GPS and ANT+ bike computer based on Raspberry Pi Zero (W, WH, 2 W). This is the first DIY project in the world integrating the necessary hardware and software for a modern bike computer. It measures and records position (GPS), ANT+ sensors (speed / cadence / power), and I2C sensors (pressure / temperature / accelerometer, etc.). It also displays these values, maps, and courses in real time. In addition, it writes logs to `.fit` format files.
4040

41-
In this project, Pi Zero Bikecomputer got basic functions needed for bike computers. Next target is to add new functions which existing products do not have!
41+
In this project, Pi Zero Bikecomputer has already got the basic functions needed for a bike computer. The next target is to add new functions that existing products do not have!
4242

4343
You will enjoy both cycling and the maker movement with Pi Zero Bikecomputer!
4444

45-
Here is detail articles in Japanese.
45+
Here are detailed articles in Japanese. The original Japanese titles are kept below, with English translations for reference.
4646

47-
- [I tried to make a bikecomputer, the result was pretty good](https://qiita.com/hishi/items/46619b271daaa9ad41b3)
48-
- [Let's make a bikecomputer with Raspberry Pi Zero (W, WH)](https://qiita.com/hishi/items/46619b271daaa9ad41b3)
47+
- [サイクルコンピューターをガチで作ってみたら、割とできてしまったという話](https://qiita.com/hishi/items/8f77fd4655027fac7c7d) (English: I tried to seriously build a bike computer, and it turned out surprisingly well)
48+
- [Raspberry Pi Zero (W, WH, 2 W)でサイクルコンピューターを作ってみよう](https://qiita.com/hishi/items/46619b271daaa9ad41b3) (English: Let's build a bike computer with Raspberry Pi Zero (W, WH, 2 W))
4949

50-
Daily update [at twitter (@pi0bikecomputer)](https://twitter.com/pi0bikecomputer), and [my cycling activity at STRAVA](https://www.strava.com/athletes/40248693).
50+
Daily updates are posted on [X (@pi0bikecomputer)](https://x.com/pi0bikecomputer), and my riding activities are on [STRAVA](https://www.strava.com/athletes/40248693).
5151

5252

5353
<img width="836" alt="system-01-202106" src="https://user-images.githubusercontent.com/12926652/120964687-a6ac4500-c79e-11eb-8598-98ab2e612cd6.png">
@@ -72,10 +72,10 @@ Daily update [at twitter (@pi0bikecomputer)](https://twitter.com/pi0bikecomputer
7272
- Pi Zero Bikecomputer uses same libraries as for standard Linux.
7373
- [Python](https://www.python.org)
7474
- [numpy](https://numpy.org)
75-
- [PyQt6](https://pypi.org/project/PyQt6/) and [PyQtGraph](http://www.pyqtgraph.org)
75+
- [PyQt6](https://pypi.org/project/PyQt6/), [PySide6](https://pypi.org/project/PySide6/) and [PyQtGraph](http://www.pyqtgraph.org)
7676
- [GPSd](https://gpsd.gitlab.io/gpsd/index.html) for GPS modules.
7777
- [CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/what-is-circuitpython) libraries for some I2C sensors.
78-
- So, you can run in cross platform environments such as Raspberry Pi OS, some Linux, macOS and Windows.
78+
- So, you can run in cross-platform environments such as Raspberry Pi OS, Linux, macOS and Windows.
7979

8080
- Good balance between battery life and performance
8181

@@ -91,9 +91,10 @@ Some functions depend on your parts.
9191
| Logging | Yes | See below. |
9292
| Sensors | Yes | ANT+ sensors and I2C sensors. See below. |
9393
| Maps and navigations | Yes | A GPS module or the Android app [GadgetBridge](https://gadgetbridge.org) is required. See below. |
94-
| GUI | Yes | Implemented using PyQt. See below. |
94+
| Displays, controls and power | Yes | Multiple displays, hardware buttons, remote controls, and battery modules are supported. See below. |
95+
| GUI | Yes | PyQt is the primary GUI. QML, Kivy, and headless modes are also available. |
9596
| Wifi & Bluetooth | Yes | Using built-in modules.|
96-
| Smartphone connections | Yes | Android only. Mirroring notifications and getting locations via [GadgetBridge](https://gadgetbridge.org).|
97+
| Smartphone connections | Yes | Android only. GadgetBridge integration and route sharing from Google Maps via Bluetooth. |
9798
| Battery life(Reference) | 18h | with 3100mAh mobile battery([Garmin Charge Power Pack](https://buy.garmin.com/en-US/US/p/571552)) and MIP Reflective color LCD. |
9899

99100
## Logging
@@ -130,9 +131,10 @@ USB dongle is required if using ANT+ sensors.
130131
| ANT+ Light | Yes | Bontrager Flare RT only. |
131132
| ANT+ Control | Yes | Garmin Edge Remote only. |
132133
| ANT+ Environment | Yes | Garmin tempe (temperature sensor) |
133-
| Bluetooth sensors | No | developping now... |
134+
| BLE peripherals | Partial | Zwift Click V2 remote and Fake Trainer for Zwift are supported. |
134135
| Barometric altimeter | Yes | I2C sensor(pressure, temperature) |
135136
| Accelerometer | Yes | I2C sensor |
137+
| Gyroscope | Yes | I2C sensor |
136138
| Magnetometer | Yes | I2C sensor |
137139
| Light sensor | Yes | I2C sensor. Use for auto backlight and lighting. |
138140

@@ -143,12 +145,26 @@ USB dongle is required if using ANT+ sensors.
143145
| GPS module | Yes | UART GPS module(via GPSd) and I2C GPS are supported. |
144146
| Positioning from smartphones | Yes | Using the Android app [GadgetBridge](https://gadgetbridge.org). |
145147
| Map | Yes | Support raster map tile format like OSM (z/x/y.png or jpg). So, offline map is available with local caches. Also, raster .mbtile format is supported. |
146-
| Course on the map| Yes | Local file(.tcx), or cloud course from Ride with GPS with internet connection. |
148+
| Course on the map| Yes | Local `.tcx` files, cloud courses from Ride with GPS, and routes shared from Google Maps on Android via Bluetooth. |
147149
| Search route | Yes | Google Directions API |
148150
| Course profile | Yes | |
149151
| Detect climbs | Yes | Like Garmin ClimbPro. Only climbs on the course, not detect nearby climbs. |
150152
| Cuesheet | Yes | Use course points included in course files(.tcx). |
151-
| Map overlay | Yes | Heatmap (Strava / Ride with GPS) and weather(rain / wind). |
153+
| Map overlay | Yes | Heatmap (Strava / Ride with GPS), weather (rain / wind), and configurable wind / DEM data sources. |
154+
| DEM / wind data sources | Yes | External DEM tiles and wind data sources can be selected from the menu and settings. |
155+
156+
## Displays, controls and power
157+
158+
| Specs | Support | Detail |
159+
|:-|:-|:-|
160+
| MIP reflective color LCD | Yes | JDI 2.7 / 4.4 inch and Azumo 3.4 inch modules are supported. |
161+
| SHARP memory display | Yes | 2.7 / 4.4 inch monochrome MIP modules are supported. |
162+
| TFT LCD | Yes | Pirate Audio, Display HAT Mini, generic ST7789 breakout, and PiTFT are supported. |
163+
| E-paper | Yes | Papirus and DFRobot RPi Display are supported. |
164+
| Touchscreen | Partial | Available on supported TFT displays. |
165+
| Hardware buttons | Yes | Button SHIM, MCP23008 / MCP23009-based IO expanders, and display-attached buttons are supported. |
166+
| Remote control | Yes | Garmin Edge Remote (ANT+) and Zwift Click V2 (BLE) are supported. |
167+
| Battery modules | Partial | PiJuice HAT / Zero and PiSugar3 are supported. |
152168

153169
### Map example
154170

@@ -181,11 +197,11 @@ In Japan, [気象庁降水ナウキャスト](https://www.jma.go.jp/bosai/nowc/)
181197
| Graph | Yes | Altitude and performance(HR, PWR, W prime balance) |
182198
| Customize data pages | Yes | With layout.yaml |
183199
| ANT+ pairing | Yes | |
184-
| Select course | Yes | local .tcx file and Ride with GPS. |
200+
| Select course | Yes | local `.tcx`, Ride with GPS, and Android Google Maps via Bluetooth. |
185201
| Upload activity | Yes | Strava, Garmin and Ride with GPS. |
186-
| Select map | Yes | maps and overlays(heatmap and weather) |
202+
| Select map | Yes | base maps, overlays, and external data sources |
187203
| Adjust parameter | Yes | wheel size, altitude, CP and W prime balance |
188-
| Network setting | Yes | Toggle wifi and BT, BT tethering. |
204+
| Network setting | Yes | Toggle Wi-Fi / Bluetooth, BT pairing / tethering, and GadgetBridge-related options. |
189205
| Language localization | Yes | Font and translation file of items are required. |
190206
| No GUI option | Yes | headless mode |
191207

@@ -221,12 +237,20 @@ it displays three of the people around you in the order in which you caught sens
221237

222238
# Hardware Installation
223239

224-
See [hardware_installation.md](/doc/hardware_installation.md).
240+
See [hardware_installation.md](/doc/hardware_installation.md) for supported displays, GPS modules, I2C sensors, buttons, batteries, and assembly examples.
225241

226242
# Software Installation
227243

228244
See [software_installation.md](/doc/software_installation.md).
229245

246+
For a new Raspberry Pi OS Trixie setup, the recommended entry point is:
247+
248+
```bash
249+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/hishizuka/pizero_bikecomputer/refs/heads/master/install.sh)"
250+
```
251+
252+
For macOS or Linux development, see the manual setup steps in [software_installation.md](/doc/software_installation.md).
253+
230254
# PCB Gallery (under development)
231255
- <img width="480" alt="4inch-01" src="https://github.com/user-attachments/assets/d31f1cd3-5472-47b1-8995-1efe8fb5ef97" />
232256
- <img width="480" alt="4inch-02" src="https://github.com/user-attachments/assets/87afa6c3-ba28-4dbc-970b-e3c7c9a55806" />
@@ -263,7 +287,7 @@ This project also includes code vendored from `hishizuka/crdp`, which is based o
263287

264288
# Author
265289

266-
[hishizuka](https://github.com/hishizuka/) ([@pi0bikecomputer](https://twitter.com/pi0bikecomputer) at twitter, [pizero bikecomputer](https://www.strava.com/athletes/40248693) at STRAVA)
290+
[hishizuka](https://github.com/hishizuka/) ([@pi0bikecomputer](https://x.com/pi0bikecomputer) on X, [pizero bikecomputer](https://www.strava.com/athletes/40248693) on STRAVA)
267291

268292
# Link
269293

0 commit comments

Comments
 (0)