From 215b202408a41d387ffb24f924b25ffd315196bb Mon Sep 17 00:00:00 2001 From: Leandre Gohy Date: Thu, 24 Jul 2014 10:23:23 +0200 Subject: [PATCH] update documentation --- DOCUMENTATION.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index eb81721..7c005ef 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -699,6 +699,8 @@ The tone will be played until you set the frequency to 0. Cold-junction compensated thermocouple-to-digital converter (SPI) +*Datasheet*: http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf + #### max31855Setup(pinBase, spiChannel) >= 1.0.0 @@ -706,6 +708,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 12-Bit DAC (SPI) +*Datasheet*: http://datasheets.maximintegrated.com/en/ds/MAX5322.pdf + #### max5322Setup(pinBase, spiChannel) >= 1.0.0 @@ -713,6 +717,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 8-Bit I/O expander (I2C) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21919e.pdf + #### mcp23008Setup(pinBase, i2cAddress) >= 1.0.0 @@ -720,6 +726,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 16-Bit I/O expander (I2C) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/20090C.pdf + #### mcp23016Setup(pinBase, i2cAddress) >= 1.0.0 @@ -727,6 +735,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 16-Bit I/O expander (I2C) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf + #### mcp23017Setup(pinBase, i2cAddress) >= 1.0.0 @@ -734,6 +744,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 8-Bit I/O expander (SPI) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21919e.pdf + #### mcp23s08Setup(pinBase, spiChannel, devId) >= 1.0.0 @@ -741,6 +753,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 16-Bit I/O expander (SPI) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf + #### mcp23s17Setup(pinBase, spiChannel, devId) >= 1.0.0 @@ -748,6 +762,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 2-Channel 10-Bit ADC (SPI) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21294E.pdf + #### mcp3002Setup(pinBase, spiChannel) >= 1.0.0 @@ -755,6 +771,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 4/8-Channel 10-Bit ADC (SPI) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21295C.pdf + #### mcp3004Setup(pinBase, spiChannel) >= 1.0.0 @@ -762,6 +780,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 2/4-Channel 18-Bit ADC (I2C) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/22088b.pdf + #### mcp3422Setup(pinBase, i2cAddress, sampleRate, gain) >= 1.0.0 @@ -769,6 +789,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 2-Channel 8/10/12-Bit DAC (SPI) +*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/22249A.pdf + #### mcp4802Setup(pinBase, spiChannel) >= 1.0.0 @@ -776,6 +798,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 16-Channel 12-Bit PWM led/servo driver (I2C) +*Datasheet*: http://www.adafruit.com/datasheets/PCA9685.pdf + #### pca9685Setup(pinBase, i2cAddress, frequency) >= 1.1.0 @@ -783,6 +807,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 8-Bit I/O expander (I2C) +*Datasheet*: http://www.nxp.com/documents/data_sheet/PCF8574.pdf + #### pcf8574Setup(pinBase, i2cAddress) >= 1.0.0 @@ -790,6 +816,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 8-Bit ADC and DAC (I2C) +*Datasheet*: http://www.nxp.com/documents/data_sheet/PCF8591.pdf + #### pcf8591Setup(pinBase, i2cAddress) >= 1.0.0 @@ -797,6 +825,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 18-Channel PWM led driver (I2C) +*Datasheet*: http://www.si-en.com/uploadpdf/s2011517171720.pdf + #### sn3218Setup(pinBase) >= 1.0.0 @@ -804,6 +834,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) 74x595 shift register +*Datasheet*: http://www.nxp.com/documents/data_sheet/74HC_HCT595.pdf + #### sr595Setup(pinBase, numPins, dataPin, clockPin, latchPin) >= 1.0.0 @@ -815,6 +847,8 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) Trickle-charge timekeeping chip +*Datasheet*: http://datasheets.maximintegrated.com/en/ds/DS1302.pdf + #### ds1302setup(clockPin, dataPin, csPin) >= 2.0.0 @@ -1034,29 +1068,47 @@ You can use the constants: ### tcs34725 +Color light-to-digital converter with IR filter + +*Datasheet*: http://www.adafruit.com/datasheets/TCS34725.pdf + #### tcs34725Setup(i2cAddress, integrationTime, gain) >= 2.0.0 #### tcs34725ReadRGBC(id) >= 2.0.0 +Read the raw red, green, blue and clear channel values + #### tcs34725GetCorrelatedColorTemperature(r, g, b) >= 2.0.0 +Convert the raw R/G/B values to color temperature in degrees Kelvin + #### tcs34725GetIlluminance(r, g, b) >= 2.0.0 +Convert the raw R/G/B values to illuminance in Lux + #### tcs34725SetInterrupt(id, aien) >= 2.0.0 +Enable/Disable interrupt + #### tcs34725ClearInterrupt(id) >= 2.0.0 +Clear interrupt + #### tcs34725SetInterruptLimits(id, low, high) >= 2.0.0 #### tcs34725Enable(id) >= 2.0.0 +Enable the device + #### tcs34725Disable(id) >= 2.0.0 + +Disable the device (putting it in lower power sleep mode)