hid_8h.html

BlueLab3 bluetooth API 说明文档

</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Possible status codes for the initialiation confirmation. 
<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="a90a30" doxytag="hid_init_success" ></a>hid_init_success</em>&nbsp;</td><td>
Successful initialisation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a90a31" doxytag="hid_init_sdp_reg_fail" ></a>hid_init_sdp_reg_fail</em>&nbsp;</td><td>
SDP registration failed. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a90a32" doxytag="hid_init_l2cap_reg_fail" ></a>hid_init_l2cap_reg_fail</em>&nbsp;</td><td>
L2CAP PSM registration failed. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a91" doxytag="hid.h::hid_connect_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="hid_8h.html#a91">hid_connect_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Possible status codes for the connection. 
<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="a91a33" doxytag="hid_connect_success" ></a>hid_connect_success</em>&nbsp;</td><td>
Successful connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a91a34" doxytag="hid_connect_failed" ></a>hid_connect_failed</em>&nbsp;</td><td>
Connection failed. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a91a35" doxytag="hid_connect_out_of_resources" ></a>hid_connect_out_of_resources</em>&nbsp;</td><td>
Out of resource. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a91a36" doxytag="hid_connect_timeout" ></a>hid_connect_timeout</em>&nbsp;</td><td>
Timeout waiting for connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a91a37" doxytag="hid_connect_disconnected" ></a>hid_connect_disconnected</em>&nbsp;</td><td>
Disconnected remotely during setup </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a92" doxytag="hid.h::hid_disconnect_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="hid_8h.html#a92">hid_disconnect_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Possible status codes for the disconnection. 
<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="a92a38" doxytag="hid_disconnect_success" ></a>hid_disconnect_success</em>&nbsp;</td><td>
Successful disconnection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a92a39" doxytag="hid_disconnect_link_loss" ></a>hid_disconnect_link_loss</em>&nbsp;</td><td>
Unsuccessful due to the link being lost. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a92a40" doxytag="hid_disconnect_timeout" ></a>hid_disconnect_timeout</em>&nbsp;</td><td>
Unsuccessful due to time out. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a92a41" doxytag="hid_disconnect_violation" ></a>hid_disconnect_violation</em>&nbsp;</td><td>
Disconnection due to protocol violation </td></tr>
<tr><td valign=top><em><a class="anchor" name="a92a42" doxytag="hid_disconnect_error" ></a>hid_disconnect_error</em>&nbsp;</td><td>
Unsuccessful for some other reason. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a92a43" doxytag="hid_disconnect_virtual_unplug" ></a>hid_disconnect_virtual_unplug</em>&nbsp;</td><td>
Virtual unplug disconnection </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a93" doxytag="hid.h::hid_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="hid_8h.html#a93">hid_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Possible result codes for the HANDSHAKE messages. See HID profile 7,4,1 table 5. NOTE: These values must match those defined in the HID profile specification. 
<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="a93a44" doxytag="hid_success" ></a>hid_success</em>&nbsp;</td><td>
Successful operation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a45" doxytag="hid_busy" ></a>hid_busy</em>&nbsp;</td><td>
Device is busy with previous operation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a46" doxytag="hid_invalid_id" ></a>hid_invalid_id</em>&nbsp;</td><td>
Invalid report ID. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a47" doxytag="hid_unsupported" ></a>hid_unsupported</em>&nbsp;</td><td>
Operation is unsupported. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a48" doxytag="hid_invalid_param" ></a>hid_invalid_param</em>&nbsp;</td><td>
Invalid parameter. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a49" doxytag="hid_failed" ></a>hid_failed</em>&nbsp;</td><td>
Unknown failure. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a50" doxytag="hid_timeout" ></a>hid_timeout</em>&nbsp;</td><td>
Operation timeout. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a93a51" doxytag="hid_resource_error" ></a>hid_resource_error</em>&nbsp;</td><td>
Not enough resource to complete operation. (Local error, never reported to remote host/device) </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a94" doxytag="hid.h::hid_protocol" ></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="hid_8h.html#a94">hid_protocol</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
HID boot modes. See HID profile 7.4.5, table 10 &amp; 7.4.6, table 11. NOTE: These values must match those defined in the HID profile specification. 
<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="a94a52" doxytag="hid_protocol_boot" ></a>hid_protocol_boot</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a94a53" doxytag="hid_protocol_report" ></a>hid_protocol_report</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a95" doxytag="hid.h::hid_control_op" ></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="hid_8h.html#a95">hid_control_op</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
HID control operations. See HID profile 7.4.2, table 6. NOTE: These values must match those defined in the HID profile specification. 
<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="a95a54" doxytag="hid_control_op_nop" ></a>hid_control_op_nop</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a95a55" doxytag="hid_control_op_hard_reset" ></a>hid_control_op_hard_reset</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a95a56" doxytag="hid_control_op_soft_reset" ></a>hid_control_op_soft_reset</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a95a57" doxytag="hid_control_op_suspend" ></a>hid_control_op_suspend</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a95a58" doxytag="hid_control_op_exit_suspend" ></a>hid_control_op_exit_suspend</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a95a59" doxytag="hid_control_op_unplug" ></a>hid_control_op_unplug</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a96" doxytag="hid.h::hid_pin_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="hid_8h.html#a96">hid_pin_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Status of pin code entry. 
<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="a96a60" doxytag="hid_pin_ok" ></a>hid_pin_ok</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a61" doxytag="hid_pin_full" ></a>hid_pin_full</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a62" doxytag="hid_pin_complete" ></a>hid_pin_complete</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a63" doxytag="hid_pin_add" ></a>hid_pin_add</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a64" doxytag="hid_pin_delete" ></a>hid_pin_delete</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a65" doxytag="hid_pin_cleared" ></a>hid_pin_cleared</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a96a66" doxytag="hid_pin_error" ></a>hid_pin_error</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a67" doxytag="hid.h::HidInit" ></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 HidInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>theAppTask</em>, </td>
        </tr>