node-switchbot 3.1.0 → 3.1.2-beta.0

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 (175) hide show
  1. package/.github/npm-version-script.cjs +81 -0
  2. package/CHANGELOG.md +7 -0
  3. package/dist/types/types.d.ts +1 -0
  4. package/dist/types/types.d.ts.map +1 -1
  5. package/dist/types/types.js +1 -0
  6. package/dist/types/types.js.map +1 -1
  7. package/docs/assets/icons.js +1 -1
  8. package/docs/assets/icons.svg +1 -1
  9. package/docs/assets/main.js +1 -1
  10. package/docs/assets/navigation.js +1 -1
  11. package/docs/assets/search.js +1 -1
  12. package/docs/assets/style.css +66 -21
  13. package/docs/classes/Advertising.html +21 -0
  14. package/docs/classes/SwitchBotBLE.html +18 -37
  15. package/docs/classes/SwitchBotOpenAPI.html +8 -8
  16. package/docs/classes/SwitchbotDevice.html +20 -19
  17. package/docs/classes/WoBlindTilt.html +75 -0
  18. package/docs/classes/WoBulb.html +86 -0
  19. package/docs/classes/WoCeilingLight.html +104 -0
  20. package/docs/classes/WoContact.html +49 -0
  21. package/docs/classes/WoCurtain.html +69 -0
  22. package/docs/classes/WoHand.html +59 -0
  23. package/docs/classes/WoHub2.html +49 -0
  24. package/docs/classes/WoHumi.html +62 -0
  25. package/docs/classes/WoIOSensorTH.html +50 -0
  26. package/docs/classes/WoPlugMini.html +82 -0
  27. package/docs/classes/WoPresence.html +49 -0
  28. package/docs/classes/WoSensorTH.html +56 -0
  29. package/docs/classes/WoSmartLock.html +110 -0
  30. package/docs/classes/WoSmartLockPro.html +110 -0
  31. package/docs/classes/WoStrip.html +91 -0
  32. package/docs/enums/LogLevel.html +3 -3
  33. package/docs/enums/SwitchBotBLEModel.html +2 -2
  34. package/docs/enums/SwitchBotBLEModelFriendlyName.html +2 -2
  35. package/docs/enums/SwitchBotBLEModelName.html +2 -2
  36. package/docs/enums/SwitchBotModel.html +3 -2
  37. package/docs/hierarchy.html +1 -1
  38. package/docs/index.html +1 -1
  39. package/docs/interfaces/Ad-1.html +2 -2
  40. package/docs/interfaces/AdvertisementData.html +2 -2
  41. package/docs/interfaces/Chars.html +2 -2
  42. package/docs/interfaces/ErrorObject.html +2 -2
  43. package/docs/interfaces/Params.html +2 -2
  44. package/docs/interfaces/Rule.html +2 -2
  45. package/docs/interfaces/ServiceData.html +2 -2
  46. package/docs/interfaces/SwitchBotBLEDevice.html +2 -2
  47. package/docs/interfaces/WebhookDetail.html +2 -2
  48. package/docs/interfaces/ad.html +2 -2
  49. package/docs/interfaces/body.html +2 -2
  50. package/docs/interfaces/bodyChange.html +2 -2
  51. package/docs/interfaces/deleteWebhookResponse.html +2 -2
  52. package/docs/interfaces/device.html +2 -2
  53. package/docs/interfaces/deviceList.html +2 -2
  54. package/docs/interfaces/deviceStatus.html +2 -2
  55. package/docs/interfaces/deviceStatusRequest.html +2 -2
  56. package/docs/interfaces/deviceWebhook.html +2 -2
  57. package/docs/interfaces/deviceWebhookContext.html +2 -2
  58. package/docs/interfaces/devices.html +2 -2
  59. package/docs/interfaces/infraredRemoteList.html +2 -2
  60. package/docs/interfaces/irdevice.html +2 -2
  61. package/docs/interfaces/pushResponse.html +2 -2
  62. package/docs/interfaces/queryWebhookResponse.html +2 -2
  63. package/docs/interfaces/setupWebhookResponse.html +2 -2
  64. package/docs/interfaces/switchbot.html +2 -2
  65. package/docs/interfaces/updateWebhookResponse.html +2 -2
  66. package/docs/interfaces/webhookRequest.html +2 -2
  67. package/docs/media/BLE.md +1 -0
  68. package/docs/media/OpenAPI.md +2 -2
  69. package/docs/modules.html +18 -2
  70. package/docs/types/MacAddress.html +1 -1
  71. package/docs/types/batteryCirculatorFan.html +1 -1
  72. package/docs/types/batteryCirculatorFanServiceData.html +1 -1
  73. package/docs/types/batteryCirculatorFanStatus.html +1 -1
  74. package/docs/types/batteryCirculatorFanWebhookContext.html +1 -1
  75. package/docs/types/blindTilt.html +1 -1
  76. package/docs/types/blindTiltServiceData.html +1 -1
  77. package/docs/types/blindTiltStatus.html +1 -1
  78. package/docs/types/blindTiltWebhookContext.html +1 -1
  79. package/docs/types/bot.html +1 -1
  80. package/docs/types/botServiceData.html +1 -1
  81. package/docs/types/botStatus.html +1 -1
  82. package/docs/types/botWebhookContext.html +1 -1
  83. package/docs/types/ceilingLight.html +1 -1
  84. package/docs/types/ceilingLightPro.html +1 -1
  85. package/docs/types/ceilingLightProServiceData.html +1 -1
  86. package/docs/types/ceilingLightProStatus.html +1 -1
  87. package/docs/types/ceilingLightProWebhookContext.html +1 -1
  88. package/docs/types/ceilingLightServiceData.html +1 -1
  89. package/docs/types/ceilingLightStatus.html +1 -1
  90. package/docs/types/ceilingLightWebhookContext.html +1 -1
  91. package/docs/types/colorBulb.html +1 -1
  92. package/docs/types/colorBulbServiceData.html +1 -1
  93. package/docs/types/colorBulbStatus.html +1 -1
  94. package/docs/types/colorBulbWebhookContext.html +1 -1
  95. package/docs/types/contactSensor.html +1 -1
  96. package/docs/types/contactSensorServiceData.html +1 -1
  97. package/docs/types/contactSensorStatus.html +1 -1
  98. package/docs/types/contactSensorWebhookContext.html +1 -1
  99. package/docs/types/curtain.html +1 -1
  100. package/docs/types/curtain3.html +1 -1
  101. package/docs/types/curtain3ServiceData.html +1 -1
  102. package/docs/types/curtain3WebhookContext.html +1 -1
  103. package/docs/types/curtainServiceData.html +1 -1
  104. package/docs/types/curtainStatus.html +1 -1
  105. package/docs/types/curtainWebhookContext.html +1 -1
  106. package/docs/types/floorCleaningRobotS10.html +1 -1
  107. package/docs/types/floorCleaningRobotS10Status.html +1 -1
  108. package/docs/types/floorCleaningRobotS10WebhookContext.html +1 -1
  109. package/docs/types/hub2.html +1 -1
  110. package/docs/types/hub2ServiceData.html +1 -1
  111. package/docs/types/hub2Status.html +1 -1
  112. package/docs/types/hub2WebhookContext.html +1 -1
  113. package/docs/types/humidifier.html +1 -1
  114. package/docs/types/humidifierServiceData.html +1 -1
  115. package/docs/types/humidifierStatus.html +1 -1
  116. package/docs/types/humidifierWebhookContext.html +1 -1
  117. package/docs/types/indoorCam.html +1 -1
  118. package/docs/types/indoorCameraWebhookContext.html +1 -1
  119. package/docs/types/keypad.html +1 -1
  120. package/docs/types/keypadTouch.html +1 -1
  121. package/docs/types/keypadTouchWebhookContext.html +1 -1
  122. package/docs/types/keypadWebhookContext.html +1 -1
  123. package/docs/types/lock.html +1 -1
  124. package/docs/types/lockPro.html +1 -1
  125. package/docs/types/lockProServiceData.html +1 -1
  126. package/docs/types/lockProStatus.html +1 -1
  127. package/docs/types/lockProWebhookContext.html +1 -1
  128. package/docs/types/lockServiceData.html +1 -1
  129. package/docs/types/lockStatus.html +1 -1
  130. package/docs/types/lockWebhookContext.html +1 -1
  131. package/docs/types/meter.html +1 -1
  132. package/docs/types/meterPlus.html +1 -1
  133. package/docs/types/meterPlusServiceData.html +1 -1
  134. package/docs/types/meterPlusStatus.html +1 -1
  135. package/docs/types/meterPlusWebhookContext.html +1 -1
  136. package/docs/types/meterServiceData.html +1 -1
  137. package/docs/types/meterStatus.html +1 -1
  138. package/docs/types/meterWebhookContext.html +1 -1
  139. package/docs/types/motionSensor.html +1 -1
  140. package/docs/types/motionSensorServiceData.html +1 -1
  141. package/docs/types/motionSensorStatus.html +1 -1
  142. package/docs/types/motionSensorWebhookContext.html +1 -1
  143. package/docs/types/outdoorMeter.html +1 -1
  144. package/docs/types/outdoorMeterServiceData.html +1 -1
  145. package/docs/types/outdoorMeterStatus.html +1 -1
  146. package/docs/types/outdoorMeterWebhookContext.html +1 -1
  147. package/docs/types/panTiltCamWebhookContext.html +1 -1
  148. package/docs/types/pantiltCam.html +1 -1
  149. package/docs/types/pantiltCam2k.html +1 -1
  150. package/docs/types/plug.html +1 -1
  151. package/docs/types/plugMini.html +1 -1
  152. package/docs/types/plugMiniJPServiceData.html +1 -1
  153. package/docs/types/plugMiniJPWebhookContext.html +1 -1
  154. package/docs/types/plugMiniStatus.html +1 -1
  155. package/docs/types/plugMiniUSServiceData.html +1 -1
  156. package/docs/types/plugMiniUSWebhookContext.html +1 -1
  157. package/docs/types/plugStatus.html +1 -1
  158. package/docs/types/plugWebhookContext.html +1 -1
  159. package/docs/types/remote.html +1 -1
  160. package/docs/types/robotVacuumCleanerS1.html +1 -1
  161. package/docs/types/robotVacuumCleanerS1Plus.html +1 -1
  162. package/docs/types/robotVacuumCleanerS1PlusStatus.html +1 -1
  163. package/docs/types/robotVacuumCleanerS1PlusWebhookContext.html +1 -1
  164. package/docs/types/robotVacuumCleanerS1Status.html +1 -1
  165. package/docs/types/robotVacuumCleanerS1WebhookContext.html +1 -1
  166. package/docs/types/robotVacuumCleanerServiceData.html +1 -1
  167. package/docs/types/stripLight.html +1 -1
  168. package/docs/types/stripLightServiceData.html +1 -1
  169. package/docs/types/stripLightStatus.html +1 -1
  170. package/docs/types/stripLightWebhookContext.html +1 -1
  171. package/docs/types/waterLeakDetector.html +1 -1
  172. package/docs/types/waterLeakDetectorServiceData.html +1 -1
  173. package/docs/types/waterLeakDetectorStatus.html +1 -1
  174. package/docs/types/waterLeakDetectorWebhookContext.html +1 -1
  175. package/package.json +3 -3
