MirrorSave
/
ESPresense
mirror of https://github.com/ESPresense/ESPresense.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Implement a id type hierachy

This commit is contained in:
DTTerastar 2021-10-10 22:49:56 -04:00
parent 96a3af0248
commit 6519e1ab7a
5 changed files with 73 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.0.1]
- Query bugs squashed! Needs a bit more testing, but it's MUCH better than 2.0
- Apple model fingerprint updated to apple:model (with the , turned into a -)
- BH1750 sensor support added [lux sensor](https://amzn.to/3AoKlQ4)
## [2.0.0] ## [2.0.0]
- Add `Query` switch to mqtt and webapp setup (defaults to off so as to not break existing fingerprints) - Add `Query` switch to mqtt and webapp setup (defaults to off so as to not break existing fingerprints)

62
lib/BleFingerprint/BleFingerprint.cpp
View File

@ -55,29 +55,30 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
if (advertisedDevice->isAdvertisingService(tileUUID)) if (advertisedDevice->isAdvertisingService(tileUUID))
{ {
calRssi = _parent->getRefRssi() + TILE_TX; calRssi = _parent->getRefRssi() + TILE_TX;
if (!pidOverriden) pid = "tile:" + getMac(); setId("tile:" + getMac(), ID_TYPE_TILE);
} }
else if (advertisedDevice->isAdvertisingService(exposureUUID)) else if (advertisedDevice->isAdvertisingService(exposureUUID))
{ // found covid exposure tracker { // found covid exposure tracker
std::string strServiceData = advertisedDevice->getServiceData(exposureUUID); std::string strServiceData = advertisedDevice->getServiceData(exposureUUID);
calRssi = _parent->getRefRssi() + EXPOSURE_TX; calRssi = _parent->getRefRssi() + EXPOSURE_TX;
if (!pidOverriden) pid = "exp:" + String(strServiceData.length()); setId("exp:" + String(strServiceData.length()), ID_TYPE_EXPOSURE);
name = hexStr(strServiceData).c_str(); name = hexStr(strServiceData).c_str();
} }
else if (advertisedDevice->isAdvertisingService(sonosUUID)) else if (advertisedDevice->isAdvertisingService(sonosUUID))
{ {
asRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI; asRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI;
if (!pidOverriden) pid = "sonos:" + getMac(); setId("sonos:" + getMac(), ID_TYPE_SONOS);
} }
else if (advertisedDevice->isAdvertisingService(itagUUID)) else if (advertisedDevice->isAdvertisingService(itagUUID))
{ {
asRssi = _parent->getRefRssi() + (advertisedDevice->haveTXPower() ? advertisedDevice->getTXPower() : ITAG_TX); asRssi = _parent->getRefRssi() + (advertisedDevice->haveTXPower() ? advertisedDevice->getTXPower() : ITAG_TX);
if (!pidOverriden) pid = "itag:" + getMac(); setId("itag:" + getMac(), ID_TYPE_ITAG);
} }
else if (advertisedDevice->isAdvertisingService(roomAssistantService)) else if (advertisedDevice->isAdvertisingService(roomAssistantService))
{ {
asRssi = advertisedDevice->haveTXPower() ? advertisedDevice->getTXPower() - 65 : NO_RSSI; asRssi = advertisedDevice->haveTXPower() ? advertisedDevice->getTXPower() - 65 : NO_RSSI;
shouldQuery = true; shouldQuery = true;
rmAsst = true;
} }
else if (advertisedDevice->isAdvertisingService(eddystoneUUID)) else if (advertisedDevice->isAdvertisingService(eddystoneUUID))
{ {
@ -86,7 +87,6 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
{ {
BLEEddystoneURL oBeacon = BLEEddystoneURL(); BLEEddystoneURL oBeacon = BLEEddystoneURL();
oBeacon.setData(strServiceData); oBeacon.setData(strServiceData);
url = String(oBeacon.getDecodedURL().c_str());
calRssi = EDDYSTONE_ADD_1M + oBeacon.getPower(); calRssi = EDDYSTONE_ADD_1M + oBeacon.getPower();
} }
else if (strServiceData[0] == EDDYSTONE_TLM_FRAME_TYPE) else if (strServiceData[0] == EDDYSTONE_TLM_FRAME_TYPE)
@ -111,7 +111,7 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
} }
if (advertisedDevice->haveTXPower()) if (advertisedDevice->haveTXPower())
fingerprint = fingerprint + String(-advertisedDevice->getTXPower()); fingerprint = fingerprint + String(-advertisedDevice->getTXPower());
sid = fingerprint; setId(fingerprint, ID_TYPE_SID);
} }
} }
@ -131,28 +131,30 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
{ {
BLEBeacon oBeacon = BLEBeacon(); BLEBeacon oBeacon = BLEBeacon();
oBeacon.setData(strManufacturerData); oBeacon.setData(strManufacturerData);
if (!pidOverriden) pid = Sprintf("iBeacon:%s-%d-%d", std::string(oBeacon.getProximityUUID()).c_str(), ENDIAN_CHANGE_U16(oBeacon.getMajor()), ENDIAN_CHANGE_U16(oBeacon.getMinor())); setId(Sprintf("iBeacon:%s-%d-%d", std::string(oBeacon.getProximityUUID()).c_str(), ENDIAN_CHANGE_U16(oBeacon.getMajor()), ENDIAN_CHANGE_U16(oBeacon.getMinor())), ID_TYPE_IBEACON);
calRssi = oBeacon.getSignalPower(); calRssi = oBeacon.getSignalPower();
} }
else if (strManufacturerData.length() >= 4 && strManufacturerData[2] == 0x10) else if (strManufacturerData.length() >= 4 && strManufacturerData[2] == 0x10)
{ {
shouldQuery = true; shouldQuery = true;
ignore = false; ignore = false;
if (!pidOverriden)
{ {
String pid;
if (advertisedDevice->haveTXPower()) if (advertisedDevice->haveTXPower())
pid = Sprintf("apple:%02x%02x:%d%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length(), -advertisedDevice->getTXPower()); pid = Sprintf("apple:%02x%02x:%d%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length(), -advertisedDevice->getTXPower());
else else
pid = Sprintf("apple:%02x%02x:%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length()); pid = Sprintf("apple:%02x%02x:%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length());
setId(pid, ID_TYPE_APPLE_NEARBY);
} }
disc = hexStr(strManufacturerData.substr(4)).c_str();
mdRssi = _parent->getRefRssi() + APPLE_TX; mdRssi = _parent->getRefRssi() + APPLE_TX;
} }
else else
{ {
if (advertisedDevice->haveTXPower()) if (advertisedDevice->haveTXPower())
sid = Sprintf("apple:%02x%02x:%d%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length(), -advertisedDevice->getTXPower()); setId(Sprintf("apple:%02x%02x:%d%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length(), -advertisedDevice->getTXPower()), ID_TYPE_MISC_APPLE + ID_TYPE_TX_POW);
else else
sid = Sprintf("apple:%02x%02x:%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length()); setId(Sprintf("apple:%02x%02x:%d", strManufacturerData[2], strManufacturerData[3], strManufacturerData.length()), ID_TYPE_MISC_APPLE);
mdRssi = _parent->getRefRssi() + APPLE_TX; mdRssi = _parent->getRefRssi() + APPLE_TX;
ignore = true; ignore = true;
} }
@ -160,18 +162,18 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
else if (manuf == "05a7") //Sonos else if (manuf == "05a7") //Sonos
{ {
mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI; mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI;
if (!pidOverriden) pid = "sonos:" + getMac(); setId("sonos:" + getMac(), ID_TYPE_SONOS);
} }
else if (manuf == "0157") //Mi-fit else if (manuf == "0157") //Mi-fit
{ {
mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI; mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI;
pid = "mifit:" + getMac(); setId("mifit:" + getMac(), ID_TYPE_MIFIT);
} }
else if (manuf == "0006" && strManufacturerData.length() == 29) //microsoft else if (manuf == "0006" && strManufacturerData.length() == 29) //microsoft
{ {
mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI; mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI;
pid = "md:microsoft:29"; setId("md:microsoft:29", ID_TYPE_MSFT);
name = Sprintf("%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x", disc = Sprintf("%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
strManufacturerData[6], strManufacturerData[7], strManufacturerData[8], strManufacturerData[9], strManufacturerData[10], strManufacturerData[11], strManufacturerData[6], strManufacturerData[7], strManufacturerData[8], strManufacturerData[9], strManufacturerData[10], strManufacturerData[11],
strManufacturerData[12], strManufacturerData[13], strManufacturerData[14], strManufacturerData[15], strManufacturerData[16], strManufacturerData[17], strManufacturerData[12], strManufacturerData[13], strManufacturerData[14], strManufacturerData[15], strManufacturerData[16], strManufacturerData[17],
strManufacturerData[18], strManufacturerData[19], strManufacturerData[20], strManufacturerData[21], strManufacturerData[22], strManufacturerData[23], strManufacturerData[18], strManufacturerData[19], strManufacturerData[20], strManufacturerData[21], strManufacturerData[22], strManufacturerData[23],
@ -181,7 +183,7 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
else if (manuf == "0075") //samsung else if (manuf == "0075") //samsung
{ {
mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI; mdRssi = advertisedDevice->haveTXPower() ? _parent->getRefRssi() + advertisedDevice->getTXPower() : NO_RSSI;
if (!pidOverriden) pid = "samsung:" + getMac(); setId("samsung:" + getMac(), ID_TYPE_MISC);
} }
else else
{ {
@ -189,7 +191,7 @@ void BleFingerprint::fingerprint(BLEAdvertisedDevice *advertisedDevice)
String fingerprint = Sprintf("md:%s:%d", manuf.c_str(), strManufacturerData.length()); String fingerprint = Sprintf("md:%s:%d", manuf.c_str(), strManufacturerData.length());
if (advertisedDevice->haveTXPower()) if (advertisedDevice->haveTXPower())
fingerprint = fingerprint + String(-advertisedDevice->getTXPower()); fingerprint = fingerprint + String(-advertisedDevice->getTXPower());
sid = fingerprint; setId(fingerprint, ID_TYPE_MD);
} }
} }
} }
@ -256,7 +258,7 @@ void BleFingerprint::setInitial(int initalRssi, float initalDistance)
bool BleFingerprint::report(JsonDocument *doc, float maxDistance) bool BleFingerprint::report(JsonDocument *doc, float maxDistance)
{ {
if (pid.isEmpty() && sid.isEmpty() && !macPublic) if (ignore || (idType == 0 && !macPublic))
return false; return false;
if (reported || !hasValue) if (reported || !hasValue)
@ -277,6 +279,7 @@ bool BleFingerprint::report(JsonDocument *doc, float maxDistance)
(*doc)[F("id")] = getId(); (*doc)[F("id")] = getId();
if (!name.isEmpty()) (*doc)[F("name")] = name; if (!name.isEmpty()) (*doc)[F("name")] = name;
if (!disc.isEmpty()) (*doc)[F("disc")] = disc;
(*doc)[F("rssi@1m")] = get1mRssi(); (*doc)[F("rssi@1m")] = get1mRssi();
(*doc)[F("rssi")] = rssi; (*doc)[F("rssi")] = rssi;
@ -304,33 +307,34 @@ bool BleFingerprint::query()
pClient->setConnectTimeout(5); pClient->setConnectTimeout(5);
if (pClient->connect(address)) if (pClient->connect(address))
{ {
auto sName = pClient->getValue(genericAccessService, nameChar); if (name.isEmpty())
if (!sName.empty())
{ {
Serial.printf("%d Name | MAC: %s, ID: %-50s%s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sName.c_str()); auto sName = pClient->getValue(genericAccessService, nameChar);
if (name.length() == 0) name = sName.c_str(); if (!sName.empty())
{
Serial.printf("%d Name | MAC: %s, ID: %-60s %s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sName.c_str());
if (name.length() == 0) name = sName.c_str();
}
} }
auto sRmAst = pClient->getValue(roomAssistantService, rootAssistantCharacteristic); auto sRmAst = pClient->getValue(roomAssistantService, rootAssistantCharacteristic);
if (!sRmAst.empty()) if (!sRmAst.empty())
{ {
Serial.printf("%d RmAst | MAC: %s, ID: %-50s%s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sRmAst.c_str()); Serial.printf("%d RmAst | MAC: %s, ID: %-60s %s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sRmAst.c_str());
if (!pidOverriden) pid = String("roomAssistant:") + kebabify(sRmAst).c_str(); setId(String("roomAssistant:") + kebabify(sRmAst).c_str(), ID_TYPE_RM_ASST);
pidOverriden = true;
} }
else else
{ {
auto sMdl = pClient->getValue(deviceInformationService, modelChar); auto sMdl = pClient->getValue(deviceInformationService, modelChar);
if (!sMdl.empty()) if (!sMdl.empty())
{ {
Serial.printf("%d Model | MAC: %s, ID: %-50s%s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sMdl.c_str()); Serial.printf("%d Model | MAC: %s, ID: %-60s %s\n", xPortGetCoreID(), getMac().c_str(), getId().c_str(), sMdl.c_str());
if (!pidOverriden) pid = pid + String("-") + kebabify(sMdl).c_str(); setId(String("apple:") + kebabify(sMdl).c_str(), ID_TYPE_APPLE_MODEL);
pidOverriden = true; if (name.isEmpty()) name = sMdl.c_str();
} }
else else
{ {
if (name.length() > 0 && !pidOverriden) pid = pid + String("-") + kebabify(name); if (name.length() > 0) setId(String("name:") + kebabify(name), ID_TYPE_NAME);
pidOverriden = true;
} }
} }

36
lib/BleFingerprint/BleFingerprint.h
View File

@ -12,6 +12,23 @@
#define NO_RSSI -32768 #define NO_RSSI -32768
#define ID_TYPE_TX_POW short(1)
#define ID_TYPE_SID short(7)
#define ID_TYPE_MD short(8)
#define ID_TYPE_MISC_APPLE short(9)
#define ID_TYPE_NAME short(10)
#define ID_TYPE_MISC short(11)
#define ID_TYPE_MSFT short(12)
#define ID_TYPE_SONOS short(13)
#define ID_TYPE_MIFIT short(14)
#define ID_TYPE_EXPOSURE short(15)
#define ID_TYPE_ITAG short(16)
#define ID_TYPE_TILE short(17)
#define ID_TYPE_APPLE_NEARBY short(35)
#define ID_TYPE_APPLE_MODEL short(40)
#define ID_TYPE_IBEACON short(99)
#define ID_TYPE_RM_ASST short(100)
class BleFingerprintCollection; class BleFingerprintCollection;
class BleFingerprint class BleFingerprint
@ -26,13 +43,22 @@ public:
String getId() String getId()
{ {
if (!pid.isEmpty()) return pid; if (!id.isEmpty() && idType > 10) return id;
if (macPublic) return getMac(); if (macPublic) return getMac();
if (!sid.isEmpty()) return sid; if (!id.isEmpty()) return id;
return getMac(); return getMac();
} }
void setId(String newId, short int newIdType)
{
if (newIdType < idType) return;
id = newId;
idType = newIdType;
}
String getMac(); String getMac();
int get1mRssi(); int get1mRssi();
String getDiscriminator() { return disc; }
float getDistance() { return output.value.position; } float getDistance() { return output.value.position; }
int getRssi() { return rssi; } int getRssi() { return rssi; }
@ -54,10 +80,10 @@ private:
void fingerprint(BLEAdvertisedDevice *advertisedDevice); void fingerprint(BLEAdvertisedDevice *advertisedDevice);
BleFingerprintCollection *_parent; BleFingerprintCollection *_parent;
bool hasValue = false, close = false, reported = false, macPublic = false, ignore = false, shouldQuery = false, didQuery = false, pidOverriden = false; bool hasValue = false, close = false, reported = false, macPublic = false, ignore = false, shouldQuery = false, didQuery = false, rmAsst = false;
NimBLEAddress address; NimBLEAddress address;
String pid, sid, name, url; String id, name, disc;
int rssi = -100, calRssi = NO_RSSI, mdRssi = NO_RSSI, asRssi = NO_RSSI; short int idType = 0, rssi = -100, calRssi = NO_RSSI, mdRssi = NO_RSSI, asRssi = NO_RSSI;
int newest = -100, recent = -100, oldest = -100; int newest = -100, recent = -100, oldest = -100;
int qryAttempts = 0, seenCount = 1; int qryAttempts = 0, seenCount = 1;

2
lib/BleFingerprint/GUI.cpp
View File

@ -59,7 +59,7 @@ void GUI::connected(bool wifi = false, bool mqtt = false)
void GUI::added(BleFingerprint *f) void GUI::added(BleFingerprint *f)
{ {
if (f->getIgnore()) return; if (f->getIgnore()) return;
Serial.printf("%d New | MAC: %s, ID: %s\n", xPortGetCoreID(), f->getMac().c_str(), f->getId().c_str()); Serial.printf("%d New | MAC: %s, ID: %-60s %s\n", xPortGetCoreID(), f->getMac().c_str(), f->getId().c_str(), f->getDiscriminator().c_str());
} }
void GUI::removed(BleFingerprint *f, long age) void GUI::removed(BleFingerprint *f, long age)

2
src/main.cpp
View File

@ -449,7 +449,7 @@ void setup()
// Init BH1750 (witch default l2c adres) // Init BH1750 (witch default l2c adres)
int rc; // Returncode int rc; // Returncode
long m; // milli for calibration long m; // milli for calibration
bool state; bool state = false;
// if (! BH1750.begin(BH1750_TO_GROUND)) // if (! BH1750.begin(BH1750_TO_GROUND))
if (BH1750_I2c == "0x23") if (BH1750_I2c == "0x23")