Skip to content

Correct errors in the newly added device. #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

hsakoh
Copy link

@hsakoh hsakoh commented May 1, 2025

This pull request includes corrections for multiple errors in the API documentation.

The corrections fall into the following three categories:

  • Type1: Corrections of clear errors that have been confirmed by checking the actual device's API behavior.
    • (It is possible that the error lies not in the documentation, but that the API implementation is not functioning as intended.)
  • Type2: Corrections of clear errors that can be inferred from the product's functionality or discrepancies in Webhook/Status.
  • Type3: Corrections that seem appropriate due to suspected typographical errors, but need verification as the actual device is not available.

Correction details

@Minsheng Could you review this pull request?

hsakoh added 10 commits May 2, 2025 00:34
  * Remove the `waterLevel` property.
  It seems this was forgotten when copying from the S10 model.
  * Remove the `drying` property.
  * Modify the description of the `mode` property to match the Status API.
  These changes appear to have been overlooked when copying from the Evaporative Humidifier (Auto-refill) model.
  * mod `DeviceType`(estimated value)
  * Match the table with the example.
  * Remove waterBaseBattery from the example, as it appears to be an obvious mistake.
  * mod `DeviceType`(estimated value)
   * Add response table based on estimated values, as response table does not exist.
   * Change the data type of the `voltage` and `power` fields from integer to float.
   * Change the data type of the `switch_Voltage` and `switch_Power` fields from integer to float.
   * Adjust the case sensitivity of the status fields to match the actual API specifications, e.g., `switch1usedElectricity` to `switch1UsedElectricity`.
   * Remove field `calibrate`,`position`,`isStuck`
   * Add the `hubDeviceId` field for each device.
   * Add argument(channnel) to the `turnOff` command
   * Change the argument transmission method for the `setMode` command from comma-separated to semicolon-separated
   * Remove the `setPosition` command
    * fix DeviceType `LED Strip Light3` -> `Strip Light3`
* `Get device status` response for RGBWW Strip Light 3
    * fix DeviceType `LED Strip Light3` -> `Strip Light3`
    * remove `online` field
   * Change the field name of `online` to `onlineStatus`.
@Minsheng
Copy link
Collaborator

I will let my colleagues review the corrections. Thanks!

   * Re-add field `calibrate`,`position`,`isStuck`
* `Send device control commands` for Relay Switch 2PM
   * Re-add the `setPosition` command
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.

3 participants