Merge pull request #493 from custom-components/rssi_sensor

Add RSSI sensor

Author: Ernst79

custom_components/ble_monitor/const.py

@@ -23,19 +23,21 @@
     DEVICE_CLASS_HUMIDITY,
     DEVICE_CLASS_ILLUMINANCE,
     DEVICE_CLASS_PRESSURE,
+    DEVICE_CLASS_SIGNAL_STRENGTH,
     DEVICE_CLASS_TEMPERATURE,
     DEVICE_CLASS_VOLTAGE,
-    PERCENTAGE,
     CONDUCTIVITY,
     CONCENTRATION_MILLIGRAMS_PER_CUBIC_METER,
     ELECTRIC_POTENTIAL_VOLT,
     ENERGY_KILO_WATT_HOUR,
-    POWER_KILO_WATT,
-    PRESSURE_HPA,
     LIGHT_LUX,
     MASS_KILOGRAMS,
-    VOLUME_LITERS,
+    PERCENTAGE,
+    POWER_KILO_WATT,
+    PRESSURE_HPA,
+    SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
     TEMP_CELSIUS,
+    VOLUME_LITERS,
 )
 
 DOMAIN = "ble_monitor"
@@ -297,13 +299,14 @@ class BLEMonitorBinarySensorEntityDescription(
         state_class=STATE_CLASS_MEASUREMENT,
     ),
     BLEMonitorSensorEntityDescription(
-        key="voltage",
+        key="rssi",
         sensor_class="MeasuringSensor",
-        name="ble voltage",
-        unique_id="v_",
-        native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
-        device_class=DEVICE_CLASS_VOLTAGE,
+        name="ble rssi",
+        unique_id="rssi_",
+        native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
+        device_class=DEVICE_CLASS_SIGNAL_STRENGTH,
         state_class=STATE_CLASS_MEASUREMENT,
+        entity_registry_enabled_default=False,
     ),
     BLEMonitorSensorEntityDescription(
         key="battery",
@@ -314,6 +317,15 @@ class BLEMonitorBinarySensorEntityDescription(
         device_class=DEVICE_CLASS_BATTERY,
         state_class=STATE_CLASS_MEASUREMENT,
     ),
+    BLEMonitorSensorEntityDescription(
+        key="voltage",
+        sensor_class="MeasuringSensor",
+        name="ble voltage",
+        unique_id="v_",
+        native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
+        device_class=DEVICE_CLASS_VOLTAGE,
+        state_class=STATE_CLASS_MEASUREMENT,
+    ),
     BLEMonitorSensorEntityDescription(
         key="consumable",
         sensor_class="InstantUpdateSensor",
@@ -531,67 +543,67 @@ class BLEMonitorBinarySensorEntityDescription(
 # - [instantly updating sensor list]:   sensors that update the state instantly after new data
 # - [binary sensor list]:               binary sensors
 MEASUREMENT_DICT = {
-    'LYWSDCGQ'                : [["temperature", "humidity", "battery"], [], []],
-    'LYWSD02'                 : [["temperature", "humidity", "battery"], [], []],
-    'LYWSD03MMC'              : [["temperature", "humidity", "battery", "voltage"], [], []],
-    'HHCCJCY01'               : [["temperature", "moisture", "conductivity", "illuminance"], [], []],
-    'GCLS002'                 : [["temperature", "moisture", "conductivity", "illuminance"], [], []],
-    'HHCCPOT002'              : [["moisture", "conductivity"], [], []],
-    'WX08ZM'                  : [["consumable", "battery"], [], ["switch"]],
-    'MCCGQ02HL'               : [["battery"], [], ["opening", "light"]],
-    'YM-K1501'                : [[], ["temperature"], ["switch"]],
-    'YM-K1501EU'              : [[], ["temperature"], ["switch"]],
-    'V-SK152'                 : [[], ["temperature"], ["switch"]],
-    'SJWS01LM'                : [["battery"], [], ["moisture"]],
-    'MJYD02YL'                : [["battery"], [], ["light", "motion"]],
-    'MUE4094RT'               : [[], [], ["motion"]],
-    'RTCGQ02LM'               : [["battery"], ["button"], ["light", "motion"]],
-    'MMC-T201-1'              : [["temperature", "battery"], [], []],
-    'M1S-T500'                : [["battery"], [], ["toothbrush"]],
-    'ZNMS16LM'                : [["battery"], [], ["lock", "fingerprint"]],
-    'ZNMS17LM'                : [["battery"], [], ["lock", "fingerprint"]],
-    'CGC1'                    : [["temperature", "humidity", "battery"], [], []],
-    'CGD1'                    : [["temperature", "humidity", "battery"], [], []],
-    'CGDK2'                   : [["temperature", "humidity", "battery"], [], []],
-    'CGG1'                    : [["temperature", "humidity", "battery"], [], []],
-    'CGG1-ENCRYPTED'          : [["temperature", "humidity", "battery"], [], []],
-    'CGH1'                    : [["battery"], [], ["opening"]],
-    'CGP1W'                   : [["temperature", "humidity", "battery", "pressure"], [], []],
-    'CGPR1'                   : [["illuminance", "battery"], [], ["motion"]],
-    'MHO-C401'                : [["temperature", "humidity", "battery"], [], []],
-    'MHO-C303'                : [["temperature", "humidity", "battery"], [], []],
-    'JQJCY01YM'               : [["temperature", "humidity", "battery", "formaldehyde"], [], []],
-    'JTYJGD03MI'              : [[], ["button", "battery"], ["smoke detector"]],
-    'K9B-1BTN'                : [[], ["one btn switch"], []],
-    'K9B-2BTN'                : [[], ["two btn switch left", "two btn switch right"], []],
-    'K9B-3BTN'                : [[], ["three btn switch left", "three btn switch middle", "three btn switch right"], []],
-    'YLAI003'                 : [[], ["button", "battery"], []],
-    'YLYK01YL'                : [[], ["remote"], ["remote single press", "remote long press"]],
-    'YLYK01YL-FANCL'          : [[], ["fan remote"], []],
-    'YLYK01YL-VENFAN'         : [[], ["ventilator fan remote"], []],
-    'YLYB01YL-BHFRC'          : [[], ["bathroom heater remote"], []],
-    'YLKG07YL/YLKG08YL'       : [[], ["dimmer"], []],
-    'ATC'                     : [["temperature", "humidity", "battery", "voltage"], [], []],
-    'Mi Scale V1'             : [[], ["weight", "non-stabilized weight"], ["weight removed"]],
-    'Mi Scale V2'             : [[], ["weight", "non-stabilized weight", "impedance"], ["weight removed"]],
-    'Kegtron KT-100'          : [[], ["volume dispensed port 1"], []],
-    'Kegtron KT-200'          : [[], ["volume dispensed port 1", "volume dispensed port 2"], []],
-    'Smart hygrometer'        : [["temperature", "humidity", "battery", "voltage"], [], []],
-    'Lanyard/mini hygrometer' : [["temperature", "humidity", "battery", "voltage"], [], []],
-    'T201'                    : [["temperature", "humidity", "battery", "voltage"], [], []],
-    'H5072/H5075'             : [["temperature", "humidity", "battery"], [], []],
-    'H5101/H5102/H5177'       : [["temperature", "humidity", "battery"], [], []],
-    'H5051'                   : [["temperature", "humidity", "battery"], [], []],
-    'H5074'                   : [["temperature", "humidity", "battery"], [], []],
-    'H5178'                   : [["temperature", "temperature outdoor", "humidity", "humidity outdoor", "battery"], [], []],
-    'H5179'                   : [["temperature", "humidity", "battery"], [], []],
-    'Ruuvitag'                : [["temperature", "humidity", "pressure", "battery", "voltage"], ["acceleration"], ["motion"]],
-    'iNode Energy Meter'      : [["battery", "voltage"], ["energy", "power"], []],
-    'Blue Puck T'             : [["temperature"], [], []],
-    'Blue Coin T'             : [["temperature"], [], []],
-    'Blue Puck RHT'           : [["temperature", "humidity"], [], []],
-    'HTP.xw'                  : [["temperature", "humidity", "pressure"], [], []],
-    'HT.w'                    : [["temperature", "humidity", "pressure"], [], []]
+    'LYWSDCGQ'                : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'LYWSD02'                 : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'LYWSD03MMC'              : [["temperature", "humidity", "battery", "voltage", "rssi"], [], []],
+    'HHCCJCY01'               : [["temperature", "moisture", "conductivity", "illuminance", "rssi"], [], []],
+    'GCLS002'                 : [["temperature", "moisture", "conductivity", "illuminance", "rssi"], [], []],
+    'HHCCPOT002'              : [["moisture", "conductivity", "rssi"], [], []],
+    'WX08ZM'                  : [["consumable", "battery", "rssi"], [], ["switch"]],
+    'MCCGQ02HL'               : [["battery", "rssi"], [], ["opening", "light"]],
+    'YM-K1501'                : [["rssi"], ["temperature"], ["switch"]],
+    'YM-K1501EU'              : [["rssi"], ["temperature"], ["switch"]],
+    'V-SK152'                 : [["rssi"], ["temperature"], ["switch"]],
+    'SJWS01LM'                : [["battery", "rssi"], [], ["moisture"]],
+    'MJYD02YL'                : [["battery", "rssi"], [], ["light", "motion"]],
+    'MUE4094RT'               : [["rssi"], [], ["motion"]],
+    'RTCGQ02LM'               : [["battery", "rssi"], ["button"], ["light", "motion"]],
+    'MMC-T201-1'              : [["temperature", "battery", "rssi"], [], []],
+    'M1S-T500'                : [["battery", "rssi"], [], ["toothbrush"]],
+    'ZNMS16LM'                : [["battery", "rssi"], [], ["lock", "fingerprint"]],
+    'ZNMS17LM'                : [["battery", "rssi"], [], ["lock", "fingerprint"]],
+    'CGC1'                    : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'CGD1'                    : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'CGDK2'                   : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'CGG1'                    : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'CGG1-ENCRYPTED'          : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'CGH1'                    : [["battery", "rssi"], [], ["opening"]],
+    'CGP1W'                   : [["temperature", "humidity", "battery", "pressure", "rssi"], [], []],
+    'CGPR1'                   : [["illuminance", "battery", "rssi"], [], ["motion"]],
+    'MHO-C401'                : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'MHO-C303'                : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'JQJCY01YM'               : [["temperature", "humidity", "battery", "formaldehyde", "rssi"], [], []],
+    'JTYJGD03MI'              : [["rssi"], ["button", "battery"], ["smoke detector"]],
+    'K9B-1BTN'                : [["rssi"], ["one btn switch"], []],
+    'K9B-2BTN'                : [["rssi"], ["two btn switch left", "two btn switch right"], []],
+    'K9B-3BTN'                : [["rssi"], ["three btn switch left", "three btn switch middle", "three btn switch right"], []],
+    'YLAI003'                 : [["rssi"], ["button", "battery"], []],
+    'YLYK01YL'                : [["rssi"], ["remote"], ["remote single press", "remote long press"]],
+    'YLYK01YL-FANCL'          : [["rssi"], ["fan remote"], []],
+    'YLYK01YL-VENFAN'         : [["rssi"], ["ventilator fan remote"], []],
+    'YLYB01YL-BHFRC'          : [["rssi"], ["bathroom heater remote"], []],
+    'YLKG07YL/YLKG08YL'       : [["rssi"], ["dimmer"], []],
+    'ATC'                     : [["temperature", "humidity", "battery", "voltage", "rssi"], [], []],
+    'Mi Scale V1'             : [["rssi"], ["weight", "non-stabilized weight"], ["weight removed"]],
+    'Mi Scale V2'             : [["rssi"], ["weight", "non-stabilized weight", "impedance"], ["weight removed"]],
+    'Kegtron KT-100'          : [["rssi"], ["volume dispensed port 1"], []],
+    'Kegtron KT-200'          : [["rssi"], ["volume dispensed port 1", "volume dispensed port 2"], []],
+    'Smart hygrometer'        : [["temperature", "humidity", "battery", "voltage", "rssi"], [], []],
+    'Lanyard/mini hygrometer' : [["temperature", "humidity", "battery", "voltage", "rssi"], [], []],
+    'T201'                    : [["temperature", "humidity", "battery", "voltage", "rssi"], [], []],
+    'H5072/H5075'             : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'H5101/H5102/H5177'       : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'H5051'                   : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'H5074'                   : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'H5178'                   : [["temperature", "temperature outdoor", "humidity", "humidity outdoor", "battery", "rssi"], [], []],
+    'H5179'                   : [["temperature", "humidity", "battery", "rssi"], [], []],
+    'Ruuvitag'                : [["temperature", "humidity", "pressure", "battery", "voltage", "rssi"], ["acceleration"], ["motion"]],
+    'iNode Energy Meter'      : [["battery", "voltage", "rssi"], ["energy", "power"], []],
+    'Blue Puck T'             : [["temperature", "rssi"], [], []],
+    'Blue Coin T'             : [["temperature", "rssi"], [], []],
+    'Blue Puck RHT'           : [["temperature", "humidity", "rssi"], [], []],
+    'HTP.xw'                  : [["temperature", "humidity", "pressure", "rssi"], [], []],
+    'HT.w'                    : [["temperature", "humidity", "pressure", "rssi"], [], []]
 }
 
 KETTLES = ('YM-K1501', 'YM-K1501EU', 'V-SK152')

custom_components/ble_monitor/manifest.json

@@ -11,6 +11,6 @@
   ],
   "dependencies": [],
   "codeowners": ["@Ernst79", "@Magalex2x14", "@Thrilleratplay"],
-  "version": "5.1.3",
+  "version": "5.2.0",
   "iot_class": "local_polling"
 }

custom_components/ble_monitor/sensor.py

@@ -108,7 +108,7 @@ async def async_add_sensor(mac, sensortype, firmware):
         sensors_by_mac = {}
         sensors = []
         batt = {}  # batteries
-        rssi = {}
+        rssi = {}  # rssi
         ble_adv_cnt = 0
         ts_last = dt_util.now()
         ts_now = ts_last
@@ -241,9 +241,10 @@ class BaseSensor(RestoreEntity, SensorEntity):
     # |  |**conductivity
     # |  |**illuminance
     # |  |**formaldehyde
-    # |  |**voltage
+    # |  |**rssi
     # |  |--BatterySensor (Class)
     # |  |  |**battery
+    # |  |**voltage
     # |--InstantUpdateSensor (Class)
     # |  |**consumable
     # |  |--AccelerationSensor (Class)
@@ -508,7 +509,8 @@ async def async_update(self):
             self._measurements.clear()
             self._extra_state_attributes["median"] = state_median
             self._extra_state_attributes["mean"] = state_mean
-            self._extra_state_attributes["rssi"] = round(sts.mean(self.rssi_values))
+            if self.entity_description.key != "rssi":
+                self._extra_state_attributes["rssi"] = round(sts.mean(self.rssi_values))
             self.rssi_values.clear()
         except (AttributeError, AssertionError):
             _LOGGER.debug(

docs/_devices/CGC1.md

@@ -8,9 +8,13 @@ broadcasted_properties:
   - temperature
   - humidity
   - battery
+  - rssi
 broadcasted_property_notes:
   - property: battery
-    note: For battery level, we do not have accurate periodicity information yet
+    note: For battery level, we do not have accurate periodicity information yet.
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate:
 active_scan:
 encryption_key: Yes (Xiaomi MiBeacon advertisement)

docs/_devices/CGD1.md

@@ -8,9 +8,13 @@ broadcasted_properties:
   - temperature
   - humidity
   - battery
+  - rssi
 broadcasted_property_notes:
   - property: battery
     note: For battery level, we do not have accurate periodicity information yet.
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate: ~1/10min.
 active_scan:
 encryption_key: Yes (Xiaomi MiBeacon advertisement)

docs/_devices/CGDK2.md

@@ -8,7 +8,11 @@ broadcasted_properties:
   - temperature
   - humidity
   - battery
+  - rssi
 broadcasted_property_notes:
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate: ~1/10min.
 active_scan:
 encryption_key: true

docs/_devices/CGG1-M.md

@@ -9,9 +9,13 @@ broadcasted_properties:
   - humidity
   - battery
   - voltage
+  - rssi
 broadcasted_property_notes:
   - property: voltage
-    note: battery voltage is only available with custom firmware
+    note: Battery voltage is only available with custom firmware.
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate: ~20/min.
 active_scan:
 encryption_key: True

docs/_devices/CGG1.md

@@ -8,7 +8,11 @@ broadcasted_properties:
   - temperature
   - humidity
   - battery
+  - rssi
 broadcasted_property_notes:
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate: ~20/min.
 active_scan: false
 encryption_key: false

docs/_devices/CGH1.md

@@ -8,6 +8,7 @@ broadcasted_properties:
   - opening
   - battery
   - status
+  - rssi
 broadcasted_property_notes:
   - property: battery
     note: For battery level, we do not have accurate periodicity information yet.
@@ -18,6 +19,9 @@ broadcasted_property_notes:
         * closed
         * closing timeout
         * device reset
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate:
 active_scan:
 encryption_key: true

docs/_devices/CGP1W.md

@@ -9,9 +9,13 @@ broadcasted_properties:
   - humidity
   - pressure
   - battery
+  - rssi
 broadcasted_property_notes:
   - property: battery
     note: For battery level, we do not have accurate periodicity information yet.
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate:
 active_scan:
 encryption_key:

docs/_devices/CGPR1.md

@@ -8,13 +8,17 @@ broadcasted_properties:
   - illuminance
   - motion
   - battery
+  - rssi
 broadcasted_property_notes:
   - property: illuminance
     note: is measured in lux.
   - property: motion
     note: Motion state is ‘motion detected’ or ‘clear’.
   - property: battery
     note: For battery level, we do not have accurate periodicity information yet.
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate: See Notes
 active_scan:
 encryption_key: true

docs/_devices/GCLS002.md

@@ -10,7 +10,11 @@ broadcasted_properties:
   - illuminance
   - conductivity
   - battery
+  - rssi
 broadcasted_property_notes:
+  - property: rssi
+    note: >
+      The RSSI sensor is disabled by default. You can enable the RSSI sensor by going to `configuration`, `integrations`, select `devices` on the BLE monitor integration tile and select your device. Click on the `+1 disabled entity` to show the disabled sensor and select the disabled entity. Finally, click on `Enable entity` to enable it. 
 broadcast_rate:
 active_scan:
 encryption_key: