co2mon 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 225e5dfeefcbbee476233c59435787a6e9583d27
+  data.tar.gz: 83d21e7b76b33449175c52bc4832f1340732fb31
+SHA512:
+  metadata.gz: 1d0c191cff8e53fcac1c39461deec0cb9392dbbe5b57febe176674c7ca55f8101460f1ce750220c71be1a5ce4b754306d3697c542315fd57badf01581f144c7d
+  data.tar.gz: d5856cf0b733827f74dd5ec2736cc158af1a5ce9a42d3a6e9348de1c7b553f54e66f2942d8675401d583621dc9ff805103182abdbc7a1bddf74017c44e1e47de

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at arkadiy.butermanov@flatstack.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in co2mon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Arkadiy Butermanov
+
+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.

data/README.md

@@ -0,0 +1,7 @@
+# Co2mon
+
+Based on https://github.com/dmage/co2mon
+
+## Requirements
+
+    $ brew install hidapi

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "co2mon"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/co2mon.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'co2mon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "co2mon"
+  spec.version       = Co2mon::VERSION
+  spec.authors       = ["Arkadiy Butermanov"]
+  spec.email         = ["arkadiy.butermanov@flatstack.com"]
+
+  spec.summary       = %q{FFI bindings for MasterKit CO2 Monitor}
+  spec.homepage      = "https://github.com/arkadiybutermanov/co2mon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.extensions << './ext/co2mon/extconf.rb'
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/ext/co2mon/co2mon.c

@@ -0,0 +1,222 @@
+/*
+ * co2mon - programming interface to CO2 sensor.
+ * Copyright (C) 2015  Oleg Bulatov <oleg@bulatov.me>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <fcntl.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+#include <unistd.h>
+#include <hidapi/hidapi.h>
+#include <ruby.h>
+
+#define CODE_TAMB 0x42 /* Ambient Temperature */
+#define CODE_CNTR 0x50 /* Relative Concentration of CO2 */
+
+uint16_t co2mon_data[256];
+
+typedef hid_device *co2mon_device;
+
+typedef unsigned char co2mon_data_t[8];
+
+hid_device *
+co2mon_open_device()
+{
+    hid_device *dev = hid_open(0x04d9, 0xa052, NULL);
+    return dev;
+}
+
+int
+co2mon_device_path(hid_device *dev, char *str, size_t maxlen)
+{
+    str[0] = '\0';
+    return 1;
+}
+
+int
+co2mon_send_magic_table(hid_device *dev, co2mon_data_t magic_table)
+{
+    int r = hid_send_feature_report(dev, magic_table, sizeof(co2mon_data_t));
+    if (r < 0 || r != sizeof(co2mon_data_t))
+    {
+        fprintf(stderr, "hid_send_feature_report: error\n");
+        return 0;
+    }
+    return 1;
+}
+
+static void
+swap_char(unsigned char *a, unsigned char *b)
+{
+    unsigned char tmp = *a;
+    *a = *b;
+    *b = tmp;
+}
+
+static void
+decode_buf(co2mon_data_t result, co2mon_data_t buf, co2mon_data_t magic_table)
+{
+    swap_char(&buf[0], &buf[2]);
+    swap_char(&buf[1], &buf[4]);
+    swap_char(&buf[3], &buf[7]);
+    swap_char(&buf[5], &buf[6]);
+
+    for (int i = 0; i < 8; ++i)
+    {
+        buf[i] ^= magic_table[i];
+    }
+
+    unsigned char tmp = (buf[7] << 5);
+    result[7] = (buf[6] << 5) | (buf[7] >> 3);
+    result[6] = (buf[5] << 5) | (buf[6] >> 3);
+    result[5] = (buf[4] << 5) | (buf[5] >> 3);
+    result[4] = (buf[3] << 5) | (buf[4] >> 3);
+    result[3] = (buf[2] << 5) | (buf[3] >> 3);
+    result[2] = (buf[1] << 5) | (buf[2] >> 3);
+    result[1] = (buf[0] << 5) | (buf[1] >> 3);
+    result[0] = tmp | (buf[0] >> 3);
+
+    const unsigned char magic_word[8] = "Htemp99e";
+    for (int i = 0; i < 8; ++i)
+    {
+        result[i] -= (magic_word[i] << 4) | (magic_word[i] >> 4);
+    }
+}
+
+int
+co2mon_read_data(hid_device *dev, co2mon_data_t magic_table, co2mon_data_t result)
+{
+    co2mon_data_t data = { 0 };
+    int actual_length = hid_read_timeout(dev, data, sizeof(co2mon_data_t), 5000 /* milliseconds */);
+    if (actual_length < 0)
+    {
+        fprintf(stderr, "hid_read_timeout: error\n");
+        return actual_length;
+    }
+    if (actual_length != sizeof(co2mon_data_t))
+    {
+        fprintf(stderr, "hid_read_timeout: transferred %d bytes, expected %lu bytes\n", actual_length, (unsigned long)sizeof(co2mon_data_t));
+        return 0;
+    }
+
+    decode_buf(result, data, magic_table);
+    return actual_length;
+}
+
+static double
+decode_temperature(uint16_t w)
+{
+    return (double)w * 0.0625 - 273.15;
+}
+
+static int *device_loop(co2mon_device dev)
+{
+    co2mon_data_t magic_table = { 0 };
+    co2mon_data_t result;
+    int temp = 0;
+    int co = 0;
+    static int array [2];
+
+    if (!co2mon_send_magic_table(dev, magic_table))
+    {
+        fprintf(stderr, "Unable to send magic table to CO2 device\n");
+        return array;
+    }
+
+    while (co == 0 || temp == 0)
+    {
+        int r = co2mon_read_data(dev, magic_table, result);
+        if (r <= 0)
+        {
+            fprintf(stderr, "Error while reading data from device\n");
+            break;
+        }
+
+        if (result[4] != 0x0d)
+        {
+            fprintf(stderr, "Unexpected data from device (data[4] = %02hhx, want 0x0d)\n", result[4]);
+            continue;
+        }
+
+        unsigned char r0, r1, r2, r3, checksum;
+        r0 = result[0];
+        r1 = result[1];
+        r2 = result[2];
+        r3 = result[3];
+        checksum = r0 + r1 + r2;
+        if (checksum != r3)
+        {
+            fprintf(stderr, "checksum error (%02hhx, await %02hhx)\n", checksum, r3);
+            continue;
+        }
+
+        uint16_t w = (result[1] << 8) + result[2];
+
+        switch (r0)
+        {
+        case CODE_TAMB:
+            temp = (int)decode_temperature(w);
+
+            break;
+        case CODE_CNTR:
+            if ((unsigned)w > 3000) {
+                // Avoid reading spurious (uninitialized?) data
+                break;
+            }
+
+            co = (int)w;
+
+            break;
+        }
+    }
+
+    array[0] = co;
+    array[1] = temp;
+
+    return array;
+}
+
+static int *main_loop()
+{
+    static int empty_result[2] = {0};
+
+    co2mon_device dev = co2mon_open_device();
+
+    if (dev == NULL)
+    {
+      return empty_result;
+    }
+
+    int *result = device_loop(dev);
+
+    hid_close(dev);
+
+    return result;
+}
+
+int *get()
+{
+    hid_init();
+
+    int *result = main_loop();
+
+    hid_exit();
+
+    return result;
+}

data/ext/co2mon/extconf.rb

@@ -0,0 +1,21 @@
+require 'mkmf'
+
+LIBDIR      = RbConfig::CONFIG['libdir']
+INCLUDEDIR  = RbConfig::CONFIG['includedir']
+HEADER_DIRS = [
+  '/opt/local/include',
+  '/usr/local/include',
+  INCLUDEDIR,
+  '/usr/include'
+]
+LIB_DIRS = [
+  '/opt/local/lib',
+  '/usr/local/lib',
+  LIBDIR,
+  '/usr/lib'
+]
+
+dir_config('co2mon', HEADER_DIRS, LIB_DIRS)
+find_header('hidapi/hidapi.h')
+find_library('hidapi', "hid_init", "hid_exit")
+create_makefile('co2mon')

data/lib/co2mon.rb

@@ -0,0 +1,20 @@
+require "co2mon/version"
+require "ffi"
+
+module Co2mon
+  extend FFI::Library
+
+  ffi_lib File.expand_path("co2mon.bundle", __dir__)
+
+  attach_function :get, [], :pointer
+
+  def self.get_data
+    data = get.get_array_of_int32(0, 2)
+
+    {
+      :co2 => data[0],
+      :temp => data[1]
+    }
+  rescue => e
+  end
+end

data/lib/co2mon/version.rb

@@ -0,0 +1,3 @@
+module Co2mon
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: co2mon
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Arkadiy Butermanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- arkadiy.butermanov@flatstack.com
+executables: []
+extensions:
+- "./ext/co2mon/extconf.rb"
+extra_rdoc_files: []
+files:
+- "./ext/co2mon/extconf.rb"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- co2mon.gemspec
+- ext/co2mon/co2mon.c
+- ext/co2mon/extconf.rb
+- lib/co2mon.rb
+- lib/co2mon/version.rb
+homepage: https://github.com/arkadiybutermanov/co2mon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: FFI bindings for MasterKit CO2 Monitor
+test_files: []