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 switch 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.11.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

python_openhab-2.11.1-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python-openhab-2.11.1.tar.gz
  • Upload date:
  • Size: 8.4 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.38.0 CPython/3.8.0

File hashes

Hashes for python-openhab-2.11.1.tar.gz
Algorithm Hash digest
SHA256 2a82cbc809c89377dccaf1804246c6ac8e25f6b788f16dbefc980d7a56179ade
MD5 cdf0440bd4028d4ff217e2b3d1f0b35c
BLAKE2b-256 243c2a4b57bc3d0b1d26420a20df2f0fa5d48264c7f82126f8b1de217dfcc887

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_openhab-2.11.1-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.38.0 CPython/3.8.0

File hashes

Hashes for python_openhab-2.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0ed51e99837870894ea691cae9bb8e41bac3f53f84a72c8f89516d1dd7d12f6
MD5 c77d0089ec5f0c6b7ef77e55c6919d64
BLAKE2b-256 e44dd133761f29f558f85f185d624079b3fbbddcba06065e8793a0dbee141d1d

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