Skip to content

Commit

Permalink
docs folder, wiring instructions etc
Browse files Browse the repository at this point in the history
  • Loading branch information
stepansnigirev committed Sep 22, 2019
1 parent 1a39661 commit 39e01b6
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

## DISCLAIMER

This firmware is **WORK IN PROGRESS and NOT READY TO USE YET**. The master branch is empty **until the first release** of the firmware with core functionality implemented. At the moment all the code is in the [0.0.0-alpha branch](https://github.com/cryptoadvance/specter-diy/tree/0.0.0-alpha).
This firmware is **WORK IN PROGRESS USE AT YOUR OWN RISK**, better on testnet.

This wallet is a **FUNCTIONAL PROTOTYPE**. This means we use it to experiment with user interface, communication methods and new interesting features (like anti chosen-nonce protocol, CoinJoin and Lightning). But this prototype is not ment to be secure. That's why **we don't store your private keys on the device** - you need to type your recovery phrase every time you power it on.

We will add the #Reckless option later on that would allow to store recovery phrase on the device.

## What is this project for?

It is a Do-It-Yourself airgapped hardware wallet that uses QR codes for communication with the computer (i.e. [Specter Desktop app](https://github.com/cryptoadvance/specter-desktop) on top of Bitcoin Core). It can be used as an additional item in your multisignature setup that has a completely different security model:
Expand All @@ -16,7 +18,9 @@ It is a Do-It-Yourself airgapped hardware wallet that uses QR codes for communic

## Current status

GUI takes time... Alpha firmware should be ready for testing by September 8th.
Works for single key transactions. Multisig is coming soon.

Supported networks: Mainnet, Testnet, Regtest, Signet.

## Shopping list

Expand All @@ -35,7 +39,7 @@ For QR code scanner you have several options.

**Option 2.** Requires some soldering / mounting and configuration:

- [Waveshare scanner](https://www.waveshare.com/barcode-scanner-module.htm) - you will need to configure it to use UART for communication, solder a wire to the trigger button and connect to the D5 pin of the board.
- [Waveshare scanner](https://www.waveshare.com/barcode-scanner-module.htm) - you will need to configure it to use UART for communication, solder a wire to the trigger button and connect to the D5 pin of the board. See more details [here](waveshare.md).

Extra: battery & power charger/booster - docs will follow later.

Expand All @@ -44,8 +48,23 @@ We are also working on the kit that you could buy from us that will include a 3d
## Dev plan

- [x] Single key functionality
- [ ] Reckless storage
- [ ] Multisig
- [ ] SD card support
- [ ] Reckless storage
- [ ] Smartcard integration
- [ ] Secure boot
- [ ] DIY kit

## Video and screenshots

Check out [this Twitter thread](https://twitter.com/StepanSnigirev/status/1168923849699876881) to get an idea how it works.

A few crappy screenshots

### Init screens

![](./docs/pictures/init.jpg)

### Wallet screens

![](./docs/pictures/wallet.jpg)
Binary file added docs/pictures/ard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pictures/init.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pictures/wallet.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pictures/waveshare_config.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pictures/waveshare_wiring.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/waveshare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Waveshare Barcode scanner configuration

By default this scanner uses USB for communication. We need to change this setting to UART.

Configuration is done by scanning special QR codes. It needs to be done only once.

First, power it from microUSB cable (i.e. powerbank or laptop) or from the board - connect VCC cable to 5V of the board and GND to GND.

Then scan the following QR codes one by one. To scan a QR code you need to press the TRG button on the scanner - if scan was successfull you will hear the beep.

![](./pictures/waveshare_config.jpg)

Now the scanner is configured and we can connect it to the board. Solder a wire to a button as shown on the picture below and connect the wires.

![](./pictures/waveshare_wiring.jpg)

For convenience you can buy an Arduino Protype shield and solder & mount everything on it (i.e. [this one](https://www.digikey.com/catalog/en/partgroup/proto-shield-rev3-uno-size/79347))

0 comments on commit 39e01b6

Please sign in to comment.