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.10.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

python_openhab-2.10.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python-openhab-2.10.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3

File hashes

Hashes for python-openhab-2.10.0.tar.gz
Algorithm Hash digest
SHA256 046dbf36ac74970b4f14715c34e6c07ee60cacbab0dcd1f91bdd2de9ff538357
MD5 d33429c5013be09f53e8854581093fc6
BLAKE2b-256 5956a3d50136946b04d8d228b755b5b3b6f10f2dfd581cb92f58dfacb80d24cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_openhab-2.10.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3

File hashes

Hashes for python_openhab-2.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 edb4cf2907321d8bafdbe4d0f4ea3c8d464de7c3fd63be1aa3fef40d06d67028
MD5 b596fcfd6d499ecf2f4d9276196fa8de
BLAKE2b-256 afa28b079db19cc6d6b61d4f9ff7a4fd90deaf50c05fac733e6b5b9dab3fb5bd

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