node-switchbot 2.5.0-beta.29 → 2.5.0-beta.30

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 (206) hide show
  1. package/.github/workflows/beta-release.yml +25 -2
  2. package/.github/workflows/release.yml +13 -0
  3. package/BLE.md +1109 -0
  4. package/CHANGELOG.md +14 -0
  5. package/OpenAPI.md +172 -0
  6. package/README.md +20 -1189
  7. package/branding/Node_x_SwitchBot.svg +9 -0
  8. package/branding/icon.png +0 -0
  9. package/branding/switchbot.png +0 -0
  10. package/dist/device.d.ts +3 -3
  11. package/dist/device.d.ts.map +1 -1
  12. package/dist/device.js.map +1 -1
  13. package/dist/index.d.ts +2 -2
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.js +2 -2
  16. package/dist/index.js.map +1 -1
  17. package/dist/parameter-checker.d.ts +1 -1
  18. package/dist/parameter-checker.d.ts.map +1 -1
  19. package/dist/parameter-checker.js +1 -1
  20. package/dist/parameter-checker.js.map +1 -1
  21. package/dist/{switchbot.d.ts → switchbot-ble.d.ts} +2 -2
  22. package/dist/switchbot-ble.d.ts.map +1 -0
  23. package/dist/{switchbot.js → switchbot-ble.js} +2 -2
  24. package/dist/switchbot-ble.js.map +1 -0
  25. package/dist/test/advertising.test.d.ts +2 -0
  26. package/dist/test/advertising.test.d.ts.map +1 -0
  27. package/dist/test/advertising.test.js +96 -0
  28. package/dist/test/advertising.test.js.map +1 -0
  29. package/dist/test/device.test.d.ts +2 -0
  30. package/dist/test/device.test.d.ts.map +1 -0
  31. package/dist/test/device.test.js +60 -0
  32. package/dist/test/device.test.js.map +1 -0
  33. package/dist/test/index.test.d.ts +2 -0
  34. package/dist/test/index.test.d.ts.map +1 -0
  35. package/dist/test/index.test.js +34 -0
  36. package/dist/test/index.test.js.map +1 -0
  37. package/dist/test/parameter-checker.test.d.ts +2 -0
  38. package/dist/test/parameter-checker.test.d.ts.map +1 -0
  39. package/dist/test/parameter-checker.test.js +108 -0
  40. package/dist/test/parameter-checker.test.js.map +1 -0
  41. package/dist/test/settings.test.d.ts +2 -0
  42. package/dist/test/settings.test.d.ts.map +1 -0
  43. package/dist/test/settings.test.js +48 -0
  44. package/dist/test/settings.test.js.map +1 -0
  45. package/dist/test/switchbot-openapi.test.d.ts +2 -0
  46. package/dist/test/switchbot-openapi.test.d.ts.map +1 -0
  47. package/dist/test/switchbot-openapi.test.js +95 -0
  48. package/dist/test/switchbot-openapi.test.js.map +1 -0
  49. package/dist/test/switchbot.test.d.ts +2 -0
  50. package/dist/test/switchbot.test.d.ts.map +1 -0
  51. package/dist/test/switchbot.test.js +106 -0
  52. package/dist/test/switchbot.test.js.map +1 -0
  53. package/docs/assets/highlight.css +12 -47
  54. package/docs/assets/main.js +1 -1
  55. package/docs/assets/navigation.js +1 -1
  56. package/docs/assets/search.js +1 -1
  57. package/docs/classes/SwitchBotBLE.html +61 -0
  58. package/docs/classes/SwitchBotOpenAPI.html +47 -0
  59. package/docs/classes/SwitchbotDevice.html +28 -33
  60. package/docs/enums/LogLevel.html +6 -0
  61. package/docs/enums/SwitchBotBLEModel.html +2 -2
  62. package/docs/enums/SwitchBotBLEModelFriendlyName.html +2 -2
  63. package/docs/enums/SwitchBotBLEModelName.html +2 -2
  64. package/docs/enums/SwitchBotModel.html +2 -2
  65. package/docs/hierarchy.html +1 -0
  66. package/docs/index.html +16 -993
  67. package/docs/interfaces/Ad-1.html +5 -0
  68. package/docs/interfaces/AdvertisementData.html +3 -0
  69. package/docs/interfaces/Chars.html +4 -0
  70. package/docs/interfaces/ErrorObject.html +3 -0
  71. package/docs/interfaces/Params.html +6 -0
  72. package/docs/interfaces/ServiceData.html +2 -0
  73. package/docs/interfaces/SwitchBotBLEDevice.html +21 -0
  74. package/docs/interfaces/WebhookDetail.html +6 -0
  75. package/docs/interfaces/ad.html +5 -0
  76. package/docs/interfaces/body.html +3 -0
  77. package/docs/interfaces/bodyChange.html +4 -0
  78. package/docs/interfaces/deleteWebhookResponse.html +4 -0
  79. package/docs/interfaces/device.html +7 -0
  80. package/docs/interfaces/deviceList.html +2 -0
  81. package/docs/interfaces/deviceStatus.html +7 -0
  82. package/docs/interfaces/deviceStatusRequest.html +4 -0
  83. package/docs/interfaces/deviceWebhook.html +4 -0
  84. package/docs/interfaces/deviceWebhookContext.html +4 -0
  85. package/docs/interfaces/devices.html +4 -0
  86. package/docs/interfaces/infraredRemoteList.html +2 -0
  87. package/docs/interfaces/irdevice.html +5 -0
  88. package/docs/interfaces/pushResponse.html +4 -0
  89. package/docs/interfaces/queryWebhookResponse.html +4 -0
  90. package/docs/interfaces/setupWebhookResponse.html +4 -0
  91. package/docs/interfaces/switchbot.html +3 -0
  92. package/docs/interfaces/updateWebhookResponse.html +4 -0
  93. package/docs/interfaces/webhookRequest.html +4 -0
  94. package/docs/media/BLE.md +1109 -0
  95. package/docs/media/OpenAPI.md +172 -0
  96. package/docs/modules.html +136 -3
  97. package/docs/types/MacAddress.html +1 -0
  98. package/docs/types/batteryCirculatorFan.html +1 -0
  99. package/docs/types/batteryCirculatorFanServiceData.html +1 -0
  100. package/docs/types/batteryCirculatorFanStatus.html +1 -0
  101. package/docs/types/batteryCirculatorFanWebhookContext.html +1 -0
  102. package/docs/types/blindTilt.html +1 -0
  103. package/docs/types/blindTiltServiceData.html +1 -0
  104. package/docs/types/blindTiltStatus.html +1 -0
  105. package/docs/types/blindTiltWebhookContext.html +1 -0
  106. package/docs/types/bot.html +1 -0
  107. package/docs/types/botServiceData.html +1 -0
  108. package/docs/types/botStatus.html +1 -0
  109. package/docs/types/botWebhookContext.html +1 -0
  110. package/docs/types/ceilingLight.html +1 -0
  111. package/docs/types/ceilingLightPro.html +1 -0
  112. package/docs/types/ceilingLightProServiceData.html +1 -0
  113. package/docs/types/ceilingLightProStatus.html +1 -0
  114. package/docs/types/ceilingLightProWebhookContext.html +1 -0
  115. package/docs/types/ceilingLightServiceData.html +1 -0
  116. package/docs/types/ceilingLightStatus.html +1 -0
  117. package/docs/types/ceilingLightWebhookContext.html +1 -0
  118. package/docs/types/colorBulb.html +1 -0
  119. package/docs/types/colorBulbServiceData.html +1 -0
  120. package/docs/types/colorBulbStatus.html +1 -0
  121. package/docs/types/colorBulbWebhookContext.html +1 -0
  122. package/docs/types/contactSensor.html +1 -0
  123. package/docs/types/contactSensorServiceData.html +1 -0
  124. package/docs/types/contactSensorStatus.html +1 -0
  125. package/docs/types/contactSensorWebhookContext.html +1 -0
  126. package/docs/types/curtain.html +1 -0
  127. package/docs/types/curtain3.html +1 -0
  128. package/docs/types/curtain3ServiceData.html +1 -0
  129. package/docs/types/curtain3WebhookContext.html +1 -0
  130. package/docs/types/curtainServiceData.html +1 -0
  131. package/docs/types/curtainStatus.html +1 -0
  132. package/docs/types/curtainWebhookContext.html +1 -0
  133. package/docs/types/floorCleaningRobotS10.html +1 -0
  134. package/docs/types/floorCleaningRobotS10Status.html +1 -0
  135. package/docs/types/floorCleaningRobotS10WebhookContext.html +1 -0
  136. package/docs/types/hub2.html +1 -0
  137. package/docs/types/hub2ServiceData.html +1 -0
  138. package/docs/types/hub2Status.html +1 -0
  139. package/docs/types/hub2WebhookContext.html +1 -0
  140. package/docs/types/humidifier.html +1 -0
  141. package/docs/types/humidifierServiceData.html +1 -0
  142. package/docs/types/humidifierStatus.html +1 -0
  143. package/docs/types/humidifierWebhookContext.html +1 -0
  144. package/docs/types/indoorCam.html +1 -0
  145. package/docs/types/indoorCameraWebhookContext.html +1 -0
  146. package/docs/types/keypad.html +1 -0
  147. package/docs/types/keypadTouch.html +1 -0
  148. package/docs/types/keypadTouchWebhookContext.html +1 -0
  149. package/docs/types/keypadWebhookContext.html +1 -0
  150. package/docs/types/lock.html +1 -0
  151. package/docs/types/lockPro.html +1 -0
  152. package/docs/types/lockProServiceData.html +1 -0
  153. package/docs/types/lockProStatus.html +1 -0
  154. package/docs/types/lockProWebhookContext.html +1 -0
  155. package/docs/types/lockServiceData.html +1 -0
  156. package/docs/types/lockStatus.html +1 -0
  157. package/docs/types/lockWebhookContext.html +1 -0
  158. package/docs/types/meter.html +1 -0
  159. package/docs/types/meterPlus.html +1 -0
  160. package/docs/types/meterPlusServiceData.html +1 -0
  161. package/docs/types/meterPlusStatus.html +1 -0
  162. package/docs/types/meterPlusWebhookContext.html +1 -0
  163. package/docs/types/meterServiceData.html +1 -0
  164. package/docs/types/meterStatus.html +1 -0
  165. package/docs/types/meterWebhookContext.html +1 -0
  166. package/docs/types/motionSensor.html +1 -0
  167. package/docs/types/motionSensorServiceData.html +1 -0
  168. package/docs/types/motionSensorStatus.html +1 -0
  169. package/docs/types/motionSensorWebhookContext.html +1 -0
  170. package/docs/types/outdoorMeter.html +1 -0
  171. package/docs/types/outdoorMeterServiceData.html +1 -0
  172. package/docs/types/outdoorMeterStatus.html +1 -0
  173. package/docs/types/outdoorMeterWebhookContext.html +1 -0
  174. package/docs/types/panTiltCamWebhookContext.html +1 -0
  175. package/docs/types/pantiltCam.html +1 -0
  176. package/docs/types/pantiltCam2k.html +1 -0
  177. package/docs/types/plug.html +1 -0
  178. package/docs/types/plugMini.html +1 -0
  179. package/docs/types/plugMiniJPServiceData.html +1 -0
  180. package/docs/types/plugMiniJPWebhookContext.html +1 -0
  181. package/docs/types/plugMiniStatus.html +1 -0
  182. package/docs/types/plugMiniUSServiceData.html +1 -0
  183. package/docs/types/plugMiniUSWebhookContext.html +1 -0
  184. package/docs/types/plugStatus.html +1 -0
  185. package/docs/types/plugWebhookContext.html +1 -0
  186. package/docs/types/remote.html +1 -0
  187. package/docs/types/robotVacuumCleanerS1.html +1 -0
  188. package/docs/types/robotVacuumCleanerS1Plus.html +1 -0
  189. package/docs/types/robotVacuumCleanerS1PlusStatus.html +1 -0
  190. package/docs/types/robotVacuumCleanerS1PlusWebhookContext.html +1 -0
  191. package/docs/types/robotVacuumCleanerS1Status.html +1 -0
  192. package/docs/types/robotVacuumCleanerS1WebhookContext.html +1 -0
  193. package/docs/types/robotVacuumCleanerServiceData.html +1 -0
  194. package/docs/types/stripLight.html +1 -0
  195. package/docs/types/stripLightServiceData.html +1 -0
  196. package/docs/types/stripLightStatus.html +1 -0
  197. package/docs/types/stripLightWebhookContext.html +1 -0
  198. package/docs/types/waterLeakDetector.html +1 -0
  199. package/docs/types/waterLeakDetectorServiceData.html +1 -0
  200. package/docs/types/waterLeakDetectorStatus.html +1 -0
  201. package/docs/types/waterLeakDetectorWebhookContext.html +1 -0
  202. package/package.json +3 -3
  203. package/dist/switchbot.d.ts.map +0 -1
  204. package/dist/switchbot.js.map +0 -1
  205. package/docs/classes/SwitchBot.html +0 -16
  206. package/docs/types/SwitchBotBLEDevice.html +0 -1
