xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Test
-->
<Section key = "0">
   <SubSection key = "1"/>
</Section>
<Chapter Name="PBDI" Definition="Bluetooth devices inquiry" Software="Bxxx" Products="All" State="Released">

  <Brief>This command is used to initiate or cancel an inquiry for Bluetooth devices.</Brief>

  
  <Note Name="Details">
blabla IF(CONFIG_BLUES_VERSION_6_0){blibliblabla}
blabla2
  </Note>

  <Example>
# sharp sign will start a comment, in green in the spec
example_line1 # sharp sign will start a comment, in green in the spec
example_line2
  </Example>
  
  <!--JUMP LINES, easier to read -->

  <!-- AT*PBDI=%d -->
  <Command Name="PBDI" Format="*PBDI" ResType="NONE" ResCount="NONE" Brief="Start/Stop Bluetooth devices inquiry" Condition=”CONFIG_BLUES_VERSION_6_0”>
    <Args Count="1 2">
      <Arg Index="1" ATPos="LEFT" ATType="DEC" CType="HSTI_BT_INQUIRY_ACTION" Name="InquiryAction" Brief="Action to perform"/>NO text between <Arg> and </Arg>
      <Arg Index="2" ATType="HEX" CType="HSTI_BYTE" Name="BTAddr" CLength="HSTI_BT_ADDR_SIZE" ATPos="LEFT" Brief="Bluetooth address. (represented as 12 hexadecimal digits"/>
    </Args>
    <Result>
      <Case Comment="Inquiry in progress">
        <OK/>
        <Event Code="PBDI" Count="[0...]" Comment="This event identifies a device found by inquiry"/>
        <Event Code="PBDI_END" Comment="End of inquiry"/>
      </Case>
      <Case>
        <Error Code="HSTI_CMD_ATREQ_RES_ERR_PARAM_WRONG_VALUE"/>
        <Error Code="HSTI_CMD_ATREQ_RES_ERR_STATE_NOT_IDLE"/>
        <Error Code="HSTI_CMD_ATREQ_RES_ERR_CALLMNGT_CALL_IN_PROGRESS"/>
        <Error Code="HSTI_CMD_ATREQ_RES_ERR_STATE_NOT_INQUIRY" Comment="If InquiryAction=0 and no inquiry started"/>
      </Case>
    </Result>
  </Command>


  <!-- *PBDI:%i '%s' %x %x -->
  <Event Name="PBDI" Format="*PBDI" Type="ASYNCRESULT|UNSOLICITED" Brief="Gives the name of a Bluetooth device found">
    <Args Count="4">
      <Arg Index="1" ATType="ID" ATPos="LEFT" CType="HSTI_DEVICE_ID" Name="Id" Brief="is the device identifier (letter I + number)"/>
      <Arg Index="2" ATType="STRQ" ATPos="MIDDLE" CType="HSTI_STR" Name="BTName" CLength="HSTI_BT_MAX_NAME_LENGTH" StrType="UTF8" Brief="Bluetooth friendly name of the device found in the range"/>
      <Arg Index="3" ATType="HEX" ATPos="RIGHT" CType="HSTI_BYTE" Name="BTAddr" CLength="HSTI_BT_ADDR_SIZE" Brief="BT address of the device"/>
      <Arg Index="4" ATType="HEX" ATPos="RIGHT" CType="HSTI_UINT" BitFieldEnum="HSTI_PSBC_BT_SERVICE" Name="ServiceSupported" Brief="Bitfield of the service supported"/>
      <Arg Index="5" ATType="HEX" ATPos="RIGHT" CType="HSTI_BYTE" Name="BTCod" CLength="HSTI_BT_COD_SIZE" Brief="Bluetooth Class Of Device (3 bytes in hexadecimal format, so 6 hexadecimal digits)."/>
    </Args>
  </Event>

  <!-- *PBDI:END -->
  <Event Name="PBDI_END" OverloadName="PBDI" Format="*PBDI:END" Type="ASYNCRESULT|UNSOLICITED" Brief="Inquiry terminates.">
    <Args Count="0"/>
  </Event>

  <!-- Display a table in spec to comment the unsolicited sequence-->
  <UnsolicitedEvent>
    <Case Comment="If the inquiry is started itself">
      <Event Code="PBDI" Count="[0...]" Comment="This event identify a device found by inquiry"/>
      <Event Code="PBDI_END" Comment="End of inquiry"/>
    </Case>
  </UnsolicitedEvent>
</Chapter>