Skip to content

Commit

Permalink
Fix several clang-tidiy issues
Browse files Browse the repository at this point in the history
* Add unused annotations
* Fix missing explicit casting issues
* Remove "_" prefix from header guards and make them readable
  • Loading branch information
psachs committed Oct 24, 2024
1 parent fb89c97 commit 73b9bb3
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 38 deletions.
6 changes: 3 additions & 3 deletions src/BleClient.h
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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 */
11 changes: 5 additions & 6 deletions src/BleClientCallback.h
Original file line number Diff line number Diff line change
@@ -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 */
8 changes: 4 additions & 4 deletions src/NimBleClient.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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<char>(bleMACAddress[i]));
}

std::string name = advertisedDevice->haveName()
Expand All @@ -56,4 +56,4 @@ void NimBleClient::onResult(NimBLEAdvertisedDevice* advertisedDevice) {
std::string manufacturerData = advertisedDevice->getManufacturerData();

_callback->onAdvertisementReceived(address, name, manufacturerData);
};
}
14 changes: 8 additions & 6 deletions src/NimBleClient.h
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
#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;

private:
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 */
14 changes: 6 additions & 8 deletions src/Sensirion_upt_ble_auto_detection.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ void SensiScan::begin() {
_bleClient->keepAlive();
}

void SensiScan::getScanResults(
__attribute__((unused)) void SensiScan::getScanResults(
std::map<uint16_t, std::vector<Measurement>>& 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();
}

Expand Down Expand Up @@ -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;
}

Expand All @@ -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<unsigned char>(macAddressString[0]);
for (size_t i = 1; i < 6; i++) {
deviceID = (deviceID << 8) | macAddressString[i];
}
Expand All @@ -71,8 +71,6 @@ uint16_t SensiScan::getDeviceId(const std::string& data) {
return deviceId;
}

extern std::map<DataType, SampleConfig> sampleConfigSelector;

/**
* @brief decode chunk of Advertisement containing encoded samples
*
Expand All @@ -81,7 +79,7 @@ extern std::map<DataType, SampleConfig> sampleConfigSelector;
*/
uint8_t SensiScan::decodeData(const MetaData& metaData, const std::string& data,
std::vector<Measurement>& samples) {
uint8_t sampleType = static_cast<uint8_t>(data[3]);
auto sampleType = static_cast<uint8_t>(data[3]);

DataType dataType = getDataTypeFromSampleType(sampleType);
SampleConfig sampleConfig = sampleConfigSelector[dataType];
Expand Down
22 changes: 11 additions & 11 deletions src/Sensirion_upt_ble_auto_detection.h
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -8,24 +8,24 @@
#include <string>
#include <vector>

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<uint16_t, std::vector<Measurement>>& scanResults);
void keepAlive();
__attribute__((unused)) void keepAlive();

private:
BleClient* _bleClient;
std::map<uint16_t, std::vector<Measurement>> _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<Measurement>& 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<Measurement>& samples);
};

#endif /* _SENSIRION_UPT_BLE_AUTO_DETECTION_H_ */
#endif /* SENSIRION_UPT_BLE_AUTO_DETECTION_H */

0 comments on commit 73b9bb3

Please sign in to comment.