Giter VIP home page Giter VIP logo

node-co2-monitor's Introduction

node-co2-monitor

Node.JS library for reading CO2 concentration and indoor temperature from TFA Dostmann AirCO2NTROL Mini.

npm npm downloads

Contents

Supported Hardware

Install

npm install node-co2-monitor

Getting started

'use strict';
const CO2Monitor = require('node-co2-monitor');

const monitor = new CO2Monitor();

// Connect device.
monitor.connect((err) => {
    if (err) {
        return console.error(err.stack);
    }
    console.log('Monitor connected.');

    // Read data from CO2 monitor.
    monitor.transfer();
});

// Get results.
monitor.on('temp', (temperature) => {
    console.log(`temp: ${ temperature }`);
});
monitor.on('co2', (co2) => {
    console.log(`co2: ${ co2 }`);
});

// Error handler
monitor.on('error', (err) => {
    console.error(err.stack);
    // Disconnect device
    monitor.disconnect(() => {
        console.log('Monitor disconnected.');
        process.exit(0);
    });
});

API

Methods

new CO2Monitor(options) -> Object

Create CO2Monitor instance.

monitor.connect(Function callback)

Setup usb connection to CO2 monitor.

monitor.disconnect(Function callback)

Close device connection.

monitor.transfer([Function callback])

Start data transfer from CO2 monitor.

monitor.temperature -> Number

Get latest Ambient Temperature (Tamb) in ℃.

monitor.co2 -> Number

Get latest Relative Concentration of CO2 (CntR) in ppm.

Events

temp -> Number

Triggered by temperature update with Ambient Temperature (Tamb) in ℃.

co2 -> Number

Triggered by co2 update with Relative Concentration of CO2 (CntR) in ppm.

error -> Error

Triggered by error.

Projects using node-co2-monitor

  • CO2 Monitor Exporter - Prometheus exporter for CO2 concentration and indoor temperature from TFA Dostmann AirCO2NTROL Mini.

Credits

Inspired by Henryk Plötz: Reverse-Engineering a low-cost USB CO₂ monitor.

License

MIT

node-co2-monitor's People

Contributors

huhamhire avatar jaller94 avatar mitakas avatar slauber avatar

Forkers

fabulouscupcake

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.