h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Lint

Browse Source
This commit is contained in:
Edward Firmo
2024-04-22 10:15:30 +02:00
parent 6278cd739e
commit e20c4d2af2
1 changed files with 37 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
docs/addon_bluetooth_proxy.md
View File

@@ -16,47 +16,48 @@ Avoid switching to the `arduino` framework as it significantly increases memory
### Configuration Steps ### 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: 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 ```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 climate control ## Add-on for climate control
# heater_relay: "1" # Options: "1" or "2" # heater_relay: "1" # Options: "1" or "2"
# Begin Customization Section # Begin Customization Section
##### Customization - Start ##### ##### Customization - Start #####
## If you wanna set non-standard parameters to your Bluetooth proxy just add like this: ## If you wanna set non-standard parameters to your Bluetooth proxy 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
# #
# bluetooth_proxy: # bluetooth_proxy:
# active: true # active: true
##### Customization - End ##### ##### Customization - End #####
# 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 # - esphome/nspanel_esphome_addon_ble_tracker.yaml
- esphome/nspanel_esphome_addon_bluetooth_proxy.yaml # Bluetooth Proxy add-on package - esphome/nspanel_esphome_addon_bluetooth_proxy.yaml # Bluetooth Proxy add-on package
# - 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. 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. 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.