Differences

This shows you the differences between two versions of the page.

--- wiki:v3:general_api [2018/09/19 21:05]
jfrench - Imported by DokuWiki Advanced Plugin
+++ wiki:v3:general_api [2018/09/26 19:07] (current)
pixycam
@@ Line 44: / Line 44: @@
 setLamp() turns on/off Pixy2's integrated light source.  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. Both arguments are binary, zero or non-zero.  It returns an [[wiki:v2:general_api#Error codes|error value]] (<0) if it fails and 0 (PIXY\_RESULT\_OK) if it succeeds.
+=== int8_t getResolution() ===
+getResolution() gets the width and height of the frames used by the current program.  After calling this function, the width and height can be found in the **frameWidth** and **frameHeight** member variables.  Note, calling changeProg() will call getResolution() automatically and update **frameWidth** and **frameHeight**.
+Pixy2 will automatically change programs if, for example, you call ccc.getBlocks() from the color connected components program followed by line.getMainFeatures() from the line tracking program.  These "automatic program changes" will not update **frameWidth** and **frameHeight** member variables.
+=== int8_t getFPS() ===
+getFPS() 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 [[wiki:v2:pixymon_index#camera-tab|Camera configuration tab]].  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.

Documentation

User Tools

Site Tools

Differences

Page Tools