|
| 1 | +## Using the elgato-light sample bundle |
| 2 | + |
| 3 | +The elgato-light example bundle in `samples/elgato-light` demonstrates the ability to controll elgato keylights and elgato lightstrips. Here is a guide to how to get it working. |
| 4 | + |
| 5 | +### Prerequisites |
| 6 | + |
| 7 | +- Working NodeCG & nodecg-io installation |
| 8 | +- at least one elgato keylight or lightstrip |
| 9 | + |
| 10 | +### Configure the elgato-light sample bundle |
| 11 | + |
| 12 | +1. Start nodecg with nodecg-io installed. The elgato-light sample bundle is currently part of it so it should also be loaded. |
| 13 | + |
| 14 | +2. Go to the `nodecg-io` tab in the nodecg dashboard. |
| 15 | + |
| 16 | +3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials. |
| 17 | + |
| 18 | +4. Create a new elgato-light service instance using the left upper menu. |
| 19 | + |
| 20 | +5. Enter configuration: |
| 21 | + |
| 22 | + The created instance should be automatically selected, if not select it in the upper left menu. Enter the IP address to your light and the type (`KeyLight` or `LightStrip`) in monaco (the text-editor on the right) in this format: |
| 23 | + |
| 24 | + ```json |
| 25 | + { |
| 26 | + "lights": [ |
| 27 | + { |
| 28 | + "ipAddress": "xxx.xxx.xxx.xxx", |
| 29 | + "lightType": "KeyLight", |
| 30 | + "name": "MyLight1" |
| 31 | + } |
| 32 | + ] |
| 33 | + } |
| 34 | + ``` |
| 35 | + |
| 36 | + You can add as many lights to this service as you wish by adding more objects inside the `lights` array. |
| 37 | + |
| 38 | + `name` is optional and can be used to identify lights in bundles. You can omit it if you don't use the name to get it in any bundle. |
| 39 | + |
| 40 | + After entering it, click save. |
| 41 | + |
| 42 | + _Note:_ If you don't see monaco on the right, try reloading the page. |
| 43 | + |
| 44 | +6. Set the created elgato-light service instance to the service dependency of the elgato-light sample bundle. |
| 45 | + |
| 46 | + Select the elgato-light example bundle and the elgato-light service in the left bottom menu and then select the service instance that should be used by the elgato-light example bundle (in this case the name of the previously created elagto-light instance). |
| 47 | + |
| 48 | +7. Check the nodecg logs |
| 49 | + |
| 50 | + Your lights should blink for three seconds and you should see the current brightness in the nodecg logs. |
0 commit comments