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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

python_openhab-2.7-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for python_openhab-2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d7bd560d54a7163f8e55bac76252de3e7e9c567217c3c36c628c0fcbc09c5c89
MD5 9cbeb39beecfa910e2bbf9d5ad1f22e7
BLAKE2b-256 ef0cef928ce7b0decdf83ce6b4404cb24be5a5ef551908659f533eedd891b058

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