Luxor Documentation Hub Logo
Firmware/API Docs/LUXminer commands

voltageget

Gets the board voltage

voltageget

Description

Returns the current voltage of a board. This can be either the PSU voltage or the "on-board voltage" for PIC miners.

Command

$ echo '{"command": "voltageget", "parameter": "0"}' | nc $MINER_IP 4028 | jq

Reading the PSU voltage

To get the real voltage, according to the PSU, simply ask for it:

$ echo '{"command": "voltageget", "parameter": "0"}' | nc $MINER_IP 4028 | jq
{
  "STATUS": [
    {
      "Code": 307,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Get Voltage",
      "STATUS": "S",
      "When": 1667917088
    }
  ],
  "VOLTAGE": [
    {
      "Board": 0,
      "IsOnBoard": false,
      "Voltage": 8.90
    }
  ],
  "id": 1
}

Reading the On-board voltage

To get the on-board voltage, according to the PIC, you need to specify the second (optional) parameter as true. Please note that this value will be zero if the miner has no support for on-board voltage reading.

$ echo '{"command": "voltageget", "parameter": "0,true"}' | nc $MINER_IP 4028 | jq
{
  "STATUS": [
    {
      "Code": 307,
      "Description": "LUXminer 0.1.0-15436f7140",
      "Msg": "Get Voltage",
      "STATUS": "S",
      "When": 1667917088
    }
  ],
  "VOLTAGE": [
    {
      "Board": 0,
      "IsOnBoard": false,
      "Voltage": 8.912
    }
  ],
  "id": 1
}

Parameters

ParameterNotes
board_idBoard ID, starting from zero.
on_boardOptional. If true, returns the PIC voltage reading, if available.

Field details

FieldNotes
BoardThe board_id, same as the input parameter.
IsOnBoardtrue in case the reading is from the on-board voltage.
VoltageThe voltage value of that board.

On this page