pa-sowa / Shortumation

A better way to write automations in home-assistant without having to install and run a seperate automation engine!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Shortumation GitHub release (latest by date)

Test Build

Stable Edge
Version GitHub release (latest by date) Docker Image Version (latest semver)

A home-assistant addon for a better UI for managing and writing your automations. We provide a way to visualize your automation using a visual-programming language that draws inspirations from Node-Red.

Features

  • Sort and organize your home-assistant automations using tags!

  • Utilize the auto-generated node descriptions to understand what your automation is doing! No more reading YAML to just understand what 1 node does!

  • More condense UI for service calls!

  • Visualize complex 'choose' or 'if/else' nodes

  • Visualize parallel nodes!

  • Visualize repeat nodes!

See roadmap in Version 1 Github Project.

Installation

Addon

Add the repository URL under Supervisor → Add-on store → ⋮ → Manage add-on repositories:

https://github.com/asosnovsky/Shortumation

It should now appear in your Add-on Store and you should be able to install it!

Containerized or HA Core

Please note that this way of using Shortumation is not future proof.

If this warning does not scare you or you still want to try things out, then take a look at the example docker-compose.yaml, or read the extended guide here.

FAQ

How is this different from Node-Red?

Node-Red is both an execution engine and an automation editor, which means that in order for your automations to run you have to have an additional component running and executing the automations. Shortumation simply provides a different editor and manager for writing Homeassistant automations, while relying on Homeassistant to execute the automations (this uses the automations.yaml file as the backend database)

Which HA Installation does this support?

Currently this is only tested on HA OS. However, you should be able to get it working supervised installations as well (as they support addons). If you want to make it work for Container or Core, you will need to do some additional leg-work and I welcome a PR to get this working (it should be just a matter of mounting the /config path to the container running the images in this repo).

Which version of HA does this require?

Since I am working on this project on my own, I can only test it against my own HA installations at home, and I tend to keep things as up to date as possible. The lowest version of HA this was tested on is core-2022.5.4

This is awesome and all, how can I help?

Take a look at our Roadmap in Version 1 Github Project, the Development Guide and send me some PRs to review!

Please also note that I did went ahead and marked some good first issues if you want to pick them up just leave a comment and I will give you more context (I haven't had time to add more details).

HACS Support? I don't like docker.

Currently this is beyond v1, but if this is something you really want please +1 this issue asosnovsky#102 or perhaps help us get there yourself by contributing! :)

About

A better way to write automations in home-assistant without having to install and run a seperate automation engine!

License:MIT License


Languages

Language:TypeScript 83.5%Language:Python 9.3%Language:CSS 6.3%Language:HTML 0.2%Language:JavaScript 0.2%Language:Makefile 0.2%Language:Shell 0.2%Language:Dockerfile 0.2%