2021-05-02 15:06:06 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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" / >
2022-12-15 11:52:18 +01:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2021-05-02 15:06:06 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > USB Host Shield 2.0: AMBX Class Reference< / 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 >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "imageStyle.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 id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > USB Host Shield 2.0
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2022-12-15 11:52:18 +01:00
<!-- Generated by Doxygen 1.9.1 -->
2021-05-02 15:06:06 +02:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2022-12-15 11:52:18 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2021-05-02 15:06:06 +02:00
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
<!-- 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 > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "#pro-attribs" > Protected Attributes< / a > |
< a href = "class_a_m_b_x-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > AMBX Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for AMBX:< / div >
< div class = "dyncontent" >
2022-12-15 11:52:18 +01:00
< div class = "center" > < img src = "class_a_m_b_x__inherit__graph.png" border = "0" usemap = "#a_a_m_b_x_inherit__map" alt = "Inheritance graph" / > < / div >
< map name = "a_a_m_b_x_inherit__map" id = "a_a_m_b_x_inherit__map" >
2021-05-02 15:06:06 +02:00
< area shape = "rect" title = " " alt = "" coords = "42,80,103,107" / >
< area shape = "rect" href = "class_u_s_b_device_config.html" title = " " alt = "" coords = "5,5,140,32" / >
< / map >
< center > < span class = "legend" > [< a href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< div class = "dynheader" >
Collaboration diagram for AMBX:< / div >
< div class = "dyncontent" >
2022-12-15 11:52:18 +01:00
< div class = "center" > < img src = "class_a_m_b_x__coll__graph.png" border = "0" usemap = "#a_a_m_b_x_coll__map" alt = "Collaboration graph" / > < / div >
< map name = "a_a_m_b_x_coll__map" id = "a_a_m_b_x_coll__map" >
2021-05-02 15:06:06 +02:00
< area shape = "rect" title = " " alt = "" coords = "158,171,219,197" / >
< area shape = "rect" href = "class_u_s_b_device_config.html" title = " " alt = "" coords = "5,81,140,108" / >
< area shape = "rect" href = "class_u_s_b.html" title = " " alt = "" coords = "164,81,213,108" / >
< area shape = "rect" href = "class_m_a_x3421e.html" title = " " alt = "" coords = "143,5,235,32" / >
< area shape = "rect" href = "struct_ep_info.html" title = " " alt = "" coords = "237,81,300,108" / >
< / map >
< center > < span class = "legend" > [< a href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a66268906efc2172fec6676affec35bac" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a66268906efc2172fec6676affec35bac" > AMBX< / a > (< a class = "el" href = "class_u_s_b.html" > USB< / a > *< a class = "el" href = "class_a_m_b_x.html#a4a431d51355935d2a5a3e0b0be445a5e" > pUsb< / a > )< / td > < / tr >
< tr class = "separator:a66268906efc2172fec6676affec35bac" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac6d86347274400d7db5d2394c53ad972" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#ac6d86347274400d7db5d2394c53ad972" > setLight< / a > (uint8_t ambx_light, uint8_t r, uint8_t g, uint8_t b)< / td > < / tr >
< tr class = "separator:ac6d86347274400d7db5d2394c53ad972" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a759fc6f01f0ee80bee878253eebf21e5" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a759fc6f01f0ee80bee878253eebf21e5" > setLight< / a > (< a class = "el" href = "_a_m_b_x_enums_8h.html#ab89d9ad8d1631f26d5e35b3e3c9b6ee2" > AmbxLightsEnum< / a > ambx_light, < a class = "el" href = "_a_m_b_x_enums_8h.html#a629a6a0310b15932888986a4e775fedb" > AmbxColorsEnum< / a > color)< / td > < / tr >
< tr class = "separator:a759fc6f01f0ee80bee878253eebf21e5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab49ac5d8724c26f83ebb7ba6d74a3c14" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#ab49ac5d8724c26f83ebb7ba6d74a3c14" > setAllLights< / a > (< a class = "el" href = "_a_m_b_x_enums_8h.html#a629a6a0310b15932888986a4e775fedb" > AmbxColorsEnum< / a > color)< / td > < / tr >
< tr class = "separator:ab49ac5d8724c26f83ebb7ba6d74a3c14" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3f9cdf123c542dcadccc39f4f782af70" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a3f9cdf123c542dcadccc39f4f782af70" > attachOnInit< / a > (void(*funcOnInit)(void))< / td > < / tr >
< tr class = "separator:a3f9cdf123c542dcadccc39f4f782af70" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr > < td colspan = "2" > < div class = "groupHeader" > USBDeviceConfig implementation< / div > < / td > < / tr >
< tr class = "memitem:a676e193add396dd56527cf538765d01c" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a676e193add396dd56527cf538765d01c" > Init< / a > (uint8_t parent, uint8_t port, bool lowspeed)< / td > < / tr >
< tr class = "separator:a676e193add396dd56527cf538765d01c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1bac21499826d3730b09c0518285261b" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a1bac21499826d3730b09c0518285261b" > Release< / a > ()< / td > < / tr >
< tr class = "separator:a1bac21499826d3730b09c0518285261b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a170eab5afaacf6cf1c795fe20aaf452d" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a170eab5afaacf6cf1c795fe20aaf452d" > Poll< / a > ()< / td > < / tr >
< tr class = "separator:a170eab5afaacf6cf1c795fe20aaf452d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac8050fa02a28f3bcb823044f85630343" > < td class = "memItemLeft" align = "right" valign = "top" > virtual uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#ac8050fa02a28f3bcb823044f85630343" > GetAddress< / a > ()< / td > < / tr >
< tr class = "separator:ac8050fa02a28f3bcb823044f85630343" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a02fc08db15af0a428d551e4a86584ae5" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a02fc08db15af0a428d551e4a86584ae5" > VIDPIDOK< / a > (uint16_t vid, uint16_t pid)< / td > < / tr >
< tr class = "separator:a02fc08db15af0a428d551e4a86584ae5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pub_methods_class_u_s_b_device_config" > < td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_class_u_s_b_device_config')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "class_u_s_b_device_config.html" > USBDeviceConfig< / a > < / td > < / tr >
< tr class = "memitem:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config" > < td class = "memItemLeft" align = "right" valign = "top" > virtual uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e" > ConfigureDevice< / a > (uint8_t parent, uint8_t port, bool lowspeed)< / td > < / tr >
< tr class = "separator:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391" > ResetHubPort< / a > (uint8_t port)< / td > < / tr >
< tr class = "separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_u_s_b_device_config.html#a2bb3e09cf128c8ecd04ea0dfce2126e1" > DEVCLASSOK< / a > (uint8_t klass)< / td > < / tr >
< tr class = "separator:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_u_s_b_device_config.html#ad2d535af92d0b97e4445a6bd51d35c57" > DEVSUBCLASSOK< / a > (uint8_t subklass)< / td > < / tr >
< tr class = "separator:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a2dea8d23588f26a82e439618f57b7ffb" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a2dea8d23588f26a82e439618f57b7ffb" > AMBXConnected< / a > < / td > < / tr >
< tr class = "separator:a2dea8d23588f26a82e439618f57b7ffb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pro-attribs" > < / a >
Protected Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a4a431d51355935d2a5a3e0b0be445a5e" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "class_u_s_b.html" > USB< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a4a431d51355935d2a5a3e0b0be445a5e" > pUsb< / a > < / td > < / tr >
< tr class = "separator:a4a431d51355935d2a5a3e0b0be445a5e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7e9cefbb6409c68bcb1a82c965d8e57d" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a7e9cefbb6409c68bcb1a82c965d8e57d" > bAddress< / a > < / td > < / tr >
< tr class = "separator:a7e9cefbb6409c68bcb1a82c965d8e57d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a20ab54576f57720b20c140bc2980a602" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "struct_ep_info.html" > EpInfo< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_m_b_x.html#a20ab54576f57720b20c140bc2980a602" > epInfo< / a > [< a class = "el" href = "_a_m_b_x_8h.html#a09eb75d75cfff1e7747324eb57562f6b" > AMBX_MAX_ENDPOINTS< / a > ]< / td > < / tr >
< tr class = "separator:a20ab54576f57720b20c140bc2980a602" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > This class implements support for < a class = "el" href = "class_a_m_b_x.html" > AMBX< / a > One can only set the color of the bulbs, no other accesories like rumble pad, fans, etc. are supported < / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00063" > 63< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "a66268906efc2172fec6676affec35bac" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a66268906efc2172fec6676affec35bac" > ◆ < / a > < / span > AMBX()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > AMBX::AMBX < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_u_s_b.html" > USB< / a > *  < / td >
< td class = "paramname" > < em > pUsb< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Constructor for the < a class = "el" href = "class_a_m_b_x.html" > AMBX< / a > class. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > pUsb< / td > < td > Pointer to < a class = "el" href = "class_u_s_b.html" > USB< / a > class instance. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00021" > 21< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a676e193add396dd56527cf538765d01c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a676e193add396dd56527cf538765d01c" > ◆ < / a > < / span > Init()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t AMBX::Init < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > parent< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > port< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > lowspeed< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Initialize the < a class = "el" href = "class_a_m_b_x.html" > AMBX< / a > Controller. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > parent< / td > < td > Hub number. < / td > < / tr >
< tr > < td class = "paramname" > port< / td > < td > Port number on the hub. < / td > < / tr >
< tr > < td class = "paramname" > lowspeed< / td > < td > Speed of the device. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > 0 on success. < / dd > < / dl >
< p > Reimplemented from < a class = "el" href = "class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738" > USBDeviceConfig< / a > .< / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00037" > 37< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "a1bac21499826d3730b09c0518285261b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1bac21499826d3730b09c0518285261b" > ◆ < / a > < / span > Release()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t AMBX::Release < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Release the < a class = "el" href = "class_u_s_b.html" > USB< / a > device. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > 0 on success. < / dd > < / dl >
< p > Reimplemented from < a class = "el" href = "class_u_s_b_device_config.html#a61e301efedae55c6ac12c6cce154e432" > USBDeviceConfig< / a > .< / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00205" > 205< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "a170eab5afaacf6cf1c795fe20aaf452d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a170eab5afaacf6cf1c795fe20aaf452d" > ◆ < / a > < / span > Poll()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t AMBX::Poll < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Poll the < a class = "el" href = "class_u_s_b.html" > USB< / a > Input endpoins and run the state machines. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > 0 on success. < / dd > < / dl >
< p > Reimplemented from < a class = "el" href = "class_u_s_b_device_config.html#a893ea73deab98be837c257201e7da25a" > USBDeviceConfig< / a > .< / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00212" > 212< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "ac8050fa02a28f3bcb823044f85630343" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac8050fa02a28f3bcb823044f85630343" > ◆ < / a > < / span > GetAddress()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual uint8_t AMBX::GetAddress < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the device address. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > The device address. < / dd > < / dl >
< p > Reimplemented from < a class = "el" href = "class_u_s_b_device_config.html#a2bfde6c290d32888a6f4e97fa1e222f1" > USBDeviceConfig< / a > .< / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00095" > 95< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< a id = "a02fc08db15af0a428d551e4a86584ae5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a02fc08db15af0a428d551e4a86584ae5" > ◆ < / a > < / span > VIDPIDOK()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool AMBX::VIDPIDOK < / td >
< td > (< / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > vid< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > pid< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Used by the < a class = "el" href = "class_u_s_b.html" > USB< / a > core to check what this driver support. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > vid< / td > < td > The device's VID. < / td > < / tr >
< tr > < td class = "paramname" > pid< / td > < td > The device's PID. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Returns true if the device's VID and PID matches this driver. < / dd > < / dl >
< p > Reimplemented from < a class = "el" href = "class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141" > USBDeviceConfig< / a > .< / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00105" > 105< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< a id = "ac6d86347274400d7db5d2394c53ad972" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac6d86347274400d7db5d2394c53ad972" > ◆ < / a > < / span > setLight() < span class = "overload" > [1/2]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void AMBX::setLight < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > ambx_light< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > r< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > g< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > b< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Use this to set the Color using RGB values. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > r,g,b< / td > < td > RGB value. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00223" > 223< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "a759fc6f01f0ee80bee878253eebf21e5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a759fc6f01f0ee80bee878253eebf21e5" > ◆ < / a > < / span > setLight() < span class = "overload" > [2/2]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void AMBX::setLight < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "_a_m_b_x_enums_8h.html#ab89d9ad8d1631f26d5e35b3e3c9b6ee2" > AmbxLightsEnum< / a >   < / td >
< td class = "paramname" > < em > ambx_light< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "_a_m_b_x_enums_8h.html#a629a6a0310b15932888986a4e775fedb" > AmbxColorsEnum< / a >   < / td >
< td class = "paramname" > < em > color< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Use this to set the color using the predefined colors in < a class = "el" href = "controller_enums_8h.html#aac6fa7b0395b95cc528deaad0ce884a2" > ColorsEnum< / a > . < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > color< / td > < td > The desired color. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00233" > 233< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "ab49ac5d8724c26f83ebb7ba6d74a3c14" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab49ac5d8724c26f83ebb7ba6d74a3c14" > ◆ < / a > < / span > setAllLights()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void AMBX::setAllLights < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "_a_m_b_x_enums_8h.html#a629a6a0310b15932888986a4e775fedb" > AmbxColorsEnum< / a >   < / td >
< td class = "paramname" > < em > color< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Use this to set the color using the predefined colors in < a class = "el" href = "controller_enums_8h.html#aac6fa7b0395b95cc528deaad0ce884a2" > ColorsEnum< / a > . < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > color< / td > < td > The desired color. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8cpp_source.html#l00237" > 237< / a > of file < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > .< / p >
< / div >
< / div >
< a id = "a3f9cdf123c542dcadccc39f4f782af70" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3f9cdf123c542dcadccc39f4f782af70" > ◆ < / a > < / span > attachOnInit()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void AMBX::attachOnInit < / td >
< td > (< / td >
< td class = "paramtype" > void(*)(void)  < / td >
< td class = "paramname" > < em > funcOnInit< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Used to call your own function when the controller is successfully initialized. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > funcOnInit< / td > < td > Function to call. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00131" > 131< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "a2dea8d23588f26a82e439618f57b7ffb" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2dea8d23588f26a82e439618f57b7ffb" > ◆ < / a > < / span > AMBXConnected< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool AMBX::AMBXConnected< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-12-15 11:52:18 +01:00
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00136" > 136< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
2021-05-02 15:06:06 +02:00
< / div >
< / div >
< a id = "a4a431d51355935d2a5a3e0b0be445a5e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a4a431d51355935d2a5a3e0b0be445a5e" > ◆ < / a > < / span > pUsb< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_u_s_b.html" > USB< / a > * AMBX::pUsb< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > protected< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Pointer to < a class = "el" href = "class_u_s_b.html" > USB< / a > class instance. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00140" > 140< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< a id = "a7e9cefbb6409c68bcb1a82c965d8e57d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a7e9cefbb6409c68bcb1a82c965d8e57d" > ◆ < / a > < / span > bAddress< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t AMBX::bAddress< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > protected< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Device address. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00142" > 142< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< a id = "a20ab54576f57720b20c140bc2980a602" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a20ab54576f57720b20c140bc2980a602" > ◆ < / a > < / span > epInfo< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "struct_ep_info.html" > EpInfo< / a > AMBX::epInfo[< a class = "el" href = "_a_m_b_x_8h.html#a09eb75d75cfff1e7747324eb57562f6b" > AMBX_MAX_ENDPOINTS< / a > ]< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > protected< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Endpoint info structure. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "_a_m_b_x_8h_source.html#l00144" > 144< / a > of file < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > < a class = "el" href = "_a_m_b_x_8h_source.html" > AMBX.h< / a > < / li >
< li > < a class = "el" href = "_a_m_b_x_8cpp_source.html" > AMBX.cpp< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2022-12-15 11:52:18 +01:00
Generated by  < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.9.1
2021-05-02 15:06:06 +02:00
< / small > < / address >
< / body >
< / html >