From e20c4d2af2a591c6fda855ea2957e6033b904fcd Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Mon, 22 Apr 2024 10:15:30 +0200 Subject: [PATCH] Lint --- docs/addon_bluetooth_proxy.md | 73 ++++++++++++++++++----------------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/docs/addon_bluetooth_proxy.md b/docs/addon_bluetooth_proxy.md index 28de023..f665bf6 100644 --- a/docs/addon_bluetooth_proxy.md +++ b/docs/addon_bluetooth_proxy.md @@ -16,47 +16,48 @@ Avoid switching to the `arduino` framework as it significantly increases memory ### Configuration Steps 1. **Edit Your ESPHome YAML File**: Add the Bluetooth Proxy add-on to your configuration by including the `remote_package` entry under the `packages` section as illustrated 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 climate control -# heater_relay: "1" # Options: "1" or "2" + # Optional configurations (uncomment if needed) + ## Add-on for climate control + # heater_relay: "1" # Options: "1" or "2" -# Begin Customization Section -##### Customization - Start ##### -## If you wanna set non-standard parameters to your Bluetooth proxy just add like this: -# esp32_ble_tracker: -# scan_parameters: -# interval: 1100ms -# window: 1100ms -# active: true -# -# bluetooth_proxy: -# active: true -##### Customization - End ##### + # Begin Customization Section + ##### Customization - Start ##### + ## If you wanna set non-standard parameters to your Bluetooth proxy just add like this: + # esp32_ble_tracker: + # scan_parameters: + # interval: 1100ms + # window: 1100ms + # active: true + # + # bluetooth_proxy: + # active: true + ##### Customization - End ##### -# 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 - - esphome/nspanel_esphome_addon_bluetooth_proxy.yaml # Bluetooth Proxy add-on package - # - 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 + - esphome/nspanel_esphome_addon_bluetooth_proxy.yaml # Bluetooth Proxy add-on package + # - 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.