API and command line tools to interface with EZOutlets.
Project description
EZOutlet SDK
Overview
API and command line tools to interface with EZOutlets.
- EZ-73a (2 outlet)
- EZ-72b (1 outlet)
- EZ-62b (1 outlet)
Installation
Install EZOutlet SDK:
python3 -m pip install ezoutlet-sdk
Usage
You can use it by importing:
from ezoutlet import EzOutletAPI
ezoutlet = EzOutletAPI("192.168.1.100", "user", "pass")
# Turn outlet on/off
ezoutlet.turn_on_outlet(1)
ezoutlet.turn_off_outlet(1)
# Switch outlet (i.e. from On → Off, or from Off → On)
ezoutlet.switch_outlet(1)
# Reset outlet (turn off/on) - only if on
ezoutlet.reset_outlet(1)
# Enable/Disable auto reset
ezoutlet.enable_auto_reset()
ezoutlet.disable_auto_reset()
# Get status
status = ezoutlet.get_status()
print(status)
Or as a command line app:
# Turn on outlet #1
ezoutlet-sdk --ip 192.168.1.100 --user admin --password pass --outlet 1 --mode 1
# Turn off outlet #1
ezoutlet-sdk --ip 192.168.1.100 --user admin --password pass --outlet 1 --mode 0
# Enable auto-reset
ezoutlet-sdk --ip 192.168.1.100 --user admin --password pass --outlet 0 --mode 1
# Disable auto-reset
ezoutlet-sdk --ip 192.168.1.100 --user admin --password pass --outlet 0 --mode 0
NOTE: For all CLI options run
ezoutlet-sdk --help
.
Development
To get a list of all commands with descriptions simply run make
.
make env
make pip_install
make pip_install_editable
Testing
make pytest
make coverage
make open_coverage
Issues
If you experience any issues, please create an issue on Github.
History
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
0.1.0 (2024-05-02)
- First release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ezoutlet_sdk-0.1.0.tar.gz
(9.7 kB
view details)
Built Distribution
File details
Details for the file ezoutlet_sdk-0.1.0.tar.gz
.
File metadata
- Download URL: ezoutlet_sdk-0.1.0.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00b0e0efddad6321dec694695d2f2677a92bc2b5036ff57f37395d2c1c1b3e9b |
|
MD5 | 009c1eca8399be90b714e662e9cf1c4d |
|
BLAKE2b-256 | 637ec8085f853e3b80fcd1a2e283dee966ad71a54809b6a1f6e6b0baf00b6bea |
File details
Details for the file ezoutlet_sdk-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: ezoutlet_sdk-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 752765b4aef1060509dcbdb4c1f0f6b9341ef9405fb415922414c4284b09f4f9 |
|
MD5 | 575e04024be66b083cbb30895a2f7061 |
|
BLAKE2b-256 | 11ba846d8fc2620ef76d002c29f40236283294068f54548824f983f200e3c56d |