Skip to content

1.2.0: hyperdeckwire.setup, the deck's configuration API

Choose a tag to compare

@lucas-romanenko lucas-romanenko released this 09 Oct 17:21
· 70 commits to main since this release
028ac26

hyperdeckwire.setup: a client for the HyperDeck's configuration API.

Everything HyperDeck Setup shows for a networked deck lives on a REST API on the deck's HTTP port (/admin/api/v1/). None of it exists in the 9993 Ethernet Protocol, whose configuration verb covers codec, inputs and timecode only. HyperdeckSetup covers:

  • name and identify;
  • the network interface (address, netmask, gateway, DNS, DHCP);
  • the FTP and Web Media Manager switches (Disabled / Enabled / SecureOnly);
  • the HyperDeck Ethernet Protocol switch (TCP 9993 on or off);
  • certificate, users, date and time, NTP, timezone, reboot.

Every setter reads the setting back and raises HyperdeckSetupError when the deck holds something else. A network change is read back until the interface is live on the new values, at the new address if the address changed.

"Configure via USB and Ethernet" has no setter. While it is off, the deck refuses every PUT with 401, including the one that would turn it on. So it can only be enabled over USB, and turning it off over Ethernet would cut off the channel doing it. remote_admin() reads it so a 401 can be explained before it happens.

Measured on two HyperDeck Studio HD Mini units on software 9.0.2: every read endpoint, and the write paths as same-value round trips (name, network, network access, Ethernet protocol, NTP, timezone, identify).

Wheels for Linux x86_64 and aarch64, macOS arm64 and x86_64, Windows x86 and x86_64 on CPython 3.10 to 3.14, plus the sdist.