From 73b9bb3ba48a9d2a5c92f1620d185225a603fb8d Mon Sep 17 00:00:00 2001 From: Pascal Sachs Date: Thu, 24 Oct 2024 15:10:09 +0200 Subject: [PATCH] Fix several clang-tidiy issues * Add unused annotations * Fix missing explicit casting issues * Remove "_" prefix from header guards and make them readable --- src/BleClient.h | 6 +++--- src/BleClientCallback.h | 11 +++++------ src/NimBleClient.cpp | 8 ++++---- src/NimBleClient.h | 14 ++++++++------ src/Sensirion_upt_ble_auto_detection.cpp | 14 ++++++-------- src/Sensirion_upt_ble_auto_detection.h | 22 +++++++++++----------- 6 files changed, 37 insertions(+), 38 deletions(-) diff --git a/src/BleClient.h b/src/BleClient.h index c7a8439..68f955a 100644 --- a/src/BleClient.h +++ b/src/BleClient.h @@ -1,5 +1,5 @@ -#ifndef _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENT_H -#define _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENT_H +#ifndef SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_H +#define SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_H #include "Arduino.h" #include "BleClientCallback.h" @@ -13,4 +13,4 @@ class BleClient { virtual void keepAlive() = 0; }; -#endif /* _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENT_H */ +#endif /* SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_H */ diff --git a/src/BleClientCallback.h b/src/BleClientCallback.h index 3106190..e4216dd 100644 --- a/src/BleClientCallback.h +++ b/src/BleClientCallback.h @@ -1,13 +1,12 @@ -#ifndef _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENTCALLBACK_H -#define _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENTCALLBACK_H +#ifndef SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_CALLBACK_H +#define SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_CALLBACK_H class BleClientCallback { public: - virtual ~BleClientCallback() { - } + virtual ~BleClientCallback() = default; virtual void onAdvertisementReceived(std::string address, std::string name, - std::string data); + std::string data) = 0; }; -#endif /* _SENSIRION_UPT_BLE_AUTO_DETECTION_BLECLIENTCALLBACK_H */ +#endif /* SENSIRION_UPT_BLE_AUTO_DETECTION_BLE_CLIENT_CALLBACK_H */ diff --git a/src/NimBleClient.cpp b/src/NimBleClient.cpp index b5b01ef..6e2ffdc 100644 --- a/src/NimBleClient.cpp +++ b/src/NimBleClient.cpp @@ -3,11 +3,11 @@ void NimBleClient::begin(BleClientCallback* callback) { _callback = callback; setupAndStartBleScans(); -}; +} void NimBleClient::keepAlive() { // If an error occurs that stops the scan, it will be restarted here. - if (_bleScan->isScanning() == false) { + if (!_bleScan->isScanning()) { // Start scan with: duration = 0 seconds(forever), no scan end callback, // not a continuation of a previous scan. _bleScan->start(0, nullptr, false); @@ -47,7 +47,7 @@ void NimBleClient::onResult(NimBLEAdvertisedDevice* advertisedDevice) { const uint8_t* bleMACAddress = advertisedDevice->getAddress().getNative(); std::string address; for (int i = 5; i >= 0; i--) { - address.push_back(bleMACAddress[i]); + address.push_back(static_cast(bleMACAddress[i])); } std::string name = advertisedDevice->haveName() @@ -56,4 +56,4 @@ void NimBleClient::onResult(NimBLEAdvertisedDevice* advertisedDevice) { std::string manufacturerData = advertisedDevice->getManufacturerData(); _callback->onAdvertisementReceived(address, name, manufacturerData); -}; +} diff --git a/src/NimBleClient.h b/src/NimBleClient.h index 23918b3..e03bb59 100644 --- a/src/NimBleClient.h +++ b/src/NimBleClient.h @@ -1,12 +1,14 @@ -#ifndef _SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLECLIENT_H -#define _SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLECLIENT_H +#ifndef SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLE_CLIENT_H +#define SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLE_CLIENT_H #include "BleClient.h" #include "NimBLEDevice.h" -class NimBleClient: public BleClient, public NimBLEAdvertisedDeviceCallbacks { +class __attribute__((unused)) NimBleClient + : public BleClient, + public NimBLEAdvertisedDeviceCallbacks { public: - NimBleClient() : _bleScan(nullptr), _callback(nullptr){}; + NimBleClient() : _bleScan(nullptr), _callback(nullptr) {}; void begin(BleClientCallback* callback) override; void keepAlive() override; @@ -14,7 +16,7 @@ class NimBleClient: public BleClient, public NimBLEAdvertisedDeviceCallbacks { NimBLEScan* _bleScan; BleClientCallback* _callback; void setupAndStartBleScans(); - void onResult(NimBLEAdvertisedDevice* advertisedDevice); + void onResult(NimBLEAdvertisedDevice* advertisedDevice) override; }; -#endif /* _SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLECLIENT_H */ +#endif /* SENSIRION_UPT_BLE_AUTO_DETECTION_NIMBLE_CLIENT_H */ diff --git a/src/Sensirion_upt_ble_auto_detection.cpp b/src/Sensirion_upt_ble_auto_detection.cpp index 9a57a89..e868557 100644 --- a/src/Sensirion_upt_ble_auto_detection.cpp +++ b/src/Sensirion_upt_ble_auto_detection.cpp @@ -9,15 +9,15 @@ void SensiScan::begin() { _bleClient->keepAlive(); } -void SensiScan::getScanResults( +__attribute__((unused)) void SensiScan::getScanResults( std::map>& scanResults) { for (const auto& cachedSample : _sampleCache) { - scanResults[cachedSample.first] = _sampleCache[cachedSample.first]; + scanResults[cachedSample.first] = cachedSample.second; } _sampleCache.clear(); } -void SensiScan::keepAlive() { +__attribute__((unused)) void SensiScan::keepAlive() { _bleClient->keepAlive(); } @@ -45,7 +45,7 @@ void SensiScan::onAdvertisementReceived(const std::string address, return; } - // Last two digits of MAC addr. suffice to uniquely ID a BLE device + // Last two digits of MAC addr. Suffice to uniquely ID a BLE device _sampleCache[getDeviceId(data)] = samples; } @@ -55,7 +55,7 @@ void SensiScan::onAdvertisementReceived(const std::string address, */ uint64_t SensiScan::squashMACAddress(const std::string& macAddressString) { - uint64_t deviceID = macAddressString[0]; + uint64_t deviceID = static_cast(macAddressString[0]); for (size_t i = 1; i < 6; i++) { deviceID = (deviceID << 8) | macAddressString[i]; } @@ -71,8 +71,6 @@ uint16_t SensiScan::getDeviceId(const std::string& data) { return deviceId; } -extern std::map sampleConfigSelector; - /** * @brief decode chunk of Advertisement containing encoded samples * @@ -81,7 +79,7 @@ extern std::map sampleConfigSelector; */ uint8_t SensiScan::decodeData(const MetaData& metaData, const std::string& data, std::vector& samples) { - uint8_t sampleType = static_cast(data[3]); + auto sampleType = static_cast(data[3]); DataType dataType = getDataTypeFromSampleType(sampleType); SampleConfig sampleConfig = sampleConfigSelector[dataType]; diff --git a/src/Sensirion_upt_ble_auto_detection.h b/src/Sensirion_upt_ble_auto_detection.h index e94dc2a..054f125 100644 --- a/src/Sensirion_upt_ble_auto_detection.h +++ b/src/Sensirion_upt_ble_auto_detection.h @@ -1,5 +1,5 @@ -#ifndef _SENSIRION_UPT_BLE_AUTO_DETECTION_H_ -#define _SENSIRION_UPT_BLE_AUTO_DETECTION_H_ +#ifndef SENSIRION_UPT_BLE_AUTO_DETECTION_H +#define SENSIRION_UPT_BLE_AUTO_DETECTION_H #include "Arduino.h" #include "BleClient.h" @@ -8,24 +8,24 @@ #include #include -class SensiScan: public BleClientCallback { +class __attribute__((unused)) SensiScan: public BleClientCallback { public: - explicit SensiScan() : _bleClient(nullptr){}; + explicit SensiScan() : _bleClient(nullptr) {}; void begin(); - void + __attribute__((unused)) void getScanResults(std::map>& scanResults); - void keepAlive(); + __attribute__((unused)) void keepAlive(); private: BleClient* _bleClient; std::map> _sampleCache; void onAdvertisementReceived(std::string address, std::string name, std::string data) override; - uint64_t squashMACAddress(const std::string& macAddressString); - uint16_t getDeviceId(const std::string& data); - uint8_t decodeData(const MetaData& metaData, const std::string& data, - std::vector& samples); + static uint64_t squashMACAddress(const std::string& macAddressString); + static uint16_t getDeviceId(const std::string& data); + static uint8_t decodeData(const MetaData& metaData, const std::string& data, + std::vector& samples); }; -#endif /* _SENSIRION_UPT_BLE_AUTO_DETECTION_H_ */ +#endif /* SENSIRION_UPT_BLE_AUTO_DETECTION_H */