@o-lukas/homebridge-smartthings-tv 2.1.2 → 2.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +23 -27
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -10,12 +10,10 @@
10
10
 
11
11
  This is a plugin for [Homebridge](https://github.com/homebridge/homebridge). It offers some basic functions to control Samsung TVs using the SmartThings API.
12
12
 
13
- # Configuration
13
+ ## Configuration
14
14
 
15
15
  The easiest way to configure the plugin is to use [Homebridge Config UI X](https://github.com/oznu/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.
16
16
 
17
- ## Configuration example
18
-
19
17
  The following snippet shows the most simple configuration you can use for the plugin:
20
18
 
21
19
  ```json
@@ -99,8 +97,6 @@ The following snippets shows all available properties you can use for the plugin
99
97
  }
100
98
  ```
101
99
 
102
- ## Available configuration properties
103
-
104
100
  ### token
105
101
 
106
102
  The SmartThings API token is needed to authenticate the requests sent to the SmartThings API. To generate a token open [SmartThings website]( https://account.smartthings.com/tokens) and generate a new one (make sure at least devices is selected).
@@ -143,65 +139,65 @@ Use the device mappings when e.g. turning on the accessory does not work as expe
143
139
 
144
140
  #### deviceId
145
141
 
146
- The SmartThings device id. Check the log or go to https://account.smartthings.com/ and get the device id.
142
+ The SmartThings device id. Check the log or go to <https://account.smartthings.com/> and get the device id.
147
143
 
148
- ### nameOverride
144
+ #### nameOverride
149
145
 
150
146
  Use this to override the default display name of the device. Must be configured here because name configured in HomeKit will get lost after restart.
151
147
 
152
- ### wol
148
+ #### wol
153
149
 
154
150
  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.
155
151
 
156
- ### macAddress
152
+ #### macAddress
157
153
 
158
154
  The mac address of the device to turn device on using wake-on-lan functionality.
159
155
 
160
- ### ping
156
+ #### ping
161
157
 
162
158
  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.
163
159
 
164
- ### ipAddress
160
+ #### ipAddress
165
161
 
166
162
  The IP address of the device (assign a static IP address to make sure it does not change) to determine the status using ping.
167
163
 
168
- ### infoKey
164
+ #### infoKey
169
165
 
170
166
  The key to be emulated when pressing info button in HomeKit remote. The list of valid values must be read from the log as it differs per device. To do so enable capabilityLogging and look for log entry containing the possible values.
171
167
 
172
- ### inputSources
168
+ #### inputSources
173
169
 
174
170
  Overrides the device's default input sources map to add custom input sources. Check the log for information about the default input sources.
175
171
 
176
- #### name
172
+ ##### name
177
173
 
178
174
  The input source's name.
179
175
 
180
- #### id
176
+ ##### id
181
177
 
182
178
  The input source's id.
183
179
 
184
- ### applications
180
+ #### applications
185
181
 
186
182
  Overrides the default application mapping list to add custom applications. See [registerApplications](#registerapplications) for more details about application registration.
187
183
 
188
- #### name
184
+ ##### name
189
185
 
190
186
  The application's name.
191
187
 
192
- #### ids
188
+ ##### ids
193
189
 
194
190
  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.
195
191
 
196
- # Common issues
192
+ ## Common issues
197
193
 
198
- ## TV does not show in HomeKit
194
+ ### TV does not show in HomeKit
199
195
 
200
196
  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.
201
197
 
202
198
  If your TV is lost after an update/restart/etc. you might need to reset the connection. To do so reset the externally published accessories in Homebridge using: Unpair Bridges / Cameras / TVs / External Accessories in the Homebridge settings.
203
199
 
204
- ## TV does not turn on
200
+ ### TV does not turn on
205
201
 
206
202
  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.
207
203
 
@@ -226,7 +222,7 @@ The command to turn the TV on using the SmartThings API does not work for some T
226
222
  }
227
223
  ```
228
224
 
229
- ## TV state does not match actual state
225
+ ### TV state does not match actual state
230
226
 
231
227
  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.
232
228
 
@@ -251,21 +247,21 @@ Some TVs report a false active state using the SmartThings API. To get the actua
251
247
  }
252
248
  ```
253
249
 
254
- ## Picture/sound mode switches do not match TV picture mode settings
250
+ ### Picture/sound mode switches do not match TV picture mode settings
255
251
 
256
252
  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.
257
253
 
258
- ## Error `invalid device state`
254
+ ### Error `invalid device state`
259
255
 
260
256
  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.
261
257
 
262
- ## DisplayPort input sources do not show up
258
+ ### DisplayPort input sources do not show up
263
259
 
264
260
  For some TVs display port sources do not show up. When having the same problem you might try to use [inputSources](#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.
265
261
 
266
- ## Name of TV gets reset in HomeKit after HomeBridge restart
262
+ ### Name of TV gets reset in HomeKit after HomeBridge restart
267
263
 
268
- The configured name can not be cached because TV is published as external accessory. To permanently change the name use [nameOverride](#nameOverride).
264
+ The configured name can not be cached because TV is published as external accessory. To permanently change the name use [nameOverride](#nameoverride).
269
265
 
270
266
  ***
271
267
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "displayName": "Homebridge SmartThings TV",
3
3
  "name": "@o-lukas/homebridge-smartthings-tv",
4
- "version": "2.1.2",
4
+ "version": "2.1.3",
5
5
  "description": "This is a plugin for Homebridge. It offers some basic functions to control Samsung TVs using the SmartThings API.",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -55,7 +55,7 @@
55
55
  },
56
56
  "overrides": {
57
57
  "@smartthings/core-sdk": {
58
- "axios": "~>1.6.0"
58
+ "axios": "~>1.7.3"
59
59
  }
60
60
  },
61
61
  "release": {