https://github.com/home-assistant/scenegen

:fireworks: Generate Scenes for Home Assistant
https://github.com/home-assistant/scenegen

home-assistant home-automation scene

Last synced: about 1 month ago
JSON representation

:fireworks: Generate Scenes for Home Assistant

• Host: GitHub
• URL: https://github.com/home-assistant/scenegen
• Owner: home-assistant
• License: other
• Archived: true
• Created: 2016-05-29T14:50:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-10-16T15:53:11.000Z (about 5 years ago)
• Last Synced: 2024-02-13T21:39:29.347Z (9 months ago)
• Topics: home-assistant, home-automation, scene
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 60
• Watchers: 9
• Forks: 26
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# SceneGen

Scenegen is a scene generation tool for [Home Assistant](https://home-assistant.io/) home automation software. It creates scenes by example, by reading the current states of devices and outputting a corresponding scene. Scenegen is written in python using Home Assistant's RESTFul API so can be run from anywhere. It currently supports lights and switches only.

To set up SceneGen and install it locally, run the following from a shell in

the checkout:

    $ make

Then the script can be run locally from the checkout:

    $ ./bin/scenegen --help

See the Home Assistant documentation for [full usage instructions and

documentation](https://home-assistant.io/ecosystem/scenegen).

## Exporting Multiple Scenes

Use the `$ make export` target to aid in exporting multiple scenes to YAML on

the filesystem.  This can be useful for "exporting" scenes from an

integration, such as SmartThings, to native Home Assistant themes:

    $ make EXPORT_ALL_SCENES=true URL=https://home-assistant.example.com:8123 TOKEN=... EXPORT_SCENE_DIR=../path/to/scenes export

If you don't want to export all the scenes, you can create a `.scenes` file in

the `EXPORT_SCENE_DIR` listing one scene per line to export and remove the

`EXPORT_ALL_SCENES` option.

Beyond these options, the `export*` targets in `Makefile` can be used as a

reference or starting point to automate exporting multiple scenes.