Skip to content

Commit

Permalink
deploy: 8431fdf
Browse files Browse the repository at this point in the history
  • Loading branch information
odudex committed Mar 20, 2024
1 parent 102c1cd commit 88d9b21
Show file tree
Hide file tree
Showing 17 changed files with 125 additions and 63 deletions.
16 changes: 15 additions & 1 deletion en/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1027,6 +1027,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#why-doesnt-my-maix-amigo-touchscreen-work-with-v24030-if-it-worked-fine-with-v23091" class="md-nav__link">
<span class="md-ellipsis">
Why doesn't my Maix Amigo touchscreen work with v24.03.0 if it worked fine with v23.09.1?
</span>
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1212,6 +1221,11 @@ <h1>FAQ</h1>
<h2 id="why-are-the-buttons-on-my-maix-amigo-in-the-wrong-order-why-is-my-amigo-screen-displaying-the-wrong-colors">Why are the buttons on my Maix Amigo in the wrong order? Why is my Amigo screen displaying the wrong colors?<a class="headerlink" href="#why-are-the-buttons-on-my-maix-amigo-in-the-wrong-order-why-is-my-amigo-screen-displaying-the-wrong-colors" title="Permanent link">&para;</a></h2>
<p>Some Amigo screens have inverted X coordinates while others don’t. If you notice that the buttons on keypad input screens appear to be in the wrong order, please go to <code>Settings &gt; Hardware &gt; Display</code> and change the value of <code>Flipped X Coordinates</code> which should correct the issue.</p>
<p>Others have found that there are issues with the colors displayed in the interface and camera preview. To fix this we have two options in <code>Settings &gt; Hardware &gt; Display</code>, <code>BGR Colors</code> and <code>Inverted Colors</code>, test with them until the colors appear to be correct on your device.</p>
<h2 id="why-doesnt-my-maix-amigo-touchscreen-work-with-v24030-if-it-worked-fine-with-v23091">Why doesn't my Maix Amigo touchscreen work with v24.03.0 if it worked fine with v23.09.1?<a class="headerlink" href="#why-doesnt-my-maix-amigo-touchscreen-work-with-v24030-if-it-worked-fine-with-v23091" title="Permanent link">&para;</a></h2>
<p><img src="../img/amigo-inside-switch-up.jpg" align="right"></p>
<p>We added IRQ to the firmware, so when you open your Maix Amigo, you will see a switch in the middle of the device board, it must be in the upper position for the touchscreen to work with v24.03.0 and later.</p>
<div style="clear: both"></div>

