npm:@agilatech/cozir5

README

Node addon for hardware COZIR5 CO2 sensor

This addon should work on any Linux platform, but has only been tested on BBB

Install

npm install @agilatech/cozir5

git clone https://github.com/Agilatech/cozir5.git
node-gyp configure build

Usage

Load the module and create an instance

const addon = require('@agilatech/cozir5');

// create an instance on the /dev/ttyO2 serial device file
const cozir5 = new addon.Cozir5('/dev/ttyO2');

Get basic device info

const name = cozir5.deviceName();  // returns string with name of device
const type = cozir5.deviceType();  // returns string with type of device
const version = cozir5.deviceVersion(); // returns this software version
const active = cozir5.deviceActive(); // true if active, false if inactive
const numVals =  cozir5.deviceNumValues(); // returns the number of paramters sensed

Get parameter info and values

const paramName0 = cozir5.nameAtIndex(0);
const paramType0 = cozir5.typeAtIndex(0);
const paramVal0  = cozir5.valueAtIndexSync(0);

Asynchronous value collection is also available

cozir5.valueAtIndex(0, function(err, val) {
    if (err) {
        console.log(err);
    }
    else {
        console.log(`Asynchronous call return: ${val}`);
    }
});

Operation Notes

This driver is programmed and calibrated for use with the COZIR 5% CO2 sensor, model GC-0015 manufactured by CO2Meter. The measurement range for this sensor is 0-50,000ppm, or 0-5% CO2 concentration. The accuracy is within plus/minus 70ppm, or about a 5% tolerance.

This code may be adopted for other sensor models with different ranges. Please contact Agilatech at tech@agilatech.com if you need help with this.

Dependencies

node-gyp is required to configure and build

Copyright

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!