Skip to content

Split and organize SwitchBot API v1.1 documentation by device#472

Merged
Minsheng merged 1 commit into
OpenWonderLabs:mainfrom
hsakoh:feature/split_by_device
Jul 23, 2026
Merged

Split and organize SwitchBot API v1.1 documentation by device#472
Minsheng merged 1 commit into
OpenWonderLabs:mainfrom
hsakoh:feature/split_by_device

Conversation

@hsakoh

@hsakoh hsakoh commented Mar 6, 2026

Copy link
Copy Markdown
Contributor

Overview

Restructured the large SwitchBot API v1.1 specification into a modular, device-specific and categorized document structure.

Key Changes

  • Document Splitting: Decomposed monolithic spec into 75 device-specific + 1 common documentation files
  • Category Organization: Introduced 12-category folder structure (locks-security, lighting, climate-control, etc.)

Benefits

  • Maintainability: Modular structure makes updates easier
  • Searchability: Device-specific files enable quick information retrieval
  • Scalability: Auto-classification & categorization for new devices

Is this approach acceptable?

For a visual preview, please check the branch directly.

@hsakoh

hsakoh commented Apr 17, 2026

Copy link
Copy Markdown
Contributor Author

@Minsheng
Could you please take a look at this PR when you have time?

@hsakoh
hsakoh force-pushed the feature/split_by_device branch from 952077d to 8ba15c3 Compare May 16, 2026 03:40
@hsakoh

hsakoh commented May 16, 2026

Copy link
Copy Markdown
Contributor Author

I have rebased onto the latest main (commit 0214825) and force-pushed this branch to incorporate the four newly added devices:

  • Weather Station — device list, status, control commands, and webhook events
  • Lock Pro Matter Enabled — device list (with status JSON example), status, control commands (lock, unlock, nightLatchUnlock, deadbolt), and webhook events
  • Lock Vision — device list (with passcode keyList), status, control commands (lock, unlock, createKey, deleteKey), and webhook events
  • Lock Vision Pro — same structure as Lock Vision

Each device has been split into its own dedicated Markdown file following the same structure as the existing device pages, and the Glossary and Device Specifications table in README.md have been updated accordingly.

@hsakoh
hsakoh force-pushed the feature/split_by_device branch from 8ba15c3 to e36d61b Compare May 16, 2026 03:52
@hsakoh

hsakoh commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

#490

@oneroproduct

Copy link
Copy Markdown

#490

Thanks for taking the initiative! It's true that the document becomes absurdly long. I think it's time to do some reorganizaiton on our end too.

@oneroproduct oneroproduct left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merge folder restructuring

@Minsheng

Copy link
Copy Markdown
Collaborator

Reviewed and good to go.

@Minsheng
Minsheng merged commit f6d1b9a into OpenWonderLabs:main Jul 23, 2026
hsakoh added a commit to hsakoh/SwitchBotAPI that referenced this pull request Jul 24, 2026
The split branch (OpenWonderLabs#472) was authored against 9764a7c and rebased onto
0214825; the wholesale README rewrite dropped some of 0214825's changes
and one Lock Lite command:

- README: add Weather Station, Lock Pro Matter Enabled, Lock Vision and
  Lock Vision Pro to the physical device list (the `new` tag now
  belongs to the July 2026 products added in 9ec540a)
- Lock Lite: restore the deadbolt command
- Plug Mini (EU) / Meter Plus: use WoPlugEU / WoMeterPlus in webhook
  event examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants