Documentation for Adafruit Libraries

Post here about your Arduino projects, get help - for Adafruit customers!

Moderators: adafruit_support_bill, adafruit

Please be positive and constructive with your questions and comments.
Locked
User avatar
rickseiden
 
Posts: 66
Joined: Thu Oct 06, 2016 2:48 pm

Documentation for Adafruit Libraries

Post by rickseiden »

Hello,

Where can I find documentation for Adafruit Arduino Libraries? Specifically, I'm looking for documentation on the Adafruit_SH110X library for use with the MacroPad that came with the last AdaBox.

I know that there are learning modules on it, there are examples for the libraries, and the source is available on gitHub (and in my libraries folder), but I'm looking for actual documentation. Something that lists out what the functions are and what they do.

For example, I know that I can use .setTextSize(1) to set the text, and setCursor(0,0) to put the cursor in the upper left hand corner of the display, but how many rows and columns are there at text size 1? Or, maybe, how big is a character at text size 1? What other functions are available to me?

The problem I have with the learning modules and the examples is that they only cover the basics, and don't really explain the details. The problem I have with the source code is that not all of us are skilled enough in Arduino programming to decipher the well written but complex code that is needed to author an efficient library.

Thanks in advance
Rick

User avatar
dastels
 
Posts: 15656
Joined: Tue Oct 20, 2015 3:22 pm

Re: Documentation for Adafruit Libraries

Post by dastels »

Documentation for CircuitPython libraries is pretty good, that for C++/Arduino libraries seems to be somewhat more inconsistent. In many cases your best option beyond the guides/examples is the source.

Dave

User avatar
rickseiden
 
Posts: 66
Joined: Thu Oct 06, 2016 2:48 pm

Re: Documentation for Adafruit Libraries

Post by rickseiden »

dastels wrote:Documentation for CircuitPython libraries is pretty good, that for C++/Arduino libraries seems to be somewhat more inconsistent. In many cases your best option beyond the guides/examples is the source.

Dave
Dave,

One of Adafruit's main goals, as I understand it, is to make making easier. Having beginners search through the source code that was written by experts is not going to accomplish that goal.

User avatar
dastels
 
Posts: 15656
Joined: Tue Oct 20, 2015 3:22 pm

Re: Documentation for Adafruit Libraries

Post by dastels »

I agree. I don't have an inside scoop or anything, so this is somewhat guesswork. The C++/Arduino stuff is fairly old in some cases and maybe docs didn't get the same attention as those for CircuitPython are getting. There are also more standards around documentation in the Python community which no doubt helps as well.

Dave

User avatar
adafruit2
 
Posts: 22148
Joined: Fri Mar 11, 2005 7:36 pm

Re: Documentation for Adafruit Libraries

Post by adafruit2 »


Locked
Please be positive and constructive with your questions and comments.

Return to “Arduino”