Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add IRK support to ble_rssi #6422

Merged
merged 4 commits into from
May 9, 2024
Merged

Add IRK support to ble_rssi #6422

merged 4 commits into from
May 9, 2024

Conversation

chbmuc
Copy link
Contributor

@chbmuc chbmuc commented Mar 23, 2024

What does this implement/fix?

Most modern smartphones use use a privacy feature called Resolvable Private Addresses to avoid BLE tracking. However if you know the devices "Identity Resolving Key" (IRK), you can check if the generated private MAC address belongs to the device with the IRK.

This PR adds an option to the ble_rssi sensor to configure the IRK.

There is no support to obtain the key. You will have to use one of the options described here: https://espresense.com/beacons

Once you have the IRK, configuration is similar to the other methods for the ble_rssi binary sensor.

Implementation is almost the same as in ble_presence (#6335).

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Related issue or feature (if applicable): feature (as requested in esphome/feature-requests#2285)

Pull request in esphome-docs with documentation: esphome/esphome-docs#3707

Test Environment

  • ESP32
  • ESP32 IDF
  • ESP8266
  • RP2040
  • BK72xx
  • RTL87xx

Example entry for config.yaml:

# Example configuration entry
esp32_ble_tracker:

sensor:
  # RSSI based on IRK
  - platform: ble_rssi
    irk: 1234567890abcdef1234567890abcdef
    name: "BLE Tracker with Identity Resolving Key"

Checklist:

  • The code change is tested and works locally.
  • Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

@codecov-commenter
Copy link

codecov-commenter commented Mar 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.18%. Comparing base (4d8b5ed) to head (8c46e93).
Report is 542 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #6422      +/-   ##
==========================================
+ Coverage   53.70%   54.18%   +0.47%     
==========================================
  Files          50       50              
  Lines        9408     9579     +171     
  Branches     1654     1687      +33     
==========================================
+ Hits         5053     5190     +137     
- Misses       4056     4065       +9     
- Partials      299      324      +25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@esphome
Copy link

esphome bot commented Mar 24, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@jesserockz jesserockz merged commit d0120ce into esphome:dev May 9, 2024
100 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants