https://github.com/malopolese/sweethome3d-light-combinations-plugin

This plugin automatically generates images for all light combinations in a SweetHome3D scene in order to use it in Home Assistant picture elements card.
https://github.com/malopolese/sweethome3d-light-combinations-plugin

automation home-assistant images lights plugin sweethome3d

Last synced: 15 days ago
JSON representation

This plugin automatically generates images for all light combinations in a SweetHome3D scene in order to use it in Home Assistant picture elements card.

• Host: GitHub
• URL: https://github.com/malopolese/sweethome3d-light-combinations-plugin
• Owner: MaloPolese
• License: mit
• Created: 2024-06-23T10:40:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T17:39:03.000Z (over 1 year ago)
• Last Synced: 2025-07-11T02:50:21.475Z (11 months ago)
• Topics: automation, home-assistant, images, lights, plugin, sweethome3d
• Language: Kotlin
• Homepage:
• Size: 43.6 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SweetHome3D Light Combinations Plugin



![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/MaloPolese/sweethome3d-light-combinations-plugin/main.yml?branch=main)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/MaloPolese/sweethome3d-light-combinations-plugin/draft.yml?branch=main&label=draft%20release)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/MaloPolese/sweethome3d-light-combinations-plugin/release.yml?label=release)

![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/MaloPolese/sweethome3d-light-combinations-plugin/total)

![Logo](./docs/ha_x_sweethome3d.jpg)



This plugin automatically generates images for all light combinations in a SweetHome3D scene. Users can select which lights to include in the combinations, adjust the power level of each light, and name the lights. The generated names are used to create configurations compatible with the [Home Assistant](https://www.home-assistant.io/) [Picture Elements card](https://www.home-assistant.io/dashboards/picture-elements/).

## Features

- **Light Selection**: Choose which lights to include in the generated combinations.

- **Power Adjustment**: Configure the power level of each light.

- **Naming**: Name the lights, which will be used in generating configurations for Home Assistant.

- **Home Assistant Integration**: Create ready-to-use configurations for the Picture Elements card.

![light_selection_step](./docs/light_selection_step.png)

![image_generation_step](./docs/image_generation_step.png)

## Requirements

- **SweetHome3D**: Version 7.5 or compatible.

- **Java**: Required to run SweetHome3D via CLI (if the plugin doesn't show up in the installer version on Windows).

## Installation

Download the latest release (.jar) from the [releases page](https://github.com/MaloPolese/sweethome3d-light-combinations-plugin/releases) and follow the instructions below.

Place the JAR file in the following plugin folder depending on your OS:

- **Windows 11 / 10 / 8 / 7 / Vista**: `C:\Users\user\AppData\Roaming\eTeks\Sweet Home 3D\plugins`

- **Windows XP and older**: `C:\Documents and Settings\user\Application Data\eTeks\Sweet Home 3D\plugins`

- **macOS**: `~/Library/Application Support/eTeks/Sweet Home 3D/plugins`

- **Linux/Unix**: `~/.eteks/sweethome3d/plugins`

Start SweetHome3D and the plugin should appear in the Tools menu.

## Usage

Once installed, open SweetHome3D and the plugin should appear in the Tools menu. Select the lights you want to include in the combinations, adjust their power levels, and give each light a name. The plugin will then generate images for all possible combinations of the selected lights.

![plugin_menu](./docs/plugin_menu.png)

## Home Assistant Integration

Once the image generation is complete, the plugin will add all the generated images and a `home_assistant_config.yaml` file in the folder previously selected. To use the generated results in Home Assistant, follow these steps:

### Steps to Integrate with Home Assistant

1. **Copy Images**:

    - Copy all the generated images to your Home Assistant instance's `www/plans/` folder. If the folder doesn't exist, create it first.

   For example:

   ```bash

   www/plans/

   ├── ha-generated-0.jpg

   ├── ha-generated-1.jpg

   └── ...

   ```

2. **Create a Picture Elements Card**:

    - In your Home Assistant dashboard, create a new "[Picture Elements](https://www.home-assistant.io/dashboards/picture-elements/)" card.

    - Open the `home_assistant_config.yaml` file, which was generated alongside the images.

    - Copy the configuration from `home_assistant_config.yaml` and paste it into the Picture Elements card configuration in Home Assistant.

Now, you should have a fully functional Picture Elements card displaying all the light combinations generated by the plugin!

3. **Optional**: 

   - You can refresh the home assistant configuration

 

## Credit

This project was inspired by the work of [@sergiocasero](https://github.com/sergiocasero) and his project [sweet_home_3d_ha_lightning](https://github.com/sergiocasero/sweet_home_3d_ha_lightning).