Voting resources, early voting, and poll worker information - VOTE. ... Adafruit is open and shipping.
0

Procedure Descriptions
Moderators: adafruit_support_bill, adafruit

Please be positive and constructive with your questions and comments.

Procedure Descriptions

by Owkmann on Mon Jul 27, 2020 2:54 pm

Hi,

Are technical notes available that describe the use of Procedures or Functions in Adafruit's headers? For example,

"Serial.begin(9600);
Serial.println("RA8875 start");"

What are my options with the Serial procedure?

Or, what would you recommend as the easiest way to understand how this function works?

Thanks,

Stephen

Owkmann
 
Posts: 2
Joined: Mon Jul 27, 2020 2:49 pm

Re: Procedure Descriptions

by westfw on Mon Jul 27, 2020 5:04 pm

what would you recommend as the easiest way to understand how this function works?


There are essentially three levels of documentation for the Arduino functions (note that "Serial" is an Arduino thing, rather than an Adafruit-specific thing.)

1: There is the "Arduino Language Reference": https://www.arduino.cc/reference/en/lan ... on/serial/
2: There are many examples, and for more complex functions, there will usually be tutorials and/or discussions in the Arduino forums (or other forums.)
3: Read the source code. As far as I know, there isn't very much in the way of "internals documentation" of the sort you sometimes see in academia or "professional but not-really-helpful" vendor library documentation (like this Atmel ASF page) So for detailed information, you have to look at the actual code. Fortunately, that code is "open source" so that you CAN look at it, and is pretty readable.

westfw
 
Posts: 1722
Joined: Fri Apr 27, 2007 1:01 pm
Location: SF Bay area

Re: Procedure Descriptions

by adafruit_support_carter on Mon Jul 27, 2020 5:20 pm

That looks like Arduino code.

The libraries can come from multiple locations, and thus the documentation will also be in multiple locations. There's a whole bunch of libraries that are part of the Arduino core, and Serial is one of them. So you can look here:
https://www.arduino.cc/reference/en/lan ... on/serial/

For any Adafruit Arduino library, there should be documentation at this location:
Code: Select all | TOGGLE FULL SIZE
https://adafruit.github.io/<repo_name>

where you replace <repo_name> with the name of the github repository. For example, here's the Adafruit_RA8875 repo:
https://github.com/adafruit/Adafruit_RA8875
and here is the documentation:
https://adafruit.github.io/Adafruit_RA8875

adafruit_support_carter
 
Posts: 16944
Joined: Tue Nov 29, 2016 2:45 pm

Please be positive and constructive with your questions and comments.