niklas/node-red-contrib-teamspeak
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added README

Browse Source
This commit is contained in:
Djeeberjr 2021-04-28 17:54:01 +02:00
parent 99c82ef173
commit 2c9dc7a3d2
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md Normal file
View File

@ -0,0 +1,13 @@
Node-RED nodes to interact with Teamspeaks query. Basicly it is a wrapper for [TS3-NodeJS-Library](https://github.com/multivit4min/TS3-NodeJS-Library).
It includes 3 nodes:
- TS3 config (stores connection information)
- TS3 call (Call any function on the query)
- TS3 event (Listen to any ts3 event)
To pass parameters to the "call" node simply put it as the `msg.payload` as an array. You can lookup the functions at the TS3-NodeJS-Library [documentation](https://multivit4min.github.io/TS3-NodeJS-Library/classes/teamspeak.teamspeak-2.html).
# Install
`npm i node-red-contrib-teamspeak --save` or via the Node-RED ui.
# Development
There is a docker-compose file that includes a Node-RED and a TS3 instance. To build and test changes simply execute the `docker-pack.sh` file.