Metadata-Version: 2.1
Name: pykonkeio
Version: 2.1.5
Summary: Python library for interfacing with konke smart appliances
Home-page: https://github.com/jedmeng/python-konkeio
Author: jedmeng
Author-email: jedm@jedm.cn
License: GPLv3
Description: # KonkeIO
        This library (and its accompanying cli tool) is used to interface with
        Konke remote-control devices.
        
        ## Supported Devices
        Since some of Konke's device does not have a clear model, I used internal code to identify it.
        
        ### Socket
        - Smart Plug K `k1`
        - K2 / K2 Pro `k2`
        - Mini K / Mini Pro `minik`
        
        ### Power Strip
        - The normal one `micmul`
        - The Standing one with USB support `mul`
        
        ### Light
        - KLight (LED with RGB color) `klight`
        - KBulb `kbulb`
        
        ## Install
        
        ```bash
            pip install pykoneio
        ```
        
        ## API Reference
        
        ### classes and methods
        - K1(ip)
            - is_online
            - status
            - update()
            - turn_on()
            - turn_off()
        - K2(ip)
            - is_online
            - status
            - update()
            - turn_on()
            - turn_off()
            - turn_on_usb()
            - turn_off_usb()
            - turn_on_light()
            - turn_off_light()
            - is_support_ir()
            - ir_learn()
            - ir_quit()
            - ir_emit()
            - ir_remove()
            - ir_remove_group()
            - is_support_rf()
            - rf_learn()
            - rf_quit()
            - rf_emit()
            - rf_remove()
            - rf_remove_group()
        - MinK(ip)
            - is_online
            - status
            - update()
            - turn_on()
            - turn_off()
            - is_support_ir()
            - ir_learn()
            - ir_quit()
            - ir_emit()
            - ir_remove()
            - ir_remove_group()
        - Mul(ip)
            - is_online
            - status[]
            - usb_status[]
            - update()
            - turn_on(index)
            - turn_off(index)
            - turn_on_all()
            - turn_off_all()
            - turn_on_usb(index)
            - turn_off_usb(index)
        - MicMul(ip)
            - is_online
            - status[]
            - update()
            - turn_on(index)
            - turn_off(index)
            - turn_on_all()
            - turn_off_all()
        - KLight(ip)
            - is_online
            - status
            - color
            - brightness
            - update()
            - turn_on()
            - turn_off()
            - set_color()
            - set_brightness()
        - KBulb
            - is_online
            - status
            - ct
            - brightness
            - update()
            - turn_on()
            - turn_off()
            - set_ct()
            - set_brightness()
        
        Demo:
        
        ```python
        
            from pykonkeio import K2
        
            k2 = K2('192.168.0.222')
        
            if not k2.is_online:
                print('switch is off line')
            if k2.status == 'open':
                k2.turn_off()
            elif k2.status == 'close':
                k2.turn_on()
        ```
        
        ## CLI Command
        
        ```bash
        usage: konkeio [action] [device] [address] [value] [--verbose]
        
        Supported devices and actions supported by each device:
        global: search
        k2:     get_status turn_[on/off] turn_[on/off]_usb turn_[on/off]_light
        minik:  get_status turn_[on/off]
        micmul: get_count get_status_all get_status[1/2/3/4] turn_[on/off]_all turn_[on/off]_socket[1/2/3/4]
        mul:    get_count get_status_all get_status[1/2/3] get_usb_count get_usb_status_all get_usb_status[1/2]
                turn_[on/off]_all turn_[on/off]_socket[1/2/3] turn_[on/off]_usb[1/2]
        klight: get_status get_brightness get_color turn_[on/off] set_brightness set_color
        kbulb:  get_status get_brightness get_ct turn_[on/off] set_brightness set_ct
        
        * each action starts with 'set_' must provide a value parameter
        value format:
        color:      r,g,b
        ct:         2700-6500
        brightness: 0-100
        
        example:
        konkeio search
        konkeio turn_on minik 192.168.0.64
        konkeio get_status minik 192.168.0.64
        konkeio turn_on_usb k2 192.168.0.64
        konkeio turn_off_light k2 192.168.0.64
        konkeio get_count micmul 192.168.0.64
        konkeio turn_on_socket3 micmul 192.168.0.64
        konkeio get_status2 mul 192.168.0.64
        konkeio turn_off_all mul 192.168.0.64
        konkeio get_brightness klight 192.168.0.64
        konkeio set_color klight 192.168.0.64 255,255,0
        konkeio set_ct kbulb 192.168.0.64 3400
        konkeio turn_off bulb 192.168.0.64
        ```
Keywords: konke,iot
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
