hid_8h.html

BlueLab3 bluetooth API 说明文档

Called by application to send a report on the interrupt channel. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>report_type</em>&nbsp;</td><td>Type of report being sent to remove device. </td></tr>
    <tr><td></td><td valign=top><em>report_length</em>&nbsp;</td><td>Length of report. </td></tr>
    <tr><td></td><td valign=top><em>data</em>&nbsp;</td><td>Pointer to report data, the data is copied by the HID library. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a73" doxytag="hid.h::HidGetReportResponse" ></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 HidGetReportResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="hid_8h.html#a8">HID</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>hid</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a93">hid_status</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>status</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid__if_8h.html#a7">hid_report_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>report_type</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>report_length</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>data</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called by application in response to a HID_GET_REPORT_IND message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>report_type</em>&nbsp;</td><td>Type of report: other, input, output or feature. </td></tr>
    <tr><td></td><td valign=top><em>report_length</em>&nbsp;</td><td>Length of report data in bytes. </td></tr>
    <tr><td></td><td valign=top><em>data</em>&nbsp;</td><td>Pointer to report data, the data is copied by the HID library. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a74" doxytag="hid.h::HidSetReportResponse" ></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 HidSetReportResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="hid_8h.html#a8">HID</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>hid</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a93">hid_status</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>status</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called by application in response to a HID_SET_REPORT_IND message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>status</em>&nbsp;</td><td>Response code to send to host. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a75" doxytag="hid.h::HidGetProtocolResponse" ></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 HidGetProtocolResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="hid_8h.html#a8">HID</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>hid</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a93">hid_status</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>status</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a94">hid_protocol</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>protocol</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called by application in response to a HID_GET_PROTOCOL_IND message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>status</em>&nbsp;</td><td>Response code to send to host. </td></tr>
    <tr><td></td><td valign=top><em>protocol</em>&nbsp;</td><td>Protocol currently being used, only valid if status is hid_success. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a76" doxytag="hid.h::HidSetProtocolResponse" ></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 HidSetProtocolResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="hid_8h.html#a8">HID</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>hid</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a93">hid_status</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>status</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called by application in response to a HID_SET_PROTOCOL_IND message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>status</em>&nbsp;</td><td>Response code to send to host. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a77" doxytag="hid.h::HidGetIdleResponse" ></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 HidGetIdleResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="hid_8h.html#a8">HID</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>hid</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="hid_8h.html#a93">hid_status</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>status</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>idle_rate</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Called by application in response to a HID_GET_IDLE_IND message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>hid</em>&nbsp;</td><td>HID connection instance. </td></tr>
    <tr><td></td><td valign=top><em>status</em>&nbsp;</td><td>Response code to send to host. </td></tr>
    <tr><td></td><td valign=top><em>idle_rate</em>&nbsp;</td><td>Idle rate to report to host, only valid if status is hid_success. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a78" doxytag="hid.h::HidSetIdleResponse" ></a><p>
<table class="mdTable" width="100%" c