This is a plugin for Homebridge. It offers some basic functions to control Samsung TVs using the SmartThings API.
The easiest way to configure the plugin is to use Homebridge Config UI X which should contain a description for every needed property. The only property needed to make the plugin work is the SmartThings API token. The other properties enable some additional functions but are not mandatory for the plugin to work.
The following snippet shows the most simple configuration you can use for the plugin:
{
"bridge": {
},
"accessories": [],
"platforms": [
{
"name": "SmartThings TV",
"token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"platform": "smartthings-tv"
}
]
}The following snippets shows all available properties you can use for the plugin:
{
"bridge": {
},
"accessories": [],
"platforms": [
{
"name": "SmartThings TV",
"token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"capabilityLogging": true,
"cyclicCallsLogging": true,
"registerApplications": true,
"registerPictureModes": true,
"registerSoundModes": true,
"registerVolumeSlider": true,
"pollInterval": 5000,
"deviceBlacklist": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"deviceMappings": [
{
"deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"wol": true,
"macAddress": "xx:xx:xx:xx:xx:xx",
"ping": true,
"ipAddress": "xx:xx:xx:xx:xx:xx",
"inputSources": [
{
"name": "xxxx",
"id": "xxxx"
}
],
"applications": [
{
"name": "xxxx",
"ids": [
"xxxx",
"xxxx"
]
}
]
},
{
"deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"wol": true,
"macAddress": "xx:xx:xx:xx:xx:xx",
"ping": false
},
{
"deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"wol": false,
"ping": true,
"ipAddress": "xx:xx:xx:xx:xx:xx"
}
],
"platform": "smartthings-tv"
}
]
}The SmartThings API token is needed to authenticate the requests sent to the SmartThings API. To generate a token open SmartThings website and generate a new one (make sure at least devices is selected).
The SmartThings API returns the list of supported actions of a device as capabilities. For implementing new features it is neccessary to know the scheme the capability uses. Enable this property to log all capabilities of supported SmartThings devices.
Enable debug logging for cyclic calls (e.g. polling).
To use installed application as input sources, a predefined list of applications will be used. This list will be checked for availability at the TV(s) and eventually be registered as input sources. Make sure to have the TV(s) turned on when starting your instance as this functionality requires your TV(s) be turned on to determine whether an application is installed or not. On startup the applications will be opened to determine if they are available. Do not use your TV until the input source is being changed back to the first one (usually Live TV).
Registers all available picture modes as separate switches that can be toggled to enable/disable a picture mode. Uses the names as exposed from the SmartThings API.
Registers all available sound modes as separate switches that can be toggled to enable/disable a sound mode. Uses the names as exposed from the SmartThings API.
Registers a separate volume slider accessorry that will be exposed as a light bulb accessory (because there is currently no option to change a speaker volume directly using Home).
Some characteristics are not updated automatically (e.g. power state). To enable polling these characteristics automatically set this value to the desired polling interval in milliseconds. Leave empty to disable this functionality.
Devices not to be registered.
Use the device mappings when e.g. turning on the accessory does not work as expected. When a device mapping is available the wake-on-lan functionality is used to turn on the device instead of the SmartThings API. To make use of the functionality you must enter the mapping using the SmartThings device ID and the mac address of the device. If status does not show up properly you can use the ping functionality to determine the device status. To make use of it you must enter the SmartThings device ID and the ip address of the device.
The SmartThings device id. Check the log or go to https://account.smartthings.com/ and get the device id.
Enables usage of wake-on-lan functionality to turn the device on. Use only if using the SmartThings API does not work for your device.
The mac address of the device to turn device on using wake-on-lan functionality.
Enables usage of ping functionality to determine if device is turned on. Use only if using the SmartThings API does not work for your device.
The IP address of the device (assign a static IP address to make sure it does not change) to determine the status using ping.
Overrides the device's default input sources map to add custom input sources. Check the log for information about the default input sources.
The input source's name.
The input source's id.
Overrides the default application mapping list to add custom applications. See registerApplications for more details about application registration.
The application's name.
The application's possible ids. Since some applications have different ids for different versions of TVs you can provide a list here so the plugin will try every id and use the one that's working.
After starting you have to add the TV manually to HomeKit because they are published as external accessory to get over the limit of only one TV per bridge.
The command to turn the TV on using the SmartThings API does not work for some TVs. To solve this problem you can use the built-in wake-on-lan functionality. To activate this functionality add a device mapping containing the device id and the mac address of your TV.
{
"bridge": {
},
"accessories": [],
"platforms": [
{
"name": "SmartThings TV",
"token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"deviceMappings": [
{
"deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"macAddress": "xx:xx:xx:xx:xx:xx"
}
],
"platform": "smartthings-tv"
}
]
}Some TVs report a false active state using the SmartThings API. To get the actual state of the television you can use the build-in ping functionality. To activate this functionality add a device mapping containing the device id and the IP address of your TV.
{
"bridge": {
},
"accessories": [],
"platforms": [
{
"name": "SmartThings TV",
"token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"deviceMappings": [
{
"deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"ipAddress": "xx:xx:xx:xx:xx:xx"
}
],
"platform": "smartthings-tv"
}
]
}Some TVs always report the same picture & sound mode. This will cause the exposed switches to not match the actual picture/sound mode state. I have not found a proper solution for this problem yet. But toggling the buttons will still work.
Sometimes the SmartThings API seems to loose the contact to the device and does not update it's state so every request will end up with an error message like invalid device state. To fix this try to remove the device from your SmartThings account and add it again. This seems to fix the problem.
For some TVs display port sources do not show up. When having the same problem you might try to use inputSources. Id might be something like Display Port but you will have to experiment a bit trying different ids until you find the the right one.
Since this is my first plugin it may contain some problems. Feel free to create an issue or pull request and I will try to help and fix the problems.
But since this plugin is developed in my spare time don't expect a quick fix.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent