OpenWonderLabs / SwitchBotAPI-BLE

SwitchBot BLE open API
98 stars 9 forks source link

Add Lock BLE API documentation #13

Closed Minsheng closed 1 year ago

Minsheng commented 1 year ago

:recycle: Current situation

Describe the current situation. Explain current problems, if there are any. Be as descriptive as possible (e.g., including examples or code snippets).

:bulb: Proposed solution

Describe the proposed solution and changes. How does it affect the project? How does it affect the internal structure (e.g., refactorings)?

:gear: Release Notes

Provide a summary of the changes or features from a user's point of view. If there are breaking changes, provide migration guides using code examples of the affected features.

:heavy_plus_sign: Additional Information

If applicable, provide additional context in this section.

Testing

Which tests were added? Which existing tests were adapted/changed? Which situations are covered, and what edge cases are missing?

Reviewer Nudging

Where should the reviewer start? what is a good entry point?

Minsheng commented 1 year ago

We have released the BLE broadcast definition for SwitchBot Lock. It now supports get the state of Lock, get the state of door, and get the state of battery.