@agilatech/zetta-cozir5-linux-driver

##Zetta cozir5 carbon dioxide sensor driver for Linux

This driver should work on any Linux platform, but has so far only been tested on BeagleBone Black

###Install

$> npm install @agilatech/zetta-cozir5-linux-driver

OR

$> git clone https://github.com/Agilatech/zetta-cozir5-linux-driver zetta-cozir5-linux-driver

###Usage

var zetta = require('zetta');
var cozir5 = require('@agilatech/zetta-cozir5-linux-driver');

zetta()
.use(cozir5, [options])  // where [options] define operational paramters -- omit to accept defaults
.listen(<port number>)   // where <port number> is the port on which the zetta server should listen

####OPTIONS These options are defined in a file named 'options.json' which may be overridden by program definitions

"file":"<serial file device>"
/dev/ttyS0, /dev/ttyO2, etc...  Defaults to /dev/ttyS0

"chronPeriod":<period>
Period in milliseconds for monitored isochronal data

"streamPeriod":<period>
Period in milliseconds for streaming data. A value of 0 disables streaming.

###Example Using directly in the zetta server:

const zetta = require('zetta');
const co2_sensor = require('@agilatech/zetta-cozir5-linux-driver');
zetta().use(co2_sensor).listen(1337);

Initializes the cozir5 driver on serial device /dev/ttyS0 with a data monitoring period of 60 seconds and streaming data every second

To override the options defined in the options.json file, supply them in an object in the use statement like this:

zetta().use(co2_sensor, { "file":"/dev/ttyS2", "chronPeriod":30000, "streamPeriod":15000 });

Overrides the defaults to initialize the serial device on /dev/ttyS2 with a data monitoring period of 30 seconds and streaming data every 1.5 seconds

Hardware

• Beaglebone Black
• Beaglebone Green
• Should also work on Raspberry Pi as well as other Linux SBC

###Transitions

start-isochronal

Begins the periodic collection of carbon dioxide data. Value is monitored as co2, and the period is set by the 'chronPeriod' option (defaults to 60 sec).

stop-isochronal

Stops data collection for the monitored values.

###State chron-off is the beginning state. The driver enters this state after a transition 'stop-isochronal' command. In this state, the monitored data value co2 is set to 0, and no sensor readings are updated.

chron-on is the state after a transition 'start-isochronal' command. In this state, the monitored data value co2 is updated every time period as specified by 'chronPeriod'.

###Design

This device driver is designed for both streaming and periodic monitored data collection from the cozir5 sensor.

###Copyright Copyright © 2016 Agilatech. All Rights Reserved.

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.