Giter Club home page Giter Club logo

ducobox's Introduction

GPL v3 License

Pypi packaged release

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. These fields can be adapted for each node:

  • name: convenience name for the node (any string)
  • blacklist: flag to blacklist (don't use this node) from the network (True, or False)

The rest of the fields should not be adapted outside the script.

Logging data

The script can log the sampled data to a database.

InfluxDB

Data can be logged to an influxDB server, by passing a configuration file to the --influxdb option of the script.

Format of this configuration file through an example:

[InfluxDB]
url = localhost
port = 8086
user = root
password = root
database = ducobox-example

Other databases

The script is setup in a generic way, so adding more kinds of databases should be easy.

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

InfluxDB and Grafana

The script was in first place designed to log sample data to an InfluxDB server. Grafana can be used as a frontend to create views on the InfluxDB data.

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.

ducobox's People

Contributors

steinheselmans avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.