Skip to content

Commit

Permalink
Merge pull request #325 from tadeubas/integrated_changes
Browse files Browse the repository at this point in the history
Small changes in documentation
  • Loading branch information
odudex authored Feb 21, 2024
2 parents 6457502 + f9ed8df commit 7ffe7da
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/features/printing.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Krux has the ability to print all QR codes it generates, including mnemonic, xpub, wallet backup, and signed PSBT, via a locally-connected thermal printer over its serial port. Consult the [part list](../../parts.md) page for supported printers.
Krux has the ability to print all QR codes it generates, including mnemonic, xpub, wallet backup, and signed PSBT, via a locally-connected thermal printer over its serial port. Consult the [part list](../../parts.md#optional-thermal-printer) page for supported printers.

<img src="../../../img/maixpy_amigo_tft/print-qr-printing-150.png">
<img src="../../../img/maixpy_m5stickv/print-qr-printing-125.png">
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/settings.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Define several machining parameters according to the desired size, material you'
#### Thermal

Printers can come with different baudrates from the manufacturer. By default, Krux assumes the connected printer will have a baudrate of `9600`. If yours is different, you can change this here.
Also setup the IOs you'll use and tweak parameters according to your printer recommendations.
Also setup the IOs you'll use and tweak parameters according to your printer recommendations. Consult the [part list](../../parts.md#optional-thermal-printer) page for supported printers.

#### Driver

Expand Down
4 changes: 2 additions & 2 deletions docs/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ hide:
<img srcset="img/maixpy_m5stickv/logo-125.png" align="right">
<img srcset="img/maixpy_amigo_tft/logo-150.png" align="right">

Krux is open-source firmware that enables anyone to build their own Bitcoin signing device via off-the-shelf parts. It runs on Kendryte K210 devices such as the [M5StickV](https://docs.m5stack.com/en/core/m5stickv) and [Maix Amigo](https://www.seeedstudio.com/Sipeed-Maix-Amigo-p-4689.html), converting them into airgapped devices that can sign transactions for multisignature and single-signature wallets.
Krux is open-source firmware that enables anyone to build their own Bitcoin signing device via off-the-shelf parts. It runs on Kendryte K210 devices such as the [Maix Amigo](https://www.seeedstudio.com/Sipeed-Maix-Amigo-p-4689.html), [M5StickV](https://docs.m5stack.com/en/core/m5stickv) and [more](parts.en.md)!, converting them into airgapped devices that can sign transactions for multisignature and single-signature wallets.

You can even attach a thermal printer and print out the QR codes that it generates.
You can even attach a thermal printer and [print](getting-started/features/printing.en.md) out the QR codes that it generates.

To learn more about how Krux works, check out [Getting Started](getting-started/index.en.md).
55 changes: 26 additions & 29 deletions docs/parts.en.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,44 @@
**Krux compatible devices comparative table**

| Device | M5stickV | Maix Amigo | Maix Dock | Maix Bit |
| ------------- | ------------- | ------------- | ------------- | ------------- |
| Price | US$50 | US$47-63 | US$35 | US$35 |
| Screen size | 1.14" | 3.5" | 2.4" | 2.4" |
| Screen resolution | 135*240 | 320*480 | 240*320 | 240*320 |
| Touchscreen | | Capacitive | | |
| Camera | OV7740 | OV7740 rear<br>GC0328 front | GC0328 | OV2640 or<br>OV5642 |
| Battery | 200mAh | 520mAh | | |
| Requirements | | | Rotary encoder<br> 3D printed case<br> Soldering<br>Assembly | Buttons<br> 3D printed case<br> Soldering<br>Assembly |
| Warnings | | | *1 | |

*1: Some shops ship Maix Dock with soldered pin headers that do not fit in 3D printed enclosure

All devices feature Kendryte K210 chip:
28nm process, dual-core RISC-V 64bit @400MHz, 8 MB high-speed SRAM, DVP camera and MCU LCD interface, AES Accelerator, SHA256 Accelerator, FFT Accelerator
| Device | M5stickV | Maix Amigo | Maix Dock | Maix Bit | Yahboom k210 module |
| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
| Price avg. | US$50 | US$55 | US$35 | US$35 | US$60 |
| Screen size / resolution | 1.14" / 135*240 | 3.5" / 320*480 | 2.4" / 240*320 | 2.4" / 240*320 | 2" / 240*320 |
| Touchscreen | :x: | Capacitive | :x: | :x: | Capacitive |
| Camera | OV7740 | OV7740 rear<br>GC0328 front | GC0328 | OV2640 or<br>OV5642 | OV2640 |
| Battery | 200mAh | 520mAh | :x: | :x: | :x: |
| Requirements | None | None | [Rotary encoder](https://duckduckgo.com/?q=ky-040)<br> [3D printed case](https://github.com/selfcustody/DockEncoderCase)<br> Soldering<br>Assembly | Buttons<br> [3D printed case](https://github.com/selfcustody/MaixBitCase)<br> Soldering<br>Assembly | None |
| Warnings | | | [:material-information:{ title="Some stores ship the Maix Dock with soldered pin connectors that do not fit into the 3D printed case" }](#dock-info) | | Micro USB |

<i style="font-size: 85%">:material-information:{id="dock-info"}:
Some stores ship the Maix Dock with soldered pin connectors that do not fit into the [3D printed case](https://github.com/selfcustody/DockEncoderCase)
</i>

<i style="font-size: 85%">**All devices feature Kendryte K210 chip:**
28nm process, dual-core RISC-V 64bit @400MHz, 8 MB high-speed SRAM, DVP camera and MCU LCD interface, AES Accelerator, SHA256 Accelerator, FFT Accelerator.
</i>

## Devices
### M5StickV
Available from many distributors, including:

- [M5Stack](https://shop.m5stack.com/products/stickv)
- [Adafruit](https://www.adafruit.com/product/4321)
- [Mouser](https://www.mouser.com/)
- [Mouser](https://www.mouser.com/c/?q=m5stickv)
- [Digi-Key](https://www.digikey.com/en/products/detail/m5stack-technology-co-ltd/K027/10492135)
- [Lee's Electronic](https://leeselectronic.com/en/product/169940-m5stick-ai-camera-kendryte-k210-risc-v-core-no-wifi.html)
- [Cytron](https://www.cytron.io/c-development-tools/c-fpga/p-m5stickv-k210-ai-camera-without-wifi)
- [Pimoroni](https://shop.pimoroni.com/products/m5stick-v-k210-ai-camera-without-wifi)
- [OKDO](https://www.okdo.com/p/m5stickv-k210-ai-camera-without-wifi/)

You can expect to pay around $50 for one depending on which distributor you choose.

### Maix Amigo
Available from many distributors, including:

- [Seeed Studio](https://www.seeedstudio.com/Sipeed-Maix-Amigo-p-4689.html)
- [Mouser](https://www.mouser.com/)
- [Electromaker](https://www.electromaker.io/shop/product/sipeed-maix-amigo)
- [Antratek](https://www.antratek.com/sipeed-maix-amigo)
- [Mouser](https://www.mouser.com/c/?q=sipeed)
- [Electromaker](https://www.electromaker.io/shop/search/sipeed)
- [Digi-Key](https://www.digikey.com/en/products/detail/seeed-technology-co-ltd/102110463/13168813)
- [AliExpress](https://www.aliexpress.com/)

You can expect to pay around $70 for one depending on which distributor you choose.
- [AliExpress](https://www.aliexpress.com/w/wholesale-sipeed-amigo.html)
- [Amazon](https://www.amazon.com/s?k=sipeed+amigo&dc)

### Maix Dock and Maix Bit
For the DIYers, the Maix Dock and Bit are also supported but will require sourcing the parts individually and building the device yourself.
Expand All @@ -56,12 +53,12 @@ Below are example implementations with instructions on how to recreate them:
This will be included with the M5StickV and Maix Amigo that you purchase from one of the distributors above. It will be necessary to power and charge the device and to initially flash the firmware.

### (Optional) MicroSD Card
Not all microSD cards will work with the devices. Make sure to use one that has been [tested and shown to work](https://github.com/m5stack/m5-docs/blob/master/docs/en/core/m5stickv.md#tf-cardmicrosd-test) with the devices already. The size of the SD card isn't important; anything over a few megabytes will be plenty.
Not all microSD cards will work with the devices. Make sure to use one that has been [tested and shown to work](https://github.com/m5stack/m5-docs/blob/master/docs/en/core/m5stickv.md#tf-cardmicrosd-test) with the devices already, read the [FAQ](faq.en.md/#why-isnt-krux-detecting-my-microsd-card-or-presenting-an-error) for more info. The size of the SD card isn't important; anything over a few megabytes will be plenty.

### (Optional) Thermal Printer
Krux has the ability to print all QR codes it generates, including mnemonic, xpub, wallet backup, and signed PSBT, via a locally-connected [thermal printer from Adafruit](https://www.adafruit.com/?q=thermal+printer) over its serial port.
Krux has the ability to print all QR codes it generates, including mnemonic, xpub, wallet backup, and signed PSBT, via a locally-connected thermal printer over its serial port.

Any of their thermal printers will work, but the [starter pack](https://www.adafruit.com/product/600) would be the easiest way to get started since it includes all the parts (except the one below) you will need to begin printing.
Many thermal printers may work, but the [starter pack](https://www.adafruit.com/product/600) would be the easiest way to get started since it includes all the parts you will need to begin printing (except the conversion cable). For more info, [see here](https://github.com/selfcustody/krux/discussions/312)

### (Optional) Conversion Cable for Thermal Printer
To connect the printer to the device, you will need a [conversion cable](https://store-usa.arduino.cc/products/grove-4-pin-male-to-grove-4-pin-cable-5-pcs) with a 4-pin female Grove connector on one end (to connect to the device) and 4-pin male jumpers on the other end (to connect to the printer). You can find them at one of the distributors above or from Amazon.
To connect the printer to the device, you will need a [conversion cable](https://store-usa.arduino.cc/products/grove-4-pin-male-to-grove-4-pin-cable-5-pcs) with a 4-pin female Grove connector on one end (to connect to the device) and 4-pin male jumpers on the other end (to connect to the printer).
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
markdown_extensions:
- attr_list
- meta
- toc:
permalink: true
Expand All @@ -8,6 +9,9 @@ markdown_extensions:
preserve_tabs: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
- css/custom.css
Expand Down

0 comments on commit 7ffe7da

Please sign in to comment.