forked from btclock/btclock_v3
Compare commits
No commits in common. "5b0437a2e961cfca242e01732c4361d74dab04a4" and "2625dda8a1eae4615437cc39e547e8f3a806bc4f" have entirely different histories.
5b0437a2e9
...
2625dda8a1
4 changed files with 7 additions and 30 deletions
27
README.md
27
README.md
|
@ -17,7 +17,7 @@ Biggest differences with v2 are:
|
||||||
New features:
|
New features:
|
||||||
- BitAxe integration
|
- BitAxe integration
|
||||||
- Zap notifier
|
- Zap notifier
|
||||||
- Braiins Pool and Ocean mining stats integration
|
-
|
||||||
|
|
||||||
"Steal focus on new block" means that when a new block is mined, the display will switch to the block height screen if it's not on it already.
|
"Steal focus on new block" means that when a new block is mined, the display will switch to the block height screen if it's not on it already.
|
||||||
|
|
||||||
|
@ -27,27 +27,4 @@ Most [information](https://github.com/btclock/btclock_v2/wiki) about BTClock v2
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
Use PlatformIO to build it yourself. Make sure you fetch the [WebUI](https://github.com/btclock/webui) submodule.
|
Use PlatformIO to build it yourself. Make sure you fetch the [WebUI](https://github.com/btclock/webui) submodule.
|
||||||
|
|
||||||
|
|
||||||
## Braiins Pool and Ocean integration
|
|
||||||
Enable mining pool stats by accessing your btclock's web UI (point a web browser at the device's IP address).
|
|
||||||
|
|
||||||
Under Settings -> Extra Features: toggle Enable Mining Pool Stats.
|
|
||||||
|
|
||||||
New options will appear. Select your mining pool and enter your pool username (Ocean) or api key (Braiins).
|
|
||||||
|
|
||||||
|
|
||||||
### Braiins Pool integration
|
|
||||||
Create an API key based on the steps [here](https://academy.braiins.com/en/braiins-pool/monitoring/#api-configuration).
|
|
||||||
|
|
||||||
The key's permissions should be:
|
|
||||||
* Web Access: no
|
|
||||||
* API Access: yes
|
|
||||||
* Access Permissions: Read-only
|
|
||||||
|
|
||||||
Copy the token that is created for the new key. Enter this as your "Mining Pool username or api key" in the btclock web UI.
|
|
||||||
|
|
||||||
|
|
||||||
### Ocean integration
|
|
||||||
Your "Mining Pool username" is just the onchain withdrawal address that you specify when pointing your miners at Ocean.
|
|
|
@ -92,7 +92,7 @@ void setup()
|
||||||
setupBitaxeFetchTask();
|
setupBitaxeFetchTask();
|
||||||
}
|
}
|
||||||
|
|
||||||
if (preferences.getBool("miningPoolStats", DEFAULT_MINING_POOL_STATS_ENABLED))
|
if (preferences.getBool("miningPoolStatsEnabled", DEFAULT_MINING_POOL_STATS_ENABLED))
|
||||||
{
|
{
|
||||||
setupMiningPoolStatsFetchTask();
|
setupMiningPoolStatsFetchTask();
|
||||||
}
|
}
|
||||||
|
@ -333,7 +333,7 @@ void setupPreferences()
|
||||||
addScreenMapping(SCREEN_BITAXE_BESTDIFF, "BitAxe Best Difficulty");
|
addScreenMapping(SCREEN_BITAXE_BESTDIFF, "BitAxe Best Difficulty");
|
||||||
}
|
}
|
||||||
|
|
||||||
if (preferences.getBool("miningPoolStats", DEFAULT_MINING_POOL_STATS_ENABLED))
|
if (preferences.getBool("miningPoolStatsEnabled", DEFAULT_MINING_POOL_STATS_ENABLED))
|
||||||
{
|
{
|
||||||
addScreenMapping(SCREEN_MINING_POOL_STATS_HASHRATE, "Mining Pool Hashrate");
|
addScreenMapping(SCREEN_MINING_POOL_STATS_HASHRATE, "Mining Pool Hashrate");
|
||||||
addScreenMapping(SCREEN_MINING_POOL_STATS_EARNINGS, "Mining Pool Earnings");
|
addScreenMapping(SCREEN_MINING_POOL_STATS_EARNINGS, "Mining Pool Earnings");
|
||||||
|
|
|
@ -192,7 +192,7 @@ void setCurrentScreen(uint newScreen) {
|
||||||
}
|
}
|
||||||
case SCREEN_MINING_POOL_STATS_HASHRATE:
|
case SCREEN_MINING_POOL_STATS_HASHRATE:
|
||||||
case SCREEN_MINING_POOL_STATS_EARNINGS: {
|
case SCREEN_MINING_POOL_STATS_EARNINGS: {
|
||||||
if (preferences.getBool("miningPoolStats", DEFAULT_MINING_POOL_STATS_ENABLED)) {
|
if (preferences.getBool("miningPoolStatsEnabled", DEFAULT_MINING_POOL_STATS_ENABLED)) {
|
||||||
WorkItem miningPoolStatsUpdate = {TASK_MINING_POOL_STATS_UPDATE, 0};
|
WorkItem miningPoolStatsUpdate = {TASK_MINING_POOL_STATS_UPDATE, 0};
|
||||||
xQueueSend(workQueue, &miningPoolStatsUpdate, portMAX_DELAY);
|
xQueueSend(workQueue, &miningPoolStatsUpdate, portMAX_DELAY);
|
||||||
} else {
|
} else {
|
||||||
|
|
|
@ -549,7 +549,7 @@ void onApiSettingsPatch(AsyncWebServerRequest *request, JsonVariant &json)
|
||||||
"mowMode", "suffixShareDot", "flOffWhenDark",
|
"mowMode", "suffixShareDot", "flOffWhenDark",
|
||||||
"flAlwaysOn", "flDisable", "flFlashOnUpd",
|
"flAlwaysOn", "flDisable", "flFlashOnUpd",
|
||||||
"mempoolSecure", "useNostr", "bitaxeEnabled",
|
"mempoolSecure", "useNostr", "bitaxeEnabled",
|
||||||
"miningPoolStats", "verticalDesc",
|
"miningPoolStatsEnabled", "verticalDesc",
|
||||||
"nostrZapNotify", "stagingSource", "httpAuthEnabled"};
|
"nostrZapNotify", "stagingSource", "httpAuthEnabled"};
|
||||||
|
|
||||||
for (String setting : boolSettings)
|
for (String setting : boolSettings)
|
||||||
|
@ -714,7 +714,7 @@ void onApiSettingsGet(AsyncWebServerRequest *request)
|
||||||
root["bitaxeEnabled"] = preferences.getBool("bitaxeEnabled", DEFAULT_BITAXE_ENABLED);
|
root["bitaxeEnabled"] = preferences.getBool("bitaxeEnabled", DEFAULT_BITAXE_ENABLED);
|
||||||
root["bitaxeHostname"] = preferences.getString("bitaxeHostname", DEFAULT_BITAXE_HOSTNAME);
|
root["bitaxeHostname"] = preferences.getString("bitaxeHostname", DEFAULT_BITAXE_HOSTNAME);
|
||||||
|
|
||||||
root["miningPoolStats"] = preferences.getBool("miningPoolStats", DEFAULT_MINING_POOL_STATS_ENABLED);
|
root["miningPoolStatsEnabled"] = preferences.getBool("miningPoolStatsEnabled", DEFAULT_MINING_POOL_STATS_ENABLED);
|
||||||
root["miningPoolName"] = preferences.getString("miningPoolName", DEFAULT_MINING_POOL_NAME);
|
root["miningPoolName"] = preferences.getString("miningPoolName", DEFAULT_MINING_POOL_NAME);
|
||||||
root["miningPoolUser"] = preferences.getString("miningPoolUser", DEFAULT_MINING_POOL_USER);
|
root["miningPoolUser"] = preferences.getString("miningPoolUser", DEFAULT_MINING_POOL_USER);
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue