Added Travis CI, fixed spelling, added readme and license files.

Can't spell coefficient 😢

Author: FischerMoseley

.travis.yml

@@ -0,0 +1,23 @@
+language: c
+before_install:
+  - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16"
+  - sleep 3
+  - export DISPLAY=:1.0
+  - wget http://downloads.arduino.cc/arduino-1.8.9-linux64.tar.xz
+  - tar xf arduino-1.8.9-linux64.tar.xz
+  - sudo mv arduino-1.8.9 /usr/local/share/arduino
+  - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino
+install:
+  - ln -s $PWD /usr/local/share/arduino/libraries/Adafruit_FONA
+  - arduino --install-library "SparkFun MCP9600 Arduino Library,Adafruit MQTT Library"
+script:
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example1_BasicReadings/Example1_BasicReadings.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example2_SetThermocoupleType/Example2_SetThermocoupleType.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example3_SetFilterCoefficient/Example3_SetFilterCoefficient.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example4_SetResolution/Example4_SetResolution.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example5_BurstMode/Example5_BurstMode.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/Example6_ConfigureTemperatureAlert/Example6_ConfigureTemperatureAlert.ino    
+notifications:
+  email:
+    on_success: change
+    on_failure: change

LICENSE.md

@@ -0,0 +1,55 @@
+SparkFun License Information
+============================
+
+SparkFun uses two different licenses for our files — one for hardware and one for code.
+
+Hardware
+---------
+
+**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+
+Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format
+Adapt — remix, transform, and build upon the material
+for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+Notices:
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+
+Code
+--------
+
+**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
+
+The MIT License (MIT)
+
+Copyright (c) 2016 SparkFun Electronics
+
+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.

README.md

