Skip to main content

Read parameters from DucoBox.

Project description

Apache2 License Build status Code Coverage Code Climate Status Issue Count Requirements Status 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.

# Python2
pip2 install duco.ducobox

# Python3
pip3 install duco.ducobox

Usage

After installation, the python module is available

  • as executable, to launch from terminal:

ducobox --help
  • as python module, to launch from terminal:

python -m duco.ducobox --help
  • as python module, to import in your script:

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:

adduser <username> dialout
  1. Use udev to allow users of dialout group to serial device

Content for /etc/udev/rules.d/50-ttyusb.rules

SUBSYSTEM=="tty", KERNEL=="ttyUSB0", GROUP="dialout", MODE="0660"
  1. Reboot

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

duco.ducobox-0.0.3.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

duco.ducobox-0.0.3-py2.py3-none-any.whl (10.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file duco.ducobox-0.0.3.tar.gz.

File metadata

  • Download URL: duco.ducobox-0.0.3.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for duco.ducobox-0.0.3.tar.gz
Algorithm Hash digest
SHA256 9612945e8038f900110bd018cb04dbc613299eb88eab67e4cf483712e9ca4963
MD5 f10a2c2f9f515c192754f4417951b927
BLAKE2b-256 c1cfccb13b4267be328ccfd9fa93bd1b8dbb2c41e2fa3a2a29dda8faa4a93626

See more details on using hashes here.

File details

Details for the file duco.ducobox-0.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for duco.ducobox-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ecf085bc2b17ffda48a1ab898c82da546a334fa774d0d4827ba788bd497e3e57
MD5 4b7e838c64980bbf14600ff7c1da1bb6
BLAKE2b-256 74bc3676fde3a41180712be814e4dd4d86003105e6a47828164b9bf2cc7ff78b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page