You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ layout: default
17
17
18
18
## User Guide
19
19
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.
21
21
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.
23
23
24
24
### Flashing firmware directly
25
25
@@ -39,7 +39,7 @@ If you're setting up a new Beepy device, it's recommended to flash the firmware
39
39
40
40
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.
41
41
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).
43
43
44
44
### Firmware update utility
45
45
@@ -89,7 +89,7 @@ In this case, update the `beepy-fw` driver and run `sudo update-beepy-fw` (see [
89
89
90
90
## Developer Reference
91
91
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).
93
93
94
94
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.
95
95
@@ -122,7 +122,7 @@ In the `build` directory, you will find the files `i2c_puppet.uf2` and `app/firm
122
122
sed -i '1s;^;+Beepy dev build\n;' beepy.hex
123
123
cat beepy.hex | sudo tee /sys/firmware/beepy/update_fw
124
124
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`.
126
126
127
127
### Key values
128
128
@@ -137,7 +137,7 @@ Call is mapped to Control. The Berry button is mapped to `KEY_PROPS`. Clicking t
137
137
138
138
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.
139
139
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.
141
141
142
142
### Power draw readings
143
143
@@ -463,7 +463,7 @@ Color settings are applied after [`REG_LED`](#0x20-reg_id_led) is written.
463
463
464
464
Read-write, 1 byte.
465
465
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.
467
467
468
468
#### `0x25``REG_ID_SHUTDOWN_GRACE`
469
469
@@ -519,7 +519,7 @@ Write-only, 1 byte.
519
519
520
520
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.
521
521
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.
523
523
524
524
#### `0x2D``REG_ID_DRIVER_STATE`
525
525
@@ -540,7 +540,7 @@ Contains the reason why the Pi was booted. Useful for polling services in conjun
540
540
*`0` RP2040 initialized and booted Pi
541
541
*`1` Power button held to turn Pi back on
542
542
*`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
0 commit comments