From edd1d3fdb87113b45fa19d0b2c5cf6e5173e4a7e Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Mon, 22 Apr 2024 10:13:26 +0200 Subject: [PATCH] Lint --- docs/addon_ble_tracker.md | 72 +++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/addon_ble_tracker.md b/docs/addon_ble_tracker.md index a86784e..163fff4 100644 --- a/docs/addon_ble_tracker.md +++ b/docs/addon_ble_tracker.md @@ -18,46 +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 - substitutions: - device_name: "YOUR_NSPANEL_NAME" # Set your NSPanel's device name - friendly_name: "Your Friendly Name" # Set a friendly display name - wifi_ssid: !secret wifi_ssid # Your Wi-Fi SSID - wifi_password: !secret wifi_password # Your Wi-Fi password + ```yaml + substitutions: + device_name: "YOUR_NSPANEL_NAME" # Set your NSPanel's device name + friendly_name: "Your Friendly Name" # Set a friendly display name + wifi_ssid: !secret wifi_ssid # Your Wi-Fi SSID + wifi_password: !secret wifi_password # Your Wi-Fi password - # Optional configurations (uncomment if needed) - ## Add-on for specific tracked devices or automation triggers - # sensor: - # - platform: ble_rssi - # mac_address: MAC_ADDRESS_OF_DEVICE - # name: "BLE Device RSSI" + # Optional configurations (uncomment if needed) + ## Add-on for specific tracked devices or automation triggers + # sensor: + # - platform: ble_rssi + # mac_address: MAC_ADDRESS_OF_DEVICE + # name: "BLE Device RSSI" - ## If you wanna set non-standard parameters to your BLE tracker, just add like this: - # esp32_ble_tracker: - # scan_parameters: - # interval: 1100ms - # window: 1100ms - # active: true + ## If you wanna set non-standard parameters to your BLE tracker, just add like this: + # esp32_ble_tracker: + # scan_parameters: + # interval: 1100ms + # window: 1100ms + # active: true - # Package Configuration - packages: - remote_package: - url: https://github.com/Blackymas/NSPanel_HA_Blueprint - ref: main - refresh: 300s - files: - - nspanel_esphome.yaml # Basic NSPanel package - # 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_bluetooth_proxy.yaml - # - esphome/nspanel_esphome_addon_climate_cool.yaml - # - esphome/nspanel_esphome_addon_climate_heat.yaml - # - esphome/nspanel_esphome_addon_climate_dual.yaml - ``` + # Package Configuration + packages: + remote_package: + url: https://github.com/Blackymas/NSPanel_HA_Blueprint + ref: main + refresh: 300s + files: + - nspanel_esphome.yaml # Basic NSPanel package + # 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_bluetooth_proxy.yaml + # - esphome/nspanel_esphome_addon_climate_cool.yaml + # - esphome/nspanel_esphome_addon_climate_heat.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] - > 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. + > [!NOTE] + > 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. This configuration allows your NSPanel to efficiently manage Bluetooth connections, acting as a proxy for various BLE operations.