Lint

docs/addon_ble_tracker.md

@@ -18,47 +18,46 @@ It is crucial to use the `esp-idf` framework to avoid such issues.
 
 ## Configuration Steps
 1. **Edit Your ESPHome YAML File**: Incorporate the BLE Tracker component into your NSPanel's configuration by adding the necessary entries under the `esp32_ble_tracker:` section as shown below:
-```yaml
+  ```yaml
-substitutions:
+  substitutions:
-  device_name: "YOUR_NSPANEL_NAME"        # Set your NSPanel's device name
+    device_name: "YOUR_NSPANEL_NAME"        # Set your NSPanel's device name
-  friendly_name: "Your Friendly Name"     # Set a friendly display name
+    friendly_name: "Your Friendly Name"     # Set a friendly display name
-  wifi_ssid: !secret wifi_ssid            # Your Wi-Fi SSID
+    wifi_ssid: !secret wifi_ssid            # Your Wi-Fi SSID
-  wifi_password: !secret wifi_password    # Your Wi-Fi password
+    wifi_password: !secret wifi_password    # Your Wi-Fi password
 
-# Optional configurations (uncomment if needed)
+  # Optional configurations (uncomment if needed)
-## Add-on for specific tracked devices or automation triggers
+  ## Add-on for specific tracked devices or automation triggers
-# sensor:
+  # sensor:
-#   - platform: ble_rssi
+  #   - platform: ble_rssi
-#     mac_address: MAC_ADDRESS_OF_DEVICE
+  #     mac_address: MAC_ADDRESS_OF_DEVICE
-#     name: "BLE Device RSSI"
+  #     name: "BLE Device RSSI"
 
-## If you wanna set non-standard parameters to your BLE tracker, just add like this:
+  ## If you wanna set non-standard parameters to your BLE tracker, just add like this:
-# esp32_ble_tracker:
+  # esp32_ble_tracker:
-#   scan_parameters:
+  #   scan_parameters:
-#     interval: 1100ms
+  #     interval: 1100ms
-#     window: 1100ms
+  #     window: 1100ms
-#     active: true
+  #     active: true
 
-# Package Configuration
+  # Package Configuration
-packages:
+  packages:
-  remote_package:
+    remote_package:
-    url: https://github.com/Blackymas/NSPanel_HA_Blueprint
+      url: https://github.com/Blackymas/NSPanel_HA_Blueprint
-    ref: main
+      ref: main
-    refresh: 300s
+      refresh: 300s
-    files:
+      files:
-      - nspanel_esphome.yaml # Basic NSPanel package
+        - nspanel_esphome.yaml # Basic NSPanel package
-      # Optional packages for advanced features and other add-ons
+        # Optional packages for advanced features and other add-ons
-      - esphome/nspanel_esphome_addon_ble_tracker.yaml # BLE Tracker add-on package
+        - esphome/nspanel_esphome_addon_ble_tracker.yaml # BLE Tracker add-on package
-      # - esphome/nspanel_esphome_addon_bluetooth_proxy.yaml
+        # - esphome/nspanel_esphome_addon_bluetooth_proxy.yaml
-      # - esphome/nspanel_esphome_addon_climate_cool.yaml
+        # - esphome/nspanel_esphome_addon_climate_cool.yaml
-      # - esphome/nspanel_esphome_addon_climate_heat.yaml
+        # - esphome/nspanel_esphome_addon_climate_heat.yaml
-      # - esphome/nspanel_esphome_addon_climate_dual.yaml
+        # - esphome/nspanel_esphome_addon_climate_dual.yaml
-```
+  ```
 2. **Update Substitutions**: Customize `"YOUR_NSPANEL_NAME"` and `"Your Friendly Name"` to appropriate identifiers for your device and its Bluetooth functionality.
 3. **Save and Upload**: After making the necessary changes, save your configuration file and upload it to your NSPanel via the ESPHome dashboard.
-> [!NOTE]
+  > [!NOTE]
-> The first time this component is enabled for an ESP32, the code partition needs to be resized.
+  > The first time this component is enabled for an ESP32, the code partition needs to be resized.
-> Please flash the ESP32 via USB when adding this to your configuration. After that, you can use OTA updates again.
+  > Please flash the ESP32 via USB when adding this to your configuration. After that, you can use OTA updates again.
-
 
 This configuration allows your NSPanel to efficiently manage Bluetooth connections, acting as a proxy for various BLE operations.