-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
226 changed files
with
42,062 additions
and
3,283 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,3 +29,4 @@ Thumbs.db | |
|
||
# Pycharm settings | ||
/.idea | ||
/.vs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
def plugin_release(): | ||
return '1.6' | ||
return '1.6.1' | ||
|
||
|
||
def plugin_branch(): | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,99 @@ | ||
# Artnet | ||
|
||
## Requirements | ||
|
||
You need a device understanding Artnet. | ||
I suggest to use the software OLA http://www.opendmx.net/index.php/Open_Lighting_Architecture to translate the ArtNet packets into DMX Signals. | ||
OLA supports most USB -> DMX Adapters available at the moment. | ||
|
||
## Supported Hardware | ||
|
||
* Hardware supported by OLA. See Link above. | ||
|
||
## Configuration | ||
|
||
### plugin.yaml | ||
|
||
``` | ||
dmx1: | ||
class_name: ArtNet | ||
class_path: plugins.artnet | ||
artnet_subnet: 0 | ||
artnet_net: 0 | ||
artnet_universe: 0 | ||
ip: 192.168.1.123 | ||
port: 6454 | ||
``` | ||
|
||
### items.yaml | ||
|
||
Not needed yet. | ||
|
||
### logic.yaml | ||
Notice: First DMX channel is 1! Not 0! | ||
|
||
To send DMX Data to the universe set in plugin.yaml you have 3 possibilities: | ||
|
||
#### 1) Send single value | ||
``sh.dmx1(<DMX_CHAN>, <DMX_VALUE>)`` | ||
|
||
Sets DMX_CHAN to value DMX_VALUE. | ||
|
||
Example: ``sh.dmx1(12,255)`` | ||
If channels 1-11 are already set, they will not change. | ||
If channels 1-11 are not set till now, the will be set to value 0. | ||
This is needed because on a DMX bus you can not set just one specific channel. | ||
You have to begin at first channel setting your values. | ||
|
||
#### 2) Send a list of values starting at channel | ||
``sh.dmx1(<DMX_CHAN>, <DMX_VALUE_LIST>)`` | ||
Sends <DMX_VALUE_LIST> to DMX Bus starting at <DMX_CHAN> | ||
|
||
Example: | ||
``sh.dmx1(10,[0,33,44,55,99])`` | ||
If channels 1-9 are already set, they will not change. | ||
If channels 1-9 are not set till now, the will be set to value 0. | ||
This is needed because on a DMX bus you can not set just one specific channel. | ||
You have to begin at first channel setting your values. | ||
Values in square brackets will be written to channel (10-14) | ||
|
||
#### 3) Send a list of values | ||
|
||
``sh.dmx1(<DMX_VALUE_LIST>)`` | ||
|
||
Sends <DMX_VALUE_LIST> to DMX Bus starting at channel 1 | ||
|
||
This is nearly the same as 2) but without starting channel. | ||
|
||
Example: | ||
|
||
``sh.dmx1([0,33,44,55,99])`` | ||
Values in Square brackets will be written to channel (1-5) | ||
# Artnet | ||
|
||
## Requirements | ||
|
||
You need a device understanding Artnet. | ||
I suggest to use the software OLA http://www.opendmx.net/index.php/Open_Lighting_Architecture to translate the ArtNet packets into DMX Signals. | ||
Alternatively you can use any Art-Net to DMX Adapter. (Tested with https://www.ulrichradig.de/home/index.php/dmx/art-net-box) | ||
OLA supports most USB -> DMX Adapters available at the moment. | ||
|
||
## Supported Hardware | ||
|
||
* Hardware supported by OLA. See Link above. | ||
|
||
## Configuration | ||
|
||
### plugin.yaml | ||
|
||
```yaml | ||
artnet1: | ||
class_name: ArtNet | ||
class_path: plugins.artnet | ||
artnet_universe: 0 | ||
artnet_net: 0 | ||
artnet_subnet: 0 | ||
ip: 192.168.0.99 | ||
port: 6454 | ||
update_cycle: 120 | ||
instance: keller | ||
``` | ||
#### Attributes | ||
* `artnet_universe`: Art-Net Universe, default: 0 | ||
* `artnet_net`: Art-Net Net, default: 0 | ||
* `artnet_subnet`: Art-Net Subnet, default: 0 | ||
* `ip`: IP-address of your Art-Net node, mandatory, no default | ||
* `port`: Port to reach your Art-Net node, defaul 6454 | ||
* `update_cycle`: timeperiod between two update cycles, default 0 for no update. If a cycle is provided the current channel-settings is updated to Art-Net every n-th second. | ||
* `instance`: Name of this plugin instance (e.g. above: keller) | ||
|
||
### items.yaml | ||
|
||
#### artnet_address | ||
This attribute assigns an item to the respective artnet-address (DMX channel) | ||
|
||
### Example: | ||
```yaml | ||
lightbar: | ||
red: | ||
artnet_address@keller: 1 | ||
green: | ||
artnet_address@keller: 2 | ||
blue: | ||
artnet_address@keller: 3 | ||
``` | ||
|
||
### logic.yaml | ||
Notice: First DMX channel is 1! Not 0! | ||
|
||
To send DMX Data to the universe set in plugin.yaml you have 4 possibilities: | ||
|
||
#### 0) Use items | ||
|
||
as explained above you can use items for that | ||
|
||
#### 1) Send single value | ||
``sh.artnet1(<DMX_CHAN>, <DMX_VALUE>)`` | ||
|
||
Sets DMX_CHAN to value DMX_VALUE. | ||
|
||
Example: ``sh.artnet1(12,255)`` | ||
If channels 1-11 are already set, they will not change. | ||
If channels 1-11 are not set till now, the will be set to value 0. | ||
This is needed because on a DMX bus you can not set just one specific channel. | ||
You have to begin at first channel setting your values. | ||
|
||
#### 2) Send a list of values starting at channel | ||
``sh.artnet1(<DMX_CHAN>, <DMX_VALUE_LIST>)`` | ||
Sends <DMX_VALUE_LIST> to DMX Bus starting at <DMX_CHAN> | ||
|
||
Example: | ||
``sh.artnet1(10,[0,33,44,55,99])`` | ||
If channels 1-9 are already set, they will not change. | ||
If channels 1-9 are not set till now, the will be set to value 0. | ||
This is needed because on a DMX bus you can not set just one specific channel. | ||
You have to begin at first channel setting your values. | ||
Values in square brackets will be written to channel (10-14) | ||
|
||
#### 3) Send a list of values | ||
|
||
``sh.artnet1(<DMX_VALUE_LIST>)`` | ||
|
||
Sends <DMX_VALUE_LIST> to DMX Bus starting at channel 1 | ||
|
||
This is nearly the same as 2) but without starting channel. | ||
|
||
Example: | ||
|
||
``sh.artnet1([0,33,44,55,99])`` | ||
Values in Square brackets will be written to channel (1-5) |
Oops, something went wrong.