Skip to content

Commit

Permalink
Update documentation & changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
nekuz0r committed Dec 30, 2014
1 parent 192d253 commit bd2ff91
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# CHANGELOG

## v2.0.0 *[not released yet]*
## v2.1.0 *[not released yes]*
* **Update:** libWiringPi to [custom][nekuz0r-libWiringPi] v2.21 `nekuz0r`
* **Add:** raspberry pi A+ support `nekuz0r`

## v2.0.0 *[Jan 1 2015]*
* **Update:** libWiringPi to [custom][nekuz0r-libWiringPi] v2.20 `nekuz0r`
* **Update:** split source code (based on libWiringPi hierarchy) `nekuz0r`
* **Update:** better types check `nekuz0r`
Expand Down Expand Up @@ -32,6 +36,7 @@
* **Add:** piGlow support `nekuz0r`
* **Add:** piNes support `nekuz0r`
* **Add:** tcs34725 support `nekuz0r`
* **Add:** dac7678 support `nekuz0r`
* **Fictitious:** this release eats Pi(e)s :)

## v1.1.1 *[Jul 4 2014]*
Expand Down
33 changes: 32 additions & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* [Soft Servo](#soft-servo)
* [Soft Tone](#soft-tone)
* [Extensions](#extensions)
* [dac7678](#dac7678)
* [drcSerial](#drcserial)
* [max31855](#max31855)
* [max5322](#max5322)
Expand Down Expand Up @@ -695,6 +696,28 @@ The tone will be played until you set the frequency to 0.

## Extensions

### dac7678

12-Bit octal-channel DAC with 2.5V internal reference (I2C)

*Datasheet*: http://www.ti.com/lit/ds/sbas493c/sbas493c.pdf

#### dac7678Setup(pinBase, i2cAddress, vrefMode)
<span class="api-info"><code> >= 2.0.0 </code></span>

`state` can be one of the following value:

* `DAC7678_VREF_MODE_STATIC_ON`
<span class="api-info-list"><code> >= 2.0.0 </code></span>
* `DAC7678_VREF_MODE_STATIC_OFF`
<span class="api-info-list"><code> >= 2.0.0 </code></span>
* `DAC7678_VREF_MODE_FLEXIBLE_ON`
<span class="api-info-list"><code> >= 2.0.0 </code></span>
* `DAC7678_VREF_MODE_FLEXIBLE_ALWAYS_ON`
<span class="api-info-list"><code> >= 2.0.0 </code></span>
* `DAC7678_VREF_MODE_FLEXIBLE_ALWAYS_OFF`
<span class="api-info-list"><code> >= 2.0.0 </code></span>

### drcSerial

#### drcSetupSerial(pinBase, numPins, device, baudrate)
Expand Down Expand Up @@ -1080,10 +1103,18 @@ Color light-to-digital converter with IR filter
#### tcs34725Setup(i2cAddress, integrationTime, gain)
<span class="api-info"><code> >= 2.0.0 </code></span>

Initialize the device and returns the assigned id.
Don't forget to call `tcs34725Enable`, the device is in power sleep mode after initialization.

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

Read the raw red, green, blue and clear channel values
Read the raw red, green, blue and clear channel values (0 - 255)

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

Returns the cylindrical-coordinate representation of the sensor red, green and blue channels.

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

0 comments on commit bd2ff91

Please sign in to comment.