@@ -4,11 +4,17 @@
4
4
  --light-color-background-secondary: #eff0f1;
5
5
  --light-color-warning-text: #222;
6
6
  --light-color-background-warning: #e6e600;
7
- --light-color-icon-background: var(--light-color-background);
8
7
  --light-color-accent: #c5c7c9;
9
8
  --light-color-active-menu-item: var(--light-color-accent);
10
9
  --light-color-text: #222;
11
10
  --light-color-text-aside: #6e6e6e;
11
+
12
+ --light-color-icon-background: var(--light-color-background);
13
+ --light-color-icon-text: var(--light-color-text);
14
+
15
+ --light-color-comment-tag-text: var(--light-color-text);
16
+ --light-color-comment-tag: var(--light-color-background);
17
+
12
18
  --light-color-link: #1f70c2;
13
19
  --light-color-focus-outline: #3584e4;
14
20
 
@@ -22,16 +28,17 @@
22
28
  --light-color-ts-function: #572be7;
23
29
  --light-color-ts-class: #1f70c2;
24
30
  --light-color-ts-interface: #108024;
25
- --light-color-ts-constructor: var(--light-color-ts-class);
26
- --light-color-ts-property: var(--light-color-ts-variable);
27
- --light-color-ts-method: var(--light-color-ts-function);
31
+ --light-color-ts-constructor: #4d7fff;
32
+ --light-color-ts-property: #ff984d;
33
+ --light-color-ts-method: #ff4db8;
34
+ --light-color-ts-reference: #ff4d82;
28
35
  --light-color-ts-call-signature: var(--light-color-ts-method);
