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

Uploaded Source

Built Distribution

pyisy-3.0.12-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyisy-3.0.12.tar.gz
Algorithm Hash digest
SHA256 757c6770e1756151cef1dfe333230b6ae9077285c1ab48ae91a10ed35ef1444d
MD5 53ecf26ab4a19156512b079d02102587
BLAKE2b-256 622c9c71bcc51ba9f5c2b6fce6750bbe19cfcc79f8ce465faf33e58f41cfc24f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyisy-3.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 2e827f336312ce49cd1f250b2f437a51b95d192a73833b04165ce8a1565799ba
MD5 75971d0a8fdc498e2e0395a48b2fc4f4
BLAKE2b-256 0c0f3372101b58e499ba6433f5cc515c8753e494eca17e5a0dc3fb927273ec0c

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