|
| 1 | +# How to migrate from the old fixture definitions? |
| 2 | + |
| 3 | +All your current fixtures are now still supported! Here's the process to get your integration migrated. |
| 4 | + |
| 5 | +## Installing |
| 6 | + |
| 7 | +Our integration name changed from `artnet_led` to `dmx`. HACS doesn't allow this, so we are unable to upgrade this in-place. Therefore a manual release is needed for the beta. |
| 8 | + |
| 9 | +Under [the release](https://github.com/Breina/ha-artnet-led/releases/tag/v1.0.0-BETA) download the [source code](https://github.com/Breina/ha-artnet-led/archive/refs/tags/v1.0.0-BETA.zip). |
| 10 | + |
| 11 | +In this ZIP, navigate to `custom_components/dmx` and copy this `dmx` folder into your Home Assistant's `custom_components` folder. |
| 12 | + |
| 13 | +## Find your fixture format |
| 14 | + |
| 15 | +Most of the previously supported fixtures already have a [generic fixture variant](https://open-fixture-library.org/search?q=generic) for you to download. |
| 16 | + |
| 17 | +Download as: **Open Fixture Library JSON** |
| 18 | + |
| 19 | +Examples: |
| 20 | + |
| 21 | +* [Single dimmer](https://open-fixture-library.org/generic/desk-channel.ofl) |
| 22 | +* [CW/WW](https://open-fixture-library.org/generic/cw-ww-fader.ofl) |
| 23 | +* [Dimmer/color temperature](https://open-fixture-library.org/generic/color-temperature-fader.ofl) |
| 24 | +* [RGB](https://open-fixture-library.org/generic/rgb-fader.ofl) |
| 25 | +* [Dimmer/RGB](https://open-fixture-library.org/generic/drgb-fader.ofl) |
| 26 | +* [RGBWW](https://open-fixture-library.org/generic/rgbww-fader.ofl) |
| 27 | + |
| 28 | +This downloads a ZIP, inside this ZIP **ignore** the `manufacturers.json` and copy the JSON file of fixture itself into your HomeAssistants `config/fixtures` folder, which you will need to create. |
| 29 | +The `config` folder is the one that houses your `configuration.yaml`. |
| 30 | + |
| 31 | +This fixture format is extremely flexible and contains templating, channel switching, matrixes, and many other crazy things, and we're compatible with **all** of it. :) |
| 32 | + |
| 33 | +You can go ahead and [use the editor](https://open-fixture-library.org/fixture-editor) or [write a JSON by hand](https://github.com/OpenLightingProject/open-fixture-library/blob/master/docs/fixture-format.md#fixture). |
| 34 | + |
| 35 | +Note down the `shortName` of your fixtures, or `name` if it has no `shortName`, we will use these in the next step. |
| 36 | + |
| 37 | +## Adding the fixtures to your house |
| 38 | + |
| 39 | +Now that you have all the types of lights configured, it's time to add them. This step is explained in detail in [Configuration](config.md). |
| 40 | + |
| 41 | +## Aftercare |
| 42 | + |
| 43 | +If the new light fixtures now work, you may remove the old `artnet_led` folder and remove the old entities from your system. |
| 44 | + |
| 45 | +When the 1.0.0 releases, this integration will be submitted for HACS default repositories, so manual installation won't be needed any more. |
0 commit comments