Skip to content

Commit 1e17838

Browse files
committed
Add migration guide
1 parent e17b0c8 commit 1e17838

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

docs/beta.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ This means we now support moving heads, strobes, and much more. Since this stand
77

88
Since the DOMAIN has been renamed from `artnet_led` to `dmx`, HACS might get angry, so for now it will require a manual installation by copying `custom_components/dmx` into your `custom_components` folder on HomeAssistant, then restarting.
99

10+
For migrating your old fixtures into the new format, I've written up [a migration guide](migration.md).
11+
1012
Part of the beta is to test if my documentation suffices. So head over to [the index](index.md) and see if you can figure out how to use it.
1113

1214
## What's in the box?

docs/migration.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ nav:
1111
- Configuration: config.md
1212
- External Art-Net controller: artnet-controller-communication.md
1313
- Beta information: beta.md
14+
- Migration: migration.md
1415

1516
plugins:
1617
- search

0 commit comments

Comments
 (0)