Skip to main content

Python module to talk to ISY994 from UDI.

Project description

PyISY

Python Library for the ISY Controller

This library allows for easy interaction with ISY nodes, programs, variables, and the network module. This class also allows for functions to be assigned as handlers when ISY parameters are changed. ISY parameters can be monitored automatically as changes are reported from the device.

NOTE: Significant changes have been made in V2, please refer to the CHANGELOG for details. It is recommended you do not update to the latest version without testing for any unknown breaking changes or impacts to your dependent code.

Examples

See the examples folder for connection examples.

The full documentation is available at https://pyisy.readthedocs.io.

Development Team

Contributing

A note on contributing: contributions of any sort are more than welcome! This repo uses precommit hooks to validate all code. We use black to format our code, isort to sort our imports, flake8 for linting and syntax checks, and codespell for spell check.

To use pre-commit, see the installation instructions for more details.

Short version:

# From your copy of the pyisy repo folder:
pip install pre-commit
pre-commit install

A VSCode DevContainer is also available to provide a consistent development environment.

Assuming you have the pre-requisites installed from the link above (VSCode, Docker, & Remote-Containers Extension), to get started:

  1. Fork the repository.
  2. Clone the repository to your computer.
  3. Open the repository using Visual Studio code.
  4. When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.
    • If you don't see this notification, open the command palette and select Remote-Containers: Reopen Folder in Container.
  5. Once started, you will also have a test_scripts/ folder with a copy of the example scripts to run in the container which won't be committed to the repo, so you can update them with your connection details and test directly on your ISY.

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

pyisy-3.0.3.tar.gz (49.5 kB view details)

Uploaded Source

Built Distribution

pyisy-3.0.3-py3-none-any.whl (60.6 kB view details)

Uploaded Python 3

File details

Details for the file pyisy-3.0.3.tar.gz.

File metadata

  • Download URL: pyisy-3.0.3.tar.gz
  • Upload date:
  • Size: 49.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pyisy-3.0.3.tar.gz
Algorithm Hash digest
SHA256 affbdc19e3776cd169a851d7186cb4c00d6e5ee7236a04d52d54d15f97ee429f
MD5 fa851f42bc0b5eccec5c77eb1ffe2ea6
BLAKE2b-256 314480306c6f69b2fbc289ae5bb15e3a818c3ad78fe5241a3ac8b84788d3fb4d

See more details on using hashes here.

File details

Details for the file pyisy-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyisy-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 60.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pyisy-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e4ff23052c537086ed005404eaef58e8b56a448c5df405b1bc98720035fa112
MD5 8f7112ad67012a9dbed7a1f2ff211d64
BLAKE2b-256 32d63784cb0e90839a7f7c7d2653682fdbf502b688f955980fb66e50f9044fb4

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