max31856 0.1.1 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0906a446477b91b298684b023090288f3459f760bc68ed95f67ef67cf82df329'
-  data.tar.gz: 42041fbf89cb1d63230a79bae75ff82e243e8c3172cd7dd709c8a41f9c256b96
+  metadata.gz: 16f3ee8981f76eb1e557cdddcf157c45af6d4a9d4089272fd9d2047f7ad93697
+  data.tar.gz: d933e69b6a4e7639ab973597655913fc67a443035bb2f56338738c7fb27940a5
 SHA512:
-  metadata.gz: 9dd384a0bfd707e7899130461b879ad3715cbc0a2e501f7d3b717e6f137747066b45618c71e25889c40939c3c6404b42c89c2807de1625242e1327ef03339060
-  data.tar.gz: 5b8cbc8acb80862b2716cdb05d69912e1bc3e97af991f937d2c4fa240840a9762a7521531ffc855d61c560f296a50ba4335c998a72712bf3aa5d8406688a30c2
+  metadata.gz: af6f60484be2142230a3e68fe4846f57798b8beb7f06470550711d3c10f6c23261373b9b3db3428afe140c576b777ed2fe7df64e9ccf9a89424b3846c9859b14
+  data.tar.gz: 5c11739f21fe88af3e3f4f266eebd3d8f4ccd29b307087b7821d684a8ee4c3c51d28abc92183554af71a09c8b672f3936b9adf16032192d8d15363443ce69196

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,6 @@
 # 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/
+Do what the fuck you want to.

data/README.md

@@ -2,7 +2,7 @@
 
 MAX31856 - Precision Thermocouple to Digital Converter with Linearization
 
-SPI interface using PiPiper
+Ruby SPI interface using PiPiper
 
 
 ## Installation
@@ -21,11 +21,22 @@ Or install it yourself as:
 
     $ gem install max31856
 
+
 ## Usage
 
-    m = MAX31856.new(chip = 0, clock = 2_000_000)
-    m.config
-    m.read # [Cold Junction Temp, Thermocouple Temp] floats in celsius
+    m = MAX31856.new(chip = 0, type = :k, clock = 2_000_000)
+
+    m.config # Must be run once (shutdown resets chip)
+
+    m.read   # [Cold Junction Temp, Thermocouple Temp] Floats in celsius
+
+
+## Raspberry v3
+
+To enable SPI on the Rpi, on `/boot/config.txt`:
+
+    dtparam=spi=on
+
 
 ## Development
 

data/lib/max31856.rb

@@ -12,23 +12,24 @@ class MAX31856
   # Cold-Junction Temperature Data Resolution
   CJ_RES = 0.015625
 
-  REG_CJ = 0x08 # Fault status register
-  REG_TC = 0x0c # Fault status register
+  # Read registers
+  REG_CJ    = 0x08 # Cold Junction status register
+  REG_TC    = 0x0c # Thermocouple 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 7: Conversion Mode                         -> 1 (Normally Off Mode)
+  # bit 6: 1-shot                                  -> 0 (off)
   # 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 4: open-circuit fault detection type k     -> 1 (on)
+  # bit 3: Cold-junction sensor disabled           -> 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
+  REG_1 = [0x00, 0b10010010].freeze
 
   #
   # Config Register 2
@@ -44,6 +45,20 @@ class MAX31856
   #
   REG_2 = 0x01
 
+  #
+  # Config Register 2
+  # ------------------
+  # bit 7: Nil
+  # bit 6: Nil
+  # bit 5: Cold-Junction High Fault Threshold              -> 0 (default)
+  # bit 4: Cold-Junction Low Fault Threshold               -> 0 (default)
+  # bit 3: Thermocouple Temperature High Fault Threshold   -> 0 (default)
+  # bit 2: Thermocouple Temperature Low Fault Threshold    -> 0 (default)
+  # bit 1: Over-voltage or Undervoltage Input Fault        -> 1 (default)
+  # bit 0: Thermocouple Open-Circuit Fault                 -> 1 (default)
+  #
+  REG_3 = [0x02, 0b11111100].freeze
+
   TYPES = {
     b: 0x00,
     e: 0x01,
@@ -99,14 +114,36 @@ class MAX31856
     end
   end
 
-  def config
+  #
+  # Run once config
+  #
+  # CR1_AVERAGE_1_SAMPLE                    0x00
+  # CR1_AVERAGE_2_SAMPLES                   0x10
+  # CR1_AVERAGE_4_SAMPLES                   0x20
+  # CR1_AVERAGE_8_SAMPLES                   0x30
+  # CR1_AVERAGE_16_SAMPLES                  0x40
+  #
+  # define CR1_VOLTAGE_MODE_GAIN_8                 0x08
+  # define CR1_VOLTAGE_MODE_GAIN_32                0x0C
+  #
+  # Optionally set samples
+  def config(samples = 0x10)
     spi_work do |spi|
-      spi.write(REG_2, type)
-      spi.write(REG_1)
+      spi.write(write_reg(REG_1))
+      spi.write(write_reg([REG_2, (samples | type)]))
+      spi.write(write_reg(REG_3))
     end
-    sleep(0.2) # give it 200ms for conversion
+    sleep 0.2 # give it 200ms for conversion
   end
 
+  # Set 0x80 on first for writes
+  def write_reg(ary)
+    ary[1..-1].unshift(ary[0] | 0x80)
+  end
+
+  #
+  # Read both
+  #
   def read
     tc = cj = 0
     spi_work do |spi|
@@ -117,6 +154,9 @@ class MAX31856
     [tc, cj]
   end
 
+  #
+  # Read cold-junction
+  #
   def read_cj(raw)
     lb, mb, _offset = raw.reverse # Offset already on sum
     # MSB << 8 | LSB and remove last 2
@@ -129,6 +169,9 @@ class MAX31856
     temp * CJ_RES
   end
 
+  #
+  # Read thermocouple
+  #
   def read_tc(raw)
     fault, lb, mb, hb = raw.reverse
     FAULTS.each do |f, txt|

data/lib/max31856/version.rb

@@ -1,3 +1,3 @@
 class MAX31856
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: max31856
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.8
 platform: ruby
 authors:
 - Marcos Piccinini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pi_piper