29
36
  --light-color-ts-index-signature: var(--light-color-ts-property);
30
37
  --light-color-ts-constructor-signature: var(--light-color-ts-constructor);
31
38
  --light-color-ts-parameter: var(--light-color-ts-variable);
32
39
  /* type literal not included as links will never be generated to it */
33
40
  --light-color-ts-type-parameter: #a55c0e;
34
- --light-color-ts-accessor: var(--light-color-ts-property);
41
+ --light-color-ts-accessor: #ff4d4d;
35
42
  --light-color-ts-get-signature: var(--light-color-ts-accessor);
36
43
  --light-color-ts-set-signature: var(--light-color-ts-accessor);
37
44
  --light-color-ts-type-alias: #d51270;
@@ -46,11 +53,17 @@
46
53
  --dark-color-background-secondary: #1e2024;
47
54
  --dark-color-background-warning: #bebe00;
48
55
  --dark-color-warning-text: #222;
49
- --dark-color-icon-background: var(--dark-color-background-secondary);
50
56
  --dark-color-accent: #9096a2;
51
57
  --dark-color-active-menu-item: #5d5d6a;
52
58
  --dark-color-text: #f5f5f5;
53
59
  --dark-color-text-aside: #dddddd;
60
+
61
+ --dark-color-icon-background: var(--dark-color-background-secondary);
62
+ --dark-color-icon-text: var(--dark-color-text);
63
+
64
+ --dark-color-comment-tag-text: var(--dark-color-text);
65
+ --dark-color-comment-tag: var(--dark-color-background);
66
+
54
67
  --dark-color-link: #00aff4;