package/.github/workflows/beta-release.yml CHANGED
@@ -12,15 +12,14 @@ jobs:
12
12
  enable_coverage: true
13
13
  secrets:
14
14
  token: ${{ secrets.GITHUB_TOKEN }}
15
+
15
16
  lint:
16
17
  needs: build_and_test
17
18
  uses: OpenWonderLabs/.github/.github/workflows/eslint.yml@latest
18
19
 
19
20
  publish:
20
21
  needs: lint
21
-
22
22
  if: ${{ github.repository == 'OpenWonderLabs/node-switchbot' }}
23
-
24
23
  uses: OpenWonderLabs/.github/.github/workflows/npm-publish.yml@latest
25
24
  with:
26
25
  tag: 'beta'
@@ -29,3 +28,27 @@ jobs:
29
28
  pre_id: 'beta'
30
29
  secrets:
31
30
  npm_auth_token: ${{ secrets.npm_token }}
31
+
32
+ pre-release:
33
+ needs: publish
34
+ if: ${{ github.repository == 'OpenWonderLabs/node-switchbot' }}
35
+ uses: OpenWonderLabs/.github/.github/workflows/pre-release.yml@latest
36
+ with:
37
+ npm_version: ${{ needs.publish.outputs.NPM_VERSION }}
38
+ body: |
39
+ **Beta Release**
40
+ **Version**: v${{ needs.publish.outputs.NPM_VERSION }}
41
+ [How To Test Beta Releases](https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Beta-Version)
42
+
43
+ github-releases-to-discord:
44
+ name: Discord Webhooks
45
+ needs: [build_and_test,publish]
46
+ if: ${{ github.repository == 'OpenWonderLabs/node-switchbot' }}
47
+ uses: OpenWonderLabs/.github/.github/workflows/discord-webhooks.yml@latest
48
+ with:
49
+ title: "Node-SwitchBot Beta Release"
50
+ description: |
51
+ Version `v${{ needs.publish.outputs.NPM_VERSION }}`
52
+ url: "https://github.com/homebridge/camera-utils/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
53
+ secrets:
54
+ DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}
package/.github/workflows/release.yml CHANGED
@@ -20,3 +20,16 @@ jobs:
20
20
  uses: OpenWonderLabs/.github/.github/workflows/npm-publish.yml@latest
21
21
  secrets:
22
22
  npm_auth_token: ${{ secrets.npm_token }}
23
+
24
+ github-releases-to-discord:
25
+ name: Discord Webhooks
26
+ needs: [build_and_test,publish]
27
+ if: ${{ github.repository == 'OpenWonderLabs/node-switchbot' }}
28
+ uses: OpenWonderLabs/.github/.github/workflows/discord-webhooks.yml@latest
29
+ with:
30
+ title: "Node-SwitchBot Beta Release"
31
+ description: |
32
+ Version `v${{ needs.publish.outputs.NPM_VERSION }}`
33
+ url: "https://github.com/homebridge/camera-utils/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
34
+ secrets:
35
+ DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}