aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docu.

Browse Source
This commit is contained in:
Timo Lang
2015-06-08 11:04:50 +02:00
parent 86eb39b3a8
commit 42b6e3af36
202 changed files with 11953 additions and 976 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
pixy_8h_source.html
View File

@@ -229,7 +229,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="group__pixy_html_ga8ca61cb465cf6dc72fcae79b0c08e810"><div class="ttname"><a href="group__pixy.html#ga8ca61cb465cf6dc72fcae79b0c08e810">pixy_get_firmware_version</a></div><div class="ttdeci">int pixy_get_firmware_version(uint16_t *major, uint16_t *minor, uint16_t *build)</div><div class="ttdoc">Get pixy firmware version. </div></div>
<div class="ttc" id="group__pixy_html_ga45bb277d2ea7110def16186468e571f9"><div class="ttname"><a href="group__pixy.html#ga45bb277d2ea7110def16186468e571f9">pixy_rcs_set_frequency</a></div><div class="ttdeci">int pixy_rcs_set_frequency(uint16_t frequency)</div><div class="ttdoc">Set pixy servo pulse width modulation (PWM) frequency. </div></div>
<div class="ttc" id="group__pixy_html_gad2ec06c83cc4c8de8551e3151287c264"><div class="ttname"><a href="group__pixy.html#gad2ec06c83cc4c8de8551e3151287c264">pixy_cam_set_white_balance_value</a></div><div class="ttdeci">int pixy_cam_set_white_balance_value(uint8_t red, uint8_t green, uint8_t blue)</div><div class="ttdoc">Set pixy camera white balance. </div></div>
<div class="ttc" id="struct_block_html_ab0580f504a7428539be299fa71565f30"><div class="ttname"><a href="struct_block.html#ab0580f504a7428539be299fa71565f30">Block::y</a></div><div class="ttdeci">uint16_t y</div><div class="ttdef"><b>Definition:</b> pixy.h:81</div></div>
<div class="ttc" id="struct_block_html_ab0580f504a7428539be299fa71565f30"><div class="ttname"><a href="struct_block.html#ab0580f504a7428539be299fa71565f30">Block::y</a></div><div class="ttdeci">uint16_t y</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00081">pixy.h:81</a></div></div>
<div class="ttc" id="group__pixy_html_ga80fe76de4eb898969b0921ce53d83a65"><div class="ttname"><a href="group__pixy.html#ga80fe76de4eb898969b0921ce53d83a65">pixy_cam_get_auto_exposure_compensation</a></div><div class="ttdeci">int pixy_cam_get_auto_exposure_compensation()</div><div class="ttdoc">Get pixy camera auto exposure compensation setting. </div></div>
<div class="ttc" id="group__pixy_html_gad8ff0e513bae5acec82c6a7e0e21685f"><div class="ttname"><a href="group__pixy.html#gad8ff0e513bae5acec82c6a7e0e21685f">pixy_rcs_get_position</a></div><div class="ttdeci">int pixy_rcs_get_position(uint8_t channel)</div><div class="ttdoc">Get pixy servo axis position. </div></div>
<div class="ttc" id="group__pixy_html_ga2df93fdbd04ed434d281a4b9acfa0263"><div class="ttname"><a href="group__pixy.html#ga2df93fdbd04ed434d281a4b9acfa0263">pixy_blocks_are_new</a></div><div class="ttdeci">int pixy_blocks_are_new()</div><div class="ttdoc">Indicates when new block data from Pixy is received. </div></div>
@@ -237,31 +237,31 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="group__pixy_html_ga72a2cd126f6a5f67842e5ff66424ccb0"><div class="ttname"><a href="group__pixy.html#ga72a2cd126f6a5f67842e5ff66424ccb0">pixy_service</a></div><div class="ttdeci">int pixy_service()</div></div>
<div class="ttc" id="group__pixy_html_ga3d55779001cc649ed85be1a92f09892d"><div class="ttname"><a href="group__pixy.html#ga3d55779001cc649ed85be1a92f09892d">pixy_command</a></div><div class="ttdeci">int pixy_command(const char *name,...)</div><div class="ttdoc">Send a command to Pixy. </div></div>
<div class="ttc" id="group__pixy_html_ga0b375c58d7ddc701d6c65845ecfc11fb"><div class="ttname"><a href="group__pixy.html#ga0b375c58d7ddc701d6c65845ecfc11fb">pixy_cam_set_exposure_compensation</a></div><div class="ttdeci">int pixy_cam_set_exposure_compensation(uint8_t gain, uint16_t comp)</div><div class="ttdoc">Set pixy camera exposure compensation. </div></div>
<div class="ttc" id="struct_block_html_acb5cfd209ba75c853d03f701e7f91679"><div class="ttname"><a href="struct_block.html#acb5cfd209ba75c853d03f701e7f91679">Block::type</a></div><div class="ttdeci">uint16_t type</div><div class="ttdef"><b>Definition:</b> pixy.h:78</div></div>
<div class="ttc" id="struct_block_html_a81c9f8d0b8c3b49d770be14dbe9f0d37"><div class="ttname"><a href="struct_block.html#a81c9f8d0b8c3b49d770be14dbe9f0d37">Block::height</a></div><div class="ttdeci">uint16_t height</div><div class="ttdef"><b>Definition:</b> pixy.h:83</div></div>
<div class="ttc" id="struct_block_html_acb5cfd209ba75c853d03f701e7f91679"><div class="ttname"><a href="struct_block.html#acb5cfd209ba75c853d03f701e7f91679">Block::type</a></div><div class="ttdeci">uint16_t type</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00078">pixy.h:78</a></div></div>
<div class="ttc" id="struct_block_html_a81c9f8d0b8c3b49d770be14dbe9f0d37"><div class="ttname"><a href="struct_block.html#a81c9f8d0b8c3b49d770be14dbe9f0d37">Block::height</a></div><div class="ttdeci">uint16_t height</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00083">pixy.h:83</a></div></div>
<div class="ttc" id="group__pixy_html_ga38582b897bb2eb5f36c6f68d2e171d05"><div class="ttname"><a href="group__pixy.html#ga38582b897bb2eb5f36c6f68d2e171d05">pixy_led_set_max_current</a></div><div class="ttdeci">int pixy_led_set_max_current(uint32_t current)</div><div class="ttdoc">Set pixy LED maximum current. </div></div>
<div class="ttc" id="group__pixy_html_gac46359533378c0822a463bdd5d2466d8"><div class="ttname"><a href="group__pixy.html#gac46359533378c0822a463bdd5d2466d8">pixy_cam_set_auto_white_balance</a></div><div class="ttdeci">int pixy_cam_set_auto_white_balance(uint8_t value)</div><div class="ttdoc">Enable or disable pixy camera auto white balance. </div></div>
<div class="ttc" id="group__pixy_html_gad2eff98f2123b2070c64e4c442c859e7"><div class="ttname"><a href="group__pixy.html#gad2eff98f2123b2070c64e4c442c859e7">pixy_cam_set_auto_exposure_compensation</a></div><div class="ttdeci">int pixy_cam_set_auto_exposure_compensation(uint8_t enable)</div><div class="ttdoc">Enable or disable pixy camera auto exposure compensation. </div></div>
<div class="ttc" id="group__pixy_html_gad269822960ad0073356dab75ce3050b3"><div class="ttname"><a href="group__pixy.html#gad269822960ad0073356dab75ce3050b3">pixy_init</a></div><div class="ttdeci">int pixy_init()</div><div class="ttdoc">Creates a connection with Pixy and listens for Pixy messages. </div></div>
<div class="ttc" id="struct_block_html_ad0eab1042455a2067c812ab8071d5376"><div class="ttname"><a href="struct_block.html#ad0eab1042455a2067c812ab8071d5376">Block::width</a></div><div class="ttdeci">uint16_t width</div><div class="ttdef"><b>Definition:</b> pixy.h:82</div></div>
<div class="ttc" id="struct_block_html_ad0eab1042455a2067c812ab8071d5376"><div class="ttname"><a href="struct_block.html#ad0eab1042455a2067c812ab8071d5376">Block::width</a></div><div class="ttdeci">uint16_t width</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00082">pixy.h:82</a></div></div>
<div class="ttc" id="group__pixy_html_ga5fb9213a5459dc6c74131ecabd6b5995"><div class="ttname"><a href="group__pixy.html#ga5fb9213a5459dc6c74131ecabd6b5995">pixy_rcs_set_position</a></div><div class="ttdeci">int pixy_rcs_set_position(uint8_t channel, uint16_t position)</div><div class="ttdoc">Set pixy servo axis position. </div></div>
<div class="ttc" id="group__pixy_html_ga247afb06384e4967395a7059e0bde95d"><div class="ttname"><a href="group__pixy.html#ga247afb06384e4967395a7059e0bde95d">pixy_error</a></div><div class="ttdeci">void pixy_error(int error_code)</div><div class="ttdoc">Send description of pixy error to stdout. </div></div>
<div class="ttc" id="struct_block_html_a78963c1ed5ab32c4ac2e81797f484e0f"><div class="ttname"><a href="struct_block.html#a78963c1ed5ab32c4ac2e81797f484e0f">Block::signature</a></div><div class="ttdeci">uint16_t signature</div><div class="ttdef"><b>Definition:</b> pixy.h:79</div></div>
<div class="ttc" id="struct_block_html_a78963c1ed5ab32c4ac2e81797f484e0f"><div class="ttname"><a href="struct_block.html#a78963c1ed5ab32c4ac2e81797f484e0f">Block::signature</a></div><div class="ttdeci">uint16_t signature</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00079">pixy.h:79</a></div></div>
<div class="ttc" id="group__pixy_html_gaada09a1aeda12672050f5c3183ef6f3b"><div class="ttname"><a href="group__pixy.html#gaada09a1aeda12672050f5c3183ef6f3b">pixy_close</a></div><div class="ttdeci">void pixy_close()</div><div class="ttdoc">Terminates connection with Pixy. </div></div>
<div class="ttc" id="group__pixy_html_ga077b6b62e9af99fbd911b92dee2205c0"><div class="ttname"><a href="group__pixy.html#ga077b6b62e9af99fbd911b92dee2205c0">pixy_cam_get_exposure_compensation</a></div><div class="ttdeci">int pixy_cam_get_exposure_compensation(uint8_t *gain, uint16_t *comp)</div><div class="ttdoc">Get pixy camera exposure compensation. </div></div>
<div class="ttc" id="group__pixy_html_gab4113dedad844bc189466552c75b47a0"><div class="ttname"><a href="group__pixy.html#gab4113dedad844bc189466552c75b47a0">pixy_get_blocks</a></div><div class="ttdeci">int pixy_get_blocks(uint16_t max_blocks, struct Block *blocks)</div><div class="ttdoc">Copies up to &#39;max_blocks&#39; number of Blocks to the address pointed to by &#39;blocks&#39;. ...</div></div>
<div class="ttc" id="group__pixy_html_ga28045d2cfce3a28f4c7d5e6673b4bad7"><div class="ttname"><a href="group__pixy.html#ga28045d2cfce3a28f4c7d5e6673b4bad7">pixy_led_set_RGB</a></div><div class="ttdeci">int pixy_led_set_RGB(uint8_t red, uint8_t green, uint8_t blue)</div><div class="ttdoc">Set color of pixy LED. </div></div>
<div class="ttc" id="struct_block_html_a4dde988b1b2adba65ae3efa69f65d960"><div class="ttname"><a href="struct_block.html#a4dde988b1b2adba65ae3efa69f65d960">Block::x</a></div><div class="ttdeci">uint16_t x</div><div class="ttdef"><b>Definition:</b> pixy.h:80</div></div>
<div class="ttc" id="struct_block_html_a4dde988b1b2adba65ae3efa69f65d960"><div class="ttname"><a href="struct_block.html#a4dde988b1b2adba65ae3efa69f65d960">Block::x</a></div><div class="ttdeci">uint16_t x</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00080">pixy.h:80</a></div></div>
<div class="ttc" id="group__pixy_html_ga8c1436f86bb954d19f7c9bbb9d5e0ed1"><div class="ttname"><a href="group__pixy.html#ga8c1436f86bb954d19f7c9bbb9d5e0ed1">pixy_cam_get_white_balance_value</a></div><div class="ttdeci">uint32_t pixy_cam_get_white_balance_value()</div><div class="ttdoc">Get pixy camera white balance() </div></div>
<div class="ttc" id="struct_block_html"><div class="ttname"><a href="struct_block.html">Block</a></div><div class="ttdef"><b>Definition:</b> pixy.h:53</div></div>
<div class="ttc" id="struct_block_html"><div class="ttname"><a href="struct_block.html">Block</a></div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00053">pixy.h:53</a></div></div>
<div class="ttc" id="pixydefs_8h_html"><div class="ttname"><a href="pixydefs_8h.html">pixydefs.h</a></div></div>
<div class="ttc" id="group__pixy_html_ga3eb84125292a5bf39f63e8a9378ba5ad"><div class="ttname"><a href="group__pixy.html#ga3eb84125292a5bf39f63e8a9378ba5ad">pixy_cam_get_auto_white_balance</a></div><div class="ttdeci">int pixy_cam_get_auto_white_balance()</div><div class="ttdoc">Get pixy camera auto white balance setting. </div></div>
<div class="ttc" id="group__pixy_html_gace7a7da527f1b01abc6355fd8945d023"><div class="ttname"><a href="group__pixy.html#gace7a7da527f1b01abc6355fd8945d023">pixy_led_get_max_current</a></div><div class="ttdeci">int pixy_led_get_max_current()</div><div class="ttdoc">Get pixy LED maximum current. </div></div>
<div class="ttc" id="struct_block_html_a0674cf41ba25ce1925233d55ea692994"><div class="ttname"><a href="struct_block.html#a0674cf41ba25ce1925233d55ea692994">Block::angle</a></div><div class="ttdeci">int16_t angle</div><div class="ttdef"><b>Definition:</b> pixy.h:84</div></div>
<div class="ttc" id="struct_block_html_a0674cf41ba25ce1925233d55ea692994"><div class="ttname"><a href="struct_block.html#a0674cf41ba25ce1925233d55ea692994">Block::angle</a></div><div class="ttdeci">int16_t angle</div><div class="ttdef"><b>Definition:</b> <a href="pixy_8h_source.html#l00084">pixy.h:84</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 01:15:03 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Jun 8 2015 11:01:18 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>