doxy all, update doxyfile to search for ARDUINO_ARCH_ESP32 conditional compile

This commit is contained in:
brentru 2022-08-11 15:21:31 -04:00
parent 74acacd772
commit 571c8e2d9f
7 changed files with 17 additions and 17 deletions

View file

@ -2187,7 +2187,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = __cdecl=
PREDEFINED = __cdecl=, ARDUINO_ARCH_ESP32
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The

View file

@ -333,7 +333,7 @@ public:
// enable LEDC if esp32
#ifdef ARDUINO_ARCH_ESP32
ws_ledc *_ledc = nullptr;
ws_ledc *_ledc = nullptr; ///< Pointer to LEDC object
#endif
private:

View file

@ -19,14 +19,18 @@
#if defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE) || defined(ADAFRUIT_PYPORTAL) || \
defined(ADAFRUIT_METRO_M4_EXPRESS) || defined(USE_AIRLIFT)
#include "network_interfaces/Wippersnapper_AIRLIFT.h"
/** Nina-FW (adafruit fork) networking class */
typedef Wippersnapper_AIRLIFT Wippersnapper_WiFi;
#elif defined(ARDUINO_ARCH_ESP8266)
#include "network_interfaces/Wippersnapper_ESP8266.h"
/** ESP8266's networking class */
typedef Wippersnapper_ESP8266 Wippersnapper_WiFi;
#elif defined(ARDUINO_ARCH_ESP32)
#include "network_interfaces/Wippersnapper_ESP32.h"
/** ESP32's networking class */
typedef Wippersnapper_ESP32 Wippersnapper_WiFi;
#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_SAMD_MKRWIFI1010)
/** Nina-FW (arduino) networking class */
#include "network_interfaces/Wippersnapper_WIFININA.h"
typedef Wippersnapper_WIFININA Wippersnapper_WiFi;
#else

View file

@ -54,6 +54,7 @@ void ws_ledc_servo::setLEDCDriver(ws_ledc *ledcManager) {
@param pin Desired GPIO pin.
@param minPulseWidth Minimum pulsewidth, in uS.
@param maxPulseWidth Maximum pulsewidth, in uS.
@param servoFreq Desired servo frequency, in Hz.
@returns Channel number if a servo is successfully attached to a pin,
otherwise 255.
*/

View file

@ -131,7 +131,7 @@ uint8_t ws_ledc::_allocateChannel(double freq) {
/*!
@brief Sets the duty cycle of a pin
@param pin Desired GPIO pin to write to.
@param freq Desired duty cycle.
@param duty Desired duty cycle.
*/
/**************************************************************************/
void ws_ledc::setDuty(uint8_t pin, uint32_t duty) {

View file

@ -20,12 +20,9 @@
// Use LEDC for ESP32 arch so we can PWM
#ifdef ARDUINO_ARCH_ESP32
// use first channel of 16 channels (started from zero)
#define LEDC_CHANNEL_0 0
// use 12 bit precission for LEDC timer
#define LEDC_TIMER_12_BIT 12
// use 5000 Hz as a LEDC base frequency
#define LEDC_BASE_FREQ 5000
#define LEDC_CHANNEL_0 0 ///< use first channel of 16 channels (started from zero)
#define LEDC_TIMER_12_BIT 12 ///< use 12 bit precision for LEDC timer
#define LEDC_BASE_FREQ 5000 ///< use 5000Hz as a LEDC base frequency
#endif
#define STATUS_LED_KAT_BLINK_TIME \

View file

@ -139,12 +139,11 @@ public:
const char *connectionType() { return "ESP32"; }
protected:
const char *_ssid;
const char *_pass;
const char *_mqttBrokerURL;
WiFiClientSecure *_mqtt_client;
const char *_ssid; ///< WiFi SSID
const char *_pass; ///< WiFi password
const char *_mqttBrokerURL; ///< MQTT broker URL
WiFiClientSecure *_mqtt_client; ///< Pointer to a secure MQTT client object
// io.adafruit.us
const char *_aio_root_ca_staging =
"-----BEGIN CERTIFICATE-----\n"
"MIIEZTCCA02gAwIBAgIQQAF1BIMUpMghjISpDBbN3zANBgkqhkiG9w0BAQsFADA/\n"
@ -171,9 +170,8 @@ protected:
"qjBstzLhWVQLGAkXXmNs+5ZnPBxzDJOLxhF2JIbeQAcH5H0tZrUlo5ZYyOqA7s9p\n"
"O5b85o3AM/OJ+CktFBQtfvBhcJVd9wvlwPsk+uyOy2HI7mNxKKgsBTt375teA2Tw\n"
"UdHkhVNcsAKX1H7GNNLOEADksd86wuoXvg==\n"
"-----END CERTIFICATE-----\n";
"-----END CERTIFICATE-----\n"; ///< Root certificate for io.adafruit.us
// io.adafruit.com
const char *_aio_root_ca_prod =
"-----BEGIN CERTIFICATE-----\n"
"MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh\n"
@ -196,7 +194,7 @@ protected:
"PnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0ls\n"
"YSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQk\n"
"CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4=\n"
"-----END CERTIFICATE-----\n";
"-----END CERTIFICATE-----\n"; ///< Root certificate for io.adafruit.com
/**************************************************************************/
/*!