From cfa5423d65e203a04db3e0ea0c85d004ab021d7c Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Sun, 28 Feb 2016 11:46:02 +0000 Subject: [PATCH] Tidying --- README.md | 23 +++---- functions.txt | 113 ----------------------------------- piglow.py => tests/piglow.py | 0 test.py => tests/test.py | 0 4 files changed, 13 insertions(+), 123 deletions(-) delete mode 100644 functions.txt rename piglow.py => tests/piglow.py (100%) rename test.py => tests/test.py (100%) diff --git a/README.md b/README.md index ac68cf2..ffcd50b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -**WiringPi 2 for Python** +#WiringPi 2 for Python WiringPi: An implementation of most of the Arduino Wiring functions for the Raspberry Pi -WiringPi2: WiringPi version 2 implements new functions for managing IO expanders. +WiringPi version 2 implements new functions for managing IO expanders. -**Testing:** +##Testing Build with gcc version 4.6.3 (Debian 4.6.3-14+rpi1) Built against Python 2.7.2, Python 3.2.3 -**Prerequisites:** +##Prerequisites You **must** have python-dev and python-setuptools installed If you manually rebuild the bindings with swig -python wiringpi.i @@ -20,22 +20,25 @@ cd wiringPi sudo ./build ``` -**Get/setup repo:** +##Get/setup repo ```bash -git clone https://github.com/Gadgetoid/WiringPi2-Python.git -cd WiringPi2-Python +git clone https://github.com/WiringPi/WiringPi-Python.git +cd WiringPi-Python ``` -**Build & install with:** +##Generate Bindings +`swig3.0 -thread -python wiringpi.i` + +##Build & install with `sudo python setup.py install` Or Python 3: `sudo python3 setup.py install` -**Class-based Usage:** +#Class-based Usage Description incoming! -**Usage:** +##Usage import wiringpi2 diff --git a/functions.txt b/functions.txt deleted file mode 100644 index 106d9db..0000000 --- a/functions.txt +++ /dev/null @@ -1,113 +0,0 @@ -extern unsigned int ds1302rtcRead (const int reg) ; -extern void ds1302rtcWrite (const int reg, const unsigned int data) ; -extern unsigned int ds1302ramRead (const int addr) ; -extern void ds1302ramWrite (const int addr, const unsigned int data) ; -extern void ds1302clockRead (int clockData [8]) ; -extern void ds1302clockWrite (const int clockData [8]) ; -extern void ds1302trickleCharge (const int diodes, const int resistors) ; -extern void ds1302setup (const int clockPin, const int dataPin, const int csPin) ; -extern void gertboardAnalogWrite (const int chan, const int value) ; -extern int gertboardAnalogRead (const int chan) ; -extern int gertboardSPISetup (void) ; -extern int gertboardAnalogSetup (const int pinBase) ; -extern void lcd128x64setOrigin (int x, int y) ; -extern void lcd128x64setOrientation (int orientation) ; -extern void lcd128x64orientCoordinates (int *x, int *y) ; -extern void lcd128x64getScreenSize (int *x, int *y) ; -extern void lcd128x64point (int x, int y, int colour) ; -extern void lcd128x64line (int x0, int y0, int x1, int y1, int colour) ; -extern void lcd128x64lineTo (int x, int y, int colour) ; -extern void lcd128x64rectangle (int x1, int y1, int x2, int y2, int colour, int filled) ; -extern void lcd128x64circle (int x, int y, int r, int colour, int filled) ; -extern void lcd128x64ellipse (int cx, int cy, int xRadius, int yRadius, int colour, int filled) ; -extern void lcd128x64putchar (int x, int y, int c, int bgCol, int fgCol) ; -extern void lcd128x64puts (int x, int y, const char *str, int bgCol, int fgCol) ; -extern void lcd128x64update (void) ; -extern void lcd128x64clear (int colour) ; -extern int lcd128x64setup (void) ; -extern void lcdHome (const int fd) ; -extern void lcdClear (const int fd) ; -extern void lcdDisplay (const int fd, int state) ; -extern void lcdCursor (const int fd, int state) ; -extern void lcdCursorBlink (const int fd, int state) ; -extern void lcdSendCommand (const int fd, unsigned char command) ; -extern void lcdPosition (const int fd, int x, int y) ; -extern void lcdCharDef (const int fd, int index, unsigned char data [8]) ; -extern void lcdPutchar (const int fd, unsigned char data) ; -extern void lcdPuts (const int fd, const char *string) ; -extern void lcdPrintf (const int fd, const char *message, ...) ; -extern int lcdInit (const int rows, const int cols, const int bits, -extern int piFaceSetup (const int pinBase) ; -extern int setupNesJoystick (int dPin, int cPin, int lPin) ; -extern unsigned int readNesJoystick (int joystick) ; -extern int doExtension (char *progName, char *extensionData) ; -extern int mcp23008Setup (const int pinBase, const int i2cAddress) ; -extern int mcp23016Setup (const int pinBase, const int i2cAddress) ; -extern int mcp23017Setup (const int pinBase, const int i2cAddress) ; -extern int mcp23s08Setup (const int pinBase, const int spiPort, const int devId) ; -extern int mcp23s17Setup (int pinBase, int spiPort, int devId) ; -extern int mcp3002Setup (int pinBase, int spiChannel) ; -extern int mcp3422Setup (int pinBase, int i2cAddress, int channels, int sampleRate, int gain) ; -extern int mcp4802Setup (int pinBase, int spiChannel) ; -extern int pcf8574Setup (const int pinBase, const int i2cAddress) ; -extern int pcf8591Setup (const int pinBase, const int i2cAddress) ; -extern int softPwmCreate (int pin, int value, int range) ; -extern void softPwmWrite (int pin, int value) ; -extern void softServoWrite (int pin, int value) ; -extern int softServoSetup (int p0, int p1, int p2, int p3, int p4, int p5, int p6, int p7) ; -extern int softToneCreate (int pin) ; -extern void softToneWrite (int pin, int freq) ; -extern int sr595Setup (const int pinBase, const int numPins, -extern int wiringPiFailure (int fatal, const char *message, ...) ; -extern struct wiringPiNodeStruct *wiringPiNewNode (int pinBase, int numPins) ; -extern int wiringPiSetup (void) ; -extern int wiringPiSetupSys (void) ; -extern int wiringPiSetupGpio (void) ; -extern int wiringPiSetupPhys (void) ; -extern void pinMode (int pin, int mode) ; -extern void pullUpDnControl (int pin, int pud) ; -extern int digitalRead (int pin) ; -extern void digitalWrite (int pin, int value) ; -extern void pwmWrite (int pin, int value) ; -extern int analogRead (int pin) ; -extern void analogWrite (int pin, int value) ; -extern int wiringPiSetupPiFace (void) ; -extern int wiringPiSetupPiFaceForGpioProg (void) ; // Don't use this - for gpio program only -extern int piBoardRev (void) ; -extern int wpiPinToGpio (int wpiPin) ; -extern int physPinToGpio (int physPin) ; -extern void setPadDrive (int group, int value) ; -extern int getAlt (int pin) ; -extern void digitalWriteByte (int value) ; -extern void pwmSetMode (int mode) ; -extern void pwmSetRange (unsigned int range) ; -extern void pwmSetClock (int divisor) ; -extern void gpioClockSet (int pin, int freq) ; -extern int waitForInterrupt (int pin, int mS) ; -extern int wiringPiISR (int pin, int mode, void (*function)(void)) ; -extern int piThreadCreate (void *(*fn)(void *)) ; -extern void piLock (int key) ; -extern void piUnlock (int key) ; -extern int piHiPri (const int pri) ; -extern void delay (unsigned int howLong) ; -extern void delayMicroseconds (unsigned int howLong) ; -extern unsigned int millis (void) ; -extern unsigned int micros (void) ; -extern int wiringPiI2CRead (int fd) ; -extern int wiringPiI2CReadReg8 (int fd, int reg) ; -extern int wiringPiI2CReadReg16 (int fd, int reg) ; -extern int wiringPiI2CWrite (int fd, int data) ; -extern int wiringPiI2CWriteReg8 (int fd, int reg, int data) ; -extern int wiringPiI2CWriteReg16 (int fd, int reg, int data) ; -extern int wiringPiI2CSetupInterface (const char *device, int devId) ; -extern int wiringPiI2CSetup (const int devId) ; -extern int serialOpen (const char *device, const int baud) ; -extern void serialClose (const int fd) ; -extern void serialFlush (const int fd) ; -extern void serialPutchar (const int fd, const unsigned char c) ; -extern void serialPuts (const int fd, const char *s) ; -extern void serialPrintf (const int fd, const char *message, ...) ; -extern int serialDataAvail (const int fd) ; -extern int serialGetchar (const int fd) ; -extern uint8_t shiftIn (uint8_t dPin, uint8_t cPin, uint8_t order) ; -extern void shiftOut (uint8_t dPin, uint8_t cPin, uint8_t order, uint8_t val) ; diff --git a/piglow.py b/tests/piglow.py similarity index 100% rename from piglow.py rename to tests/piglow.py diff --git a/test.py b/tests/test.py similarity index 100% rename from test.py rename to tests/test.py