Skip to main content

python library for accessing the openHAB REST API

Project description

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

Uploaded Source

Built Distribution

python_openhab-2.10.2-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for python-openhab-2.10.2.tar.gz
Algorithm Hash digest
SHA256 4da294c769c098f2885fe6310d66dc7518ee79caaf19eb6f4fe54374e6c524f1
MD5 013e795a6de1ece3fbeaf86a2df6bb67
BLAKE2b-256 0bb6656010eaaea55e720888c74360de8d77b39bdba4a9fa586cec9a2a5ff872

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for python_openhab-2.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7caf5ff4471e051d41a7b39d257b01bf723205b5dfb314b27cf7dd76adfd3e17
MD5 341bb847318fd9a97a603d123ce63fe1
BLAKE2b-256 d8a67b32b9bd9c2a72ff47e273c94e78cc091129b88c4ebdef327c77ad066649

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