api/mraa: add mraa_get_pin_name

[contrib/mraa.git] / api / mraa / common.h

diff --git a/api/mraa/common.h b/api/mraa/common.h
index 0b641cc..9c75536 100644 (file)
--- a/api/mraa/common.h
+++ b/api/mraa/common.h
@@ -46,7 +46,9 @@ typedef unsigned int mraa_boolean_t;
 /**
  * Initialise MRAA
  *
- * Detects running platform and attempts to use included pinmap
+ * Detects running platform and attempts to use included pinmap, this is run on
+ * module/library init/load but is handy to rerun to check board initialised
+ * correctly. Anything but MRAA_SUCCESS should be considered a critical failure
  *
  * @return Result of operation
  */
@@ -147,6 +149,15 @@ mraa_platform_t mraa_get_platform_type();
  */
 unsigned int mraa_get_pin_count();
 
+/**
+* Get name of pin, board must be initialised.
+*
+* @param pin number
+*
+* @return char* of pin name
+*/
+char* mraa_get_pin_name(int pin);
+
 #ifdef __cplusplus
 }
 #endif