No description, website, or topics provided.
Python
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
openwebif - More updates Oct 22, 2016
tests - More updates Oct 22, 2016
.gitignore Initial commit May 29, 2015
.travis.yml Updates for picons Oct 13, 2016
LICENSE Initial commit May 29, 2015
MANIFEST Fix flake8 fails Jun 1, 2015
README.md Updates for README Oct 13, 2016
requirements.txt Various checks and additions May 29, 2015
setup.cfg Initial commit May 29, 2015
setup.py Added get picon method Oct 13, 2016

README.md

Introduction Build Status Coverage Status

openwebif.py is a python module providing a basic python interface to interact with a device running OpenWebIf

openwebif.py is licensed under the MIT license.

Getting started

openwebif.py is compatible with OWIF 0.4 or newer. It may work on older versions, but that has not been tested.

For further info on OpenWebIf and it's API's see: https://github.com/E2OpenPlugins/e2openplugin-OpenWebif

See file:
/plugin/controllers/web.py

Requirements

openwebif.py requires:

  • requests>=2.0

Install

pip install openwebif.py

Usage

import openwebif.api

# This will use http by default (not https)
e2_client = openwebif.api.CreateDevice('192.168.2.5')

is_now_in_standby = e2_client.is_box_in_standby()
is_now_in_standby = e2_client.toggle_standby()
xml_response = e2_client.get_about()
json_response = e2_client.get_status_info()

TODO

  • https or OpenWebIf authentication is not yet supported.
  • Add get_picon function

Developer

openwebif.py is hosted by Github at https://github.com/fbradyirl/openwebif.py.

Code has been tested with the following before commit:

flake8 openwebif
pylint openwebif
coverage run -m unittest discover tests

Copyright (c) 2015 Finbarr Brady.