diff options
Diffstat (limited to 'ucs2-lib/doc/html/modules.html')
| -rw-r--r-- | ucs2-lib/doc/html/modules.html | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/modules.html b/ucs2-lib/doc/html/modules.html new file mode 100644 index 0000000..effc161 --- /dev/null +++ b/ucs2-lib/doc/html/modules.html @@ -0,0 +1,153 @@ +<!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"/> +<title>UNICENS: API Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="style_html.css" rel="stylesheet" type="text/css" /> +<link href="inic.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div class="GlobalWrapper"> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr> + <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> + <td> + <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> + <div id="projectbrief">User Manual and API Reference</div> + <div id="searchbox"> <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> +</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.2 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('modules.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="headertitle"> +<div class="title">API Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock">Here is a list of all modules:</div><div class="directory"> +<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory"> +<tr id="row_0_" class="even"><td class="entry"><img id="arr_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_')"/><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html" target="_self">Initialization and Service</a></td><td class="desc">Provides initialization and service functions</td></tr> +<tr id="row_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html" target="_self">Initialization and Service Types</a></td><td class="desc">Referred types used by basic functions</td></tr> +<tr id="row_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_0_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('0_1_')"/><a class="el" href="group___g___u_c_s___t_r_a_c_e.html" target="_self">Tracing/Debugging</a></td><td class="desc">Tracing/Debugging Interface</td></tr> +<tr id="row_0_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___t_r_a_c_e___t_y_p_e_s.html" target="_self">Tracing/Debugging Types</a></td><td class="desc">Referred types used by Tracing/Debugging Interface</td></tr> +<tr id="row_1_" class="even"><td class="entry"><img id="arr_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_')"/><a class="el" href="group___g___u_c_s___i_n_i_c.html" target="_self">INIC</a></td><td class="desc">INIC related functions</td></tr> +<tr id="row_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___i_n_i_c___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">INIC related types</td></tr> +<tr id="row_2_" class="even"><td class="entry"><img id="arr_2_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('2_')"/><a class="el" href="group___g___u_c_s___n_e_t.html" target="_self">Network</a></td><td class="desc">Provides network management functions</td></tr> +<tr id="row_2_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Provides network management functions</td></tr> +<tr id="row_3_" class="even"><td class="entry"><img id="arr_3_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('3_')"/><a class="el" href="group___g___u_c_s___a_m_s.html" target="_self">Application Message Service</a></td><td class="desc">Application Message Service</td></tr> +<tr id="row_3_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___a_m_s___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred types used by Application Message Service</td></tr> +<tr id="row_4_" class="even"><td class="entry"><img id="arr_4_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('4_')"/><a class="el" href="group___g___u_c_s___c_m_d.html" target="_self">Command Interpreter</a></td><td class="desc">Decodes received MOST messages</td></tr> +<tr id="row_4_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___c_m_d___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred types used by the Command Interpreter</td></tr> +<tr id="row_5_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___m_g_r.html" target="_self">Manager</a></td><td class="desc">The Manager is responsible to force the network to available and handle NodeDiscovery and RoutingManagement by a default logic</td></tr> +<tr id="row_6_"><td class="entry"><img id="arr_6_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('6_')"/><a class="el" href="group___g___u_c_s___n_o_d_e___d_i_s_c_o_v_e_r_y.html" target="_self">Node Discovery</a></td><td class="desc">Node Discovery Service</td></tr> +<tr id="row_6_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___n_o_d_e___d_i_s_c_o_v_e_r_y___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred Types used by Node Discovery Service</td></tr> +<tr id="row_7_"><td class="entry"><img id="arr_7_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('7_')"/><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e.html" target="_self">Programming</a></td><td class="desc">Programming Service</td></tr> +<tr id="row_7_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred Types used by Programming Service</td></tr> +<tr id="row_8_"><td class="entry"><img id="arr_8_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('8_')"/><a class="el" href="group___g___u_c_s___b_c___d_i_a_g.html" target="_self">BackChannel Diagnosis</a></td><td class="desc">BackChannel Diagnosis</td></tr> +<tr id="row_8_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___b_c___d_i_a_g___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred Types used by BackChannel Diagnosis</td></tr> +<tr id="row_9_"><td class="entry"><img id="arr_9_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('9_')"/><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g.html" target="_self">Routing Management</a></td><td class="desc">Provides service functions to handle connection routes</td></tr> +<tr id="row_9_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_9_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('9_0_')"/><a class="el" href="group___g___u_c_s___i_r_m.html" target="_self">Extended Resources Management</a></td><td class="desc">Provides data type to manage MOST data resources</td></tr> +<tr id="row_9_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___x_r_m___s_t_r_e_a_m.html" target="_self">Additional Streaming Port Functions</a></td><td class="desc">Additional Streaming Port functions of the Extended Resource Manager</td></tr> +<tr id="row_9_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_9_0_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('9_0_1_')"/><a class="el" href="group___g___u_c_s___x_r_m___t_y_p_e_s.html" target="_self">XRM Referred Types</a></td><td class="desc">Referred types used by XRM service functions</td></tr> +<tr id="row_9_0_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___x_r_m___e_n_u_m.html" target="_self">XRM SubTypes</a></td><td class="desc">Referred types used in XRM Sockets and Ports description</td></tr> +<tr id="row_9_0_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___x_r_m___c_f_g.html" target="_self">XRM Configuration Macros</a></td><td class="desc">Configurations Macros used by XRM service functions</td></tr> +<tr id="row_9_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred types used by Routing service functions</td></tr> +<tr id="row_10_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g.html" target="_self">Node Scripting</a></td><td class="desc">Provides service function to allow execution of custom scripts in remote Nodes</td></tr> +<tr id="row_11_"><td class="entry"><img id="arr_11_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('11_')"/><a class="el" href="group___g___u_c_s___p_b_i.html" target="_self">Peripheral Bus Interface</a></td><td class="desc">Provides service functions to manage data communication over the peripheral bus interfaces I2C and GPIO</td></tr> +<tr id="row_11_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_11_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('11_0_')"/><a class="el" href="group___g___u_c_s___g_p_i_o.html" target="_self">GPIO</a></td><td class="desc">Provides service functions to handle data communication over GPIO</td></tr> +<tr id="row_11_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___g_p_i_o___t_y_p_e_s.html" target="_self">GPIO Referred Types</a></td><td class="desc">Referred types used by the Extended Resource Manager</td></tr> +<tr id="row_11_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_11_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('11_1_')"/><a class="el" href="group___g___u_c_s___i2_c.html" target="_self">I2C</a></td><td class="desc">Provides service functions to handle data communication over I2C</td></tr> +<tr id="row_11_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___i2_c___t_y_p_e_s.html" target="_self">I2C Referred Types</a></td><td class="desc">Referred types used by the Extended Resource Manager</td></tr> +<tr id="row_12_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___m_i_s_c.html" target="_self">Miscellaneous</a></td><td class="desc">Miscellaneous features</td></tr> +<tr id="row_13_"><td class="entry"><img id="arr_13_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('13_')"/><a class="el" href="group___g___u_c_s___l_l_d.html" target="_self">Low-Level Driver</a></td><td class="desc">Provides an interface for Port Message Exchange with the INIC</td></tr> +<tr id="row_13_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="group___g___u_c_s___l_l_d___a_p_i.html" target="_self">Low-Level Driver API</a></td><td class="desc">Function pointers to be used by the low-level driver</td></tr> +<tr id="row_13_1_"><td class="entry"><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="group___g___u_c_s___l_l_d___t_y_p_e_s.html" target="_self">Referred Types</a></td><td class="desc">Referred types used by the low-level driver interface</td></tr> +</table> +</div><!-- directory --> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> + </ul> +</div> +</body> +<!-- +Generated on Mon Apr 3 2017 13:53:01 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |