itiscold 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80b7a340af5d1b8a90b096f0f6484a566d3a75c7
+  data.tar.gz: 139a60181371e9e20fc7bcb1dbb5372982505e3f
+SHA512:
+  metadata.gz: bdd0edbd38a6a30703c6350e2bad504481cf7f589045c3c37c0ebd9b7e31663003f9ccb543c9183292bf45d076e3bd67f3c6e8036b2b1e8b4fa2507d8d8b4750
+  data.tar.gz: b55e71a1b272bc680840c0cf540c85e7675067942db869d212df2a4bb3e818a575945d17e2daeaddd5eef6ecf020bc756aad198c10b0a4cd8ee883ed0b8ab88f

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2016-12-13
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2016 Aaron Patterson
+
+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/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+bin/itiscold
+lib/itiscold.rb
+lib/itiscold/public/index.html
+test/test_itiscold.rb

data/README.md

@@ -0,0 +1,48 @@
+# itiscold
+
+* https://github.com/tenderlove/itiscold
+
+## DESCRIPTION:
+
+A thing that reads data from Elitech RC-5 temp sensor.  Protocol documentation
+can be found here:
+
+  https://github.com/civic/elitech-datareader/blob/master/rc-4-data.md
+
+I've tested this on my RC-5, but not an RC-4.
+
+## SYNOPSIS:
+
+Print device information
+
+```ruby
+temp = Itiscold.open '/dev/tty.wchusbserial14140'
+info = temp.device_info
+puts Psych.dump info
+```
+
+Set device information (Note that this will clear the memory)
+
+```ruby
+# Get the info
+temp = Itiscold.open '/dev/tty.wchusbserial14140'
+info = temp.device_info
+
+# Mutate it and upload to the device
+info.stop_button = :prohibit
+temp.device_params = info
+
+# Print info again
+info = temp.device_info
+puts Psych.dump info
+```
+
+Set device time
+```ruby
+temp = Itiscold.open '/dev/tty.wchusbserial14140'
+temp.set_device_time! # defaults to Time.now
+```
+
+## INSTALL:
+
+* gem install itiscold

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :minitest
+Hoe.plugin :gemspec # `gem install hoe-gemspec`
+Hoe.plugin :git     # `gem install hoe-git`
+
+Hoe.spec 'itiscold' do
+  developer('Aaron Patterson', 'tenderlove@ruby-lang.org')
+  self.readme_file   = 'README.md'
+  self.history_file  = 'CHANGELOG.md'
+  self.extra_rdoc_files  = FileList['*.md']
+  self.extra_deps << ['ruby-termios',             '~> 1']
+end
+
+# vim: syntax=ruby

data/bin/itiscold

@@ -0,0 +1,59 @@
+require 'itiscold'
+require 'optparse'
+require 'time'
+
+options = {
+  tty:        ARGV.shift,
+  command:    ARGV.shift,
+  table_name: 'samples'
+}
+
+def quit op
+  puts op
+  exit
+end
+
+op = OptionParser.new do |opts|
+  opts.banner = "Usage: itiscold path_to_tty [samples|info|server] [options]"
+
+  opts.on '--csv', 'output samples as CSV' do
+    quit(opts)  if options[:format]
+    options[:format] = :csv
+  end
+
+  opts.on '--json', 'output samples as JSON' do
+    quit(opts)  if options[:format]
+    options[:format] = :json
+  end
+end
+
+op.parse!
+
+quit(op) unless options[:command] && options[:tty]
+
+case options[:command]
+when 'samples'
+  temp = Itiscold.open options[:tty]
+  case options[:format]
+  when :csv
+    require 'csv'
+    data = temp.samples
+    CSV { |csv| csv << ['SampleTime', 'Temp']; data.each { |s| csv << s } }
+  when :json
+    require 'json'
+    puts JSON.dump temp.device_info.to_h
+    temp.samples.each { |s|
+      puts JSON.dump({ time: s.first.iso8601, temp: s.last })
+    }
+  end
+when 'info'
+  require 'psych'
+  puts Psych.dump temp.device_info
+when 'server'
+  Itiscold::WebServer.start options[:tty]
+else
+  puts op
+  exit
+end
+
+# vim: syntax=ruby

