Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/asosnovsky/Shortumation

[Not Maintained] A better way to write automations in home-assistant without having to install and run a seperate automation engine!
https://github.com/asosnovsky/Shortumation

automation docker home-assistant homeassistant reactjs smart-home smarthome

Last synced: 28 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
:no_entry: [DEPRECATED] Due to lack of time on my part, this project is no longer being worked on. :( :no_entry: [DEPRECATED]



----

#  Shortumation ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=platsic)



[![Test](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml) [![Build](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml)



|         | Stable                                                                                                                         | Edge                                                                                                                                         |

| ------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |

| Version | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge) | ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/asosnovsky/shortumation-amd64?&sort=date&label=&style=for-the-badge) |



A [home-assistant addon](https://www.home-assistant.io/addons/) 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](https://nodered.org/).






## 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](https://github.com/users/asosnovsky/projects/3/views/4).



## 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!



**Please note that you may need to enable advance mode in your settings first!**



### Containerized or HA Core



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](example/containerized/docker-compose.yaml), or read the [extended guide here](https://github.com/asosnovsky/Shortumation/wiki/Installation#containerized--ha-core).



In general, if you want to help provide this to more home-assistant fans please join on the conversation here https://github.com/asosnovsky/Shortumation/issues/102 or help contribute :)



## FAQ



**How can I buy you a coffee?**



> Buy Me a Coffee at ko-fi.com



**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](https://github.com/users/asosnovsky/projects/3/views/4), the [Development Guide](https://github.com/asosnovsky/Shortumation/wiki/Development) and send me some PRs to review!



> Please also note that I did went ahead and marked some [good first issues](https://github.com/asosnovsky/Shortumation/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 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 https://github.com/asosnovsky/Shortumation/issues/102 or perhaps help us get there yourself by contributing! :)