55
68
  --dark-color-focus-outline: #4c97f2;
56
69
 
@@ -64,16 +77,17 @@
64
77
  --dark-color-ts-function: #a280ff;
65
78
  --dark-color-ts-class: #8ac4ff;
66
79
  --dark-color-ts-interface: #6cff87;
67
- --dark-color-ts-constructor: var(--dark-color-ts-class);
68
- --dark-color-ts-property: var(--dark-color-ts-variable);
69
- --dark-color-ts-method: var(--dark-color-ts-function);
80
+ --dark-color-ts-constructor: #4d7fff;
81
+ --dark-color-ts-property: #ff984d;
82
+ --dark-color-ts-method: #ff4db8;
83
+ --dark-color-ts-reference: #ff4d82;
70
84
  --dark-color-ts-call-signature: var(--dark-color-ts-method);
71
85
  --dark-color-ts-index-signature: var(--dark-color-ts-property);
72
86
  --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);
73
87
  --dark-color-ts-parameter: var(--dark-color-ts-variable);
74
88
  /* type literal not included as links will never be generated to it */
75
89
  --dark-color-ts-type-parameter: #e07d13;
76
- --dark-color-ts-accessor: var(--dark-color-ts-property);
90
+ --dark-color-ts-accessor: #ff4d4d;
77
91
  --dark-color-ts-get-signature: var(--dark-color-ts-accessor);
78
92
  --dark-color-ts-set-signature: var(--dark-color-ts-accessor);
