python-miio icon indicating copy to clipboard operation
python-miio copied to clipboard

deprecated api documentation

Open DoganM95 opened this issue 2 years ago • 2 comments

Describe the bug The api docs are deprecated. https://github.com/rytilahti/python-miio#api-usage from miio import Vacuum does not work, as Vacuum does not esxist

Version information:

  • OS: Win 10
  • python-miio: 0.5.11

To Reproduce Steps to reproduce the behavior:

  1. Try initializing a device instance as described in https://github.com/rytilahti/python-miio#api-usage

Expected behavior Should know the class and methods of e.g. Vacuum

Console output cannot import name 'Vacuum' from 'miio'

DoganM95 avatar Mar 22 '22 18:03 DoganM95

Use RoborockVacuum for roborock vacuums, the example usage should be updated but I'd rather have it done after #1328 is in place to make it generic for all devices.

rytilahti avatar Mar 24 '22 15:03 rytilahti

I am using a dreame vacuum, but RoborockVacuum also seems to not exist.

DoganM95 avatar Mar 27 '22 21:03 DoganM95

https://github.com/rytilahti/python-miio#api-usage now points to use DeviceFactory for constructing device instances.

rytilahti avatar Jul 19 '23 01:07 rytilahti

Its also worth mentioning that DeviceFactory does not exist in the pip version yet, and only exists in the github version.

Following is the list of attributes for the current pip version:

['AirConditionerMiot', 'AirConditioningCompanion', 'AirConditioningCompanionMcn02', 'AirConditioningCompanionV3', 'AirDehumidifier', 'AirDogX3', 'AirFresh', 'AirFreshA1', 'AirFreshT2017', 'AirHumidifier', 'AirHumidifierJsq', 'AirHumidifierJsqs', 'AirHumidifierMiot', 'AirHumidifierMjjsq', 'AirPurifier', 'AirPurifierMiot', 'AirQualityMonitor', 'AirQualityMonitorCGDN1', 'AqaraCamera', 'Ceil', 'ChuangmiCamera', 'ChuangmiIr', 'ChuangmiPlug', 'CleaningDetails', 'CleaningSummary', 'CloudInterface', 'ConsumableStatus', 'Cooker', 'CurtainMiot', 'DNDStatus', 'Device', 'DeviceError', 'DeviceException', 'DeviceInfo', 'DeviceStatus', 'Discovery', 'DreameVacuum', 'EventInfo', 'Fan', 'Fan1C', 'FanLeshow', 'FanMiot', 'FanP5', 'FanZA5', 'G1Vacuum', 'Gateway', 'Heater', 'HeaterMiot', 'Huizuo', 'HuizuoLampFan', 'HuizuoLampHeater', 'HuizuoLampScene', 'Message', 'MiotDevice', 'PetWaterDispenser', 'PhilipsBulb', 'PhilipsEyecare', 'PhilipsMoonlight', 'PhilipsRwread', 'PhilipsWhiteBulb', 'PowerStrip', 'PushServer', 'PwznRelay', 'RoborockVacuum', 'RoidmiVacuumMiot', 'ScishareCoffee', 'Timer', 'Toiletlid', 'Utils', 'VacuumException', 'VacuumStatus', 'ViomiVacuum', 'Walkingpad', 'WaterPurifier', 'WaterPurifierYunmi', 'WifiRepeater', 'WifiSpeaker', 'Yeelight', 'YeelightDualControlModule', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__version__', 'airconditioner_miot', 'airconditioningcompanion', 'airconditioningcompanionMCN', 'airdehumidifier', 'airqualitymonitor', 'airqualitymonitor_miot', 'alarmclock', 'aqaracamera', 'chuangmi_camera', 'chuangmi_ir', 'chuangmi_plug', 'click_common', 'cloud', 'cooker', 'curtain_youpin', 'device', 'deviceinfo', 'discovery', 'exceptions', 'fan_common', 'gateway', 'heater', 'heater_miot', 'huizuo', 'integrations', 'interfaces', 'miioprotocol', 'miot_device', 'powerstrip', 'protocol', 'push_server', 'pwzn_relay', 'scishare_coffeemaker', 'toiletlid', 'updater', 'utils', 'version', 'walkingpad', 'waterpurifier', 'waterpurifier_yunmi', 'wifirepeater', 'wifispeaker', 'yeelight_dual_switch']

While this is for the current github version:

['AirConditionerMiot', 'AirConditioningCompanion', 'AirConditioningCompanionMcn02', 'AirConditioningCompanionV3', 'AirDehumidifier', 'AirDogX3', 'AirFresh', 'AirFreshA1', 'AirFreshT2017', 'AirHumidifier', 'AirHumidifierJsq', 'AirHumidifierJsqs', 'AirHumidifierMiot', 'AirHumidifierMjjsq', 'AirPurifier', 'AirPurifierMiot', 'AirQualityMonitor', 'AirQualityMonitorCGDN1', 'AqaraCamera', 'Ceil', 'ChuangmiCamera', 'ChuangmiIr', 'ChuangmiPlug', 'CloudDeviceInfo', 'CloudException', 'CloudInterface', 'Cooker', 'CurtainMiot', 'Device', 'DeviceError', 'DeviceException', 'DeviceFactory', 'DeviceInfo', 'DeviceStatus', 'Discovery', 'DreameVacuum', 'EventInfo', 'Fan', 'Fan1C', 'FanLeshow', 'FanMiot', 'FanP5', 'FanZA5', 'G1Vacuum', 'Gateway', 'GenericMiot', 'Heater', 'HeaterMiot', 'Huizuo', 'HuizuoLampFan', 'HuizuoLampHeater', 'HuizuoLampScene', 'Message', 'MiotDevice', 'PetWaterDispenser', 'PhilipsBulb', 'PhilipsEyecare', 'PhilipsMoonlight', 'PhilipsRwread', 'PhilipsWhiteBulb', 'PowerStrip', 'Pro2Vacuum', 'PushServer', 'PwznRelay', 'RoborockVacuum', 'RoidmiVacuumMiot', 'ScishareCoffee', 'Toiletlid', 'UnsupportedFeatureException', 'Utils', 'ViomiDishwasher', 'ViomiVacuum', 'Walkingpad', 'WaterPurifier', 'WaterPurifierYunmi', 'WifiRepeater', 'WifiSpeaker', 'Yeelight', 'YeelightDualControlModule', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__version__', 'click_common', 'cloud', 'descriptors', 'device', 'devicefactory', 'deviceinfo', 'devicestatus', 'discovery', 'exceptions', 'identifiers', 'integrations', 'miioprotocol', 'miot_cloud', 'miot_device', 'miot_models', 'protocol', 'push_server', 'updater', 'utils', 'version']

ignis-sec avatar Aug 02 '23 13:08 ignis-sec