Skip to content

marathon-gary/WMTUI

 
 

Repository files navigation

Sublime's custom image

Sublime's custom image

WMTUI

About:

WMTUI was designed as an alternative to WhatsminerTool to be used on the terminal of the local server of mining sites.

Features

  • View Whatsminers on a set ip range
    • view: IP, Mac, Status, Error Codes, Uptime, GHs, Efficiency, Wattage, Set Power Limit, 1st pool URL
  • Switch between multiple saved ip ranges
  • Send command to one or many machines
    • Sleep and Wake machines
    • Set pools
    • Set Power Limit
    • Enable / Disable Fastboot
    • Reboot

Keyboard Commands

Miner List / Selected Miner List

  • esc    - Quit
  •    - Move up the miner list
  •    - Move down the miner list
  • '    - Sort miners, toggles between four modes, ip, mac, hash rate, and uptime. Ip sort is the default
  • ?    - Show help menu
  • tab   - Switch between the miner list pane and the selected miners pane
  • enter   - Select or deselect a miner
  • a   - Enter the farm selection screen
  • f   - Enable fastboot
  • l   - Set power limit
  • m   - Refresh the miner view
  • n   - Create a new farm
  • o   - Disable fastboot
  • p   - Set pools
  • q   - Quit
  • r   - Reboot
  • s   - Sleep
  • w   - Wake

New Farm

  • esc    - Go back to the miner list
  • tab   - Switch Between text fields
  • enter   - Save new farm

Select Farm

  • esc    - Go back to the miner list
  •    - Move up the farm list
  •    - Move down the farm list
  • enter   - Select farm

Set Pools

  • esc    - Go back to the miner list
  • tab   - Switch Between text fields
  • enter   - Send the new pools

Set Power Limit

  • enter   - Send the new power limit

Basic Usage

  • Add farm - Add a new farm to MWTUI with n, switch text fields with tab and save the farm setting with enter.
  • Select farm - After creating a new farm you'll be sent to the farm selection screen, otherwise press a.
    Navigate the menu with ↓ ↑, select the desired farm with enter and wait for the miner list to refresh.
  • Select miners - Use enter to multi select miners, press tab to see all selected miners. Miners can be deselected with enter as well.
  • Send command - press the key associated with the desired command to send.
    • w - will wake machines.
    • s - will sleep machines.
    • f - will enable fastboot.
    • s - will disable fastboot.
    • p - will set pools - use tab to switch text fields and enter to send the command.
    • l - will set power limit - enter sends the new value.
  • Deselect miners - At the moment there is no way to unselect all selected miners, to avoid issues deselect all selected miners.
  • Refresh miner list - After sending a command and giving time for the command to process, press m to refresh the miner list and see the updated machine info.
  • Commands can also be sent to a single machine by just having it highlighted and pressing a command key.

Known Bugs and Missing Features

  • The view will break if your terminal window is too small.
  • The view will break if resizing the terminal window.
  • Setting pools has no validation check on both the pool URL and worker name.
  • Setting farms has no IP validation.
  • Setting power limit has no validation.
  • Farm IP ranges are only based on the last 2 octets of the IP address.
  • API Errors are currently unhandled and may crash the program.
  • No feedback on command success or failure.
  • Scanning for miners will occasionally miss some.
  • Selected miners can be sent back to the main page as duplicates if refreshing after selecting.
    • Refresh again to get rid of them.
  • There's currently no way to bulk remove selected machines
  • Will always scan an IP range from 1 - 255
  • WMTUI will occasionally lock up on launch requiring a force killing of the main process.
  • WMTUI will occasionally crash on startup.
  • When switching between farms the rescan doesn't always scan properly, requiring a restart to fully switch to the new farm.
  • When scanning for miners API errors can occur marking the machine as off and setting errors to API_ERROR.
    • The issue is related to the version of firmware on the whatsminer, currently unknown if its due to being too old or too new.

Installing from release

Download the appropriate release version from the release page and unzip it.
Open a terminal and navigate to the newly created folder and run one of the following commands:

Windows:
.\WMTUI.exe

Mac/Linux:
./WMTUI

Building From Source

Requires go >= v1.22

Download the file from the <> code button in zip format and unzip it.
From the root directory of the project run the following:
go mod tidy
go build .

Manual Farm Setup

WMTUI comes preset with the 192.168.0.0/24 ip range and more can be added while running.
The FARMS.JSON file can be manually edited as well if preferred,
farms are stored in the following JSON format:

{
    "Farms": [{
        "Name": "Name of farm"
        "Start": "192.168.0.1"
        "End": "192.168.0.255"
    }]
}

About

TUI Whatsminer Tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%