79
93
  --dark-color-ts-type-alias: #ff6492;
@@ -90,15 +104,22 @@
90
104
  --color-background-secondary: var(--light-color-background-secondary);
91
105
  --color-background-warning: var(--light-color-background-warning);
92
106
  --color-warning-text: var(--light-color-warning-text);
93
- --color-icon-background: var(--light-color-icon-background);
94
107
  --color-accent: var(--light-color-accent);
95
108
  --color-active-menu-item: var(--light-color-active-menu-item);
96
109
  --color-text: var(--light-color-text);
97
110
  --color-text-aside: var(--light-color-text-aside);
111
+
112
+ --color-icon-background: var(--light-color-icon-background);
113
+ --color-icon-text: var(--light-color-icon-text);
114
+
115
+ --color-comment-tag-text: var(--light-color-text);
116
+ --color-comment-tag: var(--light-color-background);
117
+
98
118
  --color-link: var(--light-color-link);
99
119
  --color-focus-outline: var(--light-color-focus-outline);
100
120
 
101
121
  --color-ts-keyword: var(--light-color-ts-keyword);
122
+ --color-ts-project: var(--light-color-ts-project);
102
123
  --color-ts-module: var(--light-color-ts-module);
103
124
  --color-ts-namespace: var(--light-color-ts-namespace);
104
125
  --color-ts-enum: var(--light-color-ts-enum);
@@ -110,6 +131,7 @@
110
131
  --color-ts-constructor: var(--light-color-ts-constructor);
111
132
  --color-ts-property: var(--light-color-ts-property);
112
133
  --color-ts-method: var(--light-color-ts-method);
134
+ --color-ts-reference: var(--light-color-ts-reference);
113
135
  --color-ts-call-signature: var(--light-color-ts-call-signature);
114
136
  --color-ts-index-signature: var(--light-color-ts-index-signature);
