GPIO able to be controlled by pin sysfs number like RPi.GPIO, close #65

CHANGELOG.rst

@@ -1,3 +1,12 @@
+0.7.0
+---
+* Added ability to specify GPIO only as a number, this doesn't work for PWM/SPWM/LRADC/SERVO
+
+0.6.2
+---
+* Implementation for #77 - ability to push up binary pypi
+* Implementation for #75 - wait_for_edge timeout
+
 0.6.1
 ---
 * Fixing implementation for #76

Makefile

@@ -1,10 +1,16 @@
 # PyPi Packaging
 package: clean
 	@echo " ** PACKAGING FOR PYPI **"
-	python setup.py sdist
+	python setup.py sdist bdist_wheel
+	python3 setup.py bdist_wheel
+
+# PyPi Packaging
+package3: package
+	@echo " ** PACKAGING FOR PYPI **"
+	python3 setup.py bdist_wheel
 
 # PyPi Publishing
-publish: package
+publish: package package3
 	@echo " ** UPLOADING TO PYPI **"
 	twine upload dist/*
 

debian/changelog

@@ -1,3 +1,16 @@
+chip-io (0.7.0-1) unstable; urgency=low
+
+ * Added ability to specify GPIO only as a number, this doesn't work for PWM/SPWM/LRADC/SERVO
+
+ -- Robert Wolterman <robert.wolterman@gmail.com>  Wed, 13 Sep 2017 09:51:00 -0600
+
+chip-io (0.6.2-1) unstable; urgency=low
+
+ * Implementation for number 77 ability to push up binary pypi
+ * Implementation for number 75 wait for edge timeout
+
+ -- Robert Wolterman <robert.wolterman@gmail.com>  Sun, 03 Sep 2017 21:34:00 -0600
+
 chip-io (0.6.1-1) unstable; urgency=low
 
  * Fixing implementation for #76

debian/files

@@ -1,2 +1,2 @@
-python-chip-io_0.6.1-1_armhf.deb python optional
+python-chip-io_0.7.0-1_armhf.deb python optional
-python3-chip-io_0.6.1-1_armhf.deb python optional
+python3-chip-io_0.7.0-1_armhf.deb python optional

docs/gpio.md

@@ -227,13 +227,14 @@ Add callback function to a pin that has been setup for edge detection. Refer to
   GPIO.add_event_callback("XIO-P7", mycallback, 45)
   ```
 
-### wait_for_edge(channel, edge)
+### wait_for_edge(channel, edge, timeout=-1)
 Wait for an edge to be detected.  This is a blocking function. Refer to main table for which pins are able to use edge detection.
 
 * Parameters
   
   channel - GPIO Pin
   edge - edge: RISING_EDGE, FALLING_EDGE, BOTH_EDGE
+  timeout - timeout in milliseconds to wait before exiting function (optional)
 
 * Returns
 
@@ -245,6 +246,7 @@ Wait for an edge to be detected.  This is a blocking function. Refer to main tab
   GPIO.wait_for_edge("XIO-P3", GPIO.RISING_EDGE)
   GPIO.wait_for_edge("AP-EINT3", GPIO.BOTH_EDGE)
   GPIO.wait_for_edge("I2S-DI", GPIO.FALLING_EDGE)
+  GPIO.wait_for_edge("XIO-P3", GPIO.RISING_EDGE, 40)
   ```
 
 ### gpio_function(channel)

setup.cfg

@@ -0,0 +1,6 @@
+[bdist_wheel]
+universal = 1
+
+[metadata]
+license_file = LICENSE
+

setup.py

@@ -13,7 +13,7 @@ classifiers = ['Development Status :: 3 - Alpha',
                'Topic :: System :: Hardware']
 
 setup(name             = 'CHIP_IO',
-      version          = '0.6.1',
+      version          = '0.7.0',
       author           = 'Robert Wolterman',
       author_email     = 'robert.wolterman@gmail.com',
       description      = 'A module to control CHIP IO channels',

source/common.c

@@ -371,6 +371,28 @@ int gpio_pud_capable(pins_t *pin)
   return capable;
 }
 
+int lookup_gpio_by_number(const char *num) {
+  // Convert the char to an int
+  char *ptr;
+  long ret;
+  int gpnum;
+  ret = strtol(num, &ptr, 10);
+  if (ret == 0) {
+    return -1;
+  }
+  // If we make it here, lets look for the data
+  pins_t *p;
+  for (p = pins_info; p->key != NULL; ++p) {
+      gpnum = gpio_number(p);
+      // If the number of the gpio pin matches the input
+      // we are 
+      if (gpnum == (int)ret) {
+          return gpnum;
+      }
+  }
+  return -1;
+}
+
 int lookup_gpio_by_key(const char *key)
 {
   pins_t *p;
@@ -541,10 +563,13 @@ int get_gpio_number(const char *key, int *gpio)
     if (*gpio <= 0) {
         *gpio = lookup_gpio_by_name(key);
         if (*gpio <= 0) {
-             *gpio = lookup_gpio_by_altname(key);
+            *gpio = lookup_gpio_by_altname(key);
-             if (*gpio <=0) {
+            if (*gpio <=0) {
-                 status = -1;  /* error */
+                *gpio = lookup_gpio_by_number(key);
-             }
+                if (*gpio <= 0) {
+                    status = -1;  /* error */
+                 }
+            }
         }
     }
     return status;

