From ef9a026ee8198b4caccc01104603e19b60287bd7 Mon Sep 17 00:00:00 2001 From: b-rowan Date: Sun, 14 Jan 2024 12:58:11 -0700 Subject: [PATCH] docs: update docs. --- docs/data/miner_data.md | 9 ++++++++- pyasic/data/__init__.py | 9 +++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/data/miner_data.md b/docs/data/miner_data.md index 55d35062..fb8843fa 100644 --- a/docs/data/miner_data.md +++ b/docs/data/miner_data.md @@ -1,6 +1,6 @@ # pyasic -## Miner Data +## Miner Data ::: pyasic.data.MinerData handler: python options: @@ -13,3 +13,10 @@ options: show_root_heading: false heading_level: 4 + +## Fan Data +::: pyasic.data.Fan + handler: python + options: + show_root_heading: false + heading_level: 4 diff --git a/pyasic/data/__init__.py b/pyasic/data/__init__.py index e894d697..3acf2942 100644 --- a/pyasic/data/__init__.py +++ b/pyasic/data/__init__.py @@ -39,6 +39,7 @@ class HashBoard: chip_temp: The temperature of the chips as an int. chips: The chip count of the board as an int. expected_chips: The expected chip count of the board as an int. + serial_number: The serial number of the board. missing: Whether the board is returned from the miners data as a bool. """ @@ -110,7 +111,7 @@ class MinerData: hashrate: The hashrate of the miner in TH/s as a float. Calculated automatically. _hashrate: Backup for hashrate found via API instead of hashboards. expected_hashrate: The factory nominal hashrate of the miner in TH/s as a float. - hashboards: A list of hashboards on the miner with their statistics. + hashboards: A list of [`HashBoard`][pyasic.data.HashBoard]s on the miner with their statistics. temperature_avg: The average temperature across the boards. Calculated automatically. env_temp: The environment temps as a float. wattage: Current power draw of the miner as an int. @@ -123,11 +124,7 @@ class MinerData: percent_expected_hashrate: The percent of total hashrate out of the expected hashrate. Calculated automatically. percent_expected_wattage: The percent of total wattage out of the expected wattage. Calculated automatically. nominal: Whether the number of chips in the miner is nominal. Calculated automatically. - pool_split: The pool split as a str. - pool_1_url: The first pool url on the miner as a str. - pool_1_user: The first pool user on the miner as a str. - pool_2_url: The second pool url on the miner as a str. - pool_2_user: The second pool user on the miner as a str. + config: The parsed config of the miner, using [`MinerConfig`][pyasic.config.MinerConfig]. errors: A list of errors on the miner. fault_light: Whether the fault light is on as a boolean. efficiency: Efficiency of the miner in J/TH (Watts per TH/s). Calculated automatically.