Metadata-Version: 2.1
Name: NanoLeafDiscovery
Version: 0.1.0
Summary: Discovery module for nanoleaf
Home-page: https://github.com/NotBlue-Dev/NanoLeaf-Discovery
Author: NotBlue
Author-email: 
License: MIT
Description: # Nanoleaf Discovery
        
        Nanoleaf Discovery is a Python library to discover every nanoleaf device on the network, the others api use the ssdp protocol to find the nanoleafs, the drawback is that it doesn't work every time so I used the api that the official nanoleaf app uses to find the nanoleafs, this one always works /!\ except with a vpn /!\
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Nanoleaf Discovery
        
        ```bash
        pip install NanoLeafDiscovery
        ```
        
        Or [here](https://pypi.org/project/NanoLeafDiscovery/0.0.2/) 
        
        /!\ REQUIRE [SOCKET] AND [REQUESTS](https://pypi.org/project/requests/) /!\ 
        
        
        ## Options
        You can manage different parameters :
        
        | Options | What it does | Value |
        | ------- | ------------ | ------- |
        | ip | Display IPV4 | True/False |
        | name | Display Nanoleaf Name | True/False |
        | type | Display Canvas/Shape/Aurora | True/False |
        | ipv6 | Display IPV6 | True/False |
        | ssid | Display the ssid | True/False |
        | bssid | Display the bssid | True/False |
        | timeout | Request time before timeout | Int |
        | _id | ID of the nanoleaf | True/False |
        | debug | If error display it  | True/False |
        
        ## Usage
        
        ```python
        from NanoLeafDiscovery import nano
        
        nano.discover() # returns [{'ip': '192.168.1.1'}]
        nano.discover(name=True) # returns [{'ip': 192.168.1.1, 'name': 'Canvas-f77e'}]
        nano.discover(name=True, type=True, ip=False) # returns [{'name': 'Canvas-f77e', 'type':'Canvas'}]
        ```
        
        
        
        ## License
        [GitHub Repo](https://github.com/NotBlue-Dev/NanoLeaf-Discovery)
        [MIT](https://choosealicense.com/licenses/mit/)
        
        Change Log
        ==========
        
        0.0.4 (10/01/2020)
        ------------------
        - Update Readme
Keywords: nanoleaf
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
