Skip to main content

Add your description here

Project description

Yepkit driver

jumpstarter-driver-yepkit provides functionality for interacting with Yepkit products.

Installation

pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-yepkit

Configuration

Example configuration:

export:
  power:
    type: jumpstarter_driver_yepkit.driver.Ykush
    config:
      serial: "YK25838"
      port: "1"

  power2:
    type: jumpstarter_driver_yepkit.driver.Ykush
    config:
      serial: "YK25838"
      port: "2"

Config parameters

Parameter Description Type Required Default
serial The serial number of the ykush hub, empty means auto-detection no None
port The port number to be managed, "0", "1", "2", "a" which means all str yes "a"

API Reference

The yepkit ykush driver provides a PowerClient with the following API:

.. autoclass:: jumpstarter_driver_power.client.PowerClient()
    :members: on, off

Examples

Powering on and off a device

:skipif: True
client.power.on()
time.sleep(1)
client.power.off()

CLI access

$ sudo ~/.cargo/bin/uv run jmp shell --exporter-config ./packages/jumpstarter-driver-yepkit/examples/exporter.yaml
WARNING:Ykush:No serial number provided for ykush, using the first one found: YK25838
INFO:Ykush:Power OFF for Ykush YK25838 on port 1
INFO:Ykush:Power OFF for Ykush YK25838 on port 2

$$ j
Usage: j [OPTIONS] COMMAND [ARGS]...

  Generic composite device

Options:
  --help  Show this message and exit.

Commands:
  power   Generic power
  power2  Generic power

$$ j power on
INFO:Ykush:Power ON for Ykush YK25838 on port 1

$$ exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jumpstarter_driver_yepkit-0.6.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jumpstarter_driver_yepkit-0.6.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file jumpstarter_driver_yepkit-0.6.0.tar.gz.

File metadata

File hashes

Hashes for jumpstarter_driver_yepkit-0.6.0.tar.gz
Algorithm Hash digest
SHA256 300a0c952f42e39be5f1fa654f22cbcbdd0e5bb8374b8ce569567fa4c0242af5
MD5 5e38045dca9a28658fe078615764b5cb
BLAKE2b-256 a4cfdf27dc7e2653a48799e2df27628048ec314823a8c147a7f354c891c724c4

See more details on using hashes here.

File details

Details for the file jumpstarter_driver_yepkit-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jumpstarter_driver_yepkit-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 356983a2ad6474294e3bc6516abbc82d5d2a90825c8cb18d5647373268860cc3
MD5 8ab6610602f5c2e1175d9e46822551aa
BLAKE2b-256 7193b903a9c176b60f839f39cf288fd5701a4fd69f949552337c9131cf7e4701

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page