API Docs
LuxMiner commands
curtail

curtail

Description

Execute one of the three curtailment actions:

  • sleep: Puts the miner in sleep mode, turning off the hashboards and the power supply.
  • wakeup: Wakes up the miner from either idle or sleep mode, turning the power on and setting the boards to the target frequency/voltage.

The wakeup works by setting the frequency/voltage immediately. Naturally, this causes stress and can reduce the device lifetime, so take that into consideration when using the curtail command. Note that an sleep rig can only be started again by wakeup or rebooting the machine (individual board reboots are not allowed).

The frequency and voltage steps limits can be queried using the limits command.

Command

$ echo '{"command": "curtail", "parameter":"yJN2nlj1,sleep"}' | nc $MINER_IP 4028 | jq

Examples

The example below puts the rig in sleep mode.

$ echo '{"command": "curtail", "parameter":"yJN2nlj1,sleep"}' | nc $MINER_IP 4028 | jq
{
  "CURTAIL": [
    {
      "Action": "sleep mode"
    }
  ],
  "STATUS": [
    {
      "Code": 335,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Curtailment command sent",
      "STATUS": "S",
      "When": 1681332079
    }
  ],
  "id": 1
}

The example below wakes up the miner, with a 100MHz frequency ramping step and a 1V voltage ramping step:

$ echo '{"command": "curtail", "parameter":"yJN2nlj1,wakeup"}' | nc $MINER_IP 4028 | jq
{
  "CURTAIL": [
    {
      "Action": "wake up"
    }
  ],
  "STATUS": [
    {
      "Code": 335,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Curtailment command sent",
      "STATUS": "S",
      "When": 1681332139
    }
  ],
  "id": 1
}

Parameters

ParameterNotes
session_idA valid session ID. See Session Management for details.
actionEither sleep or wakeup.

Field details

FieldNotes
ActionEither sleep mode or wake up.