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
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,37 @@
1
1
# PowerKey
2
2
3
-
> - Your password is too long to type or to remember?
3
+
> - Your password is too long to remember?
4
4
> - Try PowerKey instead!
5
5
6
+

7
+
6
8
## Brief
7
9
8
10
PowerKey is a simple single-key device which acts as a USB-keyboard and automatically types password, or any another preprogrammed string.
9
11
12
+
## Building
13
+
10
14
### Ingredients
11
15
12
-
* 1x Arduino Pro Micro.
13
-
* 2x LEDs + 220Ω resistors.
14
-
* 1x Cherry MX or another switch.
15
-
* 1x Button.
16
+
* 1x Arduino Pro Micro
17
+
* 2x LEDs + 220Ω resistors
18
+
* 1x Cherry MX or another switch
19
+
* 1x Button
20
+
* 3D Printer (optionally, to print [housing](./docs/3d-print/PowerKeyCase.f3d))
21
+
22
+
> [!NOTE]
23
+
> See [include/config.h](include/config.h) for pinout config.
24
+
25
+
## Firmware
26
+
27
+
Use `make build` and `make upload` to flash a board.
28
+
29
+
> [!IMPORTANT]
30
+
> PlatformIO is required to build the project. Install [PlatformIO CLI](https://docs.platformio.org/en/latest/core/index.html) or [VSCode extension](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide).
31
+
32
+
## Housing
33
+
34
+
You can find a Fusion 360 project [here](./docs/3d-print/PowerKeyCase.f3d).
16
35
17
36
## Configuration
18
37
@@ -24,4 +43,3 @@ See [include/config.h](include/config.h) for pinout configuration and firmware o
24
43
25
44
Use [PowerKey Programmer](https://x1unix.github.io/powerkey/flasher) web tool to re-program a device and update stored password.
0 commit comments