Merge pull request #59 from ladyada-piclaw/fix-clang-format-ci

Fix clang-format CI

Author: ladyada

.clang-format

@@ -0,0 +1,14 @@
+Language: Cpp
+BasedOnStyle: Google
+IndentWidth: 2
+ColumnLimit: 80
+AllowShortBlocksOnASingleLine: Always
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+BinPackArguments: true
+BinPackParameters: true
+BreakBeforeBraces: Attach
+DerivePointerAlignment: false
+PointerAlignment: Left
+SpacesBeforeTrailingComments: 1

.github/workflows/githubci.yml

@@ -3,7 +3,19 @@ name: Arduino Library CI
 on: [pull_request, push, repository_dispatch]
 
 jobs:
+  clang-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+        with:
+          repository: adafruit/ci-arduino
+          path: ci
+      - name: Check code formatting with clang-format
+        run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r .
+
   build:
+    needs: clang-format
     runs-on: ubuntu-latest
 
     steps:
@@ -22,11 +34,8 @@ jobs:
     - name: test platforms
       run: python3 ci/build_platform.py main_platforms
 
-    - name: clang
-      run: python3 ci/run-clang-format.py -e "ci" -e "bin/*" -r Adafruit_* 
-
     - name: doxygen
       env:
         GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
         PRETTYNAME : "Adafruit BME680 Library"
-      run: bash ci/doxy_gen_and_deploy.sh
+      run: bash ci/doxy_gen_and_deploy.sh

Adafruit_BME680.cpp

@@ -28,20 +28,21 @@
  */
 
 #include "Adafruit_BME680.h"
+
 #include "Arduino.h"
 
-//#define BME680_DEBUG
+// #define BME680_DEBUG
 
 /** Our hardware interface functions **/
-static int8_t i2c_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len,
-                       void *interface);
-static int8_t i2c_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
-                        void *interface);
-static int8_t spi_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len,
-                       void *interface);
-static int8_t spi_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
-                        void *interface);
-static void delay_usec(uint32_t us, void *intf_ptr);
+static int8_t i2c_read(uint8_t reg_addr, uint8_t* reg_data, uint32_t len,
+                       void* interface);
+static int8_t i2c_write(uint8_t reg_addr, const uint8_t* reg_data, uint32_t len,
+                        void* interface);
+static int8_t spi_read(uint8_t reg_addr, uint8_t* reg_data, uint32_t len,
+                       void* interface);
+static int8_t spi_write(uint8_t reg_addr, const uint8_t* reg_data, uint32_t len,
+                        void* interface);
+static void delay_usec(uint32_t us, void* intf_ptr);
 
 // PUBLIC FUNCTIONS
 
@@ -50,7 +51,7 @@ static void delay_usec(uint32_t us, void *intf_ptr);
  *  @param  *theWire
  *          optional Wire object
  */
-Adafruit_BME680::Adafruit_BME680(TwoWire *theWire)
+Adafruit_BME680::Adafruit_BME680(TwoWire* theWire)
     : _meas_start(0), _meas_period(0) {
   _wire = theWire;
 }
@@ -62,7 +63,7 @@ Adafruit_BME680::Adafruit_BME680(TwoWire *theWire)
  *  @param  theSPI
  *          optional SPI object
  */
