FirmwareAPI Documentation
Available Commands
This is the full list of available commands on the LUXminer API:
| Command | Notes |
|---|---|
| addgroup [1] | Adds a new group with a given name and quota. |
| addpool [1] [3] | Adds a new pool to the first group. |
| asc | Shows the details of a single ASIC board. |
| asccount | Returns the number of ASIC boards. |
| atm | Displays ATM configuration. |
| atmset [1] [2] | Changes ATM configuration. |
| autotunerget | Displays autotuner configuration. |
| autotunerset [1] [2] | Changes autotuner configuration. |
| check | Checks if a command exists and if it is available. |
| coin | Always zeros; exists only for compatibility. |
| config | Lists system configuration. |
| curtail [2] | Executes the curtailment action. |
| devdetails [3] | Shows hardware information about the connected devices. |
| devs | Provides a detailed report of the ASIC boards. |
| disableboard [1] [2] | Disables a board. |
| disablepool [1] | Disables a pool. |
| edevs | Same as devs. |
| enableboard [1] [2] | Enables a board. |
| events | List relevant miner events |
| enablepool [1] | Enables a pool. |
| estats | Shows a variety of miner stats. |
| fans | Displays fan statistics and params. |
| fanset [1] [2] | Sets the speed-related params of the fans. |
| frequencyget | Returns the frequency of one or all chips of a given board. |
| frequencyset [2] [4] | Sets a target frequency for one or more chips of a given board. |
| frequencystop [2] | Stops the frequency change of a frequencyset command. |
| groupquota [1] | Sets the quota of a group to the specified value. |
| hashboardopts | Returns the current hashboard options. |
| hashboardoptsset [1] [2] | Changes the hashboard options. |
| healthchipget | Returns per chip health, topology, and temperature information. |
| healthchipset [1] [2] | Sets a chip as the next healthcheck target. |
| healthctrl | Returns the current health check configuration. |
| healthctrlset [1] [2] | Changes the healthcheck configuration. |
| kill | Kills the current active session and records this occurrence in the log file. |
| ledset | Sets the operation mode of the LED. |
| logs | Retrieves LuxOS logs. |
| lcd | Always zeros; exists only for compatibility. |
| limits | Returns miner parameter limits. |
| logoff [2] | If the session is active, drops it. |
| logon | Creates a new session and returns its ID. |
| logset [1] [2] | Updates logging options. |
| metrics | Diplay miner metrics. |
| netset [2] | Updates network configuration. |
| poolopts | Displays pool connection options. |
| pooloptsset [1] [2] | Sets pool connection options. |
| pools [3] | Lists all the pools, in order, and their statistics. |
| power | Returns the estimated power usage, in watts. |
| powertargetget | Reads the current power target, power limit, and power minimum. |
| powertargetset | Sets the power target, power limit, and/or power minimum. |
| psuget | Displays PSU configuration. |
| psuset [1] [2] | Changes PSU configuration. |
| profileget [2] | Returns detailed information about a profile. |
| profilenew [2] | Creates a new profile. |
| profilerem [2] | Removes an existing profile. |
| profilerestore | Restore a profile to its original configuration. |
| profiles | Lists the available profiles. |
| profileset [1] [2] [4] | Assigns a profile to a given board. |
| reboot [2] | Schedules a reboot for a given board. |
| rebootdevice [2] | Reboots the mining rig. |
| removegroup | Removes a group, and all of its pools. |
| resetconfig [2] | Resets the miner and network configuration. |
| resetminer [2] | Resets the miner application. |
| removepool [1] [3] | Removes a pool from the first group. |
| session | Returns the ID of the active session. |
| systemaudit | Returns a list of system audit events. |
| stats | Shows a variety of miner stats. |
| summary | Provides the summary of all miner statistics. |
| switchpool [1] [3] | Switches a given pool to the top priority. |
| tempctrl | Displays temperature control. |
| tempctrlset [1] [2] | Sets the temperature control values. |
| temps | Shows temperature data. |
| tempsensor | Displays temperature sensor options. |
| tempsensorset [1] [2] | Updates temperature sensor options. |
| uninstallluxos [2] | Uninstalls LuxOS from the miner and restores stock firmware. |
| updatecheck | Check the available updates and return a list of package versions. |
| updaterun [2] | Manually runs the autoupdate. |
| updateset [1] [2] | Changes autoupdate configuration. |
| version | Prints the API and application version. |
| voltageget | Returns the current voltage of a given board. |
| voltageset [2] [4] | Sets the voltage of a given board. |