source/common.h

@@ -94,6 +94,7 @@ int get_xio_base(void);
 int is_this_chippro(void);
 int gpio_number(pins_t *pin);
 int gpio_pud_capable(pins_t *pin);
+int lookup_gpio_by_number(const char *num);
 int lookup_gpio_by_key(const char *key);
 int lookup_gpio_by_name(const char *name);
 int lookup_gpio_by_altname(const char *altname);

source/constants.c

@@ -85,6 +85,6 @@ void define_constants(PyObject *module)
    bcm = Py_BuildValue("i", BCM);
    PyModule_AddObject(module, "BCM", bcm);
 
-   version = Py_BuildValue("s", "0.6.1");
+   version = Py_BuildValue("s", "0.7");
    PyModule_AddObject(module, "VERSION", version);
 }

source/event_gpio.c

@@ -1027,7 +1027,7 @@ void event_cleanup(void)
 }
 
 // blocking_wait_for_edge assumes the caller has ensured the GPIO is already exported.
-int blocking_wait_for_edge(int gpio, unsigned int edge)
+int blocking_wait_for_edge(int gpio, unsigned int edge, int timeout)
 // standalone from all the event functions above
 {
     int fd = fd_lookup(gpio);
@@ -1082,7 +1082,7 @@ int blocking_wait_for_edge(int gpio, unsigned int edge)
     // epoll for event
     for (i = 0; i<2; i++)  // first time triggers with current state, so ignore
     {
-       if ((n = epoll_wait(epfd, &events, 1, -1)) == -1)
+       if ((n = epoll_wait(epfd, &events, 1, timeout)) == -1)
        {
            gpio_event_remove(gpio);
            return 5;

source/event_gpio.h

@@ -86,4 +86,4 @@ int gpio_event_remove(int gpio);
 int gpio_is_evented(int gpio);
 int event_initialise(void);
 void event_cleanup(void);
-int blocking_wait_for_edge(int gpio, unsigned int edge);
+int blocking_wait_for_edge(int gpio, unsigned int edge, int timeout);

source/py_gpio.c

@@ -36,6 +36,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
+#include <stdio.h>
 #include "stdlib.h"
 #include "Python.h"
 #include "constants.h"
@@ -129,13 +130,23 @@ static PyObject *py_cleanup(PyObject *self, PyObject *args, PyObject *kwargs)
 {
     int gpio;
     char *channel;
+    int inchan;
     static char *kwlist[] = {"channel", NULL};
 
     clear_error_msg();
 
     // Channel is optional
-    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|s", kwlist, &channel)) {
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "|s", kwlist, &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "|i", kwlist, &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
     }
 
     // The !channel fixes issues #50
@@ -157,6 +168,7 @@ static PyObject *py_setup_channel(PyObject *self, PyObject *args, PyObject *kwar
     int gpio;
     int allowed = -1;
     char *channel;
+    int inchan;
     int direction;
     int pud = PUD_OFF;
     int initial = 0;
@@ -164,13 +176,30 @@ static PyObject *py_setup_channel(PyObject *self, PyObject *args, PyObject *kwar
  
     clear_error_msg();
  
-    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "si|ii", kwlist, &channel, &direction, &pud, &initial))
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "si|ii", kwlist, &channel, &direction, &pud, &initial);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "ii|ii", kwlist, &inchan, &direction, &pud, &initial);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
  
     if (!module_setup) {
         init_module();
     }
 
+    if (get_gpio_number(channel, &gpio) < 0) {
+        char err[2000];
+        snprintf(err, sizeof(err), "Invalid channel %s. (%s)", channel, get_error_msg());
+        PyErr_SetString(PyExc_ValueError, err);
+        return NULL;
+    }
+
     if (direction != INPUT && direction != OUTPUT)
     {
         PyErr_SetString(PyExc_ValueError, "An invalid direction was passed to setup()");
@@ -263,19 +292,29 @@ static PyObject *py_setup_channel(PyObject *self, PyObject *args, PyObject *kwar
     Py_RETURN_NONE;
 }  /* py_setup_channel */
 
-
 // python function output(channel, value)
 static PyObject *py_output_gpio(PyObject *self, PyObject *args)
 {
     int gpio;
     int value;
     char *channel;
+    int inchan;
     int allowed = -1;
 
     clear_error_msg();
 
-    if (!PyArg_ParseTuple(args, "si", &channel, &value))
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "si", &channel, &value);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "ii", &inchan, &value);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
     if (get_gpio_number(channel, &gpio)) {
         PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -322,14 +361,25 @@ static PyObject *py_input_gpio(PyObject *self, PyObject *args)
 {
     int gpio;
     char *channel;
+    int inchan;
     unsigned int value;
     PyObject *py_value;
     int allowed = -1;
 
     clear_error_msg();
 
-    if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
     if (get_gpio_number(channel, &gpio)) {
         PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -376,14 +426,25 @@ static PyObject *py_read_byte_gpio(PyObject *self, PyObject *args)
 {
     int gpio;
     char *channel;
+    int inchan;
     unsigned int value = 0;
     PyObject *py_value;
     int allowed = -1;
 
     clear_error_msg();
 
-    if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
     if (get_gpio_number(channel, &gpio)) {
         PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -430,14 +491,25 @@ static PyObject *py_read_word_gpio(PyObject *self, PyObject *args)
 {
     int gpio;
     char *channel;
+    int inchan;
     unsigned int value = 0;
     PyObject *py_value;
     int allowed = -1;
 
     clear_error_msg();
 
-    if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-        return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
     if (get_gpio_number(channel, &gpio)) {
         PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -557,6 +629,7 @@ static PyObject *py_add_event_callback(PyObject *self, PyObject *args, PyObject
 {
    int gpio;
    char *channel;
+   int inchan;
    int allowed = -1;
    unsigned int bouncetime = 0;
    PyObject *cb_func;
@@ -564,8 +637,18 @@ static PyObject *py_add_event_callback(PyObject *self, PyObject *args, PyObject
 
    clear_error_msg();
 
-   if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|i", kwlist, &channel, &cb_func, &bouncetime))
+    // Try to parse the string
-      return NULL;
+    int rtn;
+    rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "sO|i", kwlist, &channel, &cb_func, &bouncetime);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "iO|i", kwlist, &inchan, &cb_func, &bouncetime);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
    if (!PyCallable_Check(cb_func))
    {
@@ -628,6 +711,7 @@ static PyObject *py_add_event_detect(PyObject *self, PyObject *args, PyObject *k
 {
    int gpio;
    char *channel;
+   int inchan;
    int edge, result;
    unsigned int bouncetime = 0;
    int allowed = -1;
@@ -636,8 +720,18 @@ static PyObject *py_add_event_detect(PyObject *self, PyObject *args, PyObject *k
 
    clear_error_msg();
 
-   if (!PyArg_ParseTupleAndKeywords(args, kwargs, "si|Oi", kwlist, &channel, &edge, &cb_func, &bouncetime))
+    // Try to parse the string
-      return NULL;
+    int rtn;
+    rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "si|Oi", kwlist, &channel, &edge, &cb_func, &bouncetime);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "ii|Oi", kwlist, &inchan, &edge, &cb_func, &bouncetime);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
    if (cb_func != NULL && !PyCallable_Check(cb_func))
    {
@@ -714,6 +808,7 @@ static PyObject *py_remove_event_detect(PyObject *self, PyObject *args)
 {
    int gpio;
    char *channel;
+   int inchan;
    struct py_callback *cb = py_callbacks;
    struct py_callback *temp;
    struct py_callback *prev = NULL;
@@ -721,8 +816,18 @@ static PyObject *py_remove_event_detect(PyObject *self, PyObject *args)
 
    clear_error_msg();
 
-   if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-      return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
    if (get_gpio_number(channel, &gpio)) {
        PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -784,12 +889,23 @@ static PyObject *py_event_detected(PyObject *self, PyObject *args)
 {
    int gpio;
    char *channel;
+   int inchan;
    int allowed = -1;
 
    clear_error_msg();
 
-   if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-      return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
    if (get_gpio_number(channel, &gpio)) {
        PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -817,19 +933,32 @@ static PyObject *py_event_detected(PyObject *self, PyObject *args)
       Py_RETURN_FALSE;
 }
 
-// python function py_wait_for_edge(gpio, edge)
+// python function py_wait_for_edge(gpio, edge, timeout = -1)
 static PyObject *py_wait_for_edge(PyObject *self, PyObject *args)
 {
    int gpio;
-   int edge, result;
+   int edge, result, timeout;
    char *channel;
+   int inchan;
    char error[81];
    int allowed = -1;
 
    clear_error_msg();
 
-   if (!PyArg_ParseTuple(args, "si", &channel, &edge))
+   timeout = -1;
-      return NULL;
+
+    // Try to parse the string
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "si|i", &channel, &edge, &timeout);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "ii|i", &inchan, &edge, &timeout);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
    if (get_gpio_number(channel, &gpio)) {
        PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -877,7 +1006,7 @@ static PyObject *py_wait_for_edge(PyObject *self, PyObject *args)
    }
 
    Py_BEGIN_ALLOW_THREADS // disable GIL
-   result = blocking_wait_for_edge(gpio, edge);
+   result = blocking_wait_for_edge(gpio, edge, timeout);
    Py_END_ALLOW_THREADS   // enable GIL
 
    if (result == 0) {
@@ -902,12 +1031,23 @@ static PyObject *py_gpio_function(PyObject *self, PyObject *args)
     unsigned int value;
     PyObject *func;
     char *channel;
+    int inchan;
     int allowed = -1;
 
     clear_error_msg();
 
-    if (!PyArg_ParseTuple(args, "s", &channel))
+    // Try to parse the string
-       return NULL;
+    int rtn;
+    rtn = PyArg_ParseTuple(args, "s", &channel);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTuple(args, "i", &inchan);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
     if (get_gpio_number(channel, &gpio)) {
         PyErr_SetString(PyExc_ValueError, "Invalid channel");
@@ -1115,14 +1255,25 @@ static PyObject *py_set_direction(PyObject *self, PyObject *args, PyObject *kwar
 {
 	int gpio;
 	char *channel;
+    int inchan;
 	int direction;
 	int allowed = -1;
 	static char *kwlist[] = { "channel", "direction", NULL };
 
 	clear_error_msg();
 
-	if (!PyArg_ParseTupleAndKeywords(args, kwargs, "si", kwlist, &channel, &direction))
+    // Try to parse the string
-		return NULL;
+    int rtn;
+    rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "si", kwlist, &channel, &direction);
+    if (!rtn) {
+        // Fall into here are try to parse an int
+        rtn = PyArg_ParseTupleAndKeywords(args, kwargs, "ii", kwlist, &inchan, &direction);
+        if (!rtn) {
+            return NULL;
+        }
+        // We make it here, we can convert inchan to a string for us to ensure it's valid
+        asprintf(&channel, "%i", inchan);
+    }
 
 	if (!module_setup) {
 		init_module();
@@ -1179,7 +1330,7 @@ PyMethodDef gpio_methods[] = {
    {"remove_event_detect", py_remove_event_detect, METH_VARARGS, "Remove edge detection for a particular GPIO channel\ngpio - gpio channel"},
    {"event_detected", py_event_detected, METH_VARARGS, "Returns True if an edge has occured on a given GPIO.  You need to enable edge detection using add_event_detect() first.\ngpio - gpio channel"},
    {"add_event_callback", (PyCFunction)py_add_event_callback, METH_VARARGS | METH_KEYWORDS, "Add a callback for an event already defined using add_event_detect()\ngpio         - gpio channel\ncallback     - a callback function\n[bouncetime] - Switch bounce timeout in ms"},
-   {"wait_for_edge", py_wait_for_edge, METH_VARARGS, "Wait for an edge.\ngpio - gpio channel\nedge - RISING, FALLING or BOTH"},
+   {"wait_for_edge", py_wait_for_edge, METH_VARARGS, "Wait for an edge.\ngpio - gpio channel\nedge - RISING, FALLING or BOTH\ntimeout (optional) - time to wait in miliseconds. -1 will wait forever (default)"},
    {"gpio_function", py_gpio_function, METH_VARARGS, "Return the current GPIO function (IN, OUT, ALT0)\ngpio - gpio channel"},
    {"setwarnings", py_setwarnings, METH_VARARGS, "Enable or disable warning messages"},
    {"get_gpio_base", py_gpio_base, METH_VARARGS, "Get the XIO base number for sysfs"},