From 70944b09f9db250827ad7db8c51261d2bc7759eb Mon Sep 17 00:00:00 2001 From: Leandre Gohy Date: Thu, 24 Jul 2014 10:09:06 +0200 Subject: [PATCH] update documentation --- DOCUMENTATION.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 1f3ce42..eb81721 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -693,102 +693,119 @@ The tone will be played until you set the frequency to 0. ### drcSerial #### drcSetupSerial(pinBase, numPins, device, baudrate) + >= 1.0.0 ### max31855 Cold-junction compensated thermocouple-to-digital converter (SPI) #### max31855Setup(pinBase, spiChannel) + >= 1.0.0 ### max5322 12-Bit DAC (SPI) #### max5322Setup(pinBase, spiChannel) + >= 1.0.0 ### mcp23008 8-Bit I/O expander (I2C) #### mcp23008Setup(pinBase, i2cAddress) + >= 1.0.0 ### mcp23016 16-Bit I/O expander (I2C) #### mcp23016Setup(pinBase, i2cAddress) + >= 1.0.0 ### mpc23017 16-Bit I/O expander (I2C) #### mcp23017Setup(pinBase, i2cAddress) + >= 1.0.0 ### mcp23s08 8-Bit I/O expander (SPI) #### mcp23s08Setup(pinBase, spiChannel, devId) + >= 1.0.0 ### mcp23s17 16-Bit I/O expander (SPI) #### mcp23s17Setup(pinBase, spiChannel, devId) + >= 1.0.0 ### mcp3002 2-Channel 10-Bit ADC (SPI) #### mcp3002Setup(pinBase, spiChannel) + >= 1.0.0 ### mcp3004/8 4/8-Channel 10-Bit ADC (SPI) #### mcp3004Setup(pinBase, spiChannel) + >= 1.0.0 ### mcp3422/3/4 2/4-Channel 18-Bit ADC (I2C) #### mcp3422Setup(pinBase, i2cAddress, sampleRate, gain) + >= 1.0.0 ### mcp4802/12/22 2-Channel 8/10/12-Bit DAC (SPI) #### mcp4802Setup(pinBase, spiChannel) + >= 1.0.0 ### pca9685 16-Channel 12-Bit PWM led/servo driver (I2C) #### pca9685Setup(pinBase, i2cAddress, frequency) + >= 1.1.0 ### pcf8574 8-Bit I/O expander (I2C) #### pcf8574Setup(pinBase, i2cAddress) + >= 1.0.0 ### pcf8591 8-Bit ADC and DAC (I2C) #### pcf8591Setup(pinBase, i2cAddress) + >= 1.0.0 ### sn3218 18-Channel PWM led driver (I2C) #### sn3218Setup(pinBase) + >= 1.0.0 ### sr595 74x595 shift register #### sr595Setup(pinBase, numPins, dataPin, clockPin, latchPin) + >= 1.0.0 --- @@ -799,24 +816,33 @@ Cold-junction compensated thermocouple-to-digital converter (SPI) Trickle-charge timekeeping chip #### ds1302setup(clockPin, dataPin, csPin) + >= 2.0.0 #### ds1302rtcRead(reg) + >= 2.0.0 #### ds1302rtcWrite(reg, data) + >= 2.0.0 #### ds1302ramRead(address) + >= 2.0.0 #### ds1302ramWrite(address, data) + >= 2.0.0 #### ds1302clockRead() + >= 2.0.0 #### ds1302clockWrite(clockData[8]) + >= 2.0.0 #### ds1302trickleCharge(diodes, resistors) + >= 2.0.0 ### GertBoard #### getboardAnalogSetup(pinBase) + >= 2.0.0 pinBase is the base pin that you want the analog ports to appear as. @@ -839,6 +865,7 @@ So reading channel pinBase + 0 reads the first analog input channel (pin DA0 on ### LCD #### lcdInit(rows, cols, bits, rs, strb, d0, d1, d2, d3, d4, d5, d6, d7) + >= 2.0.0 This is the main initialisation function and must be called before you use any other LCD functions. @@ -855,28 +882,35 @@ Only the first 4 are used if you are running the display in 4-bit mode. The return value is the ‘handle’ to be used for all subsequent calls to the lcd library when dealing with that LCD, or -1 to indicate a fault. (Usually incorrect parameters) #### lcdHome(fd) + >= 2.0.0 This home the cursor #### lcdClear(fd) + >= 2.0.0 This clear the screen #### lcdDisplay(fd, state) + >= 2.0.0 This turns the display on or off #### lcdCursor(fd, state) + >= 2.0.0 This turns the cursor on or off #### lcdCursorBlink(fd, state) + >= 2.0.0 This turns blinking cursor on or off #### lcdSendCommand(fd, command) + >= 2.0.0 #### lcdPosition(fd, x, y) + >= 2.0.0 Set the position of the cursor for subsequent text entry. @@ -885,6 +919,7 @@ x is the column and 0 is the left-most edge. y is the line and 0 is the top line. #### lcdCharDef(fd, index, data[8]) + >= 2.0.0 This allows you to re-define one of the 8 user-definable chanracters in the display. @@ -895,22 +930,28 @@ Note that the characters are actually 5×8, so only the lower 5 bits are used. The index is from 0 to 7 and you can subsequently print the character defined using the lcdPutchar() call. #### lcdPutchar(fd, character) + >= 2.0.0 #### lcdPuts(fd, string) + >= 2.0.0 #### lcdPrintf(fd, string) + >= 2.0.0 ### LCD 128x64 ### MaxDetect #### maxDetectRead(pin) + >= 2.0.0 #### readRHT03(pin) + >= 2.0.0 ### piFace #### piFaceSetup(pinBase) + >= 2.0.0 pinBase is the base pin that you want your PiFace to appear as – the examples provided use 200 as the base pin. @@ -931,6 +972,7 @@ The remaining 16 pins are used by the underlying MCP23S17 driver and should not ### piGlow #### piGlowSetup(clear) + >= 2.0.0 This initialises the PiGlow devLib software. @@ -955,18 +997,21 @@ If TRUE, then all the LEDs will be turned off to start with. **NOTE: Internally the PiGlow devLib extension adds 18 more pins to wiringPi’s pin map. These pin are normally at location 577. This should not be an issue as the PiGlow is designed to be the only peripheral on the Pi, but if you have used a breakout board to add other devices to it, then you should pick a pinBase that’s outside the range 577 through 595.** #### piGlow1(leg, ring, intensity) + >= 2.0.0 This lights up an individual LED to the intensity given. The leg and ring parameters specify the LED to set. #### piGlowLeg(leg, intensity) + >= 2.0.0 This will light up all 6 LEDs on the given led (0, 1 or 2) to the supplied intensity. The leg number will depend on which way up you have the Pi, but leg 0 is normally the one that points to the same edge the composite video connector in on, 1 is to the right (clockwise) and 2 is to the left (anticlockwise) #### piGlowRing(ring, intensity) + >= 2.0.0 This will light up all 3 LEDs on the given ring at the given intensity – 0 (off) to 255 (really bright!) The ring number is 0 from the outside to 5 for the inside. @@ -982,25 +1027,36 @@ You can use the constants: ### piNes #### setupNesJoystick(dPin, cPin, lPin) + >= 2.0.0 #### readNesJoystick(joystick) + >= 2.0.0 ### tcs34725 #### tcs34725Setup(i2cAddress, integrationTime, gain) + >= 2.0.0 #### tcs34725ReadRGBC(id) + >= 2.0.0 #### tcs34725GetCorrelatedColorTemperature(r, g, b) + >= 2.0.0 #### tcs34725GetIlluminance(r, g, b) + >= 2.0.0 #### tcs34725SetInterrupt(id, aien) + >= 2.0.0 #### tcs34725ClearInterrupt(id) + >= 2.0.0 #### tcs34725SetInterruptLimits(id, low, high) + >= 2.0.0 #### tcs34725Enable(id) + >= 2.0.0 -#### tcs34725Disable(id) \ No newline at end of file +#### tcs34725Disable(id) + >= 2.0.0