include cli parameter overview

docs/architecture/timelords.md

@@ -39,7 +39,7 @@ It's good to have a few Timelords out there. There can be things like routing fl
 
 The Company plans to run a few Timelords around the world - and some backups too - to ensure that all Farmers and nodes can hear the beat that the Timelords are calling.
 
-For installation and usage documentation please refer [here](/timelords).
+For installation and usage documentation please refer [here](/timelord-install).
 
 ## Troubleshooting a Timelord
 

docs/cli-reference/asic-hwvdf.md

@@ -0,0 +1,119 @@
+---
+sidebar_label: ASICs
+title: ASICs HW VDF
+slug: /asic-cli
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Reference
+
+### `hw_vdf_client`
+
+Functionality: Run the ASIC HW VDF Software
+
+Usage: hw_vdf_client [OPTIONS] PORT [N_VDFS]
+
+Options:
+
+| Long Command       | Type    | Required | Description                                           |
+| :----------------- | :------ | :------- | :---------------------------------------------------- |
+| --freq             | INTEGER | False    | set ASIC frequency [%d, 200 - 2200]                   |
+| --voltage          | INTEGER | False    | set board voltage [.88, 0.7 - 1.0]                    |
+| --ip               | TEXT    | False    | timelord IP address [localhost]                       |
+| --vdfs-mask        | TEXT    | False    | mask for enabling VDF engines [7, 1 - 7]              |
+| --vdf-threads      | TEXT    | False    | number of software threads per VDF engine [4, 2 - 64] |
+| --proof-threads    | TEXT    | False    | number of proof threads per VDF engine [3, 1 - 63]    |
+| --auto-freq-period | TEXT    | False    | auto-adjust frequency every N seconds [0, 10 - inf]   |
+| --list             | TEXT    | False    | list available devices and exit                       |
+| --help             | None    | False    | Show a help message and exit                          |
+
+<details>
+<summary>Example 1 - Run the ASIC software with defaults</summary>
+
+```bash
+hw_vdf_client 8000 3
+```
+
+Response:
+
+```
+2024-04-12T10:32:05.898 Setting frequency to 1100.000000 MHz
+2024-04-12T10:32:06.016 Frequency is 1100.000000 MHz
+2024-04-12T10:32:06.020 Board voltage is 0.875 V
+2024-04-12T10:32:06.020 Setting voltage to 0.880 V
+2024-04-12T10:32:06.021 Board voltage is now 0.875 V
+2024-04-12T10:32:06.032 Board current is 0.698 A
+2024-04-12T10:32:06.043 Board power is 0.610 W
+2024-04-12T10:32:06.049 Connecting to 127.0.0.1:8000
+2024-04-12T10:32:06.049 VDF 0: Connected to timelord, waiting for challenge
+```
+
+</details>
+
+<details>
+<summary>Example 2 - Run the ASIC software with auto-frequency, initial frequency, and defined ip</summary>
+
+```bash
+hw_vdf_client --freq 1500 --auto-freq 60 --ip 192.168.0.122 8000 3
+```
+
+Response:
+
+```
+2024-04-12T10:32:05.898 Setting frequency to 1500.000000 MHz
+2024-04-12T10:32:06.016 Frequency is 1500.000000 MHz
+2024-04-12T10:32:06.020 Board voltage is 0.875 V
+2024-04-12T10:32:06.020 Setting voltage to 0.880 V
+2024-04-12T10:32:06.021 Board voltage is now 0.875 V
+2024-04-12T10:32:06.032 Board current is 0.698 A
+2024-04-12T10:32:06.043 Board power is 0.610 W
+2024-04-12T10:32:06.049 Connecting to 192.168.0.122:8000
+2024-04-12T10:32:06.049 VDF 0: Connected to timelord, waiting for challenge
+```
+
+</details>
+
+<details>
+<summary>Example 3 - Run the ASIC software with defined ip and only 1 vdf (i.e. defaults for cluster)</summary>
+
+```bash
+hw_vdf_client --ip 192.168.0.122 8000 1
+```
+
+Response:
+
+```
+2024-04-12T10:32:05.898 Setting frequency to 1100.000000 MHz
+2024-04-12T10:32:06.016 Frequency is 1100.000000 MHz
+2024-04-12T10:32:06.020 Board voltage is 0.875 V
+2024-04-12T10:32:06.020 Setting voltage to 0.880 V
+2024-04-12T10:32:06.021 Board voltage is now 0.875 V
+2024-04-12T10:32:06.032 Board current is 0.698 A
+2024-04-12T10:32:06.043 Board power is 0.610 W
+2024-04-12T10:32:06.049 Connecting to 192.168.0.122:8000
+2024-04-12T10:32:06.049 VDF 0: Connected to timelord, waiting for challenge
+```
+
+</details>
+
+---
+
+## Troubleshooting a Timelord
+
+For troubleshooting steps please refer to the documentation [here](/troubleshooting/timelords).
+
+---
+
+## Timelord support
+
+Join Our [Discord](https://discord.gg/chia) and jump into the #support channel for support
+
+---
+
+## Timelord FAQ
+
+For FAQ please refer to the documentation [here](/timelord-install#timelord-faq).
+
+---

docs/getting-started/timelords.md

@@ -1,6 +1,6 @@
 ---
 title: Timelords
-slug: /timelords
+slug: /timelord-install
 ---
 
 import Tabs from '@theme/Tabs';
@@ -10,7 +10,8 @@ import TabItem from '@theme/TabItem';
 **DO NOT** overclock ASICs, overclocking diminishes the life of the ASIC!
 :::
 
-Detailed information regarding timelord architecture can be found [here](/timelord-architecture)
+Timelord architecture information can be found [here](/timelord-architecture)
+The hw_vdf_client parameter information can be found [here](/asic-cli).
 
 ---
 
@@ -39,6 +40,8 @@ Dependencies:
 - git (if installing from source)
 - ca-certificates curl gnupg (if installing from APT or if running an ASIC - RECOMMENDED)
 
+---
+
 ## Installing a Timelord
 
 :::info
@@ -111,6 +114,7 @@ chia start node timelord &
 
 :::warning
 **DO NOT** overclock ASICs, overclocking diminishes the life of the ASIC!
+Detailed information about the hw_vdf_client parameters can be found [here](/asic-cli).
 :::
 
 ```bash
@@ -144,6 +148,7 @@ chia start node timelord-only
 
 :::info
 On MacOS x86_64 and all Linux distributions, building a Timelord is as easy as running `chia start timelord &` in the virtual environment. You can also run `./vdf_bench square_asm 400000` once you've built Timelord to give you a sense of your optimal and unloaded ips. Each run of `vdf_bench` can be surprisingly variable and, in production, the actual ips you will obtain will usually be about 20% lower due to load of creating proofs. The default configuration for Timelords is good enough to just let you start it up. Set your log level to INFO and then grep for "Estimated IPS:" to get a sense of what actual ips your Timelord is achieving.
+Detailed information about the hw_vdf_client parameters can be found [here](/asic-cli).
 :::
 
 ```bash
@@ -199,6 +204,8 @@ chia start node timelord-only
 
 ```
 
+---
+
 ## ASIC Timelord Systemd Setup
 
 Below is an example of a systemd service file to run the ASIC hw vdf processes.
@@ -253,6 +260,8 @@ Stop the ASIC systemd software:
 Check status of the ASIC systemd software:
 `sudo systemctl status chiahw-vdf.service`
 
+---
+
 ## Troubleshooting a Timelord
 
 For troubleshooting steps please refer to the documentation [here](/troubleshooting/timelords).
@@ -272,7 +281,7 @@ Join Our [Discord](https://discord.gg/chia) and jump into the #support channel f
 There are no specific requirements as timelords are a fastest wins process. This means that those with higher end hardware are more likely to generate Proofs of Time than those with lower end hardware.
 Currently, a modern gaming PC with 8 cores and 8 GB of RAM is recommended when running an ASIC or Bluebox timelord. With the release of ASIC timelords, software timelords will have a near impossible time competing. It is recommended to only run a software timelord for experimentation and learning purposes.
 
-### Can a Singe ASIC Compete with an ASIC Cluster?
+### Can a Single ASIC Compete with an ASIC Cluster?
 
 The nature of timelords is to create three VDF chains, one can create the chains themselves in parallel (i.e. one on each ASIC) but one cannot break down the VDFs themselves to parallelize them.
 This means that the ASIC cluster will always have an advantage but there are times when a single ASIC can reasonably compete. This almost always requires the block farming node to be closer in physical proximity to the single ASIC than to the ASIC cluster establishing a minor time advantage for the single ASIC

sidebars.js

@@ -96,6 +96,7 @@ module.exports = {
             'cli-reference/cat-admin',
             'cli-reference/clawback',
             'cli-reference/custody-tool',
+            'cli-reference/asic-hwvdf',
           ],
         },
         {