Merge pull request #8 from canchebagur/add-docs

Add docs folder

Author: aentinger

docs/api.md

@@ -0,0 +1,130 @@
+# Arduino MKR THERM library
+
+## Methods
+
+### `begin()`
+
+Initialize the sensor connected to the shield. 
+
+#### Syntax 
+
+```
+THERM.begin()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+1 on success, 0 on failure.
+
+#### Example
+
+```
+if (!THERM.begin()) {
+    Serial.println("Failed to initialize MKR THERM shield!");
+    while (1);
+}
+```
+
+#### See also
+
+* [end()](#end)
+* [readTemperature()](#readTemperature)
+* [readReferenceTemperature()](#readReferenceTemperature)
+
+### `end()`
+
+De-initialize the sensor connected to the shield. 
+
+#### Syntax 
+
+```
+THERM.end()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+None.
+
+#### Example
+
+```
+THERM.end();
+```
+
+#### See also
+
+* [begin()](#begin)
+* [readTemperature()](#readTemperature)
+* [readReferenceTemperature()](#readReferenceTemperature)
+
+### `readTemperature()`
+
+Read the thermocouple’s hot junction (its tip) temperature value. 
+
+#### Syntax 
+
+```
+THERM.readTemperature() 
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+The thermocouple’s hot junction temperature value in degrees Celsius. 
+
+#### Example
+
+```
+Serial.print("Temperature = ");
+Serial.print(THERM.readTemperature());
+Serial.println(" °C");
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readReferenceTemperature()](#readReferenceTemperature)
+
+### `readReferenceTemperature()`
+
+Read the thermocouple’s cold junction (the connection between the wire of the thermocouple and the connector or the screw terminal) temperature value. This value is used to compensate the temperature reading of the themocouple's hot junction. 
+
+#### Syntax 
+
+```
+THERM.readReferenceTemperature()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+The thermocouple’s cold junction temperature value in degrees Celsius. 
+
+#### Example
+
+```
+Serial.print("Reference temperature = ");
+Serial.print(THERM.readReferenceTemperature());
+Serial.println(" °C");
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readTemperature()](#readTemperature)

docs/readme.md

@@ -0,0 +1,12 @@
+# Arduino MKR THERM library
+
+
+The Arduino MKR THERM library allows you to manage a thermocouple attached to the MKR THERM Shield with a type k connector or with screw terminals. This library manages the MAX31855 chip of the MKR THERM Shield.
+
+The functions available in the library are just two. They allows you to read the temperature of the hot junction of the thermocouple (the tip of the thermocouple) and also the temperature of the cold junction (the connection between the wire of the thermocouple and the connector or the screw terminal). The temperature value of the cold junction is used to give a compensated value of the current measured at the hot junction. This current is then converted into a temperature value. 
+
+To use this library:
+
+```
+#include <Arduino_MKRTHERM.h>
+```