Skip to content

Commit 50b924c

Browse files
tyethtyeth
committed
Cleanup header docstrings, and remove <wire.h> (breaks pio)
1 parent 00deb17 commit 50b924c

4 files changed

Lines changed: 0 additions & 142 deletions

File tree

‎src/components/i2c/drivers/WipperSnapper_I2C_Driver.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
#include "wippersnapper/i2c/v1/i2c.pb.h"
2020
#include <Adafruit_Sensor.h>
2121
#include <Arduino.h>
22-
#include <Wire.h>
2322

2423
#define PERIOD_24HRS_AGO_MILLIS (millis() - (24 * 60 * 60 * 1000))
2524
///< Used for last sensor read time, initially set 24hrs ago (max period)

‎src/components/i2c/drivers/WipperSnapper_I2C_Driver_INA237.h‎

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -30,62 +30,12 @@ class Adafruit_INA237;
3030
/**************************************************************************/
3131
class WipperSnapper_I2C_Driver_INA237 : public WipperSnapper_I2C_Driver {
3232
public:
33-
/*******************************************************************************/
34-
/*!
35-
@brief Constructor for a INA237 sensor.
36-
@param i2c
37-
The I2C interface.
38-
@param sensorAddress
39-
The 7-bit I2C address of the sensor.
40-
*/
41-
/*******************************************************************************/
4233
WipperSnapper_I2C_Driver_INA237(TwoWire *i2c, uint16_t sensorAddress);
43-
44-
/*******************************************************************************/
45-
/*!
46-
@brief Destructor for an INA237 sensor.
47-
*/
48-
/*******************************************************************************/
4934
~WipperSnapper_I2C_Driver_INA237();
5035

51-
/*******************************************************************************/
52-
/*!
53-
@brief Initializes the INA237 sensor and begins I2C.
54-
@returns True if initialized successfully, False otherwise.
55-
*/
56-
/*******************************************************************************/
5736
bool begin();
58-
59-
/*******************************************************************************/
60-
/*!
61-
@brief Reads a voltage sensor and converts the
62-
reading into the expected SI unit.
63-
@param voltageEvent
64-
voltage sensor reading, in volts.
65-
@returns True if the sensor event was obtained successfully, False
66-
otherwise.
67-
*/
68-
/*******************************************************************************/
6937
bool getEventVoltage(sensors_event_t *voltageEvent);
70-
71-
/**
72-
* @brief Get the current sensor event.
73-
*
74-
* @param currentEvent Pointer to the current sensor event.
75-
*
76-
* @returns True if the sensor event was obtained successfully, False
77-
* otherwise.
78-
*/
7938
bool getEventCurrent(sensors_event_t *currentEvent);
80-
81-
/**
82-
* @brief Get the raw (power) sensor event.
83-
*
84-
* @param powerEvent Pointer to the power sensor event.
85-
*
86-
* @returns True if the sensor event was obtained successfully, False
87-
* otherwise.
88-
*/
8939
bool getEventRaw(sensors_event_t *powerEvent);
9040

9141
protected:

‎src/components/i2c/drivers/WipperSnapper_I2C_Driver_INA238.h‎

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -29,62 +29,12 @@ class Adafruit_INA238;
2929
/**************************************************************************/
3030
class WipperSnapper_I2C_Driver_INA238 : public WipperSnapper_I2C_Driver {
3131
public:
32-
/*******************************************************************************/
33-
/*!
34-
@brief Constructor for a INA238 sensor.
35-
@param i2c
36-
The I2C interface.
37-
@param sensorAddress
38-
The 7-bit I2C address of the sensor.
39-
*/
40-
/*******************************************************************************/
4132
WipperSnapper_I2C_Driver_INA238(TwoWire *i2c, uint16_t sensorAddress);
42-
43-
/*******************************************************************************/
44-
/*!
45-
@brief Destructor for an INA238 sensor.
46-
*/
47-
/*******************************************************************************/
4833
~WipperSnapper_I2C_Driver_INA238();
4934

50-
/*******************************************************************************/
51-
/*!
52-
@brief Initializes the INA238 sensor and begins I2C.
53-
@returns True if initialized successfully, False otherwise.
54-
*/
55-
/*******************************************************************************/
5635
bool begin();
57-
58-
/*******************************************************************************/
59-
/*!
60-
@brief Reads a voltage sensor and converts the
61-
reading into the expected SI unit.
62-
@param voltageEvent
63-
voltage sensor reading, in volts.
64-
@returns True if the sensor event was obtained successfully, False
65-
otherwise.
66-
*/
67-
/*******************************************************************************/
6836
bool getEventVoltage(sensors_event_t *voltageEvent);
69-
70-
/**
71-
* @brief Get the current sensor event.
72-
*
73-
* @param currentEvent Pointer to the current sensor event.
74-
*
75-
* @returns True if the sensor event was obtained successfully, False
76-
* otherwise.
77-
*/
7837
bool getEventCurrent(sensors_event_t *currentEvent);
79-
80-
/**
81-
* @brief Get the Raw (power) sensor event.
82-
*
83-
* @param powerEvent Pointer to the power sensor event.
84-
*
85-
* @returns True if the sensor event was obtained successfully, False
86-
* otherwise.
87-
*/
8838
bool getEventRaw(sensors_event_t *powerEvent);
8939

9040
protected:

‎src/components/i2c/drivers/WipperSnapper_I2C_Driver_INA260.h‎

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -27,52 +27,11 @@ class Adafruit_INA260;
2727
/**************************************************************************/
2828
class WipperSnapper_I2C_Driver_INA260 : public WipperSnapper_I2C_Driver {
2929
public:
30-
/*******************************************************************************/
31-
/*!
32-
@brief Constructor for a INA260 sensor.
33-
@param i2c
34-
The I2C interface.
35-
@param sensorAddress
36-
The 7-bit I2C address of the sensor.
37-
*/
38-
/*******************************************************************************/
3930
WipperSnapper_I2C_Driver_INA260(TwoWire *i2c, uint16_t sensorAddress);
40-
41-
/*******************************************************************************/
42-
/*!
43-
@brief Destructor for an INA260 sensor.
44-
*/
45-
/*******************************************************************************/
4631
~WipperSnapper_I2C_Driver_INA260();
4732

48-
/*******************************************************************************/
49-
/*!
50-
@brief Initializes the INA260 sensor and begins I2C.
51-
@returns True if initialized successfully, False otherwise.
52-
*/
53-
/*******************************************************************************/
5433
bool begin();
55-
56-
/*******************************************************************************/
57-
/*!
58-
@brief Reads a voltage sensor and converts the
59-
reading into the expected SI unit.
60-
@param voltageEvent
61-
voltage sensor reading, in volts.
62-
@returns True if the sensor event was obtained successfully, False
63-
otherwise.
64-
*/
65-
/*******************************************************************************/
6634
bool getEventVoltage(sensors_event_t *voltageEvent);
67-
68-
/**
69-
* @brief Get the current sensor event.
70-
*
71-
* @param currentEvent Pointer to the current sensor event.
72-
*
73-
* @returns True if the sensor event was obtained successfully, False
74-
* otherwise.
75-
*/
7635
bool getEventCurrent(sensors_event_t *currentEvent);
7736

7837
protected:

0 commit comments

Comments
 (0)