0

Adafruit IO C++ API documentation
Moderators: adafruit_support_bill, adafruit

Forum rules
If you're posting code, please make sure your code does not include your Adafruit IO Active Key or WiFi network credentials.
Please be positive and constructive with your questions and comments.

Adafruit IO C++ API documentation

by Bart66 on Tue Jul 02, 2019 8:12 pm

Is there reference documention somewhere for the Adafruit IO C++ API for Arduino? I don't mean the HTTP or MQTT APIs documented at https://io.adafruit.com/api/docs, nor the tutorial and examples at https://learn.adafruit.com/adafruit-io. Those are excellent, but I'm looking for documentation on the C++ classes evident in the Arduino examples, such as AdafruitIO_WiFi with methods like connect() and disconnect(), or class AdafruitIO_Feed with methods like save().

I would like to find a list of the public methods available in each class, with short descriptions of the arguments and return value for each method. Sort of like Javadoc for Java classes. Does such a thing exist? I have searched extensively without finding it, but it might be out there somewhere. I've checked https://adafruit-io-arduino.readthedocs.io/en/latest/, and I've checked all the URLs in the .rst files on https://github.com/adafruit/Adafruit_IO_Arduino.

Thanks!

Bart66
 
Posts: 3
Joined: Tue Jul 02, 2019 7:17 pm

Re: Adafruit IO C++ API documentation

by brubell on Fri Jul 05, 2019 9:46 am

Hi Bart,

Adding doxygen (https://learn.adafruit.com/the-well-aut ... ry/doxygen) to Adafruit IO Arduino is on my radar (https://github.com/adafruit/Adafruit_IO ... /issues/86). It's a *lot* to document and will take some time, I'll likely get to it before the summer is over.

For now - if you have any questions about specific classes or functions, post up on the forum/discord and we'll answer them.

brubell
 
Posts: 604
Joined: Fri Jul 17, 2015 10:33 pm

Re: Adafruit IO C++ API documentation

by Bart66 on Fri Jul 05, 2019 12:04 pm

Thanks Brubell! Between the MQTT documentation, the examples, the library source code, the forums, and playing with it, there's plenty of information available. I was just looking for a shortcut!
Cheers,
Bart

Bart66
 
Posts: 3
Joined: Tue Jul 02, 2019 7:17 pm

Please be positive and constructive with your questions and comments.