You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
* Add sample doc for elgato light service
Adds sample documentation for elgato light service (codeoverflow-org/nodecg-io#247).
* Update elgato-light sample doc to adhere to new template
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
+
You will need a working `nodecg-io` installation. If you have non yet take a
8
+
look at [installation guide](../getting_started/install.md). You may need to
9
+
install this bundle, so take a look at the
10
+
[“Try an included sample”](../getting_started/try_example_bundle.md)-Guide. It
11
+
will also tell you how to log in and how to use the GUI.
12
+
13
+
**You also need:**
14
+
15
+
- at least one elgato keylight or lightstrip
16
+
17
+
### Configure the elgato-light sample bundle
18
+
19
+
1. In NodeCG, create a new elgato-light service instance.
20
+
2. Enter your IP address of your light and the type (`KeyLight` or `LightStrip`):
21
+
22
+
```json
23
+
{
24
+
"lights": [
25
+
{
26
+
"ipAddress": "xxx.xxx.xxx.xxx",
27
+
"lightType": "KeyLight",
28
+
"name": "MyLight1"
29
+
}
30
+
]
31
+
}
32
+
```
33
+
34
+
You can add as many lights to this service as you wish by adding more objects inside the `lights` array.
35
+
36
+
`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.
37
+
38
+
After entering it, click save.
39
+
40
+
3. Set the sample's (`elgato-light`) dependency to be the newly created
41
+
service instance (of type `elgato-light`).
42
+
4. Check the NodeCG logs:
43
+
44
+
Your lights should blink for three seconds and you should see the current brightness in the NodeCG logs.
0 commit comments