Skip to content

Commit 0e1ad44

Browse files
committed
Update README
1 parent c76cac2 commit 0e1ad44

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,23 @@ TurtlPass Firmware offers a straightforward and secure method for creating robus
99
<p align="center">
1010
<a href="https://github.com/TurtlPass/turtlpass-android"><img src="https://img.shields.io/github/v/release/TurtlPass/turtlpass-android?color=blue&label=Android%20App&logo=android" alt="Android Repo"/></a>
1111
<a href="https://github.com/TurtlPass/turtlpass-chrome-extension"><img src="https://img.shields.io/github/v/release/TurtlPass/turtlpass-chrome-extension?color=blue&label=Chrome%20Extension&logo=googlechrome" alt="Chrome Extension Repo"/></a>
12+
<a href="https://github.com/TurtlPass/turtlpass-python"><img src="https://img.shields.io/github/v/release/TurtlPass/turtlpass-python?color=blue&label=Python%20CLI&logo=python" alt="Python CLI Repo"/></a>
1213
</p>
1314

1415

1516
## ⚡ Features
1617

1718
* **Hardware Password Generator**
1819
* Unlimited passwords are generated on the device
19-
* Passwords are 100 characters long, including a combination of lowercase and uppercase letters, as well as numbers
20+
* Passwords are 100 characters long, including a combination of lowercase and uppercase letters, as well as numbers (plus symbols if you choose to)
2021
* Automatically types the password for you, so you don't have to
2122
* **Hardware 2FA Manager**
22-
* One-time passwords (OTP) are generated on the device&#x20;
23+
* One-time passwords are generated on the device
2324
* Automatically types the OTP code whenever you're ready
24-
* Shared secrets are encrypted with `AES-256` in the virtual `EEPROM`
25+
* Shared secrets are encrypted with `ChaCha20` algorithm in the `EEPROM`
2526
* **Hardware Encryption**
2627
* Files encrypted on the device using the `ChaCha20` algorithm
28+
* Speed: ~80 kB/s @ 133 Mhz
2729

2830

2931
## 🏗️ Circuit Diagram
@@ -100,6 +102,19 @@ __9 different color/SEED pairs available:__
100102

101103
**Run the following command to compile the firmware to your RP2040 board:**
102104

105+
_Option A:_ If you have a touch sensor TTP-223 wired to the PIN number `2`
106+
107+
```
108+
$ arduino-cli compile --clean \
109+
--fqbn "rp2040:rp2040:generic" \
110+
--output-dir ../turtlpass-firmware/build/ \
111+
--build-property "build.extra_flags=\"-D__TURTLPASS_VERSION__=\"2.0.0\"\"" \
112+
--build-property "build.extra_flags=\"-D__TURTLPASS_PIN_TTP223__=2\"" \
113+
../turtlpass-firmware/turtlpass-firmware.ino
114+
```
115+
116+
_Option B:_ If you don't have a touch sensor TTP-223, fallback to built-in `BOOTSEL` button
117+
103118
```
104119
$ arduino-cli compile --clean \
105120
--fqbn "rp2040:rp2040:generic" \

0 commit comments

Comments
 (0)