115
137
  --color-ts-constructor-signature: var(
@@ -134,15 +156,22 @@
134
156
  --color-background-secondary: var(--dark-color-background-secondary);
135
157
  --color-background-warning: var(--dark-color-background-warning);
136
158
  --color-warning-text: var(--dark-color-warning-text);
137
- --color-icon-background: var(--dark-color-icon-background);
138
159
  --color-accent: var(--dark-color-accent);
139
160
  --color-active-menu-item: var(--dark-color-active-menu-item);
140
161
  --color-text: var(--dark-color-text);
141
162
  --color-text-aside: var(--dark-color-text-aside);
163
+
164
+ --color-icon-background: var(--dark-color-icon-background);
165
+ --color-icon-text: var(--dark-color-icon-text);
166
+
167
+ --color-comment-tag-text: var(--dark-color-text);
168
+ --color-comment-tag: var(--dark-color-background);
169
+
142
170
  --color-link: var(--dark-color-link);
143
171
  --color-focus-outline: var(--dark-color-focus-outline);
144
172
 
145
173
  --color-ts-keyword: var(--dark-color-ts-keyword);
174
+ --color-ts-project: var(--dark-color-ts-project);
146
175
  --color-ts-module: var(--dark-color-ts-module);
147
176
  --color-ts-namespace: var(--dark-color-ts-namespace);
148
177
  --color-ts-enum: var(--dark-color-ts-enum);
@@ -154,6 +183,7 @@
154
183
  --color-ts-constructor: var(--dark-color-ts-constructor);
155
184
  --color-ts-property: var(--dark-color-ts-property);
156
185
  --color-ts-method: var(--dark-color-ts-method);
186
+ --color-ts-reference: var(--dark-color-ts-reference);
157
187
  --color-ts-call-signature: var(--dark-color-ts-call-signature);
158
188
  --color-ts-index-signature: var(--dark-color-ts-index-signature);
159
189
  --color-ts-constructor-signature: var(
@@ -190,10 +220,16 @@ body {
190
220
  --color-active-menu-item: var(--light-color-active-menu-item);
191
221
  --color-text: var(--light-color-text);
192
222
  --color-text-aside: var(--light-color-text-aside);
223
+ --color-icon-text: var(--light-color-icon-text);
224
+
225
+ --color-comment-tag-text: var(--light-color-text);
226
+ --color-comment-tag: var(--light-color-background);
227
+
193
228
  --color-link: var(--light-color-link);
194
229
  --color-focus-outline: var(--light-color-focus-outline);
195
230
 
196
231
  --color-ts-keyword: var(--light-color-ts-keyword);
232
+ --color-ts-project: var(--light-color-ts-project);
197
233
  --color-ts-module: var(--light-color-ts-module);
198
234
  --color-ts-namespace: var(--light-color-ts-namespace);
199
235
  --color-ts-enum: var(--light-color-ts-enum);
@@ -205,6 +241,7 @@ body {
205
241
  --color-ts-constructor: var(--light-color-ts-constructor);
206
242
  --color-ts-property: var(--light-color-ts-property);
207
243
  --color-ts-method: var(--light-color-ts-method);
244
+ --color-ts-reference: var(--light-color-ts-reference);
208
245
  --color-ts-call-signature: var(--light-color-ts-call-signature);
209
246
  --color-ts-index-signature: var(--light-color-ts-index-signature);
210
247
  --color-ts-constructor-signature: var(
@@ -232,10 +269,16 @@ body {
232
269
  --color-active-menu-item: var(--dark-color-active-menu-item);
233
270
  --color-text: var(--dark-color-text);
234
271
  --color-text-aside: var(--dark-color-text-aside);
272
+ --color-icon-text: var(--dark-color-icon-text);
273
+
274
+ --color-comment-tag-text: var(--dark-color-text);
275
+ --color-comment-tag: var(--dark-color-background);
276
+
235
277
  --color-link: var(--dark-color-link);
236
278
  --color-focus-outline: var(--dark-color-focus-outline);
237
279
 
238
280
  --color-ts-keyword: var(--dark-color-ts-keyword);
281
+ --color-ts-project: var(--dark-color-ts-project);
239
282
  --color-ts-module: var(--dark-color-ts-module);
240
283
  --color-ts-namespace: var(--dark-color-ts-namespace);
241
284
  --color-ts-enum: var(--dark-color-ts-enum);
@@ -247,6 +290,7 @@ body {
247
290
  --color-ts-constructor: var(--dark-color-ts-constructor);
248
291
  --color-ts-property: var(--dark-color-ts-property);
249
292
  --color-ts-method: var(--dark-color-ts-method);
293
+ --color-ts-reference: var(--dark-color-ts-reference);
250
294
  --color-ts-call-signature: var(--dark-color-ts-call-signature);
251
295
  --color-ts-index-signature: var(--dark-color-ts-index-signature);
252
296
  --color-ts-constructor-signature: var(
@@ -439,7 +483,6 @@ pre {
439
483
 
440
484
  pre {
441
485
  position: relative;
442
- white-space: pre;
443
486
  white-space: pre-wrap;
444
487
  word-wrap: break-word;
445
488
  padding: 10px;
@@ -860,6 +903,12 @@ a.tsd-index-link {
860
903
  margin-bottom: 0.75rem;
861
904
  }
862
905
 
906
+ .tsd-no-select {
907
+ -webkit-user-select: none;
908
+ -moz-user-select: none;
909
+ -ms-user-select: none;
910
+ user-select: none;
911
+ }
863
912
  .tsd-kind-icon {
864
913
  margin-right: 0.5rem;
865
914
  width: 1.25rem;
@@ -867,10 +916,6 @@ a.tsd-index-link {
867
916
  min-width: 1.25rem;
868
917
  min-height: 1.25rem;
869
918
  }
870
- .tsd-kind-icon path {
871
- transform-origin: center;
872
- transform: scale(1.1);
873
- }
874
919
  .tsd-signature > .tsd-kind-icon {
875
920
  margin-right: 0.8rem;
876
921
  }
@@ -1242,6 +1287,9 @@ img {
1242
1287
  .tsd-kind-method {
1243
1288
  color: var(--color-ts-method);
1244
1289
  }
1290
+ .tsd-kind-reference {
1291
+ color: var(--color-ts-reference);
1292
+ }
1245
1293
  .tsd-kind-call-signature {
1246
1294
  color: var(--color-ts-call-signature);
1247
1295
  }
@@ -1254,9 +1302,6 @@ img {
1254
1302
  .tsd-kind-parameter {
1255
1303
  color: var(--color-ts-parameter);
1256
1304
  }
1257
- .tsd-kind-type-literal {
1258
- color: var(--color-ts-type-literal);
1259
- }
1260
1305
  .tsd-kind-type-parameter {
1261
1306
  color: var(--color-ts-type-parameter);
1262
1307
  }
@@ -1435,7 +1480,7 @@ img {
1435
1480
  }
1436
1481
 
1437
1482
  .site-menu {
1438
- margin-top: 1rem 0;
1483
+ margin-top: 1rem;
1439
1484
  }
1440
1485
 
1441
1486
  .page-menu,
@@ -0,0 +1,21 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Advertising | node-switchbot</title><meta name="description" content="Documentation for node-switchbot"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-switchbot</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-switchbot</a></li><li><a href="Advertising.html">Advertising</a></li></ul><h1> ClassAdvertising</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the advertising data parser for SwitchBot devices.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/node-switchbot/blob/8932109d5e4a9d67b37cc17c442e5cb7c428042d/src/advertising.ts#L31">advertising.ts:31</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Advertising.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Advertising.html#parse" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse</span></a>
4
+ <a href="Advertising.html#parseServiceData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Service<wbr/>Data</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Advertising" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Advertising</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Advertising.html" class="tsd-signature-type tsd-kind-class">Advertising</a><a href="#constructor.new_Advertising" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Advertising.html" class="tsd-signature-type tsd-kind-class">Advertising</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/node-switchbot/blob/8932109d5e4a9d67b37cc17c442e5cb7c428042d/src/advertising.ts#L32">advertising.ts:32</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="parse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="parse.parse-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">parse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">peripheral</span>, <span class="tsd-kind-parameter">emitLog</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Ad-1.html" class="tsd-signature-type tsd-kind-interface">Ad</a><span class="tsd-signature-symbol">&gt;</span><a href="#parse.parse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parses the advertisement data coming from SwitchBot device.</p>
6
+ <p>This function processes advertising packets received from SwitchBot devices
7
+ and extracts relevant information based on the device type.</p>
8
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">peripheral</span>: <span class="tsd-signature-type">Peripheral</span></span><div class="tsd-comment tsd-typography"><p>The peripheral device object from noble.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">emitLog</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The function to emit log messages.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Ad-1.html" class="tsd-signature-type tsd-kind-interface">Ad</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
11
+ <li>An object containing parsed data specific to the SwitchBot device type, or <code>null</code> if the device is not recognized.</li>
12
+ </ul>
13
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/node-switchbot/blob/8932109d5e4a9d67b37cc17c442e5cb7c428042d/src/advertising.ts#L44">advertising.ts:44</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="parseServiceData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>parse<wbr/>Service<wbr/>Data</span><a href="#parseServiceData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="parseServiceData.parseServiceData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">parse<wbr/>Service<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">serviceData</span>, <span class="tsd-kind-parameter">manufacturerData</span>, <span class="tsd-kind-parameter">emitLog</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#parseServiceData.parseServiceData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parses the service data based on the device model.</p>
14
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The device model.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">serviceData</span>: <span class="tsd-signature-type">Buffer</span></span><div class="tsd-comment tsd-typography"><p>The service data buffer.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">manufacturerData</span>: <span class="tsd-signature-type">Buffer</span></span><div class="tsd-comment tsd-typography"><p>The manufacturer data buffer.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">emitLog</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The function to emit log messages.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
19
+ <li>The parsed service data.</li>
20
+ </ul>
21
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/node-switchbot/blob/8932109d5e4a9d67b37cc17c442e5cb7c428042d/src/advertising.ts#L98">advertising.ts:98</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#parse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse</span></a><a href="#parseServiceData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Service<wbr/>Data</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>node-switchbot</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>