Skip to main content

API and command line tools to interface with EZOutlets.

Project description

EZOutlet SDK

Coverage

Overview

API and command line tools to interface with EZOutlets.

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


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 hashes)

Uploaded Source

Built Distribution

ezoutlet_sdk-0.1.0-py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 3

Supported by

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