Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

aio: Update documentation to mention 0 indexed

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2017-06-06 15:56:14 +02:00
parent c36e4add5a
commit 4109b8b454
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/mraa/aio.h
View File

@@ -51,7 +51,9 @@ extern "C" {
typedef struct _aio* mraa_aio_context; typedef struct _aio* mraa_aio_context;
/** /**
* Initialise an Analog input device, connected to the specified pin * Initialise an Analog input device, connected to the specified pin. Aio pins
* are always 0 indexed reguardless of their position. Check your board mapping
* for details. An arduino style layout will have A0 as pin14 but AIO0.
* *
* @param pin Channel number to read ADC inputs * @param pin Channel number to read ADC inputs
* @returns aio context or NULL * @returns aio context or NULL

4
api/mraa/aio.hpp
View File

@@ -56,7 +56,9 @@ class Aio
} }
/** /**
* Aio Constructor, takes a pointer to the AIO context and initialises * Aio Constructor, takes a pointer to the AIO context and initialises
* the AIO class * the AIO class. Aio pins are always 0 indexed reguardless of their
* position. Check your board mapping for details. An arduino style layout
* will have A0 as pin14 but AIO0.
* *
* @param void * to an AIO context * @param void * to an AIO context
*/ */