Publish site for 224b3b37e8 [skip ci]
This commit is contained in:
File diff suppressed because one or more lines are too long
+19
@@ -0,0 +1,19 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Overview - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href=""><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="" class=on>Overview</a><a href="manual/">Manual</a><a href="quality/">Code quality</a><a href="bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><h1>Alkane Toolkit</h1>
|
||||
<p>Desktop discovery and monitoring for ASIC miners on your network: find every
|
||||
miner in your IP ranges, see hashrate, power, temperatures, fans and hashboard
|
||||
health at a glance, and run the controls each firmware supports.</p>
|
||||
<div class="buttons"><a class="primary" href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Download for Windows or Linux</a>
|
||||
<a href="manual/">Read the manual</a><a href="quality/">Code quality: C</a>
|
||||
<a href="bench/">Benchmarks</a></div>
|
||||
<h2>Platforms</h2>
|
||||
<ul><li><b>Windows 10 and 11</b> (x86_64): one signed, self-contained <code>alkane-toolkit.exe</code>.</li>
|
||||
<li><b>Linux</b> (x86_64, GTK 3): one binary.</li></ul>
|
||||
<p>Every release is built, tested and signed by CI from the public source.</p>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,160 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Actions - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html" class=on>Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="actions">Actions</h1>
|
||||
<p>Right-click one or more selected miners for the actions menu. With several
|
||||
miners selected, labels show the count, for example <em>Restart (12)</em>. An action
|
||||
appears only when <strong>every</strong> selected miner's firmware supports it, so the menu
|
||||
changes with the selection.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Action</th>
|
||||
<th>What it does</th>
|
||||
<th>Changes the miner</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Open in browser</td>
|
||||
<td>opens each miner's web page</td>
|
||||
<td>no</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Refresh</td>
|
||||
<td>re-reads just these miners</td>
|
||||
<td>no</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Check access (auth)</td>
|
||||
<td>tests whether the saved login is accepted</td>
|
||||
<td>no</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>View log (API)...</td>
|
||||
<td>shows the first selected miner's log (WhatsMiner: its active fault codes)</td>
|
||||
<td>no</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Restore to stock firmware...</td>
|
||||
<td>removes aftermarket firmware; see <a href="restore.html">Restore to stock</a></td>
|
||||
<td>yes, reboots</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Flash lights / Stop flashing lights</td>
|
||||
<td>locate light on or off</td>
|
||||
<td>yes, harmless</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Pause mining / Resume mining</td>
|
||||
<td>stop or start hashing</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Set tuning %...</td>
|
||||
<td>tuning level, 0 to 100</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Set power target...</td>
|
||||
<td>power target in watts; the prompt shows the current value and the allowed range</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Set hashrate target...</td>
|
||||
<td>hashrate target in TH/s, for firmware that tunes by hashrate</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Set profile...</td>
|
||||
<td>pick a firmware profile or preset (only profiles every selected miner has are listed)</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Restart</td>
|
||||
<td>reboot</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Configure pools...</td>
|
||||
<td>set up to three pools</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Set timezone...</td>
|
||||
<td>IANA time zone, for example <code>America/Edmonton</code></td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Change password...</td>
|
||||
<td>new web/API password</td>
|
||||
<td>yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Factory reset...</td>
|
||||
<td>wipes pools, tuning and network settings and reboots; the miner may come back on a new DHCP address</td>
|
||||
<td>yes, destructive</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="safety">Safety</h2>
|
||||
<ul>
|
||||
<li>Pause, Resume, Restart and Factory reset ask for confirmation. Value prompts
|
||||
(tuning, targets, timezone, password) apply when you confirm the value.</li>
|
||||
<li>Actions that change miners do not start while a scan is running, including an
|
||||
automatic rescan. Wait for it to finish or press <strong>Pause</strong>. Scans in turn wait
|
||||
for running actions.</li>
|
||||
<li>Each changed miner is re-read automatically when the action finishes. Results
|
||||
and failures appear in the bottom-right corner of the status bar and in
|
||||
<strong>Settings > Logs</strong>.</li>
|
||||
<li>If <strong>Change password</strong> succeeds on every selected miner, the saved global
|
||||
login is updated to the new password. If only some succeed, the saved login
|
||||
is left alone and the log says so.</li>
|
||||
</ul>
|
||||
<h2 id="configuring-pools">Configuring pools</h2>
|
||||
<p>The pool dialog has three rows: Address, Account, Worker and Password. A row is
|
||||
used only when it has an address and an account. A blank password becomes <code>x</code>.
|
||||
The miner's username becomes <code>account.worker</code>.</p>
|
||||
<p>Each field has a <strong>+</strong> menu with common pool addresses and the values you saved
|
||||
before (<strong>Add new...</strong> edits that list). Worker names can use placeholders that
|
||||
are filled in per miner:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Placeholder</th>
|
||||
<th>Becomes</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>{ip1}</code> to <code>{ip4}</code></td>
|
||||
<td>one octet of the miner's IP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{serial}</code>, <code>{mac}</code></td>
|
||||
<td>serial number; MAC without colons</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{hostname}</code></td>
|
||||
<td>the miner's hostname</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{brand}</code>, <code>{model}</code>, <code>{submodel}</code></td>
|
||||
<td>make and model</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{firmware}</code>, <code>{cpu}</code>, <code>{cb}</code></td>
|
||||
<td>firmware family, control-board CPU and board</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{nameplate-hr}</code></td>
|
||||
<td>the model's rated hashrate</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>For example, <code>rack3-{ip3}-{ip4}</code> gives <code>rack3-1-50</code> for <code>10.0.1.50</code>.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,82 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Command line and environment - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html" class=on>Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="command-line-and-environment">Command line and environment</h1>
|
||||
<h2 id="environment-variables">Environment variables</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Effect</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>ALKANE_FAKE_SCAN=1</code></td>
|
||||
<td>demo mode: a built-in sample fleet, no network traffic, simulated actions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALKANE_APPEARANCE=light</code> or <code>dark</code></td>
|
||||
<td>force the light or dark theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALKANE_SELFTEST=1</code></td>
|
||||
<td>run the built-in UI self-test on the sample fleet and exit (prints <code>SELFTEST PASS</code> or <code>FAIL</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALKANE_ACCESS_PROBE="<ip> <make>"</code></td>
|
||||
<td>print whether the saved login can change that miner, then exit</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ALKANE_LOG_SCAN="<ip> <brand>"</code></td>
|
||||
<td>fetch that miner's log through its API, print the size, then exit</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>On Windows these one-shot modes print to the Command Prompt they are started
|
||||
from.</p>
|
||||
<h2 id="miner_probe">miner_probe</h2>
|
||||
<p><code>miner_probe</code> is a command-line companion for scripting and diagnosis. These
|
||||
commands only read:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Command</th>
|
||||
<th>Prints</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>miner_probe scan <cidr> [<cidr>...]</code></td>
|
||||
<td>discovered miners and their telemetry, as tab-separated values</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>miner_probe hashrate <cidr>...</code></td>
|
||||
<td>raw hashrate and algorithm</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>miner_probe msgs <ip></code></td>
|
||||
<td>fault messages and per-board data</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>miner_probe tune <ip></code></td>
|
||||
<td>tuning support and limits</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>miner_probe presets <ip></code></td>
|
||||
<td>available firmware profiles</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>miner_probe timezone <ip></code></td>
|
||||
<td>the current time zone</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Its other commands change miners. It uses the global login from the settings
|
||||
folder, or <code>ALKANE_PROBE_USER</code> and <code>ALKANE_PROBE_PASS</code>, and
|
||||
<code>ALKANE_PROBE_CONCURRENCY</code> (default 128).</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,20 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Export - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html" class=on>Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="export">Export</h1>
|
||||
<p><strong>Export</strong> saves the scan as a CSV file for spreadsheets or other tools.</p>
|
||||
<ol>
|
||||
<li>Choose the fields to include (all are ticked by default; <strong>All</strong> and
|
||||
<strong>None</strong> help).</li>
|
||||
<li>Pick where to save. The suggested name is <code>alkane-export-YYYYMMDD-HHMMSS.csv</code>.</li>
|
||||
</ol>
|
||||
<p>The export contains <strong>every scanned miner</strong>, not just the rows the current
|
||||
filter shows. Per-board temperatures, fan speeds, board status and pools
|
||||
become numbered columns (<code>board_temp_1_c</code>, <code>fan_2_rpm</code>, <code>pool_1_url</code>, ...).</p>
|
||||
<p>Values that start with <code>=</code>, <code>+</code>, <code>-</code> or <code>@</code> are prefixed with <code>'</code> so a
|
||||
spreadsheet treats them as text, not formulas.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,109 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Getting started - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html" class=on>Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="getting-started">Getting started</h1>
|
||||
<p>Alkane Toolkit finds the ASIC miners on your network and shows them in one
|
||||
table: model, firmware, hashrate, power, temperatures, fans and the health of
|
||||
every hashboard. From the same table you can run the controls each miner's
|
||||
firmware supports, such as pausing, restarting or changing pools.</p>
|
||||
<h2 id="download">Download</h2>
|
||||
<p>Get the latest release from the
|
||||
<a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">downloads page</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Platform</th>
|
||||
<th>File</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Windows 10 and 11 (x86_64)</td>
|
||||
<td><code>alkane-toolkit-vX.Y.Z-windows-x86_64.zip</code></td>
|
||||
<td>One signed <code>alkane-toolkit.exe</code>; nothing to install</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Linux (x86_64)</td>
|
||||
<td><code>alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz</code></td>
|
||||
<td>One binary; needs GTK 3 (<code>sudo apt install libgtk-3-0</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>macOS 11 or later (Apple Silicon and Intel)</td>
|
||||
<td><code>alkane-toolkit-vX.Y.Z-macos-universal.zip</code></td>
|
||||
<td>One app; not notarized, so confirm the first launch</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="windows">Windows</h3>
|
||||
<ol>
|
||||
<li>Download the zip, right-click it, choose <strong>Properties</strong>, tick <strong>Unblock</strong> if
|
||||
it is shown, then extract it.</li>
|
||||
<li>Run <code>alkane-toolkit.exe</code>. Windows shows <em>BlueFlare Energy Solutions Inc.</em> as
|
||||
the verified publisher. To check the signature yourself, right-click the exe,
|
||||
choose <strong>Properties</strong> and open <strong>Digital Signatures</strong>.</li>
|
||||
</ol>
|
||||
<h3 id="macos">macOS</h3>
|
||||
<ol>
|
||||
<li>Download the zip and open it; drag <strong>Alkane Toolkit</strong> to Applications.</li>
|
||||
<li>Open it. The app is not notarized, so macOS blocks the first launch:</li>
|
||||
<li>macOS 15 or later: open <strong>System Settings > Privacy & Security</strong> and
|
||||
choose <strong>Open Anyway</strong> for Alkane Toolkit.</li>
|
||||
<li>macOS 11 to 14: Control-click the app, choose <strong>Open</strong>, then <strong>Open</strong>.</li>
|
||||
<li>When asked, allow it to find devices on your local network. Scanning
|
||||
needs this.</li>
|
||||
</ol>
|
||||
<h3 id="linux">Linux</h3>
|
||||
<pre><code class="language-sh">tar xzf alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz
|
||||
./alkane-toolkit-vX.Y.Z-linux-x86_64/alkane-toolkit
|
||||
</code></pre>
|
||||
<h2 id="first-run">First run</h2>
|
||||
<p>The toolkit starts a scan as soon as it opens. Set your own ranges first with
|
||||
<strong>Scan ranges</strong> (see <a href="scanning.html">Scanning</a>); until you do, it scans
|
||||
192.168.1.0/24, the usual router subnet.</p>
|
||||
<p>To look around without touching any miner, start it in demo mode. It shows a
|
||||
built-in sample fleet and simulates every action:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Platform</th>
|
||||
<th>Command</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Windows (Command Prompt)</td>
|
||||
<td><code>set ALKANE_FAKE_SCAN=1 && alkane-toolkit.exe</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Linux</td>
|
||||
<td><code>ALKANE_FAKE_SCAN=1 ./alkane-toolkit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="where-settings-are-kept">Where settings are kept</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Platform</th>
|
||||
<th>Folder</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Windows</td>
|
||||
<td><code>%APPDATA%\alkane-toolkit</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Linux</td>
|
||||
<td><code>~/.config/alkane-toolkit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>See <a href="settings.html">Settings and credentials</a> for the files in that folder.
|
||||
Deleting the folder resets the toolkit to its defaults.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,77 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Health, access and light - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html" class=on>Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="health-access-and-light">Health, access and light</h1>
|
||||
<h2 id="the-health-column">The Health column</h2>
|
||||
<p>Each miner gets a row of icons, always in the same order, so problems line up
|
||||
across the table:</p>
|
||||
<ol>
|
||||
<li><strong>Bolt</strong>: the power supply</li>
|
||||
<li><strong>Brain</strong>: the control board</li>
|
||||
<li><strong>Fan</strong>: one icon per fan</li>
|
||||
<li><strong>Chip</strong>: one icon per hashboard</li>
|
||||
</ol>
|
||||
<p>Hover over any icon to see its details: PSU voltage and current, the fan speed,
|
||||
or a hashboard's actual and expected hashrate, frequency and voltage, and any
|
||||
fault message with its code.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Colour</th>
|
||||
<th>Meaning</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Green</td>
|
||||
<td>healthy</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Amber</td>
|
||||
<td>working but below par (a slow board, a fan well below the others, a PSU fault while still mining)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Red</td>
|
||||
<td>detected but down (a faulted board, a stopped fan, a PSU that is not delivering)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Grey</td>
|
||||
<td>expected but not detected or not reachable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Blue</td>
|
||||
<td>the miner is paused, so its boards and stopped fans are idle on purpose</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>How each part is judged:</p>
|
||||
<ul>
|
||||
<li><strong>Power</strong> is green when the miner draws power, its PSU fan turns or it is
|
||||
mining; a reported PSU fault makes it amber (still mining) or red.</li>
|
||||
<li><strong>Control board</strong> is red for a control-board fault and amber for a
|
||||
miner-wide warning such as a high ambient temperature.</li>
|
||||
<li><strong>Fans</strong> are red at 0 rpm and amber below half the speed of the fastest fan.</li>
|
||||
<li><strong>Hashboards</strong> follow the status the miner reports for each board. When the
|
||||
firmware names the failing boards, only those turn red. A board the miner
|
||||
cannot see is grey.</li>
|
||||
</ul>
|
||||
<p>While an action runs on a miner, its Health cell shows progress such as
|
||||
<code>restarting...</code> or <code>refreshing...</code>.</p>
|
||||
<h2 id="access">Access</h2>
|
||||
<p>The padlock shows whether the toolkit can change the miner:</p>
|
||||
<ul>
|
||||
<li><strong>green, open</strong>: changes are possible with the saved credentials;</li>
|
||||
<li><strong>red, closed</strong>: view only;</li>
|
||||
<li><strong>blank</strong>: not known yet.</li>
|
||||
</ul>
|
||||
<p>After a scan the padlock is an estimate from what the firmware offers. Use
|
||||
<strong>Check access (auth)</strong> in the right-click menu for a real, read-only login
|
||||
test.</p>
|
||||
<h2 id="light">Light</h2>
|
||||
<p>A flashing green-over-red dot means the miner's locate light is on. Turn it on
|
||||
or off with <strong>Flash lights</strong> / <strong>Stop flashing lights</strong>.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,9 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Manual - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><h1>Manual</h1><p>Start with <a href="getting-started.html">Getting started</a>.</p><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,43 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Restore to stock firmware - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html" class=on>Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="restore-to-stock-firmware">Restore to stock firmware</h1>
|
||||
<p><strong>Restore to stock firmware...</strong> removes aftermarket firmware and returns the
|
||||
miner to the manufacturer's firmware it keeps on board. Nothing is uploaded.
|
||||
The miner reboots, and some firmwares come back on a new address.</p>
|
||||
<p>It is offered when the selection includes a supported firmware, and asks for
|
||||
confirmation with the list of miners first.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Firmware</th>
|
||||
<th>How it is removed</th>
|
||||
<th>Login used</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>VNish (and builds based on it)</td>
|
||||
<td>web API: unlock, then remove firmware; reboots in seconds</td>
|
||||
<td>the VNish row in Credentials, else <code>admin</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>LuxOS</td>
|
||||
<td>miner API: log on, then uninstall</td>
|
||||
<td>none</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Braiins OS</td>
|
||||
<td>SSH: runs the firmware's own <code>uninstall.sh</code></td>
|
||||
<td>the SSH row in Credentials (see <a href="settings.html#ssh-login">Settings</a>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Miners are restored one at a time. A dropped connection after the command is
|
||||
sent counts as success, because that is the reboot. A refused login counts as
|
||||
a failure and leaves the miner unchanged.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,97 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Scanning - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html" class=on>Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="scanning">Scanning</h1>
|
||||
<p>Discovery is read-only: a scan asks each address what it is and records what
|
||||
it reports. It never changes a miner.</p>
|
||||
<h2 id="scan-ranges">Scan ranges</h2>
|
||||
<p>Click <strong>Scan ranges</strong> to edit the addresses to scan. Put one entry per line;
|
||||
blank lines and lines starting with <code>#</code> are ignored.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Form</th>
|
||||
<th>Example</th>
|
||||
<th>Scans</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Single address</td>
|
||||
<td><code>192.168.1.50</code></td>
|
||||
<td>that address</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CIDR block</td>
|
||||
<td><code>192.168.1.0/24</code></td>
|
||||
<td>the whole block</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Full range</td>
|
||||
<td><code>192.168.1.10-192.168.2.40</code></td>
|
||||
<td>every address between the two, inclusive</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Short range</td>
|
||||
<td><code>192.168.1.10-90</code></td>
|
||||
<td><code>.10</code> to <code>.90</code> within the same /24</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Per-octet ranges</td>
|
||||
<td><code>10.1-4.0-1.1-255</code></td>
|
||||
<td>every combination (10.1.0.1 ... 10.4.1.255)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Commas or spaces between several entries on one line are not accepted; use one
|
||||
line each. Duplicates are removed automatically. One line, and all lines
|
||||
together, may cover at most 1,000,000 addresses.</p>
|
||||
<p><strong>Apply</strong> saves the ranges and starts a scan. A mistake keeps the dialog open
|
||||
and the status bar explains it, for example <code>invalid range: bad octet range</code>.</p>
|
||||
<p>The same dialog has three numbers:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Meaning</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Rescan (s)</td>
|
||||
<td>seconds between automatic rescans; <code>0</code> turns auto-rescan off</td>
|
||||
<td>300</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Timeout (s)</td>
|
||||
<td>how long to wait for one miner (scans, refreshes, actions and log fetches)</td>
|
||||
<td>10</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Concurrency</td>
|
||||
<td>how many addresses are probed at once (8 to 256); higher is faster but slow miners may report fewer values</td>
|
||||
<td>128</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>When the ranges change, miners outside the new ranges leave the table at the
|
||||
next scan.</p>
|
||||
<h2 id="running-pausing-and-stopping">Running, pausing and stopping</h2>
|
||||
<p>The three buttons next to <strong>Scan ranges</strong> control scanning:</p>
|
||||
<ul>
|
||||
<li><strong>Play</strong> (green) turns auto-rescan on and starts a scan now if none is running.</li>
|
||||
<li><strong>Pause</strong> (amber) turns auto-rescan off and lets the current scan finish.</li>
|
||||
<li><strong>Stop</strong> (red) turns auto-rescan off and cancels the current scan.</li>
|
||||
</ul>
|
||||
<p>While a scan runs, a progress bar spans the top of the table and the status bar
|
||||
shows progress such as <code>1935/4590 - scanning 192.168.1.86 (92 found)</code>. Afterwards
|
||||
it shows the count and the time to the next scan, for example
|
||||
<code>245 miners - next scan in 4m 12s</code>.</p>
|
||||
<p>Actions that change miners wait for the scan to finish; see
|
||||
<a href="actions.html">Actions</a>.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,142 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Settings and credentials - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html" class=on>Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="settings-and-credentials">Settings and credentials</h1>
|
||||
<p><strong>Settings</strong> opens a menu with Credentials, Language and Logs.</p>
|
||||
<h2 id="credentials">Credentials</h2>
|
||||
<p>Miners need a login for anything beyond basic discovery: for some details, and
|
||||
for every action. The Credentials dialog has three parts:</p>
|
||||
<ul>
|
||||
<li><strong>All firmwares</strong> at the top: one username and password tried on every miner.
|
||||
The saved password is never shown; leave the field blank to keep it. Blank
|
||||
username and password clear it.</li>
|
||||
<li><strong>SSH (restore)</strong>: the control-board SSH login used to restore Braiins OS to
|
||||
stock (see <a href="#ssh-login">SSH login</a>).</li>
|
||||
<li><strong>One row per firmware</strong>, pre-filled with that firmware's factory default.
|
||||
Change a row to override the login for that firmware only.</li>
|
||||
</ul>
|
||||
<p>The toolkit tries, in order, the firmware's own row, then the global login,
|
||||
then the firmware's built-in default.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Firmware</th>
|
||||
<th>Factory default (user / password)</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>AntMiner Stock</td>
|
||||
<td>root / root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>WhatsMiner Stock</td>
|
||||
<td>admin / admin</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Braiins</td>
|
||||
<td>root / root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>VNish</td>
|
||||
<td>(none) / admin</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>LuxOS</td>
|
||||
<td>root / root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>UMC OS</td>
|
||||
<td>(none) / letmein</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Marathon</td>
|
||||
<td>root / root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>VolcMiner Stock</td>
|
||||
<td>root / ltc@dog</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Elphapex Stock</td>
|
||||
<td>root / root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>FutureBit Stock</td>
|
||||
<td>futurebit / futurebit123</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>SealMiner Stock</td>
|
||||
<td>seal / seal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Auradine Stock</td>
|
||||
<td>admin / admin</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Reset to defaults</strong> clears every override, the global login and the SSH
|
||||
login at once.</p>
|
||||
<p>Logins are stored as plain text in the settings folder, readable only by your
|
||||
user account (Linux file mode 0600; on Windows, your profile folder's
|
||||
permissions).</p>
|
||||
<h3 id="ssh-login">SSH login</h3>
|
||||
<p>Restoring Braiins to stock runs a command over SSH, using the system <code>ssh</code>
|
||||
client (built into Windows 10/11). Set its login in the <strong>SSH (restore)</strong> row
|
||||
of the Credentials dialog. The username defaults to <code>root</code>. As with the global
|
||||
login, the saved password is never shown and a blank password keeps it.</p>
|
||||
<h2 id="language">Language</h2>
|
||||
<p>English, Chinese, Russian, French, Spanish and Portuguese. The toolbar, cards
|
||||
and column headers switch immediately; menus and dialogs not yet translated
|
||||
stay in English.</p>
|
||||
<h2 id="logs">Logs</h2>
|
||||
<p>An activity log of scans, actions, errors and exports, newest last, kept for
|
||||
the current session (the last 2000 lines). Times are shown in UTC.</p>
|
||||
<h2 id="files-in-the-settings-folder">Files in the settings folder</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>File</th>
|
||||
<th>Holds</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>scan-ranges.txt</code></td>
|
||||
<td>scan ranges, one per line</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>auto-rescan-secs.txt</code>, <code>scan-timeout-secs.txt</code>, <code>scan-concurrency.txt</code></td>
|
||||
<td>the three scan numbers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>scan-credentials.txt</code></td>
|
||||
<td>global login</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>firmware-credentials.txt</code></td>
|
||||
<td>per-firmware logins</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ssh-credentials.txt</code></td>
|
||||
<td>SSH login</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>presets.json</code></td>
|
||||
<td>saved views</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>language.txt</code></td>
|
||||
<td>UI language</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>pool-addresses.txt</code>, <code>pool-accounts.txt</code>, <code>pool-workers.txt</code>, <code>pool-passwords.txt</code></td>
|
||||
<td>saved pool values</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,132 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>The table and header - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html" class=on>The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html">Troubleshooting</a></li></ol></aside><article><h1 id="the-table-and-header">The table and header</h1>
|
||||
<h2 id="summary-cards">Summary cards</h2>
|
||||
<p>The cards at the top count the miners <strong>currently shown</strong> (after any filter).
|
||||
Each miner is in exactly one status: slow, paused, hashing or not hashing.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Card</th>
|
||||
<th>Counts</th>
|
||||
<th>Click</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Total</td>
|
||||
<td>rows in the view</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Hashing (green rabbit)</td>
|
||||
<td>mining at 80% of expected hashrate or more</td>
|
||||
<td>show only these; click again to clear</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Slow (amber turtle)</td>
|
||||
<td>mining below 80% of expected hashrate</td>
|
||||
<td>show only these</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Not hashing (red glass)</td>
|
||||
<td>answering but not mining</td>
|
||||
<td>show only these</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Paused (blue otter)</td>
|
||||
<td>stopped on purpose (paused, stopped, suspended)</td>
|
||||
<td>show only these</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>SHA-256 Hashrate</td>
|
||||
<td>total hashrate, per algorithm</td>
|
||||
<td>switch algorithm when the fleet runs more than one</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Est. power</td>
|
||||
<td>total reported power draw</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>On a narrow window the hashrate and power cards are hidden.</p>
|
||||
<h2 id="columns">Columns</h2>
|
||||
<p>IP is always the first column. The default view shows Model, Health,
|
||||
Hashrate, Power, Chip temp, Firmware, CPU, Access and Light. More than seventy
|
||||
other columns are available, grouped as Identity, Firmware and board, Health
|
||||
and status, Performance, Temperature, Cooling, Hardware and Pools.</p>
|
||||
<ul>
|
||||
<li><strong>Columns</strong> opens a checklist: tick to show, drag to reorder, or sort the list
|
||||
alphabetically or by category. <em>Hide columns with no scanned values</em> hides
|
||||
columns that are empty for every miner (it resets when the app restarts).</li>
|
||||
<li>Drag a column header to move it.</li>
|
||||
<li>Right-click a header to sort by it, auto-size one or all columns, hide it, or
|
||||
open the column chooser.</li>
|
||||
</ul>
|
||||
<p>Some values worth knowing:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Column</th>
|
||||
<th>Shows</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Hashrate</td>
|
||||
<td>actual/expected, for example <code>95.0T/96.0T</code>; the actual part is red at 50% of expected or less, amber around 75%, green at 100%</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Chip temp</td>
|
||||
<td>hottest chip on each hashboard, for example <code>77 / 64 / 74</code>; blue when cool, red at 90 C and above</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Firmware</td>
|
||||
<td>the firmware family, coloured (Braiins purple, LuxOS gold, VNish green, ePIC light blue, Hiveon orange, Bixbit pink); stock firmware uses the normal text colour</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Pool account / Worker</td>
|
||||
<td>the pool user split at the first dot</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Board HR / V / freq</td>
|
||||
<td>per-hashboard hashrate, voltage and frequency</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>A blank cell means the miner did not report that value.</p>
|
||||
<h2 id="sorting">Sorting</h2>
|
||||
<p>Click a header to sort ascending, again for descending, again to clear.</p>
|
||||
<ul>
|
||||
<li><strong>Hashrate</strong> also sorts by <em>relative</em> hashrate (actual as a share of
|
||||
expected), shown as <code>%^</code> and <code>%v</code> in the header.</li>
|
||||
<li><strong>Health</strong> sorts by overall health, then by power (<code>Pwr</code>), fans (<code>Fan</code>) and
|
||||
hashboards (<code>Brd</code>). Ascending puts the most broken miners first.</li>
|
||||
</ul>
|
||||
<h2 id="selecting-miners">Selecting miners</h2>
|
||||
<p>Click a row to select it; Ctrl-click and Shift-click add to the selection, and
|
||||
you can drag across rows to select a block. The selection follows miners by IP,
|
||||
so it survives rescans. Double-click a row (or press Enter) to open the miner's
|
||||
web page in your browser. Right-click the selection for <a href="actions.html">actions</a>.</p>
|
||||
<h2 id="filters-and-presets">Filters and presets</h2>
|
||||
<p><strong>Filter</strong> keeps only the rows that match. Pick a column, then:</p>
|
||||
<ul>
|
||||
<li>for numbers: between, =, !=, >, >=, < or <= (blank cells never match);</li>
|
||||
<li>for text: <em>is any of</em> (tick values; <code>(blank)</code> matches empty cells), contains,
|
||||
does not contain, begins with, ends with or equals (case does not matter).</li>
|
||||
</ul>
|
||||
<p>Filters on different columns must all match. <strong>Reset</strong> clears them. Clicking a
|
||||
status card is a quick filter of its own.</p>
|
||||
<p><strong>Presets</strong> saves and loads whole views: column order and visibility, sort and
|
||||
filters. <em>Default</em> is built in and cannot be deleted; saving under an existing
|
||||
name replaces it.</p>
|
||||
<h2 id="zoom-and-theme">Zoom and theme</h2>
|
||||
<p>The slider in the bottom-right corner zooms the table: text, icons and column
|
||||
widths scale together. The window follows the system light or dark theme.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
@@ -0,0 +1,44 @@
|
||||
<!doctype html>
|
||||
<html lang="en"><head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Troubleshooting - Alkane Toolkit</title>
|
||||
<link rel="stylesheet" href="../style.css"></head>
|
||||
<body><header><div class="bar"><a class="brand" href="../"><i></i>Alkane Toolkit</a>
|
||||
<nav><a href="../">Overview</a><a href="../manual/" class=on>Manual</a><a href="../quality/">Code quality</a><a href="../bench/">Benchmarks</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/releases">Downloads</a><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit">Source</a></nav></div></header>
|
||||
<main><div class="layout"><aside><ol><li><a href="getting-started.html">Getting started</a></li><li><a href="scanning.html">Scanning</a></li><li><a href="the-table.html">The table and header</a></li><li><a href="health.html">Health, access and light</a></li><li><a href="actions.html">Actions</a></li><li><a href="settings.html">Settings and credentials</a></li><li><a href="restore.html">Restore to stock firmware</a></li><li><a href="export.html">Export</a></li><li><a href="command-line.html">Command line and environment</a></li><li><a href="troubleshooting.html" class=on>Troubleshooting</a></li></ol></aside><article><h1 id="troubleshooting">Troubleshooting</h1>
|
||||
<p><strong>Windows says "Windows protected your PC".</strong> SmartScreen warns about new
|
||||
downloads until a certificate has built up reputation. The publisher shown
|
||||
should be <em>BlueFlare Energy Solutions Inc.</em>; click <strong>More info</strong>, then <strong>Run
|
||||
anyway</strong>. If no publisher is shown, do not run the file and download it again
|
||||
from the releases page.</p>
|
||||
<p><strong>A miner is missing.</strong> Check that its address is inside the scan ranges and
|
||||
that it answers on its web page from this computer. On busy or slow networks,
|
||||
raise <strong>Timeout</strong> or lower <strong>Concurrency</strong> in the Scan ranges dialog.</p>
|
||||
<p><strong>An action is missing from the right-click menu.</strong> Actions appear only when
|
||||
every selected miner supports them. Select fewer miners, or only miners with
|
||||
the same firmware.</p>
|
||||
<p><strong>An action does nothing and the status says a scan is in progress.</strong> Changes
|
||||
wait for scans. Press <strong>Pause</strong>, let the scan finish, then try again.</p>
|
||||
<p><strong>Check access says locked.</strong> The saved login is not accepted. Set the right
|
||||
password in <strong>Settings > Credentials</strong>, either for all firmwares or for that
|
||||
firmware's row.</p>
|
||||
<p><strong>Values are blank.</strong> The firmware did not report them, or it needs a login to
|
||||
report them. Try <strong>Check access</strong> and the Credentials dialog.</p>
|
||||
<p><strong>The window is too small or too large.</strong> It opens at most as large as your
|
||||
screen's work area. Use the zoom slider in the status bar to scale the table.</p>
|
||||
<h2 id="reporting-a-problem">Reporting a problem</h2>
|
||||
<p><strong>Bug report</strong> in the toolbar, between Export and Settings, files a bug or a
|
||||
feature request with the developers. Choose the type (Bug, UI change or
|
||||
Feature request) and describe it; the first line becomes the title. <strong>Send</strong>
|
||||
shows the issue number when it is filed, and <strong>Open issue</strong> opens it in the
|
||||
browser. If it was not sent, the reason is shown and the text stays in the
|
||||
box.</p>
|
||||
<p>A report includes the app version, the operating system, the light or dark
|
||||
appearance, the language and the window size. <strong>Include the recent activity
|
||||
log</strong> adds the newest lines of the Settings > Logs page, with passwords,
|
||||
tokens and similar values removed first; untick it to leave the log out.
|
||||
Reports become public issues on
|
||||
<a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/issues">gitea.bluefla.re</a>,
|
||||
so do not put passwords or customer details in the text. A computer can send
|
||||
five reports an hour.</p></article></div>
|
||||
<footer>Built from 224b3b37e8. Alkane Toolkit is MIT licensed.</footer></main></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,38 @@
|
||||
:root { --bg:#ffffff; --fg:#1f2328; --muted:#59636e; --line:#d1d9e0; --card:#f6f8fa;
|
||||
--accent:#d9822b; --link:#0969da; --good:#1a7f37; --warn:#9a6700; --bad:#cf222e; }
|
||||
@media (prefers-color-scheme: dark) { :root { --bg:#0d1117; --fg:#e6edf3; --muted:#9198a1;
|
||||
--line:#30363d; --card:#151b23; --link:#4493f8; --good:#3fb950; --warn:#d29922; --bad:#f85149; } }
|
||||
* { box-sizing: border-box; }
|
||||
body { margin:0; background:var(--bg); color:var(--fg);
|
||||
font:16px/1.55 system-ui,-apple-system,"Segoe UI",Roboto,Ubuntu,sans-serif; }
|
||||
a { color:var(--link); text-decoration:none; } a:hover { text-decoration:underline; }
|
||||
header { border-bottom:1px solid var(--line); }
|
||||
header .bar, main { max-width:1040px; margin:0 auto; padding:0 16px; }
|
||||
header .bar { display:flex; align-items:center; gap:24px; height:56px; flex-wrap:wrap; }
|
||||
header .brand { font-weight:700; color:var(--fg); display:flex; gap:8px; align-items:center; }
|
||||
header .brand i { width:20px; height:20px; border-radius:5px; background:var(--accent); display:inline-block; }
|
||||
header nav { display:flex; gap:18px; flex-wrap:wrap; }
|
||||
header nav a { color:var(--muted); } header nav a.on { color:var(--fg); font-weight:600; }
|
||||
main { padding:28px 16px 64px; }
|
||||
h1 { font-size:1.9rem; margin:.2em 0 .4em; } h2 { margin-top:1.8em; border-bottom:1px solid var(--line); padding-bottom:.25em; }
|
||||
code { background:var(--card); border:1px solid var(--line); border-radius:5px; padding:.1em .35em; font-size:.92em; }
|
||||
pre { background:var(--card); border:1px solid var(--line); border-radius:8px; padding:12px; overflow:auto; }
|
||||
pre code { border:0; padding:0; }
|
||||
table { border-collapse:collapse; width:100%; margin:1em 0; display:block; overflow-x:auto; }
|
||||
th, td { border:1px solid var(--line); padding:6px 10px; text-align:left; vertical-align:top; }
|
||||
th { background:var(--card); }
|
||||
td.num, th.num { text-align:right; font-variant-numeric:tabular-nums; white-space:nowrap; }
|
||||
.cards { display:grid; grid-template-columns:repeat(auto-fill,minmax(180px,1fr)); gap:12px; margin:1.2em 0; }
|
||||
.card { background:var(--card); border:1px solid var(--line); border-radius:10px; padding:14px; }
|
||||
.card b { display:block; font-size:1.6rem; } .card span { color:var(--muted); font-size:.9rem; }
|
||||
.good { color:var(--good); } .warn { color:var(--warn); } .bad { color:var(--bad); }
|
||||
.bar-cell { min-width:120px; } .meter { height:8px; background:var(--line); border-radius:4px; overflow:hidden; }
|
||||
.meter i { display:block; height:100%; }
|
||||
.layout { display:grid; grid-template-columns:220px 1fr; gap:32px; }
|
||||
.layout aside ol { padding-left:1.2em; margin:0; } .layout aside li { margin:.3em 0; }
|
||||
.layout aside a.on { font-weight:600; color:var(--fg); }
|
||||
@media (max-width:760px) { .layout { grid-template-columns:1fr; } }
|
||||
.buttons a { display:inline-block; margin:4px 8px 4px 0; padding:8px 14px; border-radius:8px;
|
||||
border:1px solid var(--line); background:var(--card); color:var(--fg); }
|
||||
.buttons a.primary { background:var(--accent); border-color:var(--accent); color:#fff; }
|
||||
footer { color:var(--muted); font-size:.85rem; margin-top:48px; }
|
||||
Reference in New Issue
Block a user