pixy2 smart camera library www.pixycam.com
Pixy2 Library project (using UART interface)
Diff: pixy2.h
- Revision:
- 3:6ba43af28440
- Parent:
- 2:5281a6289e8b
- Child:
- 4:eed638064b42
diff -r 5281a6289e8b -r 6ba43af28440 pixy2.h --- a/pixy2.h Fri Mar 01 13:25:12 2019 +0000 +++ b/pixy2.h Mon Mar 11 14:54:44 2019 +0000 @@ -267,6 +267,16 @@ sWord pixAngle; }T_Pixy2InterLine; +/** + * \struct T_pixy2Intersection + * \brief Structured type that match pixy2 intersection definition - used in Line frame (type 48/49) - message payload + * \param pixX (Byte) : X axis coordinate of the intersection (in pixel, between 0 and 78) + * \param pixY (Byte) : Y axis coordinate of the intersection (in pixel, between 0 and 51) + * \param pixN (Byte) : Number of lines connected to the intersection (between 3 and 5) + * \param pixReserved (Byte) : Not documented by manufacturer + * @note More info can be found here : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:line_api + * @note or here : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:line_tracking + */ typedef struct { Byte pixX; Byte pixY; @@ -274,6 +284,16 @@ Byte pixReserved; }T_pixy2Intersection; +/** + * \struct T_pixy2BarCode + * \brief Structured type that match pixy2 barcode definition - used in Line frame (type 48/49) - message payload + * \param pixX (Byte) : X axis coordinate of the barcode (in pixel, between 0 and 78) + * \param pixY (Byte) : Y axis coordinate of the barcode (in pixel, between 0 and 51) + * \param pixFlag (Byte) : Flag to indicate if barcode met filtering constraint + * \param pixCode (Byte) : Indicate the numeric value associated with the barcode (between 0 and 15) + * @note More info can be found here : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:line_api + * @note or here : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:line_tracking + */ typedef struct { Byte pixX; Byte pixY; @@ -313,6 +333,16 @@ PIXY2(PinName tx, PinName rx, int debit = 230400); // Fonctions publiques + +/** + * Gives information about Pixy2 version and Firmware + * @note according to documentation : https://docs.pixycam.com/wiki/doku.php?id=wiki:v2:porting_guide + * @param version (T_Pixy2Version - passed by reference) : pointer to the version data + * @return 0 if OK + * @return -2 if Busy + * @return -3 if Checksum error + * @return -7 if Type Error + */ int pixy2_getVersion (T_Pixy2Version *version); int pixy2_getResolution (T_Pixy2Resolution *resolution); int pixy2_setCameraBrightness (Byte brightness);