API Docs
LUXMiner commands
voltageset

voltageset

Description

Sets the current voltage of the system.

Note: This command will always fails if the curtailment mode is sleep. See the curtail command for details.

Command

$ echo '{"command": "voltageset", "parameter":"yJN2nlj1,1,8.9"}' | nc $MINER_IP 4028 | jq
💡

Note: In previous luxminer versions, this command required a board_id parameter, to apply the voltage change to a single board. This is not allowed anymore, and you shoud omit this parameter on new code.

However, for compatibility reasons, if the second parameter can be interpreted as a number between 0 and 3 it will be seen as the board_id parameter instead of the voltage value, to avoid breaking existing code. This does not change the behavior - the voltage is still applied to all boards - but allow legacy calls to keep working.

All of the examples on this page use the new format.

Examples

$ echo '{"command": "voltageset", "parameter":"yJN2nlj1,8.9"}' | nc $MINER_IP 4028 | jq
{
  "STATUS": [
    {
      "Code": 306,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Set Voltage",
      "STATUS": "S",
      "When": 1667917794
    }
  ],
  "VOLTAGE": [
    {
      "Board": 0,
      "Voltage": 8.899999618530273,
      "VoltageStep": 0.05
    }
  ],
  "id": 1

If the optional step parameter is provided, the value will be used instead of the normal ramping step. This can be used to quickly apply a configuration change, throwing safety over the window.

️🚫

Do not use this option unless you know what you're doing; this can cause permanent damage to the rig/board, as well as a decrease in hashrate over time.

Use at your own risk.

In the example below, we change the step to 0.5 volts:

$ echo '{"command": "voltageset", "parameter":"yJN2nlj1,8.9,0.5"}' | nc $MINER_IP 4028 | jq
{
  "STATUS": [
    {
      "Code": 306,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Set Voltage",
      "STATUS": "S",
      "When": 1667917794
    }
  ],
  "VOLTAGE": [
    {
      "Board": 1,
      "Voltage": 8.899999618530273,
      "VoltageStep": 0.5
    }
  ],
  "id": 1

Parameters

ParameterNotes
session_idA valid session ID. See Session Management for details.
board_idDeprecated. Board ID, starting from zero. Only for compatibility reasons; ignore this parameter when writing new code.
voltageThe desired voltage value.
stepOptional. The step size of the ramping. The default value is 0.05, and the max is 10.0.

Field details

FieldNotes
BoardEither the provided board ID, or zero. Only exists for compatibility reasons.
VoltageThe new voltage value.
VoltageStepThe step of the voltage ramp.