Skip to main content

python library for accessing the openHAB REST API

Project description

Code Health Codacy badge Documentation Status pypi version

python library for accessing the openHAB REST API

This library allows for easily accessing the openHAB REST API. A number of features are implemented but not all, this is work in progress.

Requirements

  • python >= 3.5

  • python :: dateutil

  • python :: requests

  • python :: typing

Note on openHAB1:

The current version is focused on OpenHAB 2.x; OpenHAB 1.x might still work, though this is not tested. If you require older OpenHAB support, please use an older version of this library.

Installation

Install the latest version using pip:

pip install python-openhab

Example

Example usage of the library:

from openhab import openHAB

base_url = 'http://localhost:8080/rest'
openhab = openHAB(base_url)

# fetch all items
items = openhab.fetch_all_items()

sunset = items.get('Sunset')
print(sunset.state)

# fetch a single item
item = openhab.get_item('light_switch')

# turn a swith on
item.on()

# send a state update (this only update the state)
item.state = 'OFF'

# send a command
item.command('ON')

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

python-openhab-2.8.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

python_openhab-2.8-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file python-openhab-2.8.tar.gz.

File metadata

  • Download URL: python-openhab-2.8.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.12.4 setuptools/38.5.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.6.4+

File hashes

Hashes for python-openhab-2.8.tar.gz
Algorithm Hash digest
SHA256 949b8574cd3174b962201ca7ec467fb6491c9009ad0c606ec00a52c9cab855a1
MD5 f884e2df398f438e4f948a1d3571a2d0
BLAKE2b-256 d9db6f33feecc175db42d9a83ebc58be256174b58aa5e41139f01cef03f8ec4d

See more details on using hashes here.

File details

Details for the file python_openhab-2.8-py3-none-any.whl.

File metadata

  • Download URL: python_openhab-2.8-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.12.4 setuptools/38.5.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.6.4+

File hashes

Hashes for python_openhab-2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c8bfdde66cfd068e138e76f2408c6685aece1eba4054fbc737dfaede8eb6c9aa
MD5 5bb3b5059d3d74167617445704b3a5a1
BLAKE2b-256 6e0bf481229e863f70587c08f6469be4ce216a84cc480696d3a5c3a139cf5113

See more details on using hashes here.

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