enhomie 0.2.1

Enasis Network Homie Automate

Enasis Network Homie Automate

:children_crossing: This project has not released its first major version.

Define desired scenes for groups using flexible conditional plugins.

Configuration example

Some basic configuration examples. See next section for more documentation.

• Homie Desires
• Homie Groups
• Homie Scenes
• Philips Hue Bridges
• Philips Hue Devices
• Ubiquiti Routers
• Ubiquiti Clients

Documentation

Documentation is on Read the Docs. Should you venture into the sections below you will be able to use the sphinx recipe to build documention in the docs/html directory.

Short-term future goals

• Encrypting the values in the configuration files.
• Deploying enhomie via the sdmt project.
• Ability to send email when scene change is made.
  • Requires enconnect.stmp.Compose class.
  • Requires scene_set to be idempotent.

Long-term future goals

• CRUD for groups and scenes in Philips Hue bridges.
• Listener that can perform some basic actions.
• Plugin using light level from Philips Hue devices.
• Plugin checks current scene active for groups.

Additional scripts

• dumper.py is useful for setting desired scenes.
• dumper.py is useful for dumping configuration.
• scener.py is useful for setting scene on groups.

Useful and related links

• https://ubntwiki.com/products/software/unifi-controller/api

Installing the package

Installing stable from the PyPi repository

pip install enhomie

Installing latest from GitHub repository

pip install git+https://github.com/enasisnetwork/enhomie

Quick start for local development

Start by cloning the repository to your local machine.

git clone https://github.com/enasisnetwork/enhomie.git

Set up the Python virtual environments expected by the Makefile.

make -s venv-create

Execute the linters and tests

The comprehensive approach is to use the check recipe. This will stop on any failure that is encountered.

make -s check

However you can run the linters in a non-blocking mode.

make -s linters-pass

And finally run the various tests to validate the code and produce coverage information found in the htmlcov folder in the root of the project.

make -s pytest

Build and upload to PyPi

Build the package.

make -s pypackage

Upload to the test PyPi.

make -s pypi-upload-test

Upload to the prod PyPi.

make -s pypi-upload-prod