@@ -0,0 +1,52 @@
+SparkFun MCP9600 Arduino Library [![Build Status](https://travis-ci.com/sparkfun/SparkFun_MCP9600_Arduino_Library.svg?token=3wUDYUD5kXLUXs2Cb6te&branch=master)](https://travis-ci.com/sparkfun/SparkFun_MCP9600_Arduino_Library)
+========================================
+
+![SparkFun MCP9600 Breakout](https://media.tenor.com/images/47b81948be5023555549c01d88ae3289/tenor.gif)
+
+This library allows the user to:
+
+* Read temperature in Celcius or Fahrenheit
+* Use a variety of thermocouple types
+* Configure the onboard exponential moving average filter
+* Set up continuous and burst conversion modes
+* Configure temperature alerts
+
+
+Repository Contents
+-------------------
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/extras** - Additional documentation for the user. These files are ignored by the IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+
+Documentation
+--------------
+
+* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+* **[Product Repository](https://github.com/sparkfun/BME280-Breakout-Board)** - Main repository (including hardware files) for the SparkFun BME280 Breakout.
+* **[Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-bme280-breakout-hookup-guide)** - Basic hookup guide for the SparkFun BME280 Breakout.
+
+Products that use this Library 
+---------------------------------
+
+* [*SEN-14348*](https://www.sparkfun.com/products/14348)
+
+Version History
+---------------
+
+* [V_1.0.0](https://github.com/sparkfun/SparkFun_MCP9600_Arduino_Library/tree/V_1.0.0) - Public release.
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Please review the LICENSE.md file for license information. 
+
+If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

…ients/Example3_SetFilterCoeffecients.ino …icient/Example3_SetFilterCoefficient.inoexamples/Example3_SetFilterCoeffecients/Example3_SetFilterCoeffecients.ino renamed to examples/Example3_SetFilterCoefficient/Example3_SetFilterCoefficient.ino examples/Example3_SetFilterCoeffecients/Example3_SetFilterCoeffecients.ino renamed to examples/Example3_SetFilterCoefficient/Example3_SetFilterCoefficient.ino

@@ -1,13 +1,13 @@
 /*
-  Setting Filter Coeffecients with the MCP9600 Thermocouple Amplifier
+  Setting Filter Coefficient with the MCP9600 Thermocouple Amplifier
   By: Fischer Moseley
   SparkFun Electronics
   Date: July 8, 2019
   License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware License).
 
   This example outputs the ambient and thermocouple temperatures from the MCP9600 sensor, but allows the filtering
   onboard the MCP9600 to be controlled. The MCP9600 implements an exponential running average filter, the
-  "strength" of which is programmable! The setFilterCoeffecients function takes a coeffecient between 0 and 7, 
+  "strength" of which is programmable! The setFilterCoefficient function takes a coefficient between 0 and 7, 
   where 0 disables the filter, 1 corresponds to minimum filtering, and 7 enables maximum filtering. The "strength"
   of the filter just refers to how long it takes for the filter to respond to a step function input. 
 
@@ -19,7 +19,7 @@
 
 #include <SparkFun_MCP9600.h>
 MCP9600 tempSensor;
-uint8_t coeffecient = 3;
+uint8_t coefficient = 3;
 
 void setup(){
     Serial.begin(115200);
@@ -46,22 +46,22 @@ void setup(){
         while(1); //hang forever
     }
 
-    //print the filter coeffecient that's about to be set
-    Serial.print("Setting Filter Coeffecient to ");
-    Serial.print(coeffecient);
+    //print the filter coefficient that's about to be set
+    Serial.print("Setting Filter coefficient to ");
+    Serial.print(coefficient);
     Serial.println("!");
 
-    tempSensor.setFilterCoeffecients(coeffecient);
+    tempSensor.setFilterCoefficient(coefficient);
 
-    //tell us if the coeffecient was set sucessfully
-    if(tempSensor.getFilterCoeffecients() == coeffecient){
-        Serial.println("Filter Coeffecients set sucessfully!");
+    //tell us if the coefficient was set sucessfully
+    if(tempSensor.getFilterCoefficient() == coefficient){
+        Serial.println("Filter Coefficient set sucessfully!");
     }
 
     else{
-        Serial.println("Setting filter coeffecient failed!");
-        Serial.println("The value of the coeffecient is: ");
-        Serial.println(tempSensor.getFilterCoeffecients(), BIN);
+        Serial.println("Setting filter coefficient failed!");
+        Serial.println("The value of the coefficient is: ");
+        Serial.println(tempSensor.getFilterCoefficient(), BIN);
     }
 }
 
@@ -73,8 +73,8 @@ void loop(){ //print the thermocouple, ambient and delta temperatures every 200m
     Serial.print(" °C   Temperature Delta: ");
     Serial.print(tempSensor.tempDelta());
     Serial.print(" °C");
-    Serial.print("   Current Coeffecient: ");
-    Serial.print(tempSensor.getFilterCoeffecients(), BIN);
+    Serial.print("   Current coefficient: ");
+    Serial.print(tempSensor.getFilterCoefficient(), BIN);
     Serial.println();
     delay(200);
 }

src/SparkFun_MCP9600.cpp

@@ -145,31 +145,31 @@ Thermocouple_Type MCP9600::getThermocoupleType(){
   return (config >> 4); //clear the non-thermocouple-type bits in the config registe
 }
 
-uint8_t MCP9600::setFilterCoeffecients(uint8_t coeffecient){
-  if(coeffecient > 7) return 3; //return immediately if the value is too big
+uint8_t MCP9600::setFilterCoefficient(uint8_t coefficient){
+  if(coefficient > 7) return 3; //return immediately if the value is too big
 
   uint8_t config = readSingleRegister(THERMO_SENSOR_CONFIG);
-  bitWrite(coeffecient, 3, bitRead(config, 3));
-  bitWrite(coeffecient, 4, bitRead(config, 3));
-  bitWrite(coeffecient, 5, bitRead(config, 3));
-  bitWrite(coeffecient, 6, bitRead(config, 3));
-  bitWrite(coeffecient, 7, bitRead(config, 3));
+  bitWrite(coefficient, 3, bitRead(config, 3));
+  bitWrite(coefficient, 4, bitRead(config, 3));
+  bitWrite(coefficient, 5, bitRead(config, 3));
+  bitWrite(coefficient, 6, bitRead(config, 3));
+  bitWrite(coefficient, 7, bitRead(config, 3));
 
   //config = config >> 3;
   //config = config << 3;
-  //config |= coeffecient; //set the necessary bits in the config register
+  //config |= coefficient; //set the necessary bits in the config register
 
-  return writeSingleRegister(THERMO_SENSOR_CONFIG, coeffecient);
+  return writeSingleRegister(THERMO_SENSOR_CONFIG, coefficient);
 }
 
-uint8_t MCP9600::getFilterCoeffecients(){
+uint8_t MCP9600::getFilterCoefficient(){
   uint8_t config = readSingleRegister(THERMO_SENSOR_CONFIG);
   uint8_t coeff = 0;
   bitWrite(coeff, 0, bitRead(config, 0));
   bitWrite(coeff, 1, bitRead(config, 1));
   bitWrite(coeff, 2, bitRead(config, 2));
 
-  return coeff; //clear the non-filter-coeffecients data in the config register
+  return coeff; //clear the non-filter-Coefficient data in the config register
 }
 
 bool MCP9600::setBurstSamples(Burst_Sample samples){

src/SparkFun_MCP9600.h

@@ -120,8 +120,8 @@ class MCP9600{
 
   uint8_t setThermocoupleType(Thermocouple_Type type);              //Changes the type of thermocouple connected to the MCP9600. Supported types are KJTNSEBR.
   Thermocouple_Type getThermocoupleType();                          //Returns the type of thermocouple connected to the MCP9600 as found in its configuration register. Supported types are KJTNSEBR.
-  uint8_t setFilterCoeffecients(uint8_t coeffecient);               //Changes the weight of the on-chip exponential moving average filter. Set this to 0 for no filter, 1 for minimum filter, and 7 for maximum filter.
-  uint8_t getFilterCoeffecients();                                  //Returns the weight of the on-chip exponential moving average filter.
+  uint8_t setFilterCoefficient(uint8_t coefficient);               //Changes the weight of the on-chip exponential moving average filter. Set this to 0 for no filter, 1 for minimum filter, and 7 for maximum filter.
+  uint8_t getFilterCoefficient();                                  //Returns the weight of the on-chip exponential moving average filter.
 
   bool setBurstSamples(Burst_Sample samples);                       //Changes the amount of samples to take in burst mode. Returns 0 if set sucessfully, 1 otherwise.
   Burst_Sample getBurstSamples();                                   //Returns the amount of samples to take in burst mode, according to the device's configuration register.