-Adafruit_BME680::Adafruit_BME680(int8_t cspin, SPIClass *theSPI)
+Adafruit_BME680::Adafruit_BME680(int8_t cspin, SPIClass* theSPI)
     : _meas_start(0), _meas_period(0) {
   _spidev = new Adafruit_SPIDevice(cspin, 1000000, SPI_BITORDER_MSBFIRST,
                                    SPI_MODE0, theSPI);
@@ -111,7 +112,7 @@ bool Adafruit_BME680::begin(uint8_t addr, bool initSettings) {
 
     gas_sensor.chip_id = addr;
     gas_sensor.intf = BME68X_I2C_INTF;
-    gas_sensor.intf_ptr = (void *)_i2cdev;
+    gas_sensor.intf_ptr = (void*)_i2cdev;
     gas_sensor.read = &i2c_read;
     gas_sensor.write = &i2c_write;
 
@@ -122,7 +123,7 @@ bool Adafruit_BME680::begin(uint8_t addr, bool initSettings) {
 
     gas_sensor.chip_id = 0;
     gas_sensor.intf = BME68X_SPI_INTF;
-    gas_sensor.intf_ptr = (void *)_spidev;
+    gas_sensor.intf_ptr = (void*)_spidev;
     gas_sensor.read = &spi_read;
     gas_sensor.write = &spi_write;
   }
@@ -288,7 +289,9 @@ float Adafruit_BME680::readAltitude(float seaLevel) {
  * Adafruit_BME680#gas_resistance member variables
  *  @return True on success, False on failure
  */
-bool Adafruit_BME680::performReading(void) { return endReading(); }
+bool Adafruit_BME680::performReading(void) {
+  return endReading();
+}
 
 /*! @brief Begin an asynchronous reading.
  *  @return When the reading would be ready as absolute time in millis().
@@ -415,7 +418,6 @@ int Adafruit_BME680::remainingReadingMillis(void) {
  *  @return True on success, False on failure
  */
 bool Adafruit_BME680::setGasHeater(uint16_t heaterTemp, uint16_t heaterTime) {
-
   if ((heaterTemp == 0) || (heaterTime == 0)) {
     gas_heatr_conf.enable = BME68X_DISABLE;
   } else {
@@ -548,9 +550,8 @@ bool Adafruit_BME680::setIIRFilterSize(uint8_t filtersize) {
 /*!
  *  @brief  Reads 8 bit values over I2C
  */
-int8_t i2c_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf) {
-
-  Adafruit_I2CDevice *_dev = (Adafruit_I2CDevice *)intf;
+int8_t i2c_read(uint8_t reg_addr, uint8_t* reg_data, uint32_t len, void* intf) {
+  Adafruit_I2CDevice* _dev = (Adafruit_I2CDevice*)intf;
 
   if (!_dev->write_then_read(&reg_addr, 1, reg_data, len, true)) {
     return -1;
@@ -562,11 +563,11 @@ int8_t i2c_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf) {
 /*!
  *  @brief  Writes 8 bit values over I2C
  */
-int8_t i2c_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
-                 void *intf) {
-  Adafruit_I2CDevice *_dev = (Adafruit_I2CDevice *)intf;
+int8_t i2c_write(uint8_t reg_addr, const uint8_t* reg_data, uint32_t len,
+                 void* intf) {
+  Adafruit_I2CDevice* _dev = (Adafruit_I2CDevice*)intf;
 
-  if (!_dev->write((uint8_t *)reg_data, len, true, &reg_addr, 1)) {
+  if (!_dev->write((uint8_t*)reg_data, len, true, &reg_addr, 1)) {
     return -1;
   }
   return 0;
@@ -575,9 +576,9 @@ int8_t i2c_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
 /*!
  *  @brief  Reads 8 bit values over SPI
  */
-static int8_t spi_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len,
-                       void *intf_ptr) {
-  Adafruit_SPIDevice *_dev = (Adafruit_SPIDevice *)intf_ptr;
+static int8_t spi_read(uint8_t reg_addr, uint8_t* reg_data, uint32_t len,
+                       void* intf_ptr) {
+  Adafruit_SPIDevice* _dev = (Adafruit_SPIDevice*)intf_ptr;
 
   reg_addr |= 0x80;
 
@@ -591,18 +592,18 @@ static int8_t spi_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len,
 /*!
  *  @brief  Writes 8 bit values over SPI
  */
-static int8_t spi_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
-                        void *intf_ptr) {
-  Adafruit_SPIDevice *_dev = (Adafruit_SPIDevice *)intf_ptr;
+static int8_t spi_write(uint8_t reg_addr, const uint8_t* reg_data, uint32_t len,
+                        void* intf_ptr) {
+  Adafruit_SPIDevice* _dev = (Adafruit_SPIDevice*)intf_ptr;
 
-  if (!_dev->write((uint8_t *)reg_data, len, &reg_addr, 1)) {
+  if (!_dev->write((uint8_t*)reg_data, len, &reg_addr, 1)) {
     return -1;
   }
 
   return 0;
 }
 
-static void delay_usec(uint32_t us, void *intf_ptr) {
+static void delay_usec(uint32_t us, void* intf_ptr) {
   (void)intf_ptr; // Unused parameter
   delayMicroseconds(us);
   yield();

Adafruit_BME680.h

@@ -24,14 +24,14 @@
 #ifndef __BME680_H__
 #define __BME680_H__
 
-#include "Arduino.h"
-
-#include "bme68x.h"
 #include <Adafruit_I2CDevice.h>
 #include <Adafruit_SPIDevice.h>
 #include <Adafruit_Sensor.h>
 #include <Wire.h>
 
+#include "Arduino.h"
+#include "bme68x.h"
+
 #define BME68X_DEFAULT_ADDRESS (0x77)    ///< The default I2C address
 #define BME68X_DEFAULT_SPIFREQ (1000000) ///< The default SPI Clock speed
 
@@ -42,37 +42,37 @@
 #define BME680_OS_1X BME68X_OS_1X     ///< Alias for BME680 existing examples
 #define BME680_OS_NONE BME68X_OS_NONE ///< Alias for BME680 existing examples
 
-#define BME680_FILTER_SIZE_127                                                 \
+#define BME680_FILTER_SIZE_127 \
   BME68X_FILTER_SIZE_127 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_63                                                  \
+#define BME680_FILTER_SIZE_63 \
   BME68X_FILTER_SIZE_63 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_31                                                  \
+#define BME680_FILTER_SIZE_31 \
   BME68X_FILTER_SIZE_31 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_15                                                  \
+#define BME680_FILTER_SIZE_15 \
   BME68X_FILTER_SIZE_15 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_7                                                   \
+#define BME680_FILTER_SIZE_7 \
   BME68X_FILTER_SIZE_7 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_3                                                   \
+#define BME680_FILTER_SIZE_3 \
   BME68X_FILTER_SIZE_3 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_1                                                   \
+#define BME680_FILTER_SIZE_1 \
   BME68X_FILTER_SIZE_1 ///< Alias for BME680 existing examples
-#define BME680_FILTER_SIZE_0                                                   \
+#define BME680_FILTER_SIZE_0 \
   BME68X_FILTER_OFF ///< Alias for BME680 existing examples
 
 /*! Adafruit_BME680 Class for both I2C and SPI usage.
  *  Wraps the Bosch library for Arduino usage
  */
 class Adafruit_BME680 {
-public:
+ public:
   /** Value returned by remainingReadingMillis indicating no asynchronous
    * reading has been initiated by beginReading. **/
   static constexpr int reading_not_started = -1;
   /** Value returned by remainingReadingMillis indicating asynchronous reading
    * is complete and calling endReading will not block. **/
   static constexpr int reading_complete = 0;
 
-  Adafruit_BME680(TwoWire *theWire = &Wire);
-  Adafruit_BME680(int8_t cspin, SPIClass *theSPI = &SPI);
+  Adafruit_BME680(TwoWire* theWire = &Wire);
+  Adafruit_BME680(int8_t cspin, SPIClass* theSPI = &SPI);
   Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin);
 
   bool begin(uint8_t addr = BME68X_DEFAULT_ADDRESS, bool initSettings = true);
@@ -111,10 +111,10 @@ class Adafruit_BME680 {
    * endReading() **/
   uint32_t gas_resistance;
 
-private:
-  Adafruit_I2CDevice *_i2cdev = NULL;
-  Adafruit_SPIDevice *_spidev = NULL;
-  TwoWire *_wire = NULL;
+ private:
+  Adafruit_I2CDevice* _i2cdev = NULL;
+  Adafruit_SPIDevice* _spidev = NULL;
+  TwoWire* _wire = NULL;
 
   int32_t _sensorID;
   uint32_t _meas_start = 0;