Warning
This documentation is actively being updated as the project evolves and may not be complete in all areas.
EnerGenie¶
Drivers for EnerGenie products.
EnerGenie driver¶
This driver provides a client for the EnerGenie Programmable power switch. The driver was tested on EG-PMS2-LAN device only but should be easy to support other devices.
driver: jumpstarter_driver_energenie.driver.EnerGenie
Installation¶
pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-energenie
Configuration¶
export:
power:
type: jumpstarter_driver_energenie.driver.EnerGenie
config:
host: "192.168.0.1"
password: "password"
slot: "1"
Config parameters¶
Parameter |
Description |
Type |
Required |
Default |
---|---|---|---|---|
host |
The ip address of the EnerGenie system |
string |
yes |
None |
password |
The password of the EnerGenie system |
string |
no |
None |
slot |
The slot number to be managed, 1, 2, 3, 4 |
int |
yes |
1 |
PowerClient API¶
The EnerGenie driver provides a PowerClient
with the following API:
- class jumpstarter_driver_power.client.PowerClient
Examples¶
Powering on and off a device
client.power.on()
time.sleep(1)
client.power.off()
CLI¶
$ sudo uv run jmp exporter shell -c ./packages/jumpstarter-driver-energenie/examples/exporter.yaml
$$ j
Usage: j [OPTIONS] COMMAND [ARGS]...
Generic composite device
Options:
--help Show this message and exit.
Commands:
power Generic power
$$ j power on
$$ exit