Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit 28c42de

Browse files
Add documentation for Atem Service (#80)
* Add documentation * Add sample documentation for atem * Fix typo * Fix atem sample syntax error and add it to the nav bar Co-authored-by: Daniel <[email protected]>
1 parent 7d13969 commit 28c42de

File tree

4 files changed

+49
-0
lines changed

4 files changed

+49
-0
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ that's no problem you can head over to the
3636
- AutoHotkey
3737
- Android (using adb)
3838
- Art-Net
39+
- Atem
3940
- CurseForge
4041
- DBus
4142
- Discord

docs/samples/atem.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Using the Atem sample bundle
2+
3+
The Atem sample bundle in `samples/atem` shows how to listen to commands.
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+
14+
### Configure the Atem sample bundle
15+
16+
1. In NodeCG, create a new atem service instance.
17+
2. Enter the address and optional a port of the Atem server:
18+
19+
```json
20+
{
21+
"address": "0.0.0.0"
22+
}
23+
```
24+
25+
or
26+
27+
```json
28+
{
29+
"address": "0.0.0.0",
30+
"port": 9910
31+
}
32+
```
33+
34+
After entering it, click save.
35+
36+
3. Set the sample's (`atem`) dependency to be the newly created
37+
service instance (of type `atem`).
38+
4. Now all commands sended through the atem protocol should be logged in the console.

docs/services.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ See the [sample implementation](samples/artnet.md)
3737
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0 <br>
3838
Depends on [artnet-protocol](https://www.npmjs.com/package/artnet-protocol) @ ^0.2.1 <br>
3939

40+
## [nodecg-io-atem](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-atem)
41+
42+
**Allows you to communicate with atem protocol**
43+
44+
See the [sample implementation](samples/atem.md)
45+
46+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0 <br>
47+
Depends on [atem-connection](https://www.npmjs.com/package/atem-connection) @ ^2.3.1 <br>
48+
4049
## [nodecg-io-curseforge](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-curseforge)
4150

4251
**A service to communicate with the CurseForge API.**

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ nav:
5656
- Available services: services.md
5757
- AHK sample: samples/ahk.md
5858
- Art-Net sample: samples/artnet.md
59+
- Atem sample: samples/atem.md
5960
- Curseforge sample: samples/curseforge.md
6061
- Android: samples/android.md
6162
- DBus: samples/dbus-ratbagd.md

0 commit comments

Comments
 (0)