6 Replies Latest reply on Feb 12, 2015 3:19 AM by userc_9557

    How to use the APIs ?

      Hello, I have a question.

       

      I have the tag board and have read some documents and could download the sample programs and work well.

       

      Next, I am making a original code but I couldn't the API reference.

      I found the API reference html at WICDED-Smart-SDK->Doc->API.html but many functions are not explained.

       

      For example, the SDK make some code automatically when I make the project like,

       

      blecm_setTxPowerInADV(0);

       

      but, there is no explanation of the function's argument.

       

      How could I do?

       

      I don't want to know just the mean of the function. I want to know "how" to study the APIs.

        • 1. Re: How to use the APIs ?
          BoonT_56

          you may like to browse the below document for a start. most often than not, we start with a sample app like hello_sensor  in the sdk and modify from there.. we also have the smart_designer within the sdk to assist you...

           

          How to Write WICED Smart Applications

          • 2. Re: How to use the APIs ?

            Thank you for the reply.

             

            I already have read the document, Quick Start Guide, Hardware Interfaces Application Note, Bluetooth Core Specification and other documents that could download from Broadcom site.

            I have experience of developing other BLE chip.

             

            But I don't think the documents and the samples have enough information to use the APIs.

             

            for example,

             

            I have checked hello_sensor sample already and found a function of


            blecm_setTxPowerInADV(0);

             

            then I can imagine that it sets transmit power while advertisement, but the sample have no comment for the argument.

            I have searched the directly of the SDK but there is no information of the argument at all.

            I think we have to control the tx power especially for beacon device. I know many engineer use the SIP module, but I don't understand how they study the meaning of APIs in detail.

            • 3. Re: How to use the APIs ?

              Ishii,

               

              Parameter is in dBm and the stack chooses closest value found in the power table which is +3, -1, -5, -9,-13, -17, -21, -25 dBm

               

              JT

              • 4. Re: How to use the APIs ?

                jt,

                 

                Thank you for the reply.

                 

                But I want to know how to study for using the APIs in detail. Not just for the blecm_setTxPowerInADV() function.

                 

                Anyway, the value of dBm of the tx power can be from -127 to +127, from BLE specification.

                What is the "the power table" ? Where can I see it? I have serched the SDK folder but couldn't find the table.

                 

                Taka,

                • 5. Re: How to use the APIs ?
                  MichaelF_56

                  Unfortunately, the only API documentation we provide is that which is included within the SDK (Deoxygen output, HTML based).

                   

                  The power table is used by frmware and is not exposed to users.  The increments described by J.T (provided by the developers) in the previous note are what should be used within your program.

                  • 6. Re: How to use the APIs ?

                    I understood.

                     

                    Thank you.

                     

                    Taka,