Skip to main content

ISY99 Controller Rest and Websocket client v5 firmware

Project description

ISY994v5

Class based interface to the ISY994 device with V5 firmware.

As of version 0.6.6, using aiohttp and asyncio to manage the HTTP and WebSocket connection to the ISY.

Provides a common interface to all devices, variables, programs, and scenes on an ISY controller.

After connecting to the ISY, the 4 types (device, scenes, programs, and variables) of items on the ISY are enumerated. The event handler generates 'add' events are items are discovered. Each item has properties that generate 'property' events as they are changed.

Currently supports Insteon dimmers, switches, keypadlincs, fanlincs, templinc and contact devices ZWave locks and switches ISY Scenes ISY Programs ISY Variables

All item/node types (device,scene,program,variable) are retrieved and updated via websockets. No polling.

Each device has a common base class so that the user does not need to aware of the technology (Insteon/zWave etc) to use that device

Designed to be easy to expand support to other ISY device types and technologies such as zWave.

Requires 5.xx firmware. Tested against 5.16. Chunked can be on or off.

An event handler is supplied when the controller is started. All device events (add, remove, property) can be captured through the event handler for processing as needed.

This library is used in IYS994-Homie-Bridge, an MQTT Client to serve ISY devices to a MQTT broker using the Homie 3/4 protocol.

Example usage: The program below connects to the ISY and enumerates all items. If it finds a device with the address specified, it will flash that device on and off every 2 seconds

import time

from isy994.controller import Controller

url = '192.168.1.213'
#url = None # use autodiscovery

dimmer_address = '42 C8 99 1' # dimmer to flash on/off

dimmer = None

def isy_event_handler(container,item,event,*args):
    print ('Event {} from {}: {} {}'.format(event,container.container_type,item.name,*args))

    if container.container_type == 'Device' and event == 'add' and item.address == dimmer_address:
        global dimmer
        dimmer = item


try:
    c = Controller(url,username='admin',password='admin',use_https=False,event_handler=isy_event_handler)

    while True:
        if dimmer is not None:
            dimmer.set_level (0)

        time.sleep(2)

        if dimmer is not None:
            dimmer.set_level (100)


except KeyboardInterrupt:
    print("KeyboardInterrupt has been caught.")

Project details


Release history Release notifications | RSS feed

This version

0.7.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ISY994v5-0.7.6.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ISY994v5-0.7.6-py3-none-any.whl (78.8 kB view details)

Uploaded Python 3

File details

Details for the file ISY994v5-0.7.6.tar.gz.

File metadata

  • Download URL: ISY994v5-0.7.6.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.0

File hashes

Hashes for ISY994v5-0.7.6.tar.gz
Algorithm Hash digest
SHA256 0016f7db4a81973a7b65fc3d882ec26258aaa4561472d62a944a545f79d3802b
MD5 be30254b558096bbee3c1ebd2648f2e2
BLAKE2b-256 163866006d6a96a6a008fa9b0d061c54089817286e75f0fe1eb5b9000f931f58

See more details on using hashes here.

File details

Details for the file ISY994v5-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: ISY994v5-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 78.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.0

File hashes

Hashes for ISY994v5-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 842755cbe23fdade4eb451431deaa6ec6f652a769015196acc90849e8dcf6f29
MD5 b2e00bc033b9d3c9357f09b29a57364a
BLAKE2b-256 0f65b72a7e0be76d1482b4b686c9cc8889db8a8371c1ab886dd49f8d186279c8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page