1096 lines
54 KiB
HTML
1096 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.9.1"/>
|
|
<title>discoverpixy: Pixy</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">discoverpixy
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Pixy</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block.html">Block</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gab9471c2f9186bc9b98e4c8131efd9342"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gab9471c2f9186bc9b98e4c8131efd9342">PIXY_MAX_SIGNATURE</a>   7</td></tr>
|
|
<tr class="separator:gab9471c2f9186bc9b98e4c8131efd9342"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0834f8933ac1684e28fe4f832488b320"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga0834f8933ac1684e28fe4f832488b320">PIXY_MIN_X</a>   0</td></tr>
|
|
<tr class="separator:ga0834f8933ac1684e28fe4f832488b320"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaec6baba7922a62f334138aa17f3891f8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gaec6baba7922a62f334138aa17f3891f8">PIXY_MAX_X</a>   319</td></tr>
|
|
<tr class="separator:gaec6baba7922a62f334138aa17f3891f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0e3a3aa0490fce5c19f571541a997e8c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga0e3a3aa0490fce5c19f571541a997e8c">PIXY_MIN_Y</a>   0</td></tr>
|
|
<tr class="separator:ga0e3a3aa0490fce5c19f571541a997e8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga74b8105f78bc6befa6f639750714c7dd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga74b8105f78bc6befa6f639750714c7dd">PIXY_MAX_Y</a>   199</td></tr>
|
|
<tr class="separator:ga74b8105f78bc6befa6f639750714c7dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5361e5e4628b4f8577d2febafc4da088"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga5361e5e4628b4f8577d2febafc4da088">PIXY_RCS_MIN_POS</a>   0</td></tr>
|
|
<tr class="separator:ga5361e5e4628b4f8577d2febafc4da088"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2336b04d0e7669f8491241a455653af8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga2336b04d0e7669f8491241a455653af8">PIXY_RCS_MAX_POS</a>   1000</td></tr>
|
|
<tr class="separator:ga2336b04d0e7669f8491241a455653af8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9182417344deee5ca45dba835416a1a3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga9182417344deee5ca45dba835416a1a3">PIXY_RCS_CENTER_POS</a>   ((<a class="el" href="group__pixy.html#ga2336b04d0e7669f8491241a455653af8">PIXY_RCS_MAX_POS</a>-<a class="el" href="group__pixy.html#ga5361e5e4628b4f8577d2febafc4da088">PIXY_RCS_MIN_POS</a>)/2)</td></tr>
|
|
<tr class="separator:ga9182417344deee5ca45dba835416a1a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad3106d870305c42c4935dac3375d03d9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gad3106d870305c42c4935dac3375d03d9">PIXY_BLOCKTYPE_NORMAL</a>   0</td></tr>
|
|
<tr class="separator:gad3106d870305c42c4935dac3375d03d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3edb6eb461c90059cb4926395401b7c0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga3edb6eb461c90059cb4926395401b7c0">PIXY_BLOCKTYPE_COLOR_CODE</a>   1</td></tr>
|
|
<tr class="separator:ga3edb6eb461c90059cb4926395401b7c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gad269822960ad0073356dab75ce3050b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gad269822960ad0073356dab75ce3050b3">pixy_init</a> ()</td></tr>
|
|
<tr class="memdesc:gad269822960ad0073356dab75ce3050b3"><td class="mdescLeft"> </td><td class="mdescRight">Creates a connection with Pixy and listens for Pixy messages. <a href="#gad269822960ad0073356dab75ce3050b3">More...</a><br /></td></tr>
|
|
<tr class="separator:gad269822960ad0073356dab75ce3050b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2df93fdbd04ed434d281a4b9acfa0263"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga2df93fdbd04ed434d281a4b9acfa0263">pixy_blocks_are_new</a> ()</td></tr>
|
|
<tr class="memdesc:ga2df93fdbd04ed434d281a4b9acfa0263"><td class="mdescLeft"> </td><td class="mdescRight">Indicates when new block data from Pixy is received. <a href="#ga2df93fdbd04ed434d281a4b9acfa0263">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2df93fdbd04ed434d281a4b9acfa0263"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab4113dedad844bc189466552c75b47a0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gab4113dedad844bc189466552c75b47a0">pixy_get_blocks</a> (uint16_t max_blocks, struct <a class="el" href="struct_block.html">Block</a> *blocks)</td></tr>
|
|
<tr class="memdesc:gab4113dedad844bc189466552c75b47a0"><td class="mdescLeft"> </td><td class="mdescRight">Copies up to 'max_blocks' number of Blocks to the address pointed to by 'blocks'. <a href="#gab4113dedad844bc189466552c75b47a0">More...</a><br /></td></tr>
|
|
<tr class="separator:gab4113dedad844bc189466552c75b47a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga72a2cd126f6a5f67842e5ff66424ccb0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga72a2cd126f6a5f67842e5ff66424ccb0">pixy_service</a> ()</td></tr>
|
|
<tr class="separator:ga72a2cd126f6a5f67842e5ff66424ccb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3d55779001cc649ed85be1a92f09892d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga3d55779001cc649ed85be1a92f09892d">pixy_command</a> (const char *name,...)</td></tr>
|
|
<tr class="memdesc:ga3d55779001cc649ed85be1a92f09892d"><td class="mdescLeft"> </td><td class="mdescRight">Send a command to Pixy. <a href="#ga3d55779001cc649ed85be1a92f09892d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3d55779001cc649ed85be1a92f09892d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaada09a1aeda12672050f5c3183ef6f3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gaada09a1aeda12672050f5c3183ef6f3b">pixy_close</a> ()</td></tr>
|
|
<tr class="memdesc:gaada09a1aeda12672050f5c3183ef6f3b"><td class="mdescLeft"> </td><td class="mdescRight">Terminates connection with Pixy. <a href="#gaada09a1aeda12672050f5c3183ef6f3b">More...</a><br /></td></tr>
|
|
<tr class="separator:gaada09a1aeda12672050f5c3183ef6f3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga247afb06384e4967395a7059e0bde95d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga247afb06384e4967395a7059e0bde95d">pixy_error</a> (int error_code)</td></tr>
|
|
<tr class="memdesc:ga247afb06384e4967395a7059e0bde95d"><td class="mdescLeft"> </td><td class="mdescRight">Send description of pixy error to stdout. <a href="#ga247afb06384e4967395a7059e0bde95d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga247afb06384e4967395a7059e0bde95d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga28045d2cfce3a28f4c7d5e6673b4bad7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga28045d2cfce3a28f4c7d5e6673b4bad7">pixy_led_set_RGB</a> (uint8_t red, uint8_t green, uint8_t blue)</td></tr>
|
|
<tr class="memdesc:ga28045d2cfce3a28f4c7d5e6673b4bad7"><td class="mdescLeft"> </td><td class="mdescRight">Set color of pixy LED. <a href="#ga28045d2cfce3a28f4c7d5e6673b4bad7">More...</a><br /></td></tr>
|
|
<tr class="separator:ga28045d2cfce3a28f4c7d5e6673b4bad7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga38582b897bb2eb5f36c6f68d2e171d05"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga38582b897bb2eb5f36c6f68d2e171d05">pixy_led_set_max_current</a> (uint32_t current)</td></tr>
|
|
<tr class="memdesc:ga38582b897bb2eb5f36c6f68d2e171d05"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy LED maximum current. <a href="#ga38582b897bb2eb5f36c6f68d2e171d05">More...</a><br /></td></tr>
|
|
<tr class="separator:ga38582b897bb2eb5f36c6f68d2e171d05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gace7a7da527f1b01abc6355fd8945d023"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gace7a7da527f1b01abc6355fd8945d023">pixy_led_get_max_current</a> ()</td></tr>
|
|
<tr class="memdesc:gace7a7da527f1b01abc6355fd8945d023"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy LED maximum current. <a href="#gace7a7da527f1b01abc6355fd8945d023">More...</a><br /></td></tr>
|
|
<tr class="separator:gace7a7da527f1b01abc6355fd8945d023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac46359533378c0822a463bdd5d2466d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gac46359533378c0822a463bdd5d2466d8">pixy_cam_set_auto_white_balance</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:gac46359533378c0822a463bdd5d2466d8"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable pixy camera auto white balance. <a href="#gac46359533378c0822a463bdd5d2466d8">More...</a><br /></td></tr>
|
|
<tr class="separator:gac46359533378c0822a463bdd5d2466d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3eb84125292a5bf39f63e8a9378ba5ad"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga3eb84125292a5bf39f63e8a9378ba5ad">pixy_cam_get_auto_white_balance</a> ()</td></tr>
|
|
<tr class="memdesc:ga3eb84125292a5bf39f63e8a9378ba5ad"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy camera auto white balance setting. <a href="#ga3eb84125292a5bf39f63e8a9378ba5ad">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3eb84125292a5bf39f63e8a9378ba5ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8c1436f86bb954d19f7c9bbb9d5e0ed1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga8c1436f86bb954d19f7c9bbb9d5e0ed1">pixy_cam_get_white_balance_value</a> ()</td></tr>
|
|
<tr class="memdesc:ga8c1436f86bb954d19f7c9bbb9d5e0ed1"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy camera white balance() <a href="#ga8c1436f86bb954d19f7c9bbb9d5e0ed1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8c1436f86bb954d19f7c9bbb9d5e0ed1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad2ec06c83cc4c8de8551e3151287c264"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gad2ec06c83cc4c8de8551e3151287c264">pixy_cam_set_white_balance_value</a> (uint8_t red, uint8_t green, uint8_t blue)</td></tr>
|
|
<tr class="memdesc:gad2ec06c83cc4c8de8551e3151287c264"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy camera white balance. <a href="#gad2ec06c83cc4c8de8551e3151287c264">More...</a><br /></td></tr>
|
|
<tr class="separator:gad2ec06c83cc4c8de8551e3151287c264"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad2eff98f2123b2070c64e4c442c859e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gad2eff98f2123b2070c64e4c442c859e7">pixy_cam_set_auto_exposure_compensation</a> (uint8_t enable)</td></tr>
|
|
<tr class="memdesc:gad2eff98f2123b2070c64e4c442c859e7"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable pixy camera auto exposure compensation. <a href="#gad2eff98f2123b2070c64e4c442c859e7">More...</a><br /></td></tr>
|
|
<tr class="separator:gad2eff98f2123b2070c64e4c442c859e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga80fe76de4eb898969b0921ce53d83a65"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga80fe76de4eb898969b0921ce53d83a65">pixy_cam_get_auto_exposure_compensation</a> ()</td></tr>
|
|
<tr class="memdesc:ga80fe76de4eb898969b0921ce53d83a65"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy camera auto exposure compensation setting. <a href="#ga80fe76de4eb898969b0921ce53d83a65">More...</a><br /></td></tr>
|
|
<tr class="separator:ga80fe76de4eb898969b0921ce53d83a65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0b375c58d7ddc701d6c65845ecfc11fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga0b375c58d7ddc701d6c65845ecfc11fb">pixy_cam_set_exposure_compensation</a> (uint8_t gain, uint16_t comp)</td></tr>
|
|
<tr class="memdesc:ga0b375c58d7ddc701d6c65845ecfc11fb"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy camera exposure compensation. <a href="#ga0b375c58d7ddc701d6c65845ecfc11fb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga0b375c58d7ddc701d6c65845ecfc11fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga077b6b62e9af99fbd911b92dee2205c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga077b6b62e9af99fbd911b92dee2205c0">pixy_cam_get_exposure_compensation</a> (uint8_t *gain, uint16_t *comp)</td></tr>
|
|
<tr class="memdesc:ga077b6b62e9af99fbd911b92dee2205c0"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy camera exposure compensation. <a href="#ga077b6b62e9af99fbd911b92dee2205c0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga077b6b62e9af99fbd911b92dee2205c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4abc74c8533b17d9e2aa6dfbf4c6a5e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga4abc74c8533b17d9e2aa6dfbf4c6a5e1">pixy_cam_set_brightness</a> (uint8_t brightness)</td></tr>
|
|
<tr class="memdesc:ga4abc74c8533b17d9e2aa6dfbf4c6a5e1"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy camera brightness. <a href="#ga4abc74c8533b17d9e2aa6dfbf4c6a5e1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4abc74c8533b17d9e2aa6dfbf4c6a5e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9fda296a7a69f42625faf2e675b762ae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga9fda296a7a69f42625faf2e675b762ae">pixy_cam_get_brightness</a> ()</td></tr>
|
|
<tr class="memdesc:ga9fda296a7a69f42625faf2e675b762ae"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy camera brightness. <a href="#ga9fda296a7a69f42625faf2e675b762ae">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9fda296a7a69f42625faf2e675b762ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad8ff0e513bae5acec82c6a7e0e21685f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#gad8ff0e513bae5acec82c6a7e0e21685f">pixy_rcs_get_position</a> (uint8_t channel)</td></tr>
|
|
<tr class="memdesc:gad8ff0e513bae5acec82c6a7e0e21685f"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy servo axis position. <a href="#gad8ff0e513bae5acec82c6a7e0e21685f">More...</a><br /></td></tr>
|
|
<tr class="separator:gad8ff0e513bae5acec82c6a7e0e21685f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5fb9213a5459dc6c74131ecabd6b5995"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga5fb9213a5459dc6c74131ecabd6b5995">pixy_rcs_set_position</a> (uint8_t channel, uint16_t position)</td></tr>
|
|
<tr class="memdesc:ga5fb9213a5459dc6c74131ecabd6b5995"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy servo axis position. <a href="#ga5fb9213a5459dc6c74131ecabd6b5995">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5fb9213a5459dc6c74131ecabd6b5995"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga45bb277d2ea7110def16186468e571f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga45bb277d2ea7110def16186468e571f9">pixy_rcs_set_frequency</a> (uint16_t frequency)</td></tr>
|
|
<tr class="memdesc:ga45bb277d2ea7110def16186468e571f9"><td class="mdescLeft"> </td><td class="mdescRight">Set pixy servo pulse width modulation (PWM) frequency. <a href="#ga45bb277d2ea7110def16186468e571f9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga45bb277d2ea7110def16186468e571f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8ca61cb465cf6dc72fcae79b0c08e810"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy.html#ga8ca61cb465cf6dc72fcae79b0c08e810">pixy_get_firmware_version</a> (uint16_t *major, uint16_t *minor, uint16_t *build)</td></tr>
|
|
<tr class="memdesc:ga8ca61cb465cf6dc72fcae79b0c08e810"><td class="mdescLeft"> </td><td class="mdescRight">Get pixy firmware version. <a href="#ga8ca61cb465cf6dc72fcae79b0c08e810">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8ca61cb465cf6dc72fcae79b0c08e810"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>The Pixy Module </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga3edb6eb461c90059cb4926395401b7c0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_BLOCKTYPE_COLOR_CODE   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad3106d870305c42c4935dac3375d03d9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_BLOCKTYPE_NORMAL   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab9471c2f9186bc9b98e4c8131efd9342"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_MAX_SIGNATURE   7</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaec6baba7922a62f334138aa17f3891f8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_MAX_X   319</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga74b8105f78bc6befa6f639750714c7dd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_MAX_Y   199</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0834f8933ac1684e28fe4f832488b320"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_MIN_X   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0e3a3aa0490fce5c19f571541a997e8c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_MIN_Y   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9182417344deee5ca45dba835416a1a3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_RCS_CENTER_POS   ((<a class="el" href="group__pixy.html#ga2336b04d0e7669f8491241a455653af8">PIXY_RCS_MAX_POS</a>-<a class="el" href="group__pixy.html#ga5361e5e4628b4f8577d2febafc4da088">PIXY_RCS_MIN_POS</a>)/2)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2336b04d0e7669f8491241a455653af8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_RCS_MAX_POS   1000</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5361e5e4628b4f8577d2febafc4da088"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIXY_RCS_MIN_POS   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga2df93fdbd04ed434d281a4b9acfa0263"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_blocks_are_new </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Indicates when new block data from Pixy is received. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 New Data: <a class="el" href="struct_block.html">Block</a> data has been updated. </dd>
|
|
<dd>
|
|
0 Stale Data: <a class="el" href="struct_block.html">Block</a> data has not changed since <a class="el" href="group__pixy.html#gab4113dedad844bc189466552c75b47a0" title="Copies up to 'max_blocks' number of Blocks to the address pointed to by 'blocks'. ...">pixy_get_blocks()</a> was last called. </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga2df93fdbd04ed434d281a4b9acfa0263_icgraph.png" border="0" usemap="#group__pixy_ga2df93fdbd04ed434d281a4b9acfa0263_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga2df93fdbd04ed434d281a4b9acfa0263_icgraph" id="group__pixy_ga2df93fdbd04ed434d281a4b9acfa0263_icgraph">
|
|
<area shape="rect" id="node2" href="screen__tracking_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="200,5,261,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga80fe76de4eb898969b0921ce53d83a65"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_get_auto_exposure_compensation </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy camera auto exposure compensation setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 Auto exposure compensation enabled. </dd>
|
|
<dd>
|
|
0 Auto exposure compensation disabled. </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3eb84125292a5bf39f63e8a9378ba5ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_get_auto_white_balance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy camera auto white balance setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 Auto white balance is enabled. </dd>
|
|
<dd>
|
|
0 Auto white balance is disabled. </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9fda296a7a69f42625faf2e675b762ae"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_get_brightness </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy camera brightness. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Non-negative Brightness value. </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga077b6b62e9af99fbd911b92dee2205c0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_get_exposure_compensation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>gain</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>comp</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy camera exposure compensation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">gain</td><td>Camera gain. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">comp</td><td>Camera exposure compensation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8c1436f86bb954d19f7c9bbb9d5e0ed1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t pixy_cam_get_white_balance_value </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy camera white balance() </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Composite value for RGB white balance: white balance = green_value + (red_value << 8) + (blue << 16) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad2eff98f2123b2070c64e4c442c859e7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_set_auto_exposure_compensation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable or disable pixy camera auto exposure compensation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>0: Disable auto exposure compensation. 1: Enable auto exposure compensation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac46359533378c0822a463bdd5d2466d8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_set_auto_white_balance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable or disable pixy camera auto white balance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>1: Enable white balance. 0: Disable white balance. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4abc74c8533b17d9e2aa6dfbf4c6a5e1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_set_brightness </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>brightness</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy camera brightness. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">brightness</td><td>Brightness value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0b375c58d7ddc701d6c65845ecfc11fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_set_exposure_compensation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>gain</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>comp</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy camera exposure compensation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">gain</td><td>Camera gain. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>Camera exposure compensation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad2ec06c83cc4c8de8551e3151287c264"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_cam_set_white_balance_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>red</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>green</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>blue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy camera white balance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">red</td><td>Red white balance value. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">green</td><td>Green white balance value. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">blue</td><td>Blue white balance value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaada09a1aeda12672050f5c3183ef6f3b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void pixy_close </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates connection with Pixy. </p>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_gaada09a1aeda12672050f5c3183ef6f3b_icgraph.png" border="0" usemap="#group__pixy_gaada09a1aeda12672050f5c3183ef6f3b_icgraph" alt=""/></div>
|
|
<map name="group__pixy_gaada09a1aeda12672050f5c3183ef6f3b_icgraph" id="group__pixy_gaada09a1aeda12672050f5c3183ef6f3b_icgraph">
|
|
<area shape="rect" id="node2" href="screen__photomode_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="137,5,199,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3d55779001cc649ed85be1a92f09892d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_command </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a command to Pixy. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Chirp remote procedure call identifier string. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 Error </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga3d55779001cc649ed85be1a92f09892d_icgraph.png" border="0" usemap="#group__pixy_ga3d55779001cc649ed85be1a92f09892d_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga3d55779001cc649ed85be1a92f09892d_icgraph" id="group__pixy_ga3d55779001cc649ed85be1a92f09892d_icgraph">
|
|
<area shape="rect" id="node2" href="group__pixy__helper.html#gad8071a378a78f150cd14bbbd9b93c925" title="pixy_render_cropped\l_frame" alt="" coords="178,5,321,47"/><area shape="rect" id="node5" href="group__pixy__helper.html#gaf0820ad9bb1ae6791fecb3916372c479" title="pixy_save_cropped_frame" alt="" coords="164,71,335,98"/><area shape="rect" id="node8" href="group__pixy__helper.html#gad9068bef13bfd5e3cee9ecfe4d070f02" title="pixy_cc_set_region" alt="" coords="182,122,317,149"/><area shape="rect" id="node10" href="screen__pixytest_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="219,173,280,199"/><area shape="rect" id="node11" href="screen__tracking_8c.html#a4e5b235d9db4e14eb031143a12e26940" title="tracking_our_start" alt="" coords="186,223,313,250"/><area shape="rect" id="node12" href="screen__tracking_8c.html#a5d91f86f9a46542f9e2f469fc8e7dfc6" title="tracking_our_stop" alt="" coords="187,274,312,301"/><area shape="rect" id="node13" href="screen__tracking_8c.html#a64c8fd7aa09f5cc15cce099bf8efb46e" title="tracking_reference\l_start" alt="" coords="185,325,313,367"/><area shape="rect" id="node14" href="screen__tracking_8c.html#ab0a72aefe60e18bcbc6181f6015d1e88" title="tracking_reference_stop" alt="" coords="169,391,329,418"/><area shape="rect" id="node3" href="group__pixy__helper.html#ga31b46efdf685d2337447b1e529693e2f" title="pixy_render_full_frame" alt="" coords="383,13,533,39"/><area shape="rect" id="node4" href="screen__photomode_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="581,13,643,39"/><area shape="rect" id="node6" href="group__pixy__helper.html#gaeb47b641ad8f8cb10c26debb27c7dead" title="pixy_save_full_frame" alt="" coords="387,71,529,98"/><area shape="rect" id="node7" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="581,71,643,98"/><area shape="rect" id="node9" href="screen__tracking_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="427,122,489,149"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga247afb06384e4967395a7059e0bde95d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void pixy_error </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>error_code</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send description of pixy error to stdout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Pixy error code </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab4113dedad844bc189466552c75b47a0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_get_blocks </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_blocks</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">struct <a class="el" href="struct_block.html">Block</a> * </td>
|
|
<td class="paramname"><em>blocks</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copies up to 'max_blocks' number of Blocks to the address pointed to by 'blocks'. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_blocks</td><td>Maximum number of Blocks to copy to the address pointed to by 'blocks'. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">blocks</td><td>Address of an array in which to copy the blocks to. The array must be large enough to write 'max_blocks' number of Blocks to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Non-negative Success: Number of blocks copied </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_IO USB Error: I/O </dd>
|
|
<dd>
|
|
PIXY_ERROR_NOT_FOUND USB Error: Pixy not found </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_BUSY USB Error: Busy </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_NO_DEVICE USB Error: No device </dd>
|
|
<dd>
|
|
PIXY_ERROR_INVALID_PARAMETER Invalid pararmeter specified </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_gab4113dedad844bc189466552c75b47a0_icgraph.png" border="0" usemap="#group__pixy_gab4113dedad844bc189466552c75b47a0_icgraph" alt=""/></div>
|
|
<map name="group__pixy_gab4113dedad844bc189466552c75b47a0_icgraph" id="group__pixy_gab4113dedad844bc189466552c75b47a0_icgraph">
|
|
<area shape="rect" id="node2" href="screen__tracking_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="169,5,231,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8ca61cb465cf6dc72fcae79b0c08e810"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_get_firmware_version </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>major</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>minor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>build</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy firmware version. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Major version component </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Minor version component </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">build</td><td>Build identifier </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad269822960ad0073356dab75ce3050b3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a connection with Pixy and listens for Pixy messages. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_IO USB Error: I/O </dd>
|
|
<dd>
|
|
PIXY_ERROR_NOT_FOUND USB Error: Pixy not found </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_BUSY USB Error: Busy </dd>
|
|
<dd>
|
|
PIXY_ERROR_USB_NO_DEVICE USB Error: No device </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_gad269822960ad0073356dab75ce3050b3_icgraph.png" border="0" usemap="#group__pixy_gad269822960ad0073356dab75ce3050b3_icgraph" alt=""/></div>
|
|
<map name="group__pixy_gad269822960ad0073356dab75ce3050b3_icgraph" id="group__pixy_gad269822960ad0073356dab75ce3050b3_icgraph">
|
|
<area shape="rect" id="node2" href="screen__photomode_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="129,5,180,32"/><area shape="rect" id="node3" href="screen__photomode_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="124,56,185,83"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gace7a7da527f1b01abc6355fd8945d023"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_led_get_max_current </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy LED maximum current. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Non-negative Maximum LED current value (microamps). </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga38582b897bb2eb5f36c6f68d2e171d05"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_led_set_max_current </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>current</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy LED maximum current. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">current</td><td>Maximum current (microamps). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga38582b897bb2eb5f36c6f68d2e171d05_icgraph.png" border="0" usemap="#group__pixy_ga38582b897bb2eb5f36c6f68d2e171d05_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga38582b897bb2eb5f36c6f68d2e171d05_icgraph" id="group__pixy_ga38582b897bb2eb5f36c6f68d2e171d05_icgraph">
|
|
<area shape="rect" id="node2" href="screen__pixytest_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="228,5,289,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga28045d2cfce3a28f4c7d5e6673b4bad7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_led_set_RGB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>red</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>green</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>blue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set color of pixy LED. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">red</td><td>Brightness value for red LED element. [0, 255] 0 = Off, 255 = On </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">green</td><td>Brightness value for green LED element. [0, 255] 0 = Off, 255 = On </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">blue</td><td>Brightness value for blue LED element. [0, 255] 0 = Off, 255 = On </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga28045d2cfce3a28f4c7d5e6673b4bad7_icgraph.png" border="0" usemap="#group__pixy_ga28045d2cfce3a28f4c7d5e6673b4bad7_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga28045d2cfce3a28f4c7d5e6673b4bad7_icgraph" id="group__pixy_ga28045d2cfce3a28f4c7d5e6673b4bad7_icgraph">
|
|
<area shape="rect" id="node2" href="screen__tracking_8c.html#acd1409088e83cf2a8ba2cf96dd9b52f8" title="leave" alt="" coords="184,5,235,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad8ff0e513bae5acec82c6a7e0e21685f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_rcs_get_position </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>channel</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get pixy servo axis position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">channel</td><td>Channel value. Range: [0, 1] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Position of channel. Range: [0, 999] </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga45bb277d2ea7110def16186468e571f9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_rcs_set_frequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>frequency</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy servo pulse width modulation (PWM) frequency. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frequency</td><td>Range: [20, 300] Hz Default: 50 Hz </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5fb9213a5459dc6c74131ecabd6b5995"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_rcs_set_position </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>position</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set pixy servo axis position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">channel</td><td>Channel value. Range: [0, 1] </td></tr>
|
|
<tr><td class="paramname">position</td><td>Position value of the channel. Range: [0, 999] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 Success </dd>
|
|
<dd>
|
|
Negative Error </dd></dl>
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga5fb9213a5459dc6c74131ecabd6b5995_icgraph.png" border="0" usemap="#group__pixy_ga5fb9213a5459dc6c74131ecabd6b5995_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga5fb9213a5459dc6c74131ecabd6b5995_icgraph" id="group__pixy_ga5fb9213a5459dc6c74131ecabd6b5995_icgraph">
|
|
<area shape="rect" id="node2" href="screen__photomode_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="240,5,301,32"/><area shape="rect" id="node3" href="screen__tracking_8c.html#a4e5b235d9db4e14eb031143a12e26940" title="tracking_our_start" alt="" coords="207,56,334,83"/><area shape="rect" id="node4" href="screen__tracking_8c.html#acb647e6a47a40716583b11336f58e023" title="tracking_our_update" alt="" coords="201,107,340,133"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga72a2cd126f6a5f67842e5ff66424ccb0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int pixy_service </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__pixy_ga72a2cd126f6a5f67842e5ff66424ccb0_icgraph.png" border="0" usemap="#group__pixy_ga72a2cd126f6a5f67842e5ff66424ccb0_icgraph" alt=""/></div>
|
|
<map name="group__pixy_ga72a2cd126f6a5f67842e5ff66424ccb0_icgraph" id="group__pixy_ga72a2cd126f6a5f67842e5ff66424ccb0_icgraph">
|
|
<area shape="rect" id="node2" href="screen__photomode_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="147,5,208,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Jun 8 2015 01:15:03 for discoverpixy by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|