Metadata-Version: 1.1
Name: duco.ducobox
Version: 0.0.3
Summary: Read parameters from DucoBox.
Home-page: https://github.com/SteinHeselmans/DucoBox
Author: Stein Heselmans
Author-email: stein.heselmans@gmail.com
License: Apache License, Version 2.0
Description-Content-Type: UNKNOWN
Description: .. image:: https://img.shields.io/hexpm/l/plug.svg
            :target: http://www.apache.org/licenses/LICENSE-2.0
            :alt: Apache2 License
        
        .. image:: https://travis-ci.org/SteinHeselmans/DucoBox.svg?branch=master
            :target: https://travis-ci.org/SteinHeselmans/DucoBox
            :alt: Build status
        
        .. image:: https://codecov.io/gh/SteinHeselmans/DucoBox/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/SteinHeselmans/DucoBox
            :alt: Code Coverage
        
        .. image:: https://codeclimate.com/github/SteinHeselmans/DucoBox/badges/gpa.svg
            :target: https://codeclimate.com/github/SteinHeselmans/DucoBox
            :alt: Code Climate Status
        
        .. image:: https://codeclimate.com/github/SteinHeselmans/DucoBox/badges/issue_count.svg
            :target: https://codeclimate.com/github/SteinHeselmans/DucoBox
            :alt: Issue Count
        
        .. image:: https://requires.io/github/SteinHeselmans/DucoBox/requirements.svg?branch=master
            :target: https://requires.io/github/SteinHeselmans/DucoBox/requirements/?branch=master
            :alt: Requirements Status
        
        .. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
            :target: https://github.com/SteinHeselmans/DucoBox/issues
            :alt: Contributions welcome
        
        
        =======
        DucoBox
        =======
        
        Script to monitor a Duco ventilation system.
        
        
        ------------
        Installation
        ------------
        
        Every release is uploaded to pip so it can be installed simply by using pip.
        
        .. code-block:: bash
        
            # Python2
            pip2 install duco.ducobox
        
            # Python3
            pip3 install duco.ducobox
        
        
        -----
        Usage
        -----
        
        After installation, the python module is available
        
        - as executable, to launch from terminal:
        
        .. code-block:: bash
        
        	ducobox --help
        
        - as python module, to launch from terminal:
        
        .. code-block:: bash
        
        	python -m duco.ducobox --help
        
        - as python module, to import in your script:
        
        .. code-block:: python
        
        	import duco.ducobox as duco
        
        --------------------
        Stored configuration
        --------------------
        
        The network configuration of your setup is stored in an ini-file. If the network configuration file is not found,
        it is created.
        
        The script first tries to find all of the nodes in the network, by executing the *network* command. It creates
        objects for all of the found nodes. If nodes are found, the network configuration is saved to the provided
        network configuration file.
        
        The network configuration file gives an overview of all the nodes with their specific parameters. The *name* of
        every node can be adapted by the user, in order to easily recognize the nodes. The rest of the fields should not
        be adapted outside the script.
        
        -----
        Hints
        -----
        
        Serial cable details
        ====================
        
        TODO: provide serial cable details
        
        Allowing non-root user to access serial port (Ubuntu, Linux)
        ============================================================
        
        1. Add user to dialout group:
        
        .. code-block:: bash
        
            adduser <username> dialout
        
        2. Use udev to allow users of dialout group to serial device
        
        Content for /etc/udev/rules.d/50-ttyusb.rules
        
        .. code-block:: bash
        
            SUBSYSTEM=="tty", KERNEL=="ttyUSB0", GROUP="dialout", MODE="0660"
        
        3. Reboot
        
        .. code-block:: bash
        
            reboot
        
        -----------
        Limitations
        -----------
        
        The main contributor to this project has a limited Duco ventilation system, with not too much devices:
        
        - DucoBox Silent
        - Humidity box sensor
        - Remote control on battery
        
        The python module was not tested on other devices, allthough some effort was done in order to support them.
        
        -----------------------
        Issues and new Features
        -----------------------
        
        In case you have any problems with usage of the plugin, please open an issue
        on GitHub. Provide as many valid information as possible, as this will help us
        to resolve Issues faster. We would also like to hear your suggestions about new
        features which would help your Continuous Integration run better.
        
        ----------
        Contribute
        ----------
        
        There is a Contribution guide available if you would like to get involved in
        development of the plugin. We encourage anyone to contribute to our repository.
        Missing a feature or node, but you're not sure how to start with it? Create an issue.
        
Keywords: Duco,DucoBox,DucoBox Silent,ventilation,home automation
Platform: any
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Home Automation
