Conversation
…lineStatus and webhook doorState
…ok, fix deleteKey trailing space
…example deviceType
…iceId description
Contributor
Author
Open question: documented fields that were never observedThe following fields are documented but never appeared in any response or webhook from my devices. I have not removed them in this PR because absence alone is not proof. Could you confirm whether they should be removed, or whether the condition under which they are returned (firmware version, device configuration, trigger source) should be noted?
If any of these are confirmed obsolete I am happy to remove them in a follow-up commit. |
Contributor
Author
|
Pushed two more commits based on a new capture (2026-09-15/16, same devices):
No other differences from the documentation were found in the new capture. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I verified the documentation against actual API responses and webhook payloads captured from real devices (29 physical device types I own, covering device list, status polling, and webhook
changeReportevents), and fixed the differences that were directly observed.Methodology
GET /devices,GET /devices/{id}/status, and webhook payloads from real devices over roughly a day, plus targeted status polling.jammed, event-dependent fields such asoverload) were left untouched.Notable fixes
Smart Lock Ultra) and webhook (Lock Ultra) were documented the other way around;lockState/doorStatevalues corrected to the observed past-participle forms (unlocked/closed); missingonlineStatus(status) anddoorState(webhook) added.detectionState/pressfields. Observed payloads use nestedhumanEvent/ringEvent/motionEventobjects ({detectionType, eventTime, id, img}); the section was rewritten accordingly.WoCamKvs5mp, nestedmotionEvent/humanEvent); documented both and updated the support table.switch1Status/switch2Status(only the changed switch is included) andtimeOfSampleis present; the table/example were inconsistent with each other and with observed payloads.doorState,brightness) added.detected(lowercase, wasDetected), and the webhook example deviceType wasWoContact.voltage/power/usedElectricity/electricCurrent, always0since the device has no power monitoring.online(Boolean), which was undocumented; also added missing status fields (power,onlineStatus,colorTemperature) and fixed a wrong webhook example deviceType (RGBICWW Strip Light→RGBIC Wire Neon Rope Light).slidePositionis a number, not a String.chargingStatus/hubDeviceIdand wrongnightStatustype in the webhook table.batteryandversion. Observed webhooks include undocumentedkeyName/battery, and the"deleteKey "trailing space in the example was confirmed to be a typo.New device documentation
Outdoor PTC 3K; webhook deviceTypeW1156000with nestedhumanEvent/motionEvent.remote with screen(all lowercase); status returnsversion/battery/chargingStatus.body.deviceTypekey; status responds with an emptybody.All observed sample payloads were captured with SwitchBot API v1.1 on 2026-07-22/23 (JP region).