node-switchbot 4.0.0-beta.14 → 4.0.0-beta.15

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 (164) hide show
  1. package/dist/switchbot.d.ts.map +1 -1
  2. package/dist/switchbot.js +42 -5
  3. package/dist/switchbot.js.map +1 -1
  4. package/docs/classes/APIError.html +2 -2
  5. package/docs/classes/APINotAvailableError.html +2 -2
  6. package/docs/classes/BLEConnection.html +10 -10
  7. package/docs/classes/BLENotAvailableError.html +2 -2
  8. package/docs/classes/BLEScanner.html +9 -9
  9. package/docs/classes/CommandFailedError.html +2 -2
  10. package/docs/classes/ConnectionTimeoutError.html +2 -2
  11. package/docs/classes/DeviceManager.html +13 -13
  12. package/docs/classes/DeviceNotFoundError.html +2 -2
  13. package/docs/classes/DeviceOverrideStateDuringConnection.html +34 -34
  14. package/docs/classes/DiscoveryError.html +2 -2
  15. package/docs/classes/OpenAPIClient.html +24 -24
  16. package/docs/classes/SequenceDevice.html +35 -35
  17. package/docs/classes/SwitchBot.html +11 -11
  18. package/docs/classes/SwitchBotDevice.html +34 -34
  19. package/docs/classes/SwitchBotError.html +2 -2
  20. package/docs/classes/ValidationError.html +2 -2
  21. package/docs/classes/WoAIHub.html +34 -34
  22. package/docs/classes/WoAirPurifier.html +40 -40
  23. package/docs/classes/WoAirPurifierPM25.html +34 -34
  24. package/docs/classes/WoAirPurifierTable.html +40 -40
  25. package/docs/classes/WoArtFrame.html +43 -43
  26. package/docs/classes/WoBlindTilt.html +41 -41
  27. package/docs/classes/WoBulb.html +43 -43
  28. package/docs/classes/WoCandleWarmerLamp.html +34 -34
  29. package/docs/classes/WoCeilingLight.html +43 -43
  30. package/docs/classes/WoCirculatorFan.html +40 -40
  31. package/docs/classes/WoClimatePanel.html +40 -40
  32. package/docs/classes/WoContact.html +34 -34
  33. package/docs/classes/WoCurtain.html +40 -40
  34. package/docs/classes/WoFloorLamp.html +43 -43
  35. package/docs/classes/WoGarageDoorOpener.html +39 -39
  36. package/docs/classes/WoHand.html +43 -43
  37. package/docs/classes/WoHub2.html +34 -34
  38. package/docs/classes/WoHub3.html +34 -34
  39. package/docs/classes/WoHubMiniMatter.html +34 -34
  40. package/docs/classes/WoHumi.html +41 -41
  41. package/docs/classes/WoHumi2.html +41 -41
  42. package/docs/classes/WoIOSensorTH.html +34 -34
  43. package/docs/classes/WoKeypad.html +34 -34
  44. package/docs/classes/WoKeypadVision.html +34 -34
  45. package/docs/classes/WoKeypadVisionPro.html +34 -34
  46. package/docs/classes/WoLeak.html +34 -34
  47. package/docs/classes/WoPanTiltCamPlus3K.html +34 -34
  48. package/docs/classes/WoPlugMiniJP.html +37 -37
  49. package/docs/classes/WoPlugMiniUS.html +37 -37
  50. package/docs/classes/WoPresence.html +34 -34
  51. package/docs/classes/WoRGBICBulb.html +45 -45
  52. package/docs/classes/WoRGBICNeonWireRopeLight.html +34 -34
  53. package/docs/classes/WoRGBICWWFloorLamp.html +45 -45
  54. package/docs/classes/WoRGBICWWStripLight.html +45 -45
  55. package/docs/classes/WoRelaySwitch1.html +39 -39
  56. package/docs/classes/WoRelaySwitch1PM.html +39 -39
  57. package/docs/classes/WoRelaySwitch2PM.html +41 -41
  58. package/docs/classes/WoRemote.html +34 -34
  59. package/docs/classes/WoRemoteWithScreen.html +34 -34
  60. package/docs/classes/WoRollerShade.html +40 -40
  61. package/docs/classes/WoSensorTH.html +34 -34
  62. package/docs/classes/WoSensorTHPlus.html +34 -34
  63. package/docs/classes/WoSensorTHPro.html +34 -34
  64. package/docs/classes/WoSensorTHProCO2.html +34 -34
  65. package/docs/classes/WoSmartLock.html +37 -37
  66. package/docs/classes/WoSmartLockLite.html +37 -37
  67. package/docs/classes/WoSmartLockPro.html +39 -39
  68. package/docs/classes/WoSmartLockProWiFi.html +39 -39
  69. package/docs/classes/WoSmartLockVision.html +37 -37
  70. package/docs/classes/WoSmartLockVisionPro.html +39 -39
  71. package/docs/classes/WoSmartThermostatRadiator.html +40 -40
  72. package/docs/classes/WoStrip.html +43 -43
  73. package/docs/classes/WoStripLight3.html +43 -43
  74. package/docs/classes/WoVacuum.html +42 -42
  75. package/docs/classes/WoVacuumK10Plus.html +42 -42
  76. package/docs/classes/WoVacuumK10Pro.html +42 -42
  77. package/docs/classes/WoVacuumK10ProCombo.html +42 -42
  78. package/docs/classes/WoVacuumK11Plus.html +42 -42
  79. package/docs/classes/WoVacuumK20.html +42 -42
  80. package/docs/classes/WoVacuumS10.html +42 -42
  81. package/docs/classes/WoVacuumS20.html +42 -42
  82. package/docs/classes/WoWaterDetector.html +34 -34
  83. package/docs/enums/LogLevel.html +2 -2
  84. package/docs/enums/SwitchBotBLEModel.html +2 -2
  85. package/docs/enums/SwitchBotBLEModelName.html +2 -2
  86. package/docs/functions/updateBaseURL.html +1 -1
  87. package/docs/interfaces/APICommandRequest.html +2 -2
  88. package/docs/interfaces/APICommandResponse.html +2 -2
  89. package/docs/interfaces/APIDevice.html +2 -2
  90. package/docs/interfaces/APIDeviceStatus.html +2 -2
  91. package/docs/interfaces/APIErrorResponse.html +2 -2
  92. package/docs/interfaces/APIResponse.html +2 -2
  93. package/docs/interfaces/AirPurifierCommands.html +2 -2
  94. package/docs/interfaces/AirPurifierServiceData.html +13 -13
  95. package/docs/interfaces/AirPurifierStatus.html +7 -7
  96. package/docs/interfaces/BLEAdvertisement.html +5 -5
  97. package/docs/interfaces/BLEScanOptions.html +5 -5
  98. package/docs/interfaces/BLEServiceData.html +13 -13
  99. package/docs/interfaces/BlindTiltCommands.html +2 -2
  100. package/docs/interfaces/BlindTiltServiceData.html +13 -13
  101. package/docs/interfaces/BlindTiltStatus.html +6 -6
  102. package/docs/interfaces/BotCommands.html +2 -2
  103. package/docs/interfaces/BotServiceData.html +13 -13
  104. package/docs/interfaces/BotStatus.html +6 -6
  105. package/docs/interfaces/BulbCommands.html +2 -2
  106. package/docs/interfaces/BulbServiceData.html +13 -13
  107. package/docs/interfaces/BulbStatus.html +6 -6
  108. package/docs/interfaces/CeilingLightCommands.html +2 -2
  109. package/docs/interfaces/CeilingLightServiceData.html +13 -13
  110. package/docs/interfaces/CeilingLightStatus.html +6 -6
  111. package/docs/interfaces/CommandResult.html +6 -6
  112. package/docs/interfaces/ContactServiceData.html +13 -13
  113. package/docs/interfaces/ContactStatus.html +6 -6
  114. package/docs/interfaces/CurtainCommands.html +2 -2
  115. package/docs/interfaces/CurtainExtendedInfo.html +2 -2
  116. package/docs/interfaces/CurtainServiceData.html +13 -13
  117. package/docs/interfaces/CurtainStatus.html +6 -6
  118. package/docs/interfaces/DeviceInfo.html +18 -18
  119. package/docs/interfaces/DeviceListResponse.html +2 -2
  120. package/docs/interfaces/DeviceStatus.html +6 -6
  121. package/docs/interfaces/DiscoveryOptions.html +7 -7
  122. package/docs/interfaces/HubServiceData.html +13 -13
  123. package/docs/interfaces/HubStatus.html +6 -6
  124. package/docs/interfaces/HumidifierCommands.html +2 -2
  125. package/docs/interfaces/HumidifierServiceData.html +14 -14
  126. package/docs/interfaces/HumidifierStatus.html +6 -6
  127. package/docs/interfaces/KeypadStatus.html +6 -6
  128. package/docs/interfaces/LeakServiceData.html +13 -13
  129. package/docs/interfaces/LeakStatus.html +6 -6
  130. package/docs/interfaces/LockCommands.html +2 -2
  131. package/docs/interfaces/LockServiceData.html +14 -14
  132. package/docs/interfaces/LockStatus.html +6 -6
  133. package/docs/interfaces/MeterServiceData.html +13 -13
  134. package/docs/interfaces/MeterStatus.html +6 -6
  135. package/docs/interfaces/MotionServiceData.html +13 -13
  136. package/docs/interfaces/MotionStatus.html +6 -6
  137. package/docs/interfaces/PlugCommands.html +2 -2
  138. package/docs/interfaces/PlugServiceData.html +13 -13
  139. package/docs/interfaces/PlugStatus.html +6 -6
  140. package/docs/interfaces/PresenceServiceData.html +13 -13
  141. package/docs/interfaces/PresenceStatus.html +6 -6
  142. package/docs/interfaces/RelaySwitchCommands.html +2 -2
  143. package/docs/interfaces/RelaySwitchServiceData.html +13 -13
  144. package/docs/interfaces/RelaySwitchStatus.html +6 -6
  145. package/docs/interfaces/RemoteStatus.html +6 -6
  146. package/docs/interfaces/SceneListResponse.html +2 -2
  147. package/docs/interfaces/StripCommands.html +2 -2
  148. package/docs/interfaces/StripServiceData.html +13 -13
  149. package/docs/interfaces/StripStatus.html +6 -6
  150. package/docs/interfaces/SwitchBotConfig.html +15 -15
  151. package/docs/interfaces/VacuumCommands.html +2 -2
  152. package/docs/interfaces/VacuumStatus.html +6 -6
  153. package/docs/interfaces/WebhookConfig.html +2 -2
  154. package/docs/interfaces/WebhookDetails.html +2 -2
  155. package/docs/interfaces/WebhookQueryResponse.html +2 -2
  156. package/docs/interfaces/WebhookSetupResponse.html +2 -2
  157. package/docs/types/ConnectionType.html +1 -1
  158. package/docs/types/PhysicalDeviceType.html +1 -1
  159. package/docs/types/VirtualDeviceType.html +1 -1
  160. package/docs/variables/urls.html +1 -1
  161. package/package.json +1 -1
  162. package/todo/completed.md +15 -1
  163. package/todo/todo.md +0 -194
  164. package/todo/completed-task-5.4.md +0 -7
package/todo/todo.md CHANGED
@@ -1,195 +1 @@
1
- # Completed
2
-
3
-
4
1
  # TODO (Prioritized)
5
-
6
-
7
-
8
-
9
- ## ⭐ Medium Priority
10
-
11
- - `getCurrentTimeAndStartTime()` - For energy calculations
12
- - Command: `0x57 0x0F 0x51 0x01 0x05 0x01 0x00 0x00 0x00`
13
-
14
-
15
-
16
- # TODO: pySwitchBot Feature Parity Roadmap
17
-
18
- Implementation tasks to achieve feature parity with pySwitchBot.
19
-
20
- Last Updated: March 7, 2026
21
- Source: [PYSWITCHBOT_COMPARISON.md](./PYSWITCHBOT_COMPARISON.md)
22
-
23
- ---
24
-
25
- ## 📅 Phase 2: Command Enhancement (Q2 2026)
26
-
27
- ### 🤖 Bot (WoHand) Commands
28
-
29
- ### 🔒 Lock Commands
30
-
31
- ### Task 18.8: Implement key verification ✅
32
- **Completed: March 7, 2026**
33
- - Ensures users get immediate feedback on key validity before encrypted operations.
34
- - See PR/commit: Task 18.8 implementation, March 7, 2026.
35
-
36
-
37
- - ✅ Phase 2 completed. See `todo/completed.md` for completed task details.
38
-
39
- ---
40
-
41
-
42
- ✅ **Phase 3 completed!** All vacuum cleaners, lock variants, power/climate devices, lighting variants, and other devices implemented. See `todo/completed.md` for detailed task completion records.
43
-
44
- ---
45
- ## 📅 Phase 4: Advanced Features (Q4 2026)
46
-
47
-
48
- - ✅ Task 6.4 completed. See `todo/completed.md` for implementation details.
49
-
50
-
51
- ### 💧 Humidifier Commands
52
-
53
- - ✅ Task 7.1 completed. See `todo/completed.md` for implementation details.
54
-
55
- <!-- Task 7.2 moved to completed.md -->
56
-
57
-
58
- ### 🌬️ Air Purifier Commands
59
-
60
- <!-- Task 8.1 moved to completed.md -->
61
-
62
- <!-- Task 8.2 moved to completed.md -->
63
-
64
- ### 🔐 Encryption Enhancements
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
- <!-- Task 18.7 moved to completed.md -->
73
-
74
- - [x] **Task 18.8**: Implement key verification
75
- - `verifyEncryptionKey()` - Test key validity
76
- - Try commands with key before assuming valid
77
- - Better error messages for invalid keys
78
-
79
- ### 📊 Status & Response Parsing
80
-
81
- - [x] **Task 10.1**: Implement passive status from advertisements ✅
82
- - Parse device state from BLE advertisements
83
- - No connection needed for basic status
84
- - Cache last known state
85
-
86
- - [x] **Task 10.2**: Add sequence number tracking ✅
87
- - Monitor `sequence_number` in advertisements
88
- - Auto-trigger status update when sequence changes
89
- - Implement for: locks, relay switches, vacuums, air purifiers
90
-
91
-
92
-
93
-
94
-
95
- ### 🔗 Connection & Error Improvements
96
-
97
-
98
-
99
- - [x] **Task 19.4**: Enhance retry logic
100
- - DBus error backoff (0.25s)
101
- - `BLEAK_RETRY_EXCEPTIONS` handling
102
- - Better context in retry errors
103
-
104
- - [x] **Task 19.5**: Add response length validation ✅
105
- - Check minimum expected length
106
- - Throw errors for truncated responses
107
- - Include actual vs expected length in error
108
-
109
- - [x] **Task 20.3**: Implement command batching ✅
110
- - Queue multiple commands
111
- - Send in sequence on single connection
112
- - Share connection overhead
113
-
114
- - `_expected_disconnect` flag
115
- - Differentiate expected vs unexpected disconnects
116
- - Better error handling for unexpected disconnects
117
-
118
- - Per-command notification futures
119
- - Timeout handling (5s default)
120
- - Log unsolicited notifications
121
-
122
- - Cache read/write characteristics
123
- - Clear cache on characteristic missing error
124
- - Avoid repeated characteristic discovery
125
- ### 🎯 Advanced Patterns
126
-
127
-
128
-
129
-
130
-
131
- ---
132
-
133
- ## 📈 Medium Priority Enhancements
134
-
135
- ## 🏆 High Priority
136
-
137
- - [ ] **Task 1.4**: Enhance advertisement data structure
138
- - Add `rawAdvData` field
139
- - Add `isEncrypted` flag
140
- - Add `modelFriendlyName` field
141
-
142
- - [ ] **Task 1.5**: Add advertisement data merging
143
- - Preserve old values when new data is None
144
- - Recursive dict merging for nested structures
145
- - Implement `_merge_data()` helper
146
-
147
- ## ⭐ Medium Priority
148
-
149
- - [ ] **Task 5.4**: Add time/energy tracking
150
- - `getCurrentTimeAndStartTime()` - For energy calculations
151
- - Command: `0x57 0x0F 0x51 0x01 0x05 0x01 0x00 0x00 0x00`
152
-
153
-
154
- ### Status Parsing
155
-
156
-
157
- ---
158
-
159
- ## 🎯 Success Metrics
160
-
161
- - **Feature Parity**: 90%+ of pySwitchBot commands implemented
162
- - **Device Coverage**: 95%+ of SwitchBot device types supported
163
- - **Status Accuracy**: Advertisement-based status for all devices
164
- - **Connection Efficiency**: 50% reduction in connection overhead via batching
165
- - **Error Clarity**: Specific error types for all failure modes
166
-
167
- ---
168
-
169
- ## 📝 Notes
170
-
171
- ### Task Completion Process
172
- 1. Move completed task from this file to `completed.md`
173
- 2. Add completion date and any notes
174
- 3. Update "Last Updated" timestamp
175
- 4. Reference any relevant PRs or commits
176
-
177
- ### Priority Levels
178
- - **High Priority**: Core functionality, user-facing features
179
- - **Medium Priority**: Enhancements, optimizations
180
- - **Low Priority**: Nice-to-have features
181
-
182
- ### Reference
183
- - Full comparison details: [PYSWITCHBOT_COMPARISON.md](../PYSWITCHBOT_COMPARISON.md)
184
- - pySwitchBot Repository: https://github.com/Danielhiversen/pySwitchbot
185
- - SwitchBot BLE API: https://github.com/OpenWonderLabs/SwitchBotAPI-BLE
186
-
187
- ---
188
-
189
- ## 📋 Todo List
190
-
191
- - [x] Enhance retry logic: DBus backoff, BLEAK exceptions, error context
192
- - [x] Add/expand tests for retry logic (DBus, BLEAK, error context)
193
- - [x] Add response length validation (min length, error for truncated, actual vs expected)
194
- - [x] Implement command batching (queue, sequence, share connection)
195
- - [x] Implement expected disconnect tracking (track disconnects that are expected as part of command flow)
@@ -1,7 +0,0 @@
1
- ### Task 5.4: Add time/energy tracking ✅
2
- **Completed: March 7, 2026**
3
- **Implementation Details:**
4
- - Implemented `getCurrentTimeAndStartTime()` in WoRelaySwitch1 to send BLE command `0x57 0x0F 0x51 0x01 0x05 0x01 0x00 0x00 0x00` and parse the response for current time, start time, and energy.
5
- - Updated `RelaySwitchCommands` type in `src/types/device.ts` to include the new method.
6
- - Validated by full build (`npm run build`), lint (`npm run lint`), and test (`npm run test`) cycle: all passed with no errors.
7
- - See PR/commit: Task 5.4 implementation, March 7, 2026.