CCS/LAUNCHXL-CC2640R2: Where do I find the reference documentation for libraries such as I2C driver library

Gerriko Iot

Part Number: LAUNCHXL-CC2640R2
Other Parts Discussed in Thread: CC2640R2F

Tool/software: Code Composer Studio

Hi,

I am working through the i2ctmp007 example provided within TI Resource Explorer and I am using CCS Cloud.

I am now trying to find reference documentation related to the I2C library (ti/drivers/I2C.h) but there are no obvious html links in TI Resouce Explorer, or elsewhere on TI.COM for that matter, that I could find which would direct me to the library reference documentation. The TI.COM website appears to be very product related, hence making it very difficult to navigate. I tried searching but nothing came up.

I am trying to learn about all the I2C functions available. Some were used in the example I am looking at:

I2C_open( Board_I2C_TMP, &i2cParams)

I2C_transfer(i2c, &i2cTransaction)

This comment applies to all libraries actually. Where is the reference document found?

Thanks

over 7 years ago

0 Markel Robregado over 7 years ago

Guru 86745 points

Hi Gerriko,

I suggest you download the latest BLE Stack for TI CC2640R2. The document with regards to I2C can be found at "C:\ti\simplelink_cc2640r2_sdk_1_40_00_45\docs\tidrivers". Also this question is much appropriate at TI BLE Forum.

- kel

0 Gerriko Iot over 7 years ago in reply to Markel Robregado

Intellectual 300 points

Thanks. I will download. So what you are saying is that there is nothing online (within ti.com) available.

Also, not sure why you are saying that questions about I2C drivers should be directed to the BLE Forum. I thought the whole concept behind the Simplelink platform is commonality. Maybe you can explain.

0 Markel Robregado over 7 years ago in reply to Gerriko Iot

Guru 86745 points

Gerriko Iot said:
I thought the whole concept behind the Simplelink platform is commonality.

Yes, that is true. But, before the Simplelink platform became "commonality" just recently, the drivers (e.g I2C) are maintained by Teams for that specific MCU. Example drivers for TI CC2640R2F are maintained by TI BLE Team. So, if you ask the question at TI BLE Forum with regards to I2C for TI CC2640R2F, you will get more expert advice.

- kel

0 Gerriko Iot over 7 years ago in reply to Markel Robregado

Intellectual 300 points

Thanks kel for the explanation.

I eventually found what I was looking for by shear trial and error, and at least 2 hours of perserverence.

Now that I have found the documentation, I can see that it is placed in the most obvious place.

The problem I had actually originated by my attempt to use the TI Resource Explorer search box.

I selected my product and entered "I2C_init" in the search box, as this was one of the functions I wanted to read up about. It returned the following: "No search results found for “I2C_init” . We are continuously adding more content to Resource Explorer."

I tried a range of products and received the same message. I tried other functions and also received the same message.

I tried simply using the term "I2C" and the following directories came up:

- Software
-- SimpleLink CC2640R2 SDK - v:1.40.00
--- Examples
---- Development Tools (etc.)
-- SimpleLink SDK Plugins
--- SimpleLink Sensor and Actuator Plugin
---- Development Tools (etc.)

As you can see, rather irrelevant information came back.

The correct directory, which should have been returned is the following (seems obvious to me)

- Software
-- SimpleLink CC2640R2 SDK - v:1.40.00
--- Documents
---- Drivers

The information I wanted was found in the following file "TI Drivers Runtime APIs"

0 Gerriko Iot over 7 years ago in reply to Gerriko Iot

Intellectual 300 points

I thought to add to this post as I believe the TI Resource Explorer needs fixing. What I just discovered is that if I enter the term "I2C driver" the Documents folder is included in the search results. If I just enter "I2C" then, as I described before, the Documents folder is excluded altogether.

It is my opinion that when searching for terms, like "I2C", then all items need to be included in the search result and it is up to the user to narrow things down themselves.

0 JohnS over 7 years ago in reply to Gerriko Iot

TI__Guru**** 162305 points

Gerriko,

I agree with you that the documentation hits should be returned when doing the I2C search.

It looks like it is the driver keyword that triggers the doc to show up. If I search just on driver I see it.

I filed an issue against Resource Explorer to track this (REX-1609). The names of each of the drivers should trigger docs hits.

Regards,

John

Code Composer Studio™︎

Code Composer Studio forum

CCS/LAUNCHXL-CC2640R2: Where do I find the reference documentation for libraries such as I2C driver library