Giters

jimboca / udi-poly-hue-emu

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status master Build Status dev

udi-poly-hue-emu

This is the Hue Emulator Poly for the Universal Devices ISY994i Polyglot interface with Polyglot V2 (c) JimBoCA aka Jim Searle MIT license.

This node server is intended to allow controlling ISY994 devices from other devices that support a Hue Hub. So devices like a Harmony Hub can control ISY devices or scenes. The Harmony Elite remote has dedicated home control buttons which work very well with this setup. It also should work to control devices with Amazon Alexa, but I no longer use Alexa so I can not support it. The Google home no longer works with local Hue hubs, so that isn't supported either.

Previously this functionality was available in ISYHelper but all ISYHelper functions have been moved to nodeservers.

It uses the PyISY Library to connect to the ISY and control devices, and the Python Hue Hub Emulator to emulate a Hue Hub.

This version remembers the devices previous hue id so they should not ever change.

Setup

By default all devices that have a 'Spoken' property set in the ISY notes will be added to the list. To set this right click on the device in the ISY admin console and select 'Notes'. If you have a recent version of the ISY firmware and admin console you should see the option to add 'Spoken'. If you want the spoken name to always match the device name, just make the value of the Spoken property be the number one '1', without the quotes. Make sure there are no accents in the Spoken property, only plain ASCII characters, or the discovery will fail.

To control a scene you can set the Spoken on the scene controller, in which case the server will turn on the scene, or set the Spoken on the scene itself. (Need to test how brighten/dim work with scenes)

The scene status will not always be correct, this is because PyISY decides that a scene is on when any of the devices in the scene is not off. For this reason I prefer to put the spoken property on the main scene controller I want to track instead of the scene itself. But if your scene contains multiple responders at different levels this will not work properly.

IMPORTANT: Currently if you 'group device' it will not find your Spoken property on your device. This is an issue with the PyISY library that I will try to fix soon because almost all my devices were grouped. (Is this still true?)

Installation

  1. Backup Your ISY in case of problems!
    • Really, do the backup, please
  2. Go to the Polyglot Store in the UI and install HueEmulator
  3. Open the ISY Admin Console, close and re-open if it was already open.
  4. Once it installs you should see a new node 'Hue Emulator Controller'
    • If you don't see that node, then restart the node server from the Polyglot UI.
  5. Set the Configuration as described in the next section.
  6. Restart the nodeserver after all params are saved.

Configuration

The 'Configuration' tab contains the default values for all Custom Configuration Parameters. It also shows what devices are found to have spokens.

See Polyglot Configuration Page

Hue Emulator Controller node

This is the one and only node for this nodeserver. It has the following options:

  • ISY Connected: The status of the process that maintains a connection to the ISY
  • Debug Mode: The Logger mode, debug will spew a lot of information, info is he default.
  • Listen: Enabling this is the same as pushing the button on a hue hub. You should only turn on when adding the hub to another device.

Debug

The log for the nodeserver will show that it is parsing all the notes from each device. When it finds a spoken property it will print information about that device.

You should see it checking the ‘notes’ of each device on the ISY when it starts up:

And if it finds a Spoken set you should see:

followed by a few other lines about the device.

Also, in the nodeserver directory there will be a config.json that contains the devices it found

Device Type

The PyISY library currently returns dimmable for some devices that are not dimmable, like the sub buttons of a KPL. We have fixed that specific issue, but if others popup we can add exceptions for them. If you look on the Polyglot Configuration page for this Node Server you will see a table and in the Hue Type column shows what we use for the Hue device types and currently only support.

  • On/off Light
  • Dimmable Light So if your device is not being shown correctly then please let me know what the Node address by posting in the Forum Polyglot V2 Hue Hub Emulator Nodeserver SubForum and I may also ask to enable Debug logging mode, restart the node server and send me the log package.

TODO

  • Move device info Custom Configuration Paramaters instead of config.json
  • Support scenes as hue scenes?

Requirements

  1. Polyglot V2 itself should be run on Raspian Stretch. To check your version, cat /etc/os-release and the first line should look like
PRETTY_NAME=Raspbian GNU/Linux 9 (stretch)

It is possible to upgrade from Jessie Stretch, but I would recommend just reimaging the SD card. Some helpful links:

  1. This has only been tested with ISY 5.0.12 so it is not guaranteed to work with any other version.

Upgrading

Open the Polyglot web page, go to nodeserver store and click "Update" for "HueEmulator". You can answer No to the install profile question. Then restart the nodeserver by selecting it in the Polyglot dashboard and select Control -> Restart, and watch the log to make sure everything goes well.

Release Notes

  • 2.2.13: 01/09/2022
    • Move config into config folder which is the PG persist_folder so it will get saved with backups
  • 2.2.12: 12/22/2021
    • Upgrade PyISY to 2.1.2 which should fix overloading ISY with open SOAP connections
    • Support PyISY logging level 5 to support automicus/PyISY#200
  • 2.2.11: 07/04/2021
    • Fix so listener port could actually be changed
  • 2.2.10: 06/25/2021
    • Update pyisy to 2.1.1
  • 2.2.9 12/06/2020
    • Fix for arugment change in PyISY 2.1.0
  • 2.2.8 09/20/2020
    • Fix bug that kept resetting listen count to 5, even though it wasn't really listening.
  • 2.2.6 07/31/2020
    • Fix error in 2.2.5 causing a crash
  • 2.2.5 07/31/2020
  • 2.2.4 07/28/2020
  • 2.2.3 07/07/2020
    • Fixed reference to dimmable which caused a crash
  • 2.2.2 07/08/2020
  • 2.2.1 06/22/2020
    • Reorganize code
    • Fix when brightening a device it could wrap around and go back to default on value
    • Update logging levels to control module loggers properly
  • 2.2.0 06/10/2020
    • Support for PyISY 2 which is now more robust. Thanks to @shbatm for the help.
    • Listen turned off after 5 long poll's
    • Listen is on at startup
  • 2.1.2 01/21/2020
  • 2.1.1 11/04/2019
    • Trap and retry for ISY connection failures which occasionally happen on startup when ISY is overloaded
  • 2.1.0 11/04/2019
    • Fix get_network_ip to work on Polisy
  • 2.0.8 09/03/2019
    • Change to use isy.nodes.nids instead of allLowerNodes
  • 2.0.7 03/03/2019
    • No change in this code, but new version due to bug fix in locally cloned hue-upnp code that caused the wrong device to be referenced when items were removed before it from spoken list.
  • 2.0.6 08/16/2018
    • Add Heartbeat which sends DON/DOF on each longPoll
  • 2.0.5 07/29/2018
    • Add Table of Spoken devices shown in Configuration page, must be on Polyglto 2.2.1
    • Properly track status if ISY devices so proper values show in Harmony
  • 2.0.4 07/09/2018
    • Add missing polyinterface to requirements.txt
  • 2.0.3 06/21/2018
    • Fix for when a spoken is removed
    • Fix to PyISY for Scenes that contain a nodeserver node
  • 2.0.2 06/21/2018
    • Fix initialization of listen
    • Pull my PyISY again to help with debugging
  • 2.0.1 06/19/2018
    • Move to released PyISY 1.1.0 to fix finding scenes.
  • 2.0.0
    • Never officially released.

About

License:MIT License

Languages

Language:Python 98.4%Language:Shell 1.6%