kzosabe / switchbot-client Goto Github PK

• https://github.com/OpenWonderLabs/SwitchBotAPI#about-the-new-version

• OpenWonderLabs/SwitchBotAPI@e236be6

• Make the implementation of switchbot-client version 0.4 follow the latest specification of switchbot api v1.0

• Create switchbot-client version 1.0 to conform to switchbot api v1.1 specifications

• Address any incompatible changes that need to be made when updating to 1.0

air_conditioner.set_all(
    temperature=25,
    mode=AirConditioner.Parameters.MODE_DRY,
    fan_speed=AirConditioner.Parameters.FAN_SPEED_AUTO,
    power=AirConditioner.Parameters.POWER_ON
)

to

air_conditioner.set_temperature(25)
air_conditioner.set_mode(AirConditioner.Parameters.MODE_DRY)

• generate methods get state and set single value
• store current state in object (if needed, or use builder-pattern)

• use same name as official api

• Add device definitions to support official API changes
  OpenWonderLabs/SwitchBotAPI@053bbd4

• All SwitchBotDevice subclasses should implement status() method which returns Status object including device specific columns

• https://github.com/OpenWonderLabs/SwitchBotAPI#webhook
  • Add new APIs
    • v1.0/webhook/setupWebhook
    • v1.0/webhook/queryWebhook
    • v1.0/webhook/updateWebhook
    • v1.0/webhook/deleteWebhook
  • Add some codes which is useful to receive webhooks if needed

• https://switchbot-client.readthedocs.io/en/latest/

https://docs.python.org/ja/3/library/tkinter.html

• use token from ~/.config/switchbot-client/config.yml
• call api/devices on launch
• show buttons for each commands

The latest available version is 0.4.1 and does not support the new two-key authentication system. I've seen some devs made to support this new API. Is a new version of this Python package planned?

• Add SwitchBotClient class as wrapper of SwitchBotAPIClient
• Add SwitchBotClient#get_devices
  • call SwitchBotAPIClient#devices
  • merge deviceList and infraredRemoteList
  • generate SwitchBotDevice and SwitchBotRemoteDevice instance
  • returns list contains these instances

Hello @kzosabe and thank you very much for open-sourcing this library. I would like to use it to read the current temperature and humidity of my Meter Plus devices but it always throws an error as soon as I call the SwitchBotClient.devices method. The error is a TypeError with the message invalid physical device object.

Looking through the source, I see that you instantiate the device objects based on the deviceType which is MeterPlus in my case. Your DeviceType does not have this value but a Meter Plus (US) and a Meter Plus (JP). Just changing one of the Enum values to MeterPlus makes it work perfectly.

Looking at the Meter Plus devices section in the SwitchBot API docs it seems to me that the current values Meter Plus (US) and Meter Plus (JP) are simply incorrect and you only need the MeterPlus type like with Meter, no separate MeterPlusUs and MeterPlusJp

• Currently, only have the manipulate commands
• Better to implement methods to return device info using devices/status