max31856 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f58294b0e51251974b24d2e368b7c1aa4f3b9aa170d5801089aeeaf5012fe6c6
+  data.tar.gz: 3ae873a5f9c15b185ec9e46eceb0ce5e713fb9c9e98186b1b5bcdf78fb5cf41c
+SHA512:
+  metadata.gz: 687b8cfd0c66c0a297a7b513cfceecb16917a26874f192f88af47dc5f6e114c3416ac1e3410330fdf7a67f31efdf40ef35393c132e1cc5aa6086edc0a490cfa3
+  data.tar.gz: 6557ee49f31bb53ed5488bebd7a872fcc0d774f90bda1826b873cfdf4eba0753e8b303edd50092ef05b67727bc0e05da0f305fade6d825531099a155195b6dae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at x@nofxx.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in max31856.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcos Piccinini
+
+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,45 @@
+# MAX31856
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/max31856`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'max31856'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install max31856
+
+## Usage
+
+    m = MAX31856.new(chip = 0, clock = 2_000_000)
+    m.config
+    m.read
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nofxx/max31856. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Max31856 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nofxx/max31856/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'max31856'
+
+# 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(__FILE__)
+
+m = MAX31856.new
+m.read_fault
+m.config
+loop do
+  m.read_all
+end

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/lib/max31856.rb

@@ -0,0 +1,170 @@
+require 'max31856/version'
+require 'pi_piper'
+
+#
+# MAX31856
+#
+class MAX31856
+  attr_accessor :chip, :type, :clock
+
+  # Thermocouple Temperature Data Resolution
+  TC_RES = 0.0078125
+  # Cold-Junction Temperature Data Resolution
+  CJ_RES = 0.015625
+
+  REG_CJ = 0x08 # Fault status register
+  REG_TC = 0x0c # Fault status register
+  REG_FAULT = 0x0F # Fault status register
+
+  #
+  # Config Register 1
+  # ------------------
+  # bit 7: Conversion Mode                         -> 0 (Normally Off Mode)
+  # bit 6: 1-shot                                  -> 1 (ON)
+  # bit 5: open-circuit fault detection            -> 0 (off)
+  # bit 4: open-circuit fault detection            -> 0 (off)
+  # bit 3: Cold-junction temerature sensor enabled -> 0 (default)
+  # bit 2: Fault Mode                              -> 0 (default)
+  # bit 1: fault status clear                      -> 1 (clear any fault)
+  # bit 0: 50/60 Hz filter select                  -> 0 (60Hz)
+  #
+  REG_1 = [0x00, 0b01000010].freeze
+
+  #
+  # Config Register 2
+  # ------------------
+  # bit 7: Reserved                                -> 0
+  # bit 6: Averaging Mode 1 Sample                 -> 0 (default)
+  # bit 5: Averaging Mode 1 Sample                 -> 0 (default)
+  # bit 4: Averaging Mode 1 Sample                 -> 0 (default)
+  # bit 3: Thermocouple Type -> K Type (default)   -> 0 (default)
+  # bit 2: Thermocouple Type -> K Type (default)   -> 0 (default)
+  # bit 1: Thermocouple Type -> K Type (default)   -> 1 (default)
+  # bit 0: Thermocouple Type -> K Type (default)   -> 1 (default)
+  #
+  REG_2 = 0x01
+
+  TYPES = {
+    b: 0x00,
+    e: 0x01,
+    j: 0x02,
+    k: 0x03,
+    n: 0x04,
+    r: 0x05,
+    s: 0x06,
+    t: 0x07
+  }.freeze
+
+  CHIPS = {
+    0 => PiPiper::Spi::CHIP_SELECT_0,
+    1 => PiPiper::Spi::CHIP_SELECT_1,
+    2 => PiPiper::Spi::CHIP_SELECT_BOTH,
+    3 => PiPiper::Spi::CHIP_SELECT_NONE
+  }.freeze
+
+  FAULTS = {
+    0x80 => 'Cold Junction Out-of-Range',
+    0x40 => 'Thermocouple Out-of-Range',
+    0x20 => 'Cold-Junction High Fault',
+    0x10 => 'Cold-Junction Low Fault',
+    0x08 => 'Thermocouple Temperature High Fault',
+    0x04 => 'Thermocouple Temperature Low Fault',
+    0x02 => 'Overvoltage or Undervoltage Input Fault',
+    0x01 => 'Thermocouple Open-Circuit Fault'
+  }.freeze
+
+  def initialize(type = :k, chip = 0, clock = 2_000_000)
+    @type = TYPES[type]
+    @chip = CHIPS[chip]
+    @clock = clock
+  end
+
+  def spi_work
+    PiPiper::Spi.begin do |spi|
+      # Set cpol, cpha
+      PiPiper::Spi.set_mode(0, 1)
+
+      # Setup the chip select behavior
+      spi.chip_select_active_low(true)
+
+      # Set the bit order to MSB
+      spi.bit_order PiPiper::Spi::MSBFIRST
+
+      # Set the clock divider to get a clock speed of 2MHz
+      spi.clock clock
+
+      spi.chip_select(chip) do
+        yield spi
+      end
+    end
+  end
+
+  def config
+    spi_work do |spi|
+      spi.write(REG_2, type)
+      spi.write(REG_1)
+    end
+    sleep(0.2) # give it 200ms for conversion
+  end
+
+  def read
+    tc = cj = 0
+    spi_work do |spi|
+      cj = read_cj(spi.write(Array.new(4, 0xff).unshift(REG_CJ)))
+      sleep 0.2
+      tc = read_tc(spi.write(Array.new(4, 0xff).unshift(REG_TC)))
+    end
+    [tc, cj]
+  end
+
+  def read_cj(raw)
+    lb, mb, _offset = raw.reverse # Offset already on sum
+    # MSB << 8 | LSB and remove last 2
+    temp = ((mb << 8) | lb) >> 2
+
+    # Handle negative
+    temp -= 0x4000 unless (mb & 0x80).zero?
+
+    # Convert to Celsius
+    temp * CJ_RES
+  end
+
+  def read_tc(raw)
+    fault, lb, mb, hb = raw.reverse
+    FAULTS.each do |f, txt|
+      raise txt if fault & f == 1
+    end
+    # MSB << 8 | LSB and remove last 5
+    temp = ((hb << 16) | (mb << 8) | lb) >> 5
+
+    # Handle negative
+    temp -= 0x80000 unless (hb & 0x80).zero?
+
+    # Convert to Celsius
+    temp * TC_RES
+  end
+
+  # Read register faults
+  def read_fault
+    spi_work do |spi|
+      fault = spi.write(REG_FAULT, 0xff)
+      p [fault, fault.last.to_s(2).rjust(8, '0')]
+    end
+  end
+end
+
+
+# def print_c(label, temp)
+#   "🌡 #{label.to_s.upcase}: #{format('%.2f', temp)} ℃"
+# end
+
+# m = MAX31856.new # :k
+# # m.read_fault
+# m.config
+# loop do
+#   tc, cj = m.read
+#   print print_c :cj, cj
+#   print '  '
+#   puts print_c :tc, tc
+#   sleep 0.8
+# end

data/lib/max31856/version.rb

@@ -0,0 +1,3 @@
+class MAX31856
+  VERSION = '0.1.0'.freeze
+end

data/max31856.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'max31856/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'max31856'
+  spec.version       = MAX31856::VERSION
+  spec.authors       = ['Marcos Piccinini']
+  spec.email         = ['x@nofxx.com']
+
+  spec.summary       = %q{Read temperatures from MAX31856 Thermocouple.}
+  spec.description   = %q{PiPiper based wrapper for MAX31856 SPI Interface.}
+  spec.homepage      = 'https://github.com/nofxx/max31856'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pi_piper', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: max31856
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcos Piccinini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pi_piper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: PiPiper based wrapper for MAX31856 SPI Interface.
+email:
+- x@nofxx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/max31856.rb
+- lib/max31856/version.rb
+- max31856.gemspec
+homepage: https://github.com/nofxx/max31856
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Read temperatures from MAX31856 Thermocouple.
+test_files: []