Waël Hazami
/
Lib_PIXY2
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Diff: pixy2.h
- Revision:
- 24:b59f85cbc597
- Parent:
- 23:d6bbc4ec1f22
- Child:
- 25:2a2fcb9e4775
--- a/pixy2.h Thu Nov 21 08:34:07 2019 +0000
+++ b/pixy2.h Thu Nov 21 08:46:09 2019 +0000
@@ -372,16 +372,19 @@
* More informations at http://www.pixycam.com/
* Use pointer to pointer in order to connect pointer adress (passed by ref by user)
* to the address of the buffer that contains the received message : see example below
- * \code{.cpp}
- * PIXY2 myPixy(UART_TX, UART_RX);
+ * \code
+ * // Creation of Pixy2 object
+ * PIXY2 myPixy(UART_TX, UART_RX);
+ * ...
+ * // Creation of a pointer to the structure T_pixy2Version
* T_pixy2Version *pixyVersion;
* ...
- * while(1) {
- * if( myPixy.pixy2_getVersion(&pixyVersion) == PIXY2_OK ) {
- * printf("myPixy's version : %s\n\r", pixyVersion->pixHFString);
- * break;
- * }
- * }
+ * // Call for version on Pixy2 (that will be put inside the pointing structure)
+ * if (myPixy.pixy2_getVersion(&pixyVersion) == PIXY2_OK)
+ * ...
+ * // Printing Human friendly string (see Pixy2 doc for details)
+ * printf("myPixy's version : %s\n\r", pixyVersion->pixHFString);
+ * ...
* \endcode
*/
class PIXY2 {