ledset
Sets the LED mode
ledset
Description
Sets the LED operational mode. This allows the user to manually override the LED pattern to, for example, locate a physical machine more easily.
The first parameter is the LED light you want to set:
Value | Description |
---|---|
red | Changes the red LED. |
green | Changes the green LED. |
The second parameter is the mode which defines how the led should be handled:
Value | Description |
---|---|
auto | Automatic mode (the default). In this mode, LUXminer will decide what to do with the led. |
on | The led is kept on until the user changes to a different mode. |
off | The led is kept off until the user changes to a different mode. |
blink | The led will blink until the user changes to a different mode, often used to locate a miner. |
The LED lights are used by LUXminer to communicate if the machine is working properly or if an abnormal situation is present. This helps operators quickly spot affected machine(s) for troubleshooting.
Because of this, it is advisable to keep the leds on the auto
mode (the default) as much as possible. If you decide to change that via scripting for any reason, please be sure to communicate that to users and to "clean up" on exit by setting the default auto
value when possible.
Command
Examples
The example below sets the red led to a continuous blink, overriding the system handling of the lights, often used to physically locate the miner.
This sets the led mode to auto
. In this mode LUXminer will handle how the led should react.
Parameters
Parameter | Notes |
---|---|
session_id | A valid session ID. See Session Management for details. |
led | Which LED to set: "red" or "green" . |
mode | The desired mode. Can be on , off , blink or auto (the default). |