Metadata-Version: 2.1
Name: micropython-octopuslab-installer
Version: 0.2.0
Summary: OctopusLab installer for MicroPython
Home-page: https://github.com/octopusengine/octopuslab-installer
Author: OctopusLAB
Author-email: info@octopuslab.cz
License: UNKNOWN
Description: # OctopusLab Init Lite
        
        This module facilitates installation of OctopusLab MicroPython tools. We use it on ESP32 boards (all examples bellow), but it may work on other MicroPython ports as well.
        
        ## How to use?
        
        Bootstrap your ESP32 with latest MicroPython [documentation](https://docs.micropython.org/en/latest/esp32/tutorial/intro.html#esp32-intro)
        
        ```
        esptool.py --port /dev/ttyUSB0 erase_flash
        esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash -z 0x1000 esp32-idf3-20200902-v1.13.bin
        screen /dev/ttyUSB0 115200
        ```
        
        Connect to WiFi
        ```
        import network
        wlan = network.WLAN(network.STA_IF)
        wlan.active(True)
        wlan.connect('essid', 'password')
        ```
        
        Install
        ```
        import upip
        upip.install('micropython-octopuslab-installer')
        from octopuslab_installer import deploy
        deploy()
        ```
        
        After this OctopusLab from `https://octopusengine.org/download/micropython/stable.tar` is installed in your ESP **don't forget to reboot**.
        
        Please proceed with inital configuration of your OctopusLab enabled board as per [documentation](https://docs.octopuslab.cz/install/#setup-nastaveni-systemu)
        
        ## Alternative images
        
        You may like to install an image from your custom location.
        
        ```
        from octopuslab_installer import deploy
        deploy('http://192.168.1.100:8000/latest.tar')
        ```
        
        Optionally you may store downloaded image for later offline restore. Also you may use wifi connection shortcut
        
        ```
        from octopuslab_installer import connect, deploy
        connect('myssid', 'mypass')
        deploy('https://www.dtlab.cz/downloads/sensobox/latest.tar', '/img/latest.tar')
        ```
        
        Then you may deploy offline from local file. 
        
        from octopuslab_installer import deploy
        deploy('/img/latest.tar')
        
        
        # Build and publish new version of this module
        
        ```
        # initial setup of build environment
        git clone git@github.com:octopusengine/octopuslab-installer.git
        cd octopuslab-installer/
        python3 -m venv venv
        source ./venv/bin/activate
        pip install --upgrade wheel setuptools
        
        # PyPi publisher and authorisation
        pip install --upgrade twine
        mcedit ~/.pypirc
        chmod o-rwx ~/.pypirc
        
        # build command
        python setup.py sdist
        
        # publish
        twine upload -r pypi dist/*
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.6
Description-Content-Type: text/markdown
