📄 piolib_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: piolib.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>piolib.h File Reference</h1>Header file for the PIO Multiplexor library. <a href="#_details">More...</a><p><h2>Data Structures</h2><ul><li>struct <a class="el" href="struct_p_i_o_l_i_b___i_n_i_t___c_f_m___t.html">PIOLIB_INIT_CFM_T</a><dl class="el"><dd class="mdescRight">A PIO Multiplexor Library entity has completed it's initialisation process. <a href="struct_p_i_o_l_i_b___i_n_i_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_p_i_o_l_i_b___r_e_g_i_s_t_e_r___c_f_m___t.html">PIOLIB_REGISTER_CFM_T</a><dl class="el"><dd class="mdescRight">Result of an attempt to register interest in PIO messages. <a href="struct_p_i_o_l_i_b___r_e_g_i_s_t_e_r___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_p_i_o_l_i_b___d_e_r_e_g_i_s_t_e_r___c_f_m___t.html">PIOLIB_DEREGISTER_CFM_T</a><dl class="el"><dd class="mdescRight">Result of an attempt to deregister interest in PIO messages. <a href="struct_p_i_o_l_i_b___d_e_r_e_g_i_s_t_e_r___c_f_m___t.html#_details">More...</a><br></dl></ul><h2>Defines</h2><ul><li>#define <a class="el" href="piolib_8h.html#a0">PIOLIB_MAX_CLIENTS</a> 4<dl class="el"><dd class="mdescRight">Maximum number of clients that can register with the PIO Multiplexor Library. <a href="#a0"></a><br></dl><li>#define <a class="el" href="piolib_8h.html#a1">PIOLIB_MESSAGE_BASE</a> 0x6000<dl class="el"><dd class="mdescRight">The base number for connection library messages. <a href="#a1"></a><br></dl></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="piolib_8h.html#a8">pio_lib_status</a> { <br> <a class="el" href="piolib_8h.html#a8a2">piolib_success</a>, <br> <a class="el" href="piolib_8h.html#a8a3">piolib_inuse</a>, <br> <a class="el" href="piolib_8h.html#a8a4">piolib_too_many_clients</a><br> }<dl class="el"><dd class="mdescRight">PIO Multiplexor library return status. <a href="#a8">More...</a><br></dl></ul><h2>Functions</h2><ul><li>void <a class="el" href="piolib_8h.html#a5">PiolibInit</a> (<a class="el" href="struct_task_data.html">Task</a> retTask)<dl class="el"><dd class="mdescRight">This function is called to initialise the PIO Multiplexor Library. <a href="#a5"></a><br></dl><li>void <a class="el" href="piolib_8h.html#a6">PiolibRegister</a> (<a class="el" href="struct_task_data.html">Task</a> regTask)<dl class="el"><dd class="mdescRight">This function registers interest in PIO Messages. <a href="#a6"></a><br></dl><li>void <a class="el" href="piolib_8h.html#a7">PiolibDeRegister</a> (<a class="el" href="struct_task_data.html">Task</a> regTask)<dl class="el"><dd class="mdescRight">This function removes an interest in PIO Messages. <a href="#a7"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Header file for the PIO Multiplexor library. <p>This file provides documentation for the BlueLab3 PIO Multiplexor library API.<p>The PIO Multiplexor library allows more than 1 task to receive MESSAGE_PIO_CHANGED messages. Each registered task will receive an identical copy of the MESSAGE_PIO_CHANGED message reveived by the PIO Multiplexor.<p>To make buttonParse use PIOLIB, use the 'use_piolib' directive. In this case, the base application should call PioLibInit and PioDebounce.<p>Library variants:- piolib - Piolib with no debug output piolib_print - Piolib with debug output<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="piolib.h::PIOLIB_MAX_CLIENTS" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define PIOLIB_MAX_CLIENTS 4 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Maximum number of clients that can register with the PIO Multiplexor Library. <p> </td> </tr></table><a class="anchor" name="a1" doxytag="piolib.h::PIOLIB_MESSAGE_BASE" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define PIOLIB_MESSAGE_BASE 0x6000 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The base number for connection library messages. <p> </td> </tr></table><hr><h2>Enumeration Type Documentation</h2><a class="anchor" name="a8" doxytag="piolib.h::pio_lib_status" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> enum <a class="el" href="piolib_8h.html#a8">pio_lib_status</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>PIO Multiplexor library return status. <p><dl compact><dt><b>Enumeration values: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em><a class="anchor" name="a8a2" doxytag="piolib_success" ></a>piolib_success</em> </td><td>The operation has completed successfully. </td></tr><tr><td valign=top><em><a class="anchor" name="a8a3" doxytag="piolib_inuse" ></a>piolib_inuse</em> </td><td>A task already has already registered for PIO Messages. </td></tr><tr><td valign=top><em><a class="anchor" name="a8a4" doxytag="piolib_too_many_clients" ></a>piolib_too_many_clients</em> </td><td>Too many clients have registered for PIO Messages </td></tr></table></dl> </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="a5" doxytag="piolib.h::PiolibInit" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void PiolibInit </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a> </td> <td class="mdname1" valign="top" nowrap> <em>retTask</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>This function is called to initialise the PIO Multiplexor Library. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>retTask</em> </td><td>Task to send the confirm message to.</td></tr> </table></dl>A PIOLIB_INIT_CFM message will be received on initiailisation.<p>If PiolibInit is called for a second time, all previous registrations will be lost. </td> </tr></table><a class="anchor" name="a6" doxytag="piolib.h::PiolibRegister" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void PiolibRegister </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a> </td> <td class="mdname1" valign="top" nowrap> <em>regTask</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>This function registers interest in PIO Messages. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>theAppTask</em> </td><td>The task to receive PIO Messages.</td></tr> </table></dl>A PIOLIB_REGISTER_CFM message will be received containing the result of registration. </td> </tr></table><a class="anchor" name="a7" doxytag="piolib.h::PiolibDeRegister" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void PiolibDeRegister </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a> </td> <td class="mdname1" valign="top" nowrap> <em>regTask</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>This function removes an interest in PIO Messages. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>theAppTask</em> </td><td>The task to stop receiving PIO Messages.</td></tr> </table></dl>A PIOLIB_DEREGISTER_CFM message will be received containing the result of registration removal. </td> </tr></table></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -