Theo Le Paih / Mbed 2 deprecated 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.

Dependencies:   mbed

Diff: pixy2.h

Revision:
9:764075b514bf
Parent:
8:c93e1d706c0e
Child:
10:ea759846c2d5
--- a/pixy2.h	Tue Mar 12 09:50:51 2019 +0000
+++ b/pixy2.h	Tue Mar 12 10:49:53 2019 +0000
@@ -386,7 +386,7 @@
 
 /**
  * Gets the width and height of the frames used by the current program.
- * @note After calling this function, the width and height can be found in the frameWidth and frameHeight member variables.
+ * After calling this function, the width and height can be found in the frameWidth and frameHeight member variables.
  * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
  * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:general_api
  * @param resolution (T_Pixy2Resolution - passed by reference) : pointer to the resolution data structure
@@ -395,7 +395,8 @@
 Pixy2ErrorCode pixy2_getResolution (T_Pixy2Resolution *resolution);
 
 /**
- * Sets the relative exposure level of Pixy2's image sensor. Higher values result in a brighter (more exposed) image. 
+ * Sets the relative exposure level of Pixy2's image sensor.
+ * Higher values result in a brighter (more exposed) image. 
  * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
  * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:general_api
  * @param brightness (Byte - passed by value) : brightness level 
@@ -415,7 +416,7 @@
 
 /**
  * Sets Pixy2's RGB LED value. The three arguments sets the brightness of the red, green and blue sections of the LED.
- * @note It will override Pixy2's own setting of the RGB LED. 
+ * It will override Pixy2's own setting of the RGB LED. 
  * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
  * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:general_api
  * @param red (Byte - passed by value) : Red component value (between 0 and 255) 
@@ -427,8 +428,8 @@
 
 /**
  * Turns on/off Pixy2's integrated light source.
- * @note The upper argument controls the two white LEDs along the top edge of Pixy2's PCB. The lower argument sets the RGB LED, causing it to turn on all three color channels at full brightness, resulting in white light.
- * @note It will override Pixy2's own setting of the RGB LED. 
+ * The upper argument controls the two white LEDs along the top edge of Pixy2's PCB. The lower argument sets the RGB LED, causing it to turn on all three color channels at full brightness, resulting in white light.
+ * It will override Pixy2's own setting of the RGB LED. 
  * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
  * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:general_api
  * @param upper (Byte - passed by value) : binary, zero or non-zero 
@@ -440,13 +441,25 @@
 /**
  * Gets Pixy2's framerate.
  * The framerate can range between 2 and 62 frames per second depending on the amount of light in the environment and the min frames per second setting in the Camera configuration tab.
- * @note This function can also serve as a simple indicator of the amount of light in the environment. That is, low framerates necessarily imply lower lighting levels
+ * This function can also serve as a simple indicator of the amount of light in the environment. That is, low framerates necessarily imply lower lighting levels
  * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
  * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:general_api
  * @param framerate (T_pixy2returnCode - passed by reference) : acknoledge 
  * @return Pixy2ErrorCode : error code.
  */
 Pixy2ErrorCode pixy2_getFPS (T_pixy2returnCode *framerate);
+
+/**
+ * Gets all detected blocks in the most recent frame.
+ * The new data is then available in the blocks member variable. The returned blocks are sorted by area, with the largest blocks appearing first in the blocks array.
+ * @note General description : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:color_connected_components
+ * @note Frame Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide
+ * @note Function Documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:pixy2_full_api#plugin_include__wiki__v2__ccc_api
+ * @param sigmap (Byte - passed by value) : signature filtering 
+ * @param maxBloc (Byte - passed by value) : maximum number of blocks to return 
+ * @return Pixy2ErrorCode : error code.
+ * @note There is 7 possible signatures definition. Filtering is based on ORing codes : 1 for signature 1 (sig1), 2 for sig2, 4 for sig3, etc. and 7 for color code. 255 = no filtering, 0 = filter all. For example filtering to get only sig1 and sig 4 means using 9 (8 + 1) as sigmap.
+ */
 Pixy2ErrorCode pixy2_getBlocks (Byte sigmap, Byte maxBloc);
 Pixy2ErrorCode pixy2_getMainFeature (Byte type, Byte features);
 Pixy2ErrorCode pixy2_getAllFeature (Byte features);