Component to integrate with a Teamspeak 3 Server instance.
DISCLAIMER: This project is a private open source project and doesn't have any connection with TeamSpeak Systems, Inc.
This component will set up the following platforms.
Platform | Description |
---|---|
sensor |
Shows info from the configured Teamspeak 3 Server. |
The following information can be found under Attributes
Attribute | Description |
---|---|
unique_identifier |
Unique identifier of the configured Teamspeak Server |
status |
Online status |
name |
Servername |
platform |
Platform the server is hosted on (e.g Windows, Linux, Mac) |
port |
Port the server listens on |
version |
Currently installed Teamspeak verison |
maxclients |
Maximum simultaneous allowed client connections |
reservedslots |
Number of reserved slots |
clientsonline |
Number of connections (includes Server query users) |
clientconnections |
Number of connected clients |
channelsonline |
Number of available channels |
created |
Unix time stamp of server creation date |
uptime |
Seconds since server start |
- Install using HACS
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml
). - If you do not have a
custom_components
directory (folder) there, you need to create it. - In the
custom_components
directory (folder) create a new folder calledteamspeak
. - Download all the files from the
custom_components/teamspeak/
directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Restart Home Assistant
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Teamspeak 3 Server"
Using your HA configuration directory (folder) as a starting point you should now also have this:
custom_components/teamspeak/translations/en.json
custom_components/teamspeak/translations/de.json
custom_components/teamspeak/__init__.py
custom_components/teamspeak/api.py
custom_components/teamspeak/config_flow.py
custom_components/teamspeak/const.py
custom_components/teamspeak/manifest.json
custom_components/teamspeak/sensor.py
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Teamspeak 3 Server"
- Enter the IP address of your Teamspeak 3 Server
- Enter username and password for a valid Server Query Account. The credentials for the Server Query Admin Account can be found in the Teamspeak server logs after the first start:
------------------------------------------------------------------
Server Query Admin Account created
loginname= "serveradmin", password= "ZS8PRONS"
apikey= "BADUFzEGXK60NntGmTWYGkfH6nSrM9Dh_SThG7X"
------------------------------------------------------------------
If you want to contribute to this please read the Contribution guidelines