Merge pull request #35 from caternuson/actionsci

moving to github actions

Author: ladyada

.github/workflows/githubci.yml

@@ -0,0 +1,32 @@
+name: Arduino Library CI
+
+on: [pull_request, push, repository_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: test platforms
+      run: python3 ci/build_platform.py main_platforms
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r .
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit MAX31855 Library"
+      run: bash ci/doxy_gen_and_deploy.sh

Adafruit_MAX31855.cpp

@@ -1,45 +1,91 @@
-/***************************************************
-  This is a library for the Adafruit Thermocouple Sensor w/MAX31855K
-
-  Designed specifically to work with the Adafruit Thermocouple Sensor
-  ----> https://www.adafruit.com/products/269
-
-  These displays use SPI to communicate, 3 pins are required to
-  interface
-  Adafruit invests time and resources providing this open source code,
-  please support Adafruit and open-source hardware by purchasing
-  products from Adafruit!
-
-  Written by Limor Fried/Ladyada for Adafruit Industries.
-  BSD license, all text above must be included in any redistribution
- ****************************************************/
+/*!
+ * @file Adafruit_MAX31855.cpp
+ *
+ * @mainpage Adafruit MAX31855 Thermocouple Breakout Driver
+ *
+ * @section intro_sec Introduction
+ *
+ * This is the documentation for Adafruit's MAX31855 thermocouple breakout
+ * driver for the Arduino platform.  It is designed specifically to work with
+ * the Adafruit MAX31855 breakout: https://www.adafruit.com/products/269
+ *
+ * This breakout uses SPI to communicate, 3 pins are required
+ * to interface with the breakout.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * @section dependencies Dependencies
+ *
+ * This library depends on <a
+ * href="https://github.com/adafruit/Adafruit_BusIO"> Adafruit_BusIO</a> being
+ * present on your system. Please make sure you have installed the latest
+ * version before using this library.
+ *
+ * @section author Author
+ *
+ * Written by Limor Fried/Ladyada for Adafruit Industries.
+ *
+ * @section license License
+ *
+ * BSD license, all text above must be included in any redistribution.
+ *
+ */
 
 #include "Adafruit_MAX31855.h"
 #ifdef __AVR
-  #include <avr/pgmspace.h>
+#include <avr/pgmspace.h>
 #elif defined(ESP8266)
-  #include <pgmspace.h>
+#include <pgmspace.h>
 #endif
 
 #include <stdlib.h>
 
+/**************************************************************************/
+/*!
+    @brief  Instantiates a new Adafruit_MAX31855 class using software SPI.
 
+    @param _sclk The pin to use for SPI Serial Clock.
+    @param _cs The pin to use for SPI Chip Select.
+    @param _miso The pin to use for SPI Master In Slave Out.
+*/
+/**************************************************************************/
 Adafruit_MAX31855::Adafruit_MAX31855(int8_t _sclk, int8_t _cs, int8_t _miso) {
   spi_dev = Adafruit_SPIDevice(_cs, _sclk, _miso, -1, 4000000);
 
   initialized = false;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Instantiates a new Adafruit_MAX31855 class using hardware SPI.
+
+    @param _cs The pin to use for SPI Chip Select.
+*/
+/**************************************************************************/
 Adafruit_MAX31855::Adafruit_MAX31855(int8_t _cs) {
   spi_dev = Adafruit_SPIDevice(_cs, 4000000);
 
   initialized = false;
 }
 
-void Adafruit_MAX31855::begin(void) {
-  initialized = spi_dev.begin();
-}
+/**************************************************************************/
+/*!
+    @brief  Setup the HW
+
+    @return True if the device was successfully initialized, otherwise false.
+*/
+/**************************************************************************/
+void Adafruit_MAX31855::begin(void) { initialized = spi_dev.begin(); }
+
+/**************************************************************************/
+/*!
+    @brief  Read the internal temperature.
 
+    @return The internal temperature in degrees Celsius.
+*/
+/**************************************************************************/
 double Adafruit_MAX31855::readInternal(void) {
   uint32_t v;
 
@@ -57,17 +103,24 @@ double Adafruit_MAX31855::readInternal(void) {
     internal = tmp;
   }
   internal *= 0.0625; // LSB = 0.0625 degrees
-  //Serial.print("\tInternal Temp: "); Serial.println(internal);
+  // Serial.print("\tInternal Temp: "); Serial.println(internal);
   return internal;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Read the thermocouple temperature.
+
+    @return The thermocouple temperature in degrees Celsius.
+*/
+/**************************************************************************/
 double Adafruit_MAX31855::readCelsius(void) {
 
   int32_t v;
 
   v = spiread32();
 
-  //Serial.print("0x"); Serial.println(v, HEX);
+  // Serial.print("0x"); Serial.println(v, HEX);
 
   /*
   float internal = (v >> 4) & 0x7FF;
@@ -85,12 +138,11 @@ double Adafruit_MAX31855::readCelsius(void) {
   if (v & 0x80000000) {
     // Negative value, drop the lower 18 bits and explicitly extend sign bits.
     v = 0xFFFFC000 | ((v >> 18) & 0x00003FFFF);
-  }
-  else {
+  } else {
     // Positive value, just drop the lower 18 bits.
     v >>= 18;
   }
-  //Serial.println(v, HEX);
+  // Serial.println(v, HEX);
 
   double centigrade = v;
 
@@ -99,25 +151,44 @@ double Adafruit_MAX31855::readCelsius(void) {
   return centigrade;
 }
 
-uint8_t Adafruit_MAX31855::readError() {
-  return spiread32() & 0x7;
-}
+/**************************************************************************/
+/*!
+    @brief  Read the error state.
+
+    @return The error state.
+*/
+/**************************************************************************/
+uint8_t Adafruit_MAX31855::readError() { return spiread32() & 0x7; }
 
-double Adafruit_MAX31855::readFarenheit(void) {
+/**************************************************************************/
+/*!
+    @brief  Read the thermocouple temperature.
+
+    @return The thermocouple temperature in degrees Fahrenheit.
+*/
+/**************************************************************************/
+double Adafruit_MAX31855::readFahrenheit(void) {
   float f = readCelsius();
   f *= 9.0;
   f /= 5.0;
   f += 32;
   return f;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Read 4 bytes (32 bits) from breakout over SPI.
+
+    @return The raw 32 bit value read.
+*/
+/**************************************************************************/
 uint32_t Adafruit_MAX31855::spiread32(void) {
   int i;
   uint32_t d = 0;
   uint8_t buf[4];
 
   // backcompatibility!
-  if (! initialized) {
+  if (!initialized) {
     begin();
   }
 
@@ -128,10 +199,10 @@ uint32_t Adafruit_MAX31855::spiread32(void) {
   d |= buf[1];
   d <<= 8;
   d |= buf[2];
-  d <<=8;
+  d <<= 8;
   d |= buf[3];
 
-  //Serial.println(d, HEX);
+  // Serial.println(d, HEX);
 
   return d;
 }

Adafruit_MAX31855.h

@@ -1,42 +1,51 @@
-/***************************************************
-  This is a library for the Adafruit Thermocouple Sensor w/MAX31855K
-
-  Designed specifically to work with the Adafruit Thermocouple Sensor
-  ----> https://www.adafruit.com/products/269
-
-  These displays use SPI to communicate, 3 pins are required to
-  interface
-  Adafruit invests time and resources providing this open source code,
-  please support Adafruit and open-source hardware by purchasing
-  products from Adafruit!
-
-  Written by Limor Fried/Ladyada for Adafruit Industries.
-  BSD license, all text above must be included in any redistribution
- ****************************************************/
+/*!
+ * @file Adafruit_MAX31855.h
+ *
+ * This is the documentation for Adafruit's MAX31855 thermocouple breakout
+ * driver for the Arduino platform.  It is designed specifically to work with
+ * the Adafruit MAX31855 breakout: https://www.adafruit.com/products/269
+ *
+ * These sensors use SPI to communicate, 3 pins are required
+ * to interface with the breakout.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Written by Limor Fried/Ladyada for Adafruit Industries.
+ *
+ * BSD license, all text above must be included in any redistribution.
+ *
+ */
 
 #ifndef ADAFRUIT_MAX31855_H
 #define ADAFRUIT_MAX31855_H
 
 #if (ARDUINO >= 100)
- #include "Arduino.h"
+#include "Arduino.h"
 #else
- #include "WProgram.h"
+#include "WProgram.h"
 #endif
 
 #include <Adafruit_SPIDevice.h>
 
+/**************************************************************************/
+/*!
+    @brief  Sensor driver for the Adafruit MAX31855 thermocouple breakout.
+*/
+/**************************************************************************/
 class Adafruit_MAX31855 {
- public:
+public:
   Adafruit_MAX31855(int8_t _sclk, int8_t _cs, int8_t _miso);
   Adafruit_MAX31855(int8_t _cs);
 
   void begin(void);
   double readInternal(void);
   double readCelsius(void);
-  double readFarenheit(void);
+  double readFahrenheit(void);
   uint8_t readError();
 
- private:
+private:
   Adafruit_SPIDevice spi_dev = NULL;
   boolean initialized;
 

README.md

@@ -1,32 +1,16 @@
-# Adafruit-MAX31855-library
-<!-- START COMPATIBILITY TABLE -->
+# Adafruit-MAX31855-library ![Build Status](https://github.com/adafruit/Adafruit-MAX31855-library/workflows/Arduino%20Library%20CI/badge.svg)
 
-## Compatibility
+Driver for the [Adafruit MAX31855 Thermocouple Amplifier](https://www.adafruit.com/product/269)
 
-MCU                | Tested Works | Doesn't Work | Not Tested  | Notes
------------------- | :----------: | :----------: | :---------: | -----
-Atmega328 @ 16MHz  |      X       |             |            | 
-Atmega328 @ 12MHz  |      X       |             |            | For LCD example had to move pin 7.
-Atmega32u4 @ 16MHz |      X       |             |            | 
-Atmega32u4 @ 8MHz  |      X       |             |            | 
-ESP8266            |      X       |             |            | 
-Atmega2560 @ 16MHz |      X       |             |            | 
-ATSAM3X8E          |      X       |             |            | 
-ATSAM21D           |      X       |             |            | 
-ATtiny85 @ 16MHz   |             |      X       |            | 
-ATtiny85 @ 8MHz    |             |      X       |            | 
-Intel Curie @ 32MHz |             |             |     X       | 
-STM32F2            |             |             |     X       | 
+## Info
 
-  * ATmega328 @ 16MHz : Arduino UNO, Adafruit Pro Trinket 5V, Adafruit Metro 328, Adafruit Metro Mini
-  * ATmega328 @ 12MHz : Adafruit Pro Trinket 3V
-  * ATmega32u4 @ 16MHz : Arduino Leonardo, Arduino Micro, Arduino Yun, Teensy 2.0
-  * ATmega32u4 @ 8MHz : Adafruit Flora, Bluefruit Micro
-  * ESP8266 : Adafruit Huzzah
-  * ATmega2560 @ 16MHz : Arduino Mega
-  * ATSAM3X8E : Arduino Due
-  * ATSAM21D : Arduino Zero, M0 Pro
-  * ATtiny85 @ 16MHz : Adafruit Trinket 5V
-  * ATtiny85 @ 8MHz : Adafruit Gemma, Arduino Gemma, Adafruit Trinket 3V
+The MAX31855K does everything for you, and can be easily interfaced with any microcontroller, even one without an analog input. This breakout board has the chip itself, a 3.3V regulator with 10uF bypass capacitors and level shifting circuitry, all assembled and tested. For use with
+[type K thermocouples](http://www.adafruit.com/products/270)
 
-<!-- END COMPATIBILITY TABLE -->
+Adafruit invests time and resources providing this open source code, please
+support Adafruit and open-source hardware by purchasing products from
+[Adafruit](https://www.adafruit.com)!
+
+## License
+
+ BSD license, all text above must be included in any redistribution.