adafruit-mirror/Adafruit_Wippersnapper_Arduino
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

complete doxygen pass through

Browse source
This commit is contained in:
brentru 2025-02-11 14:58:34 -05:00
parent 560d707992
commit c362d0b27e
8 changed files with 57 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Doxyfile
View file

@ -380,7 +380,7 @@ MARKDOWN_ID_STYLE = DOXYGEN
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
AUTOLINK_SUPPORT = NO
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this

37
src/Wippersnapper_V2.h
View file

@ -9,10 +9,9 @@
* please support Adafruit and open-source hardware by purchasing
* products from Adafruit!
*
* Copyright (c) Brent Rubell 2020-2024 for Adafruit Industries.
* @copyright Copyright (c) Brent Rubell 2020-2024 for Adafruit Industries.
*
* BSD license, all text here must be included in any redistribution.
*
*/
#ifndef WIPPERSNAPPER_V2_H
@ -20,29 +19,41 @@
// Debug Flags
// #DEBUG_PROFILE 1 ///< Enable debug output for function profiling
#define WS_DEBUG ///< Define to enable debugging to serial terminal
#define WS_PRINTER Serial ///< Where debug messages will be printed
// Debug Flags
#define WS_DEBUG /**< Define to enable debugging to serial terminal */
#define WS_PRINTER Serial /**< Where debug messages will be printed */
/**************************************************************************/
/*!
@brief Debug print macros
@brief Debug print macros for WipperSnapper debugging output
@details These macros provide debug output functionality when WS_DEBUG is
defined
*/
/**************************************************************************/
#ifdef WS_DEBUG
#define WS_DEBUG_PRINT(...) \
{ WS_PRINTER.print(__VA_ARGS__); } ///< Prints debug output.
{ WS_PRINTER.print(__VA_ARGS__); } /**< Print debug message to serial */
#define WS_DEBUG_PRINTLN(...) \
{ WS_PRINTER.println(__VA_ARGS__); } ///< Prints line from debug output.
{ WS_PRINTER.println(__VA_ARGS__); } /**< Print debug message with newline \
*/
#define WS_DEBUG_PRINTHEX(...) \
{ WS_PRINTER.print(__VA_ARGS__, HEX); } ///< Prints debug output.
{ \
WS_PRINTER.print(__VA_ARGS__, HEX); \
} /**< Print debug message in hexadecimal */
#else
#define WS_DEBUG_PRINT(...) \
{} ///< Prints debug output
{} /**< Debug print */
#define WS_DEBUG_PRINTLN(...) \
{} ///< Prints line from debug output.
{} /**< Debug println */
#endif
/**************************************************************************/
/*!
@brief delay() function for use with a watchdog timer
@param timeout
Delay duration in milliseconds
*/
/**************************************************************************/
#define WS_DELAY_WITH_WDT(timeout) \
{ \
unsigned long start = millis(); \
@ -51,10 +62,10 @@
yield(); \
feedWDT(); \
if (millis() < start) { \
start = millis(); /* if rollover */ \
start = millis(); \
} \
} \
} ///< Delay function
}
// Cpp STD
#include <functional>

22
src/Wippersnapper_demo.ino.cpp Normal file
View file

@ -0,0 +1,22 @@
# 1 "/var/folders/ff/dmzflvf52tq9kzvt6g8jglxw0000gn/T/tmpgufeaxcd"
#include <Arduino.h>
# 1 "/Users/brentrubell/Documents/Arduino/libraries/Adafruit_Wippersnapper_Arduino/src/Wippersnapper_demo.ino"
# 11 "/Users/brentrubell/Documents/Arduino/libraries/Adafruit_Wippersnapper_Arduino/src/Wippersnapper_demo.ino"
#include "ws_adapters.h"
ws_adapter_offline wipper;
#define WS_DEBUG
void setup();
void loop();
#line 17 "/Users/brentrubell/Documents/Arduino/libraries/Adafruit_Wippersnapper_Arduino/src/Wippersnapper_demo.ino"
void setup() {
Serial.begin(115200);
while (!Serial) delay(10);
wipper.provision();
wipper.connect();
}
void loop() {
wipper.run();
}

2
src/adapters/wifi/ws_wifi_airlift.h
View file

@ -34,7 +34,7 @@
#define SPIWIFI SPI /*!< Instance of SPI interface used by an AirLift. */
extern Wippersnapper WS;
extern Wippersnapper WS; ///< Global Wippersnapper instance
/****************************************************************************/
/*!
@brief Class for using the AirLift Co-Processor network iface.

4
src/adapters/wifi/ws_wifi_esp32.h
View file

@ -8,7 +8,7 @@
* please support Adafruit and open-source hardware by purchasing
* products from Adafruit!
*
* Copyright (c) Brent Rubell 2020-2024 for Adafruit Industries.
* Copyright (c) Brent Rubell 2020-2025 for Adafruit Industries.
*
* MIT license, all text here must be included in any redistribution.
*
@ -27,7 +27,7 @@
#include "WiFiMulti.h"
#include <NetworkClient.h>
#include <NetworkClientSecure.h>
extern Wippersnapper_V2 WsV2;
extern Wippersnapper_V2 WsV2; ///< Wippersnapper client instance
/****************************************************************************/
/*!

2
src/adapters/wifi/ws_wifi_ninafw.h
View file

@ -27,7 +27,7 @@
#define SPIWIFI \
SPI /*!< Instance of SPI interface used by an external uBlox module. */
extern Wippersnapper WS;
extern Wippersnapper WS; ///< Global Wippersnapper instance
/****************************************************************************/
/*!
@brief Class for using the AirLift Co-Processor network iface.

7
src/components/i2c/drivers/drvDps310.h
View file

@ -152,8 +152,11 @@ public:
}
protected:
sensors_event_t _temp_event, _pressure_event;
ulong _last_read;
sensors_event_t _temp_event = {
0}; ///< DPS310 sensor event for temperature readings
sensors_event_t
_pressure_event; ///< DPS310 sensor event for pressure readings
ulong _last_read; ///< Last time the sensor was read
Adafruit_DPS310 *_dps310; ///< DPS310 driver object
Adafruit_Sensor *_dps_temp =
NULL; ///< Holds data for the DPS310's temperature sensor

2
src/display/ws_display_driver.h
View file

@ -51,6 +51,6 @@ private:
uint8_t
_displayRotationMode; ///< Display rotation (mode, not number in degrees)
};
extern Wippersnapper WS;
extern Wippersnapper WS; ///< Global Wippersnapper instance
#endif // WIPPERSNAPPER_DISPLAY_H