Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nekuz0r committed Jul 24, 2014
1 parent 70944b0 commit 215b202
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -699,111 +699,143 @@ 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)
<span class="api-info"><code> >= 1.0.0 </code></span>

### max5322

12-Bit DAC (SPI)

*Datasheet*: http://datasheets.maximintegrated.com/en/ds/MAX5322.pdf

#### max5322Setup(pinBase, spiChannel)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp23008

8-Bit I/O expander (I2C)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21919e.pdf

#### mcp23008Setup(pinBase, i2cAddress)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp23016

16-Bit I/O expander (I2C)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/20090C.pdf

#### mcp23016Setup(pinBase, i2cAddress)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mpc23017

16-Bit I/O expander (I2C)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf

#### mcp23017Setup(pinBase, i2cAddress)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp23s08

8-Bit I/O expander (SPI)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21919e.pdf

#### mcp23s08Setup(pinBase, spiChannel, devId)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp23s17

16-Bit I/O expander (SPI)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf

#### mcp23s17Setup(pinBase, spiChannel, devId)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp3002

2-Channel 10-Bit ADC (SPI)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21294E.pdf

#### mcp3002Setup(pinBase, spiChannel)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp3004/8

4/8-Channel 10-Bit ADC (SPI)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/21295C.pdf

#### mcp3004Setup(pinBase, spiChannel)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp3422/3/4

2/4-Channel 18-Bit ADC (I2C)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/22088b.pdf

#### mcp3422Setup(pinBase, i2cAddress, sampleRate, gain)
<span class="api-info"><code> >= 1.0.0 </code></span>

### mcp4802/12/22

2-Channel 8/10/12-Bit DAC (SPI)

*Datasheet*: http://ww1.microchip.com/downloads/en/DeviceDoc/22249A.pdf

#### mcp4802Setup(pinBase, spiChannel)
<span class="api-info"><code> >= 1.0.0 </code></span>

### pca9685

16-Channel 12-Bit PWM led/servo driver (I2C)

*Datasheet*: http://www.adafruit.com/datasheets/PCA9685.pdf

#### pca9685Setup(pinBase, i2cAddress, frequency)
<span class="api-info"><code> >= 1.1.0 </code></span>

### pcf8574

8-Bit I/O expander (I2C)

*Datasheet*: http://www.nxp.com/documents/data_sheet/PCF8574.pdf

#### pcf8574Setup(pinBase, i2cAddress)
<span class="api-info"><code> >= 1.0.0 </code></span>

### pcf8591

8-Bit ADC and DAC (I2C)

*Datasheet*: http://www.nxp.com/documents/data_sheet/PCF8591.pdf

#### pcf8591Setup(pinBase, i2cAddress)
<span class="api-info"><code> >= 1.0.0 </code></span>

### sn3218

18-Channel PWM led driver (I2C)

*Datasheet*: http://www.si-en.com/uploadpdf/s2011517171720.pdf

#### sn3218Setup(pinBase)
<span class="api-info"><code> >= 1.0.0 </code></span>

### sr595

74x595 shift register

*Datasheet*: http://www.nxp.com/documents/data_sheet/74HC_HCT595.pdf

#### sr595Setup(pinBase, numPins, dataPin, clockPin, latchPin)
<span class="api-info"><code> >= 1.0.0 </code></span>

Expand All @@ -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)
<span class="api-info"><code> >= 2.0.0 </code></span>

Expand Down Expand Up @@ -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)
<span class="api-info"><code> >= 2.0.0 </code></span>

#### tcs34725ReadRGBC(id)
<span class="api-info"><code> >= 2.0.0 </code></span>

Read the raw red, green, blue and clear channel values

#### tcs34725GetCorrelatedColorTemperature(r, g, b)
<span class="api-info"><code> >= 2.0.0 </code></span>

Convert the raw R/G/B values to color temperature in degrees Kelvin

#### tcs34725GetIlluminance(r, g, b)
<span class="api-info"><code> >= 2.0.0 </code></span>

Convert the raw R/G/B values to illuminance in Lux

#### tcs34725SetInterrupt(id, aien)
<span class="api-info"><code> >= 2.0.0 </code></span>

Enable/Disable interrupt

#### tcs34725ClearInterrupt(id)
<span class="api-info"><code> >= 2.0.0 </code></span>

Clear interrupt

#### tcs34725SetInterruptLimits(id, low, high)
<span class="api-info"><code> >= 2.0.0 </code></span>

#### tcs34725Enable(id)
<span class="api-info"><code> >= 2.0.0 </code></span>

Enable the device

#### tcs34725Disable(id)
<span class="api-info"><code> >= 2.0.0 </code></span>

Disable the device (putting it in lower power sleep mode)

0 comments on commit 215b202

Please sign in to comment.