whatsminer-api
Unofficial python api for MicroBT Whatsminer ASICs
Code adapted from a python file found in the Whatsminer Telegram group that is credited to @passby
Installation
Python 3.x is required.
pip install whatsminer
Basic Usage
Instantiate a WhatsminerAccessToken for each ASIC that you want to access. Then make read-only or writeable API calls through WhatsminerAPI
Read-only information can be retrieved with just the ASIC's ip address:
from whatsminer import WhatsminerAccessToken, WhatsminerAPI
token = WhatsminerAccessToken(ip_address="192.168.1.100")
summary_json = WhatsminerAPI.get_read_only_info(access_token=token,
cmd="summary")
The writeable API commands can be executed by providing the ASIC's admin password:
# The token from above can be enabled for writeable access:
token.enable_write_access(admin_password="the_admin_password")
# Or you can directly instantiate a writeable one:
token = WhatsminerAccessToken(ip_address="192.168.1.100",
admin_password="the_admin_passwd")
json_response = WhatsminerAPI.exec_command(access_token=token,
cmd="power_off",
additional_params={"respbefore": "true"})
Writeable WhatsminerAccessToken objs will renew themselves if they go past the API's 30min expiration.
Managing multiple ASICs
You could define a whole server farm's worth of Whatsminer ASICs and manage them all in one script:
asics = [
('192.168.1.100', 'some_admin_pass'),
('192.168.1.101', 'some_admin_pass'),
('192.168.1.102', 'some_admin_pass'),
('192.168.1.103', 'some_admin_pass'),
('192.168.1.104', 'some_admin_pass'),
('192.168.1.105', 'some_admin_pass'),
]
tokens = []
for asic_info in asics:
tokens.append(WhatsminerAccessToken(ip_address=asic_info[0], admin_password=asic_info[1]))
# Find machines running too hot
for token in tokens:
json_summary = WhatsminerAPI.get_read_only_info(access_token=token, cmd="summary")
if json_summary['SUMMARY'][0]['Temperature'] > 78.0:
# stop mining on this ASIC
WhatsminerAPI.exec_command(access_token=token, cmd="power_off", additional_params={"respbefore": "true"})
API Documentation
It's very difficult to find any information about the Whatsminer API. This PDF documentation is slightly out of date but is the best source found so far:
Package distribution notes
There are just notes to self for updating the pypi distribution
- Update the release number in
setup.pyand commit to repo. - Draft a new release in github using the same release number.
- Run
python setup.py sdist - Publish the distribution to pypi:
twine upload dist/*
233 Dec 30, 2022
1 Nov 19, 2021
2 Jan 5, 2022
71 Dec 26, 2022
7 Oct 28, 2022
49 Oct 24, 2022
9 Nov 6, 2022
6 Apr 1, 2022
130 Dec 27, 2022
20 Dec 03, 2021
1 Feb 13, 2022
1 Aug 30, 2022
27 Oct 01, 2022
224 Dec 30, 2022
18 Jul 31, 2022
18 Jul 29, 2022
4 Aug 12, 2021
6 Nov 04, 2022
1 Dec 26, 2021
2 Jun 20, 2022
4 Dec 03, 2021
12 Oct 27, 2022
2 Dec 27, 2021
33 Oct 21, 2022
0 Dec 23, 2021
1 Jul 04, 2022
34 Nov 10, 2022
1 Nov 15, 2021
512 Jan 01, 2023