Control PoE status on select Ubiquiti switches
Project description
Control PoE status on a Ubiquiti TS-8-Pro Switch
Development work for a system to remotely and automatically control the PoE status of individual ports on multiple Ubiquiti TS-8-Pro Switch, using predefined profiles.
This has currently only been tested on the TS-8-PRO ToughSwitch routers, though others will be added soon.
IMPORTANT: This library DOES NOT (and CAN NOT) ensure that any device attached to a port is compatible with the voltage selected. BE VERY CAREFUL that you choose the correct voltage for your devices or you can DAMAGE THEM. No responsibility is taken for equipment damaged using this library.
Status
This project is in no way ready to be used, and documentation is non-existent. See the Development Plans below. Until I have a stable useful interface, check the source code if you are interested 😃
Use Cases
- Control a set of PoE-powered IP cameras, switches and access points to allow disabling when not needed or quick enabling if required.
Installation
The latest version is uploaded to pypi.org so you can install this the same as any other package:
pip install poectrl
Configuration
IMPORTANT : The configuration layout has CHANGED from version 1.2.0. If you are using config files from previous versions you will need to update the "devices" section to fit the below schema and change the profile to point to the name instead of IP address.
The program is configured using a poectrl.json file either in the current
working directory (first priority) or the user's home directory. This is a
simple file that describes all devices and profiles. There is an example in
poectrl-example.json :
{
"devices": {
"switch_1": {"ip": "192.168.0.187", "user": "ubnt", "password": "ubnt"},
"switch_2": {"ip": "192.168.0.190", "user": "ubnt", "password": "ubnt"}
},
"profiles": {
"cctv_on": {
"switch_1": {"4": 24, "5": 24, "8": 48},
"switch_2": {"5": 24, "6": 24, "7": 48}
},
"cctv_off": {
"switch_1": {"4": 0, "5": 0, "8": 0},
"switch_2": {"5": 0, "6": 0, "7": 0}
}
}
}
Usage
Apply a predefined profile, setting the PoE port voltages.
$ poectrl apply cctv_off
Using configuration from /home/seapagan/data/work/own/poectrl/poectrl.json
Conncting to switch_1 (192.168.0.187):
Setting port 4 to 0V
Setting port 5 to 0V
Setting port 8 to 0V
Conncting to switch_2 (192.168.0.190):
Setting port 5 to 0V
Setting port 6 to 0V
Setting port 7 to 0V
List all defined profiles:
$ poectrl list
Using configuration from /home/seapagan/data/work/own/ts-8-pro-control/poectrl.json
Valid profiles are :
- cctv_on
- cctv_off
Show settings for a profile :
$ poectrl show cctv_off
Using configuration from /home/seapagan/data/work/own/ts-8-pro-control/poectrl.json
{
"switch_1": {
"4": 0,
"5": 0,
"8": 0
},
"switch_2": {
"5": 0,
"6": 0,
"7": 0
}
}
Development Plans
Current proposed project plan.
- Write proof-of-concept code to control ports.
- Refactor and tidy the above code into a Library Class.
- Create a basic CLI using this Library
- Continue the CLI to use a config file, show current values, list profiles etc.
- Publish on PyPi as a standalone package.
- Develop this into a full API (using FastAPI).
- Modify the command line app to interface with the above API.
- Create a Web App to interface with the above API.
Contributing
At this time, the project is barely in it's planning stage but I do have a firm idea where it's going and how to structure it. As such, other contributions are not looked for at this time. Hopefully, within a few days this project will be at a much more advanced stage and that will change 😃.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