data/lib/itiscold.rb

@@ -0,0 +1,416 @@
+require 'termios'
+require 'fcntl'
+require 'webrick'
+require 'json'
+
+class Itiscold
+  VERSION = '1.0.0'
+
+  class TTY
+    include Termios
+
+    def self.open filename, speed, mode
+      if mode =~ /^(\d)(\w)(\d)$/
+        t.data_bits = $1.to_i
+        t.stop_bits = $3.to_i
+        t.parity = { 'N' => :none, 'E' => :even, 'O' => :odd }[$2]
+        t.speed = speed
+        t.read_timeout = 5
+        t.reading = true
+        t.update!
+      end
+    end
+
+    def self.data_bits t, val
+      t.cflag &= ~CSIZE               # clear previous values
+      t.cflag |= const_get("CS#{val}") # Set the data bits
+      t
+    end
+
+    def self.stop_bits t, val
+      case val
+      when 1 then t.cflag &= ~CSTOPB
+      when 2 then t.cflag |= CSTOPB
+      else
+        raise
+      end
+      t
+    end
+
+    def self.parity t, val
+      case val
+      when :none
+        t.cflag &= ~PARENB
+      when :even
+        t.cflag |= PARENB  # Enable parity
+        t.cflag &= ~PARODD # Make it not odd
+      when :odd
+        t.cflag |= PARENB  # Enable parity
+        t.cflag |= PARODD  # Make it odd
+      else
+        raise
+      end
+      t
+    end
+
+    def self.speed t, speed
+      t.ispeed = const_get("B#{speed}")
+      t.ospeed = const_get("B#{speed}")
+      t
+    end
+
+    def self.read_timeout t, val
+      t.cc[VTIME] = val
+      t.cc[VMIN] = 0
+      t
+    end
+
+    def self.reading t
+      t.cflag |= CLOCAL | CREAD
+      t
+    end
+  end
+
+  def self.open filename, speed = 115200
+    f = File.open filename, File::RDWR|Fcntl::O_NOCTTY|Fcntl::O_NDELAY
+    f.sync = true
+
+    # enable blocking reads, otherwise read timeout won't work
+    f.fcntl Fcntl::F_SETFL, f.fcntl(Fcntl::F_GETFL, 0) & ~Fcntl::O_NONBLOCK
+
+    t = Termios.tcgetattr f
+    t = TTY.data_bits    t, 8
+    t = TTY.stop_bits    t, 1
+    t = TTY.parity       t, :none
+    t = TTY.speed        t, speed
+    t = TTY.read_timeout t, 5
+    t = TTY.reading      t
+
+    Termios.tcsetattr f, Termios::TCSANOW, t
+    Termios.tcflush f, Termios::TCIOFLUSH
+
+    temp = new f
+
+    # Try reading the version a few times before giving up
+    temp.flush
+    temp
+  end
+
+  def initialize tty
+    @tty = tty
+  end
+
+  DeviceInfo = Struct.new :station_number,
+    :model_number,
+    :sample_interval,   # in seconds
+    :upper_limit,
+    :lower_limit,
+    :last_online,
+    :work_status,
+    :start_time,
+    :stop_button,
+    :sample_count,
+    :current_time,
+    :user_info,
+    :number,
+    :delay_time,        # in seconds
+    :tone_set,
+    :alarm,
+    :temp_unit,
+    :temp_calibration,
+    :new_station_number
+
+  def device_info
+    val = retry_comm(1) do
+      @tty.write with_checksum([0xCC, 0x00, 0x06, 0x00]).pack('C5')
+      @tty.read 160
+    end
+    _,            # C set number
+    station_no,   # C station number
+    _,            # C
+    model_no,     # C model number
+    _,            # C
+    rec_int_h,    # C record interval hour
+    rec_int_m,    # C record interval min
+    rec_int_s,    # C record interval sec
+    upper_limit,  # n upper limit
+    lower_limit,  # s> lower limit
+    last_online,  # A7 (datetime)
+    ws,           # C work status
+    start_time,   # A7 (datetime)
+    sb,           # C stop button
+    _,            # C
+    sample_count, # n number of records
+    current_time, # A7 (datetime)
+    user_info,    # A100
+    number,       # A10
+    delaytime,    # C
+    tone_set,     # C
+    alrm,         # C
+    tmp_unit,     # C
+    temp_calib,   # C temp calibration
+    _,            # A6 padding
+    check,        # C padding
+    = val.unpack('C8ns>A7CA7CCnA7A100A10C5A6C')
+    check_checksum check, checksum(val.bytes.first(val.bytesize - 1))
+    DeviceInfo.new station_no, model_no,
+      (rec_int_h * 3600 + rec_int_m * 60 + rec_int_s),
+      upper_limit / 10.0, lower_limit / 10.0, unpack_datetime(last_online),
+      work_status(ws), unpack_datetime(start_time), allowed_decode(sb),
+      sample_count, unpack_datetime(current_time), user_info, number,
+      delay_time_decode(delaytime), allowed_decode(tone_set), alrm, temp_unit_decode(tmp_unit),
+      temp_calib / 10.0
+  end
+
+  def device_params= values
+    data = [
+      0x33, # C
+      values.station_number, # C
+      0x05, 0x00,            # CC
+    ] + split_time(values.sample_interval) + # CCC
+    [
+      (values.upper_limit * 10).to_i, # n
+      (values.lower_limit * 10).to_i, # s>
+      values.new_station_number || values.station_number, # C
+      allowed_encode(values.stop_button), # C
+      delay_time_encode(values.delay_time), # C
+      allowed_encode(values.tone_set), # C
+      values.alarm, # C
+      temp_unit_encode(values.temp_unit), # C
+      (values.temp_calibration * 10).to_i, # C
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00 # C6
+    ]
+    retry_comm(1) do
+      @tty.write with_checksum(data).pack('CCCCCCCns>CCCCCCCC6C')
+      @tty.read 3
+    end
+  end
+
+  def set_device_number station_number, dev_number
+    str = dev_number.bytes.first(10)
+    str.concat([0x00] * (10 - str.length))
+    data = [ 0x33, station_number, 0x0b, 0x00 ] + str
+
+    retry_comm(1) do
+      @tty.write with_checksum(data).pack("C#{data.length + 1}")
+      @tty.read 3
+    end
+  end
+
+  def set_user_info info, station_number = device_info.station_number
+    str = info.bytes.first(100)
+    str.concat([0x00] * (100 - str.length))
+    data = [ 0x33, station_number, 0x09, 0x00 ] + str
+
+    retry_comm(1) do
+      @tty.write with_checksum(data).pack("C#{data.length + 1}")
+      @tty.read 3
+    end
+  end
+
+  def set_device_time! time = Time.now, station_number = device_info.station_number
+    data = [0x33, station_number, 0x07, 0x00] + encode_datetime(time)
+
+    retry_comm(1) do
+      @tty.write with_checksum(data).pack("C4nC6")
+      @tty.read 3
+    end
+  end
+
+  DataHeader = Struct.new :sample_count, :start_time
+
+  def data_header station
+    buf = retry_comm(1) do
+      @tty.write with_checksum([0x33, station, 0x1, 0x0]).pack('C5')
+      @tty.read 11
+    end
+    _, sample_count, start_time, check = buf.unpack 'CnA7C'
+
+    check_checksum check, checksum(buf.bytes.first(buf.bytesize - 1))
+
+    DataHeader.new sample_count, unpack_datetime(start_time)
+  end
+
+  def data_body station, page
+    buf = retry_comm(1) do
+      @tty.write with_checksum([0x33, station, 0x2, page]).pack('C5')
+      @tty.read
+    end
+    temps = buf.unpack("Cn#{(buf.bytesize - 2) / 2}C")
+    temps.shift # header
+    temps.pop   # checksum
+    temps.map { |t| t / 10.0 }
+  end
+
+  def samples
+    info    = device_info
+    header  = data_header info.station_number
+    records = header.sample_count
+    page    = 0
+    list    = []
+    while records > 0
+      samples = data_body info.station_number, page
+      records -= samples.length
+      list    += samples
+      page    += 1
+    end
+    st = header.start_time
+    list.map.with_index { |v, i| [st + (i * info.sample_interval), v] }
+  end
+
+  def flush
+    Termios.tcflush @tty, Termios::TCIOFLUSH
+  end
+
+  private
+
+  def split_time time_s
+    h = time_s / 3600
+    time_s -= (h * 3600)
+    m = time_s / 60
+    time_s -= (m * 60)
+    [h, m, time_s]
+  end
+
+  def retry_comm times
+    x = nil
+    loop do
+      x = yield
+      break if x || times == 0
+      flush
+      times -= 1
+    end
+    x
+  end
+
+  def temp_unit_decode u
+    case u
+    when 0x13 then 'F'
+    when 0x31 then 'C'
+    else
+      raise u.to_s
+    end
+  end
+
+  def temp_unit_encode u
+    case u
+    when 'F' then 0x13
+    when 'C' then 0x31
+    else
+      raise u.to_s
+    end
+  end
+
+  def delay_time_decode dt
+    case dt
+    when 0x00 then 0
+    when 0x01 then 30 * 60  # 30min in sec
+    when 0x10 then 60 * 60  # 60min in sec
+    when 0x11 then 90 * 60  # 90min in sec
+    when 0x20 then 120 * 60 # 120min in sec
+    when 0x21 then 150 * 60 # 150min in sec
+    end
+  end
+
+  def delay_time_encode dt
+    case dt
+    when 0        then 0x00
+    when 30 * 60  then 0x01 # 30min in sec
+    when 60 * 60  then 0x10 # 60min in sec
+    when 90 * 60  then 0x11 # 90min in sec
+    when 120 * 60 then 0x20 # 120min in sec
+    when 150 * 60 then 0x21 # 150min in sec
+    end
+  end
+
+  def allowed_decode sb
+    case sb
+    when 0x13 then :permit
+    when 0x31 then :prohibit
+    else
+      raise sb.to_s
+    end
+  end
+
+  def allowed_encode sb
+    case sb
+    when :permit then 0x13
+    when :prohibit then 0x31
+    else
+      raise sb.to_s
+    end
+  end
+
+  def work_status ws
+    case ws
+    when 0 then :not_started
+    when 1 then :start
+    when 2 then :stop
+    when 3 then :unknown
+    end
+  end
+
+  def check_checksum expected, actual
+    raise "invalid checksum #{expected} == #{actual}" unless expected == actual
+  end
+
+  def unpack_datetime bytes
+    Time.new(*bytes.unpack('nC5'))
+  end
+
+  def encode_datetime time
+    [time.year, time.month, time.day, time.hour, time.min, time.sec]
+  end
+
+  def with_checksum list
+    list + [checksum(list)]
+  end
+
+  def checksum list
+    list.inject(:+) % 256
+  end
+
+  module WebServer
+    class TTYServlet < WEBrick::HTTPServlet::AbstractServlet
+      def initialize server, tty, mutex
+        super server
+        @tty   = tty
+        @mutex = mutex
+      end
+    end
+
+    class InfoServlet < TTYServlet
+      def do_GET request, response
+        response.status = 200
+        response['Content-Type'] = 'text/json'
+        @mutex.synchronize do
+          json = JSON.dump(@tty.device_info.to_h)
+          response.body = json
+        end
+      end
+    end
+
+    class SampleServlet < TTYServlet
+      def do_GET request, response
+        response.status = 200
+        response['Content-Type'] = 'text/json'
+        @mutex.synchronize do
+          response.body = JSON.dump @tty.samples.map { |s|
+            { time: s.first.iso8601, temp: s.last }
+          }
+        end
+      end
+    end
+
+    def self.start tty
+      root = File.expand_path(File.join File.dirname(__FILE__), 'itiscold', 'public')
+      mutex  = Mutex.new
+      temp = Itiscold.open tty
+      server = WEBrick::HTTPServer.new(:Port => 8000, :DocumentRoot => root)
+      server.mount "/samples", SampleServlet, temp, mutex
+      server.mount "/info", InfoServlet, temp, mutex
+      trap "INT" do server.shutdown end
+      server.start
+    end
+  end
+end

