Skip to content

Commit 1f11502

Browse files
committed
Update readme
1 parent 56cc5e6 commit 1f11502

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ layout: default
1717

1818
## User Guide
1919

20-
In the Beepy device, separate from the Raspberry Pi running Linux, there is an RP2040 microcontroller chip. This chip controls basic hardware input and output functions, including keyboard and touchpad input. The firmware discussed here runs directly on the RP2040. It cooperates with the Beepy keyboard driver [beepy-kbd](docs/beepy-kbd.html) to provide key input and other functionality to Linux running on the Raspberry Pi.
20+
In the Beepy device, separate from the Raspberry Pi running Linux, there is an RP2040 microcontroller chip. This chip controls basic hardware input and output functions, including keyboard and touchpad input. The firmware discussed here runs directly on the RP2040. It cooperates with the Beepy keyboard driver [beepy-kbd](beepy-kbd.html) to provide key input and other functionality to Linux running on the Raspberry Pi.
2121

22-
See keyboard driver reference [beepy-kbd](docs/beepy-kbd.html) for more information on keymaps.
22+
See keyboard driver reference [beepy-kbd](beepy-kbd.html) for more information on keymaps.
2323

2424
### Flashing firmware directly
2525

@@ -39,7 +39,7 @@ If you're setting up a new Beepy device, it's recommended to flash the firmware
3939

4040
7. Copy the firmware image onto the presented drive just like a normal file. When copying is complete, Beepy will automatically flash and reboot with the new firmware.
4141

42-
If you're setting up a new device, you can proceed with the rest of the steps in the [quick start guide](quick-start.html).
42+
If you're setting up a new device, you can proceed with the rest of the steps in the [quick start guide](../quick-start.html).
4343

4444
### Firmware update utility
4545

@@ -89,7 +89,7 @@ In this case, update the `beepy-fw` driver and run `sudo update-beepy-fw` (see [
8989

9090
## Developer Reference
9191

92-
This section is intended for developers to reference for working directly with the firmware over I2C, at a lower level than the keyboard driver. For changing firmware settings from Linux through control files, see the keyboard driver reference [beepy-kbd](docs/beepy-kbd.html).
92+
This section is intended for developers to reference for working directly with the firmware over I2C, at a lower level than the keyboard driver. For changing firmware settings from Linux through control files, see the keyboard driver reference [beepy-kbd](beepy-kbd.html).
9393

9494
This firmware is based off of the `i2c_puppet` firmware for keyboard interaction and communication. It adds several Beepy-specific features and improvements, including sticky modifier keys, real-time-clock support, self-update capability, deep sleep mode, and touchpad tuning.
9595

@@ -122,7 +122,7 @@ In the `build` directory, you will find the files `i2c_puppet.uf2` and `app/firm
122122
sed -i '1s;^;+Beepy dev build\n;' beepy.hex
123123
cat beepy.hex | sudo tee /sys/firmware/beepy/update_fw
124124

125-
See keyboard driver reference [beepy-kbd](docs/beepy-kbd.html) for more information on using `/sys/firmware/beepy/update_fw`.
125+
See keyboard driver reference [beepy-kbd](beepy-kbd.html) for more information on using `/sys/firmware/beepy/update_fw`.
126126

127127
### Key values
128128

@@ -137,7 +137,7 @@ Call is mapped to Control. The Berry button is mapped to `KEY_PROPS`. Clicking t
137137

138138
Physical alt does not send an actual Alt key, but remaps the output scancodes to the range 135 to 161 in QWERTY order. This should be combined with a keymap for proper symbol output. This allows symbols to be customized without rebuilding the firmware, as well as proper use of the actual Alt key.
139139

140-
See keyboard driver reference [beepy-kbd](docs/beepy-kbd.html) for more information on keymaps.
140+
See keyboard driver reference [beepy-kbd](beepy-kbd.html) for more information on keymaps.
141141

142142
### Power draw readings
143143

@@ -463,7 +463,7 @@ Color settings are applied after [`REG_LED`](#0x20-reg_id_led) is written.
463463

464464
Read-write, 1 byte.
465465

466-
Write to shut down the Pi, then power-on in that many minutes. Useful for polling services in conjunction with [`REG_ID_STARTUP_REASON`](#0x2e-reg_id_startup_reason), such as with the [beepy-poll](docs/beepy-poll.html) service.
466+
Write to shut down the Pi, then power-on in that many minutes. Useful for polling services in conjunction with [`REG_ID_STARTUP_REASON`](#0x2e-reg_id_startup_reason), such as with the [beepy-poll](beepy-poll.html) service.
467467

468468
#### `0x25` `REG_ID_SHUTDOWN_GRACE`
469469

@@ -519,7 +519,7 @@ Write-only, 1 byte.
519519

520520
Write `1` to commit the values written to RTC registers to the real-time clock. Due to the Beepy hardware design, RTC settings are lost on power off of the RP2040 via power switch, or when entering deep sleep.
521521

522-
The keyboard driver [beepy-kbd](docs/beepy-kbd.html) will update the RP2040 RTC with network time settings when available.
522+
The keyboard driver [beepy-kbd](beepy-kbd.html) will update the RP2040 RTC with network time settings when available.
523523

524524
#### `0x2D` `REG_ID_DRIVER_STATE`
525525

@@ -540,7 +540,7 @@ Contains the reason why the Pi was booted. Useful for polling services in conjun
540540
* `0` RP2040 initialized and booted Pi
541541
* `1` Power button held to turn Pi back on
542542
* `2` Rewake triggered from [`REG_ID_REWAKE_MINS`](#0x24-reg_id_rewake_mins)
543-
* `3` During rewake polling, `0` was written to [`REG_ID_REWAKE_MINS`](#0x24-reg_id_rewake_mins). This allows the [beepy-poll](docs/beepy-poll.html) service to cancel the poll and proceeded with a full boot
543+
* `3` During rewake polling, `0` was written to [`REG_ID_REWAKE_MINS`](#0x24-reg_id_rewake_mins). This allows the [beepy-poll](beepy-poll.html) service to cancel the poll and proceeded with a full boot
544544

545545
#### `0x30` `REG_ID_UPDATE_DATA`
546546

0 commit comments

Comments
 (0)