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.

Version 2 End of Life Notice (EOL)

:warning: Version 2 of this library will be marked as EOL and will not be maintained after 2023-12-31. If you are still using this version, please consider migrating to pyisyox. Version 3 of this module will also be marked EOL on 2024-07-01 in favor of migration to the newest version at pyisyox.

If there is a specific feature that is not available in the current versions, please open an issue at https://github.com/shbatm/pyisyox/issues

Examples

See the examples folder for connection examples.

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

Uploaded Source

Built Distribution

pyisy-2.1.7-py3-none-any.whl (53.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyisy-2.1.7.tar.gz
  • Upload date:
  • Size: 44.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for pyisy-2.1.7.tar.gz
Algorithm Hash digest
SHA256 7dff784297ad0afff7966d7fdf05a71f83e3d8ad38158c7a45d9890f2d8148fe
MD5 c7c07ae6363df4c14e52f09493683df2
BLAKE2b-256 d3937e36ac51dde97d87c9e05035136e0d9beb2acb265a87885ea76f632883a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyisy-2.1.7-py3-none-any.whl
  • Upload date:
  • Size: 53.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for pyisy-2.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 71886a5e3ac79eeeb7cc6cc3afa9c493740673b135d03db6137c92e503bee395
MD5 40afba43fd77115aec618c0fa5e574c1
BLAKE2b-256 e06fb306f821b8a35612d6c6650ac22f2722ffc742a21a6fbd2da63261a8b1df

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