<h2 id="why-isnt-my-device-charging-or-being-recognized-when-connected-to-the-computers-usb">Why isn't my device charging or being recognized when connected to the computer's USB?<a class="headerlink" href="#why-isnt-my-device-charging-or-being-recognized-when-connected-to-the-computers-usb" title="Permanent link">&para;</a></h2>
<p>If you have a Maix Amigo, make sure you're using the USB-C port at the bottom of the device, not the one on the left side.</p>
<p>Different computer hosts have varying hardware, operating systems, and behaviors regarding their USB ports. Below are the expected behaviors:</p>
Expand Down Expand Up @@ -1243,7 +1257,7 @@ <h2 id="why-wont-my-linux-os-list-a-serial-port-after-connecting-my-device">Why
<h2 id="my-device-didnt-reboot-after-flashing-the-firmware-and-when-i-turned-it-off-and-on-again-it-just-stayed-blank-without-showing-anything-on-the-screen-what-should-i-do">My device didn't reboot after flashing the firmware and when I turned it off and on again, it just stayed blank without showing anything on the screen. What should I do?<a class="headerlink" href="#my-device-didnt-reboot-after-flashing-the-firmware-and-when-i-turned-it-off-and-on-again-it-just-stayed-blank-without-showing-anything-on-the-screen-what-should-i-do" title="Permanent link">&para;</a></h2>
<p>Check if the downloaded file matches the device, this can also occur due to data corruption. Try downloading binaries again. You can install <a href="https://dl.sipeed.com/shareURL/MAIX/MaixPy/ide/v0.2.5">MaixPy IDE</a> to help with debugging, Tools &gt; Open Terminal &gt; New Terminal &gt; Connect to serial port &gt; Select a COM port available (if it doesn't work, try another COM port). It will show the terminal and some messages, a message about an empty device or with corrupted firmware appears like: "interesting, something's wrong, boot failed with exit code 233, go to find your vendor."</p>
<h2 id="what-are-all-the-features-available-what-are-the-additional-features-of-the-test-beta-version-is-there-an-android-app">What are all the features available? What are the additional features of the Test (Beta) version? Is there an Android app?<a class="headerlink" href="#what-are-all-the-features-available-what-are-the-additional-features-of-the-test-beta-version-is-there-an-android-app" title="Permanent link">&para;</a></h2>
<p>For <a href="https://github.com/selfcustody/krux/releases">official releases</a> you will find all the features detailed here on the <a href="../getting-started/">Getting Started page</a> with a brief summary on the <a href="../getting-started/navigation/">Navigation Overview page</a>. The latest and most experimental features, which we sometimes share on our social media, can be found only in the <a href="https://github.com/odudex/krux_binaries/">test (beta) repository</a>. Only official releases are signed, Test (Beta) is just for trying new things and providing feedback. Krux Android app ia available as an <code>apk</code> on the <a href="https://github.com/odudex/krux_binaries/">test (beta) repository</a>.</p>
<p>For <a href="https://github.com/selfcustody/krux/releases">official releases</a> you will find all the features detailed here on the <a href="../getting-started/">Getting Started page</a> with a brief summary on the <a href="../getting-started/navigation/">Navigation Overview page</a>. The latest and most experimental features, which we sometimes share on our social media, can be found only in the <a href="https://github.com/odudex/krux_binaries/">test (beta) repository</a>. Only official releases are signed, Test (Beta) is just for trying new things and providing feedback. Krux Android app is available as an <code>apk</code> on the <a href="https://github.com/odudex/krux_binaries/">test (beta) repository</a> (requires Android 6.0 or above).</p>
<h2 id="why-does-krux-show-an-xpub-for-a-segwit-address">Why does Krux show an xpub for a segwit address?<a class="headerlink" href="#why-does-krux-show-an-xpub-for-a-segwit-address" title="Permanent link">&para;</a></h2>
<p>The xpub that Krux displays follows the <a href="https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md/#key-origin-identification">bitcoin core descriptors spec</a> and includes key origin and derivation info that, in theory, makes zpubs (and ypubs) unnecessary <em>if the wallet software being shown this extra information can parse it</em>. </p>
<p>From the spec:</p>
Expand Down
1 change: 1 addition & 0 deletions en/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1039,6 +1039,7 @@

<h1>Getting Started</h1>

<p><img src="../img/krux-devices.jpg"></p>
<p>Krux is open-source Bitcoin signing firmware for devices with the K210 chipset.</p>
<p>Signing operations in Krux are done offline via QR code or via SD card. You can create/load your BIP-39 mnemonic, or import a wallet output descriptor, and sign transactions all without having to plug the device into your computer (except to initially install the firmware). It reads QR codes with its camera and outputs QR codes to its screen, or to paper via an optional <a href="features/printing/">thermal printer attachment</a>. </p>
<p>Krux does not come with its own desktop wallet software. Instead, you can use Krux with third-party wallet coordinators to create/manage wallets, and send transactions from your online computer or mobile device while keeping your keys offline. Krux was built to be vendor agnostic and works with many popular wallet coordinators, including:</p>
Expand Down
4 changes: 2 additions & 2 deletions en/getting-started/installing/from-gui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,7 @@ <h1>From GUI application</h1>

<p>This page explains how to install Krux with KruxInstaller (GUI).</p>
<h3 id="installing-from-a-gui">Installing from a GUI<a class="headerlink" href="#installing-from-a-gui" title="Permanent link">&para;</a></h3>
<p>You can install krux onto your K210-based device using our official desktop application, which we named <a href="https://github.com/selfcustody/krux-installer">KruxInstaller</a>, available for Linux and Windows.</p>
<p>You can install Krux onto your K210-based device using our official desktop application, which we named <a href="https://github.com/selfcustody/krux-installer">KruxInstaller</a>, available for Linux and Windows.</p>
<p>Under the hood the GUI uses the same methods described in <a href="../from-pre-built-release/">Installing from pre-build release</a>, i.e. download, verify and flash the latest official release, but you won't need to type any command. Additionally you will be able to install the <a href="../from-test-release/">pre-built test (beta) release</a> too.</p>
<p>Keep in mind that this is software under development in the alpha stage and may be buggy. If you find any bugs or want to contribute to the project, please open an <a href="https://github.com/selfcustody/krux-installer/issues">issue</a> or make a PR.</p>
<h3 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">&para;</a></h3>
Expand All @@ -1316,7 +1316,7 @@ <h4 id="modify-permissions">Modify permissions<a class="headerlink" href="#modif
</code></pre></div>
<p>If you use Windows, the first time you run the <code>.exe</code> file the system will ask you if you trust the application. Click on <code>more info</code> and then <code>Run anyway</code>.</p>
<h3 id="openssl">Openssl<a class="headerlink" href="#openssl" title="Permanent link">&para;</a></h3>
<p>When downloading the official krux firmware, it is necessary to verify the signature to confirm the authenticity of the binaries using OpenSSL tool.</p>
<p>When downloading the official Krux firmware, it is necessary to verify the signature to confirm the authenticity of the binaries using OpenSSL tool.</p>
<p>On Linux, verification is easily done since OpenSSL is already installed. On windows we would need to install it first. To avoid that, we packaged a stable version of OpenSSL, compiled from source. The compilation process is done entirely in a virtual environment on github and it is expected to be fully verifiable and free of malicious code. You can check the build steps in <a href="https://github.com/selfcustody/krux-installer/actions">github actions</a>.</p>
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
<p>When running Krux Installer, you will be presented with a menu of three items:</p>
Expand Down
4 changes: 2 additions & 2 deletions en/getting-started/usage/generating-a-mnemonic/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1250,9 +1250,9 @@ <h2 id="how-it-works">How it works<a class="headerlink" href="#how-it-works" tit
<div style="clear: both"></div>

<h3 id="how-to-verify">How to verify<a class="headerlink" href="#how-to-verify" title="Permanent link">&para;</a></h3>
<p>Don't trust, verify. We encourage you not to trust any claim you cannot verify yourself. Therefore, there are wallets that use compatible algorithms to calculate the entropy derived from dice rolls. You can use the <a href="https://seedsigner.com/">SeedSigner</a> or Coldcard hardware wallets, or even the <a href="https://bitcoiner.guide/seed/">Bitcoiner Guide website</a>, they share the same logic that Krux uses and will give the same mnemonic.</p>
<p>Don't trust, verify. We encourage you not to trust any claim you cannot verify yourself. Therefore, there are wallets that use compatible algorithms to calculate the entropy derived from dice rolls. You can use the <a href="https://seedsigner.com/">SeedSigner</a> or Coldcard hardware wallets, or even the <a href="https://bitcoiner.guide/seed/">Bitcoiner Guide website</a>, they share the same logic that Krux uses and will give the same mnemonic for the dice roll method.</p>
<h2 id="alternatives">Alternatives<a class="headerlink" href="#alternatives" title="Permanent link">&para;</a></h2>
<p>You can use any other offline airgapped devices to generate your mnemonic. If you want to use a regular PC, a common strategy is to boot the PC using <a href="https://tails.boum.org/">Tails</a> from a USB stick, without connecting the device to the internet, and then use a copy of the the <a href="https://bitcoiner.guide/seed/">Bitcoiner Guide website</a> or even <a href="https://iancoleman.io/bip39/">Ian Coleman's BIP-39 Tool</a>. It's worth noting that both generate a QR code that Krux can read via the QR input method mentioned on the next page (Loading a Mnemonic).</p>
<p>You can use any other offline airgapped devices to generate your mnemonic. If you have an old Android smartphone that is offline (airplane mode [no active CDMA or GSM chip], no Wifi connection, no Bluetooth and localization service turned off), you can use the <a href="../../../faq/#what-are-all-the-features-available-what-are-the-additional-features-of-the-test-beta-version-is-there-an-android-app">Krux app for Android</a>. If you want to use a regular PC, a common strategy is to boot the PC using <a href="https://tails.boum.org/">Tails</a> from a USB stick, without connecting the device to the internet, and then you can run Krux using our <a href="https://github.com/selfcustody/krux?tab=readme-ov-file#run-the-simulator">simulator</a>, use a copy of the the <a href="https://bitcoiner.guide/seed/">Bitcoiner Guide website</a> or even <a href="https://iancoleman.io/bip39/">Ian Coleman's BIP-39 Tool</a>. It's worth noting that both generate a QR code that Krux can read via the QR input method mentioned on the next page (Loading a Mnemonic).</p>



Expand Down
Binary file added en/img/amigo-inside-switch-up.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 en/img/krux-devices.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 27 additions & 11 deletions en/parts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<div data-md-component="skip">


<a href="#devices" class="md-skip">
<a href="#krux-compatible-devices" class="md-skip">
Skip to content
</a>

Expand Down Expand Up @@ -1001,15 +1001,24 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#devices" class="md-nav__link">
<a href="#krux-compatible-devices" class="md-nav__link">
<span class="md-ellipsis">
Devices
Krux Compatible Devices
</span>
</a>

<nav class="md-nav" aria-label="Devices">
<nav class="md-nav" aria-label="Krux Compatible Devices">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#comparative-table" class="md-nav__link">
<span class="md-ellipsis">
Comparative Table
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#m5stickv" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -1043,13 +1052,13 @@
</li>

<li class="md-nav__item">
<a href="#ohter-parts" class="md-nav__link">
<a href="#other-parts" class="md-nav__link">
<span class="md-ellipsis">
Ohter parts
Other Parts
</span>
</a>

<nav class="md-nav" aria-label="Ohter parts">
<nav class="md-nav" aria-label="Other Parts">
<ul class="md-nav__list">

<li class="md-nav__item">
Expand Down Expand Up @@ -1161,7 +1170,9 @@

<h1>Devices and Part List</h1>

<p><strong>Krux compatible devices comparative table</strong></p>
<h2 id="krux-compatible-devices">Krux Compatible Devices<a class="headerlink" href="#krux-compatible-devices" title="Permanent link">&para;</a></h2>
<p><img src="../img/krux-devices.jpg"></p>
<h3 id="comparative-table">Comparative Table<a class="headerlink" href="#comparative-table" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1204,7 +1215,7 @@ <h1>Devices and Part List</h1>
<td>OV7740 rear<br>GC0328 front</td>
<td>GC0328</td>
<td>OV2640 or<br>OV5642</td>
<td>OV2640</td>
<td>OV2640 <!-- or<br>GC2145 --></td>
</tr>
<tr>
<td>Battery</td>
Expand Down Expand Up @@ -1244,8 +1255,8 @@ <h1>Devices and Part List</h1>
<p><i style="font-size: 85%"><strong>All devices feature Kendryte K210 chip:</strong>
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></p>
<h2 id="devices">Devices<a class="headerlink" href="#devices" title="Permanent link">&para;</a></h2>
<h3 id="m5stickv">M5StickV<a class="headerlink" href="#m5stickv" title="Permanent link">&para;</a></h3>
<p><img srcset="../img/maixpy_m5stickv/logo-125.png" align="right"></p>
<p>Available from many distributors, including:</p>
<ul>
<li><a href="https://shop.m5stack.com/products/stickv">M5Stack</a></li>
Expand All @@ -1256,7 +1267,10 @@ <h3 id="m5stickv">M5StickV<a class="headerlink" href="#m5stickv" title="Permanen
<li><a href="https://www.cytron.io/c-development-tools/c-fpga/p-m5stickv-k210-ai-camera-without-wifi">Cytron</a></li>
<li><a href="https://www.okdo.com/p/m5stickv-k210-ai-camera-without-wifi/">OKDO</a></li>
</ul>
<div style="clear: both"></div>

<h3 id="maix-amigo">Maix Amigo<a class="headerlink" href="#maix-amigo" title="Permanent link">&para;</a></h3>
<p><img srcset="../img/maixpy_amigo/logo-150.png" align="right"></p>
<p>Available from many distributors, including:</p>
<ul>
<li><a href="https://www.seeedstudio.com/Sipeed-Maix-Amigo-p-4689.html">Seeed Studio</a></li>
Expand All @@ -1266,14 +1280,16 @@ <h3 id="maix-amigo">Maix Amigo<a class="headerlink" href="#maix-amigo" title="Pe
<li><a href="https://www.aliexpress.com/w/wholesale-sipeed-amigo.html">AliExpress</a></li>
<li><a href="https://www.amazon.com/s?k=sipeed+amigo&amp;dc">Amazon</a></li>
</ul>
<div style="clear: both"></div>

<h3 id="maix-dock-and-maix-bit">Maix Dock and Maix Bit<a class="headerlink" href="#maix-dock-and-maix-bit" title="Permanent link">&para;</a></h3>
<p>For the DIYers, the Maix Dock and Maix Bit are also supported but will require sourcing the parts individually and building the device yourself.</p>
<p>Below are example implementations with instructions on how to recreate them:</p>
<ul>
<li><a href="https://github.com/selfcustody/DockEncoderCase">https://github.com/selfcustody/DockEncoderCase</a></li>
<li><a href="https://github.com/selfcustody/MaixBitCase">https://github.com/selfcustody/MaixBitCase</a></li>
</ul>
<h2 id="ohter-parts">Ohter parts<a class="headerlink" href="#ohter-parts" title="Permanent link">&para;</a></h2>
<h2 id="other-parts">Other Parts<a class="headerlink" href="#other-parts" title="Permanent link">&para;</a></h2>
<h3 id="usb-c-charge-cable">USB-C Charge Cable<a class="headerlink" href="#usb-c-charge-cable" title="Permanent link">&para;</a></h3>
<p>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.</p>
<h3 id="optional-microsd-card">(Optional) MicroSD Card<a class="headerlink" href="#optional-microsd-card" title="Permanent link">&para;</a></h3>
Expand Down
Loading

0 comments on commit 88d9b21

Please sign in to comment.