https://github.com/luckman212/unifi-usp-control

Control or retrieve status of a USP-Plug device via the Unifi API
https://github.com/luckman212/unifi-usp-control

api controller unifi wrapper

Last synced: 12 days ago
JSON representation

Control or retrieve status of a USP-Plug device via the Unifi API

• Host: GitHub
• URL: https://github.com/luckman212/unifi-usp-control
• Owner: luckman212
• Created: 2024-12-23T19:02:29.000Z (14 days ago)
• Default Branch: main
• Last Pushed: 2024-12-23T19:42:40.000Z (14 days ago)
• Last Synced: 2024-12-23T20:27:30.240Z (14 days ago)
• Topics: api, controller, unifi, wrapper
• Language: Python
• Homepage:
• Size: 48.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## unifi-usp-control

Simple Python wrapper around the Unifi API to control or retrieve status of a [USP-Plug][1] device.

### Setup and Usage

Requires a semi-recent Python with the `requests` module installed.

Edit the script to adjust the variables at the top such as default device MAC, site id, Unifi controller hostname, and API login credentials.

Run with `-h` or `--help` for help on the commandline arguments.

```

$ ./usp_power.py -h

usage: usp_power.py [--site SITE] [--mac MAC] [{get,on,off,toggle}]

Control UniFi USP-Plug outlet power state

positional arguments:

  {get,on,off,toggle}  Get or Set desired power state

options:

  --site, -s SITE      Site ID (as shown in Unifi web interface)

  --mac, -m MAC        MAC address of USP-Plug

```

### List of Environment Variables

- `UNIFI_HOST` the hostname and port of your Unifi controller e.g. `unifi.foo.com:8443`

- `UNIFI_USER` a user to authenticate with for API calls (typically `admin`)

- `UNIFI_PASS` password (_yes_ I know it's not a good idea to store passwords in the clear! Please fork the script and improve the security by using a password manager, cryptography or whatever other method you see fit!)

### Other Variables (hardcoded)

These can be overridden using arguments `--mac/-m` or `--site/-s`.

- `DEFAULT_MAC` = MAC address of the default plug you want to control

- `DEFAULT_SITE` = The site ID where your USP-Plug resides (you will see this if you navigate to your Unifi controller, it is the part after the `/manage/` in the URL)

### Example Helper Script

Here's a small helper script example for storing credentials and vars in a separate file:

```

#!/bin/sh

export UNIFI_HOST=unifi.mycorp.net:8443

export UNIFI_USER=admin

export UNIFI_PASS=supersecret123

/usr/local/bin/usp_power.py \

  --mac fc:ec:da:a3:54:2b \

  --site ioj7qtxy \

  "$@"

```

### Can this program do _xyz_ ?

I wrote this to scratch my own itch. I've tested it fairly extensively on my own setup, but YMMV. I am running UNA version 9.0.106 as of this writing. Bugreports or PRs to add features welcome!

### See Also

- [luckman212/unifi-stp-prio](https://github.com/luckman212/unifi-stp-prio/) - CLI program to show STP detail of Unifi switches

[1]: https://store.ui.com/us/en/products/unifi-smart-power