This repository was archived by the owner on Apr 13, 2025. It is now read-only.
File tree 3 files changed +52
-2
lines changed 3 files changed +52
-2
lines changed Original file line number Diff line number Diff line change @@ -53,6 +53,7 @@ that's no problem you can head over to the
53
53
- OBS
54
54
- [ OpenTTS] ( https://github.com/synesthesiam/opentts )
55
55
- Philips Hue
56
+ - [ PiShock] ( https://pishock.com )
56
57
- RCON
57
58
- Reddit
58
59
- sACN Receiver
Original file line number Diff line number Diff line change
1
+ ## Using the PiShock sample bundle
2
+
3
+ The PiShock example bundle in ` samples/pishock ` demonstrates the ability
4
+ to use the PiShock api to get the infos about the shockers. Here is a guide
5
+ to how to get it working.
6
+
7
+ ### Prerequisites
8
+
9
+ You will need a working ` nodecg-io ` installation. If you have non yet take a
10
+ look at [ installation guide] ( ../getting_started/install.md ) . You may need to
11
+ install this bundle, so take a look at the
12
+ [ “Try an included sample”] ( ../getting_started/try_example_bundle.md ) -Guide. It
13
+ will also tell you how to log in and how to use the GUI.
14
+
15
+ ** You also need:**
16
+
17
+ - 1 PiShock Hub
18
+ - At least 1 Shocker
19
+ - An PiShock Account
20
+
21
+ ### Configure the PiShock sample bundle
22
+
23
+ 1 . In NodeCG, create a new pishock service instance.
24
+
25
+ 2 . Enter your authentication details like this
26
+
27
+ ``` json
28
+ {
29
+ "authentications" : [
30
+ {
31
+ "username" : " myAwesomeUsername" ,
32
+ "apiKey" : " 12345678-1234-1234-1234-123456789012" ,
33
+ "code" : " ABCDEFGHIJK" ,
34
+ "name" : " nodecg-io-pishock-integration"
35
+ }
36
+ ]
37
+ }
38
+ ```
39
+
40
+ Multiple authentications may be provided to allow the using bundle
41
+ to access multiple devices.
42
+ Setting the client name is optional and defaults to `nodecg-io PiShock Service` if none is provided.
43
+ After entering it, click save.
44
+
45
+ 3 . Set the sample's (`pishock`) dependency to be the newly created service
46
+ instance (of type `pishock`).
47
+
48
+ 4 . View the NodeCG console log which should contain all information about the provided devices
Original file line number Diff line number Diff line change 1
1
site_name : nodecg-io Documentation
2
2
site_author : codeoverflow.org
3
3
site_url : https://nodecg.io/
4
- copyright : " © 2020-2022 codeoverflow.org CC-BY-4.0"
4
+ copyright : " © 2020-2024 codeoverflow.org CC-BY-4.0"
5
5
6
6
theme :
7
7
palette :
83
83
- Nanoleaf : samples/nanoleaf.md
84
84
- OBS : samples/obs.md
85
85
- OpenTTS : samples/opentts.md
86
- - Philips Hue sample : samples/philipshue.md
86
+ - Philips Hue : samples/philipshue.md
87
+ - PiShock : samples/pishock.md
87
88
- Rcon sample : samples/rcon.md
88
89
- Reddit sample : samples/reddit.md
89
90
- sACN :
You can’t perform that action at this time.
0 commit comments