data/lib/itiscold/public/index.html

@@ -0,0 +1,71 @@
+<html>
+  <head>
+    <link href='https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.11.0/metricsgraphics.css' rel='stylesheet' type='text/css'>
+    <link href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css' rel='stylesheet' type='text/css'>
+
+    <script src='https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.0/jquery.min.js'></script>
+    <script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js'></script>
+    <script src="https://d3js.org/d3.v4.min.js"></script>
+    <script src='https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.11.0/metricsgraphics.js'></script>
+  <script>
+    var info;
+    var samples;
+    function capitalizeFirstLetter(string) {
+      return string.charAt(0).toUpperCase() + string.slice(1);
+    }
+    $.when($.getJSON("/info", function(data) {
+        info = data;
+      }), $.getJSON("/samples", function(data) {
+        console.log("hello");
+        samples = data.map(function(sample) {
+          return { time: new Date(sample.time), temp: sample.temp };
+        });
+      })
+    ).then(function() {
+      console.log(samples);
+      console.log(info);
+      $(function() {
+        var table = $("#device-info > tbody");
+        for (var key in info) {
+          if (info.hasOwnProperty(key)) {
+            var value = info[key];
+            if (value) {
+              var words = key.split("_");
+              key = words.map(capitalizeFirstLetter).join(" ");
+              table.append("<tr><td>" + key + "</td><td>" + value + "</td></tr>");
+            }
+          }
+        }
+        MG.data_graphic({
+          title: "Temperature",
+          description: "This graph shose a time series of temperatures",
+          data: samples,
+          width: 600,
+          height: 250,
+          target: '#temp-graph',
+          x_accessor: 'time',
+          y_accessor: 'temp',
+        })
+      });
+    });
+  </script>
+  </head>
+  <body>
+    <div class="container">
+      <h1 class="text-center">Temperature Graph</h1>
+
+      <div class="row">
+        <div class="col-xs-4">
+          <h2>Device Info</h2>
+          <table id="device-info" class="table table-striped table-condensed table-bordered">
+            <tbody>
+            </tbody>
+          </table>
+        </div>
+        <div class="col-xs-8 text-center">
+          <div id='temp-graph'></div>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/test/test_itiscold.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'itiscold'
+
+class TestItiscold < Minitest::Test
+  def test_split_time
+    assert true # lol this is a project I did for fun
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: itiscold
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: |-
+  A thing that reads data from Elitech RC-5 temp sensor.  Protocol documentation
+  can be found here:
+
+    https://github.com/civic/elitech-datareader/blob/master/rc-4-data.md
+
+  I've tested this on my RC-5, but not an RC-4.
+email:
+- tenderlove@ruby-lang.org
+executables:
+- itiscold
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/itiscold
+- lib/itiscold.rb
+- lib/itiscold/public/index.html
+- test/test_itiscold.rb
+homepage: https://github.com/tenderlove/itiscold
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A thing that reads data from Elitech RC-5 temp sensor
+test_files: []