Update all docs with friendly_name

Solves #1719

ReleaseNotes.md

@@ -431,8 +431,13 @@ or our [online documentation](https://github.com/Blackymas/NSPanel_HA_Blueprint/
 ## Patch v4.2.5: Interface Refinements and Essential Documentation Updates
 In this release, we've focused on enhancing the user interface and providing crucial information for a better user experience.
 Key updates include refined control mechanisms for climate and cover entities, improved functionality for hardware buttons,
-and the introduction of support for ESPHome's `friendly_name`.
+and the introduction of support for ESPHome's `friendly_name`. 
-Moreover, we have updated our documentation to include comprehensive guidelines on memory requirements for ESPHome,
+
+**Breaking Changes:** This update brings a change in handling custom entities.
+If your setup includes custom entities using `${device_name}` in their names, please modify these entities to omit `${device_name}`.
+ESPHome will now automatically append the `friendly_name` or `device_name` from your substitutions, simplifying the naming process.
+
+Additionally, we have updated our documentation to include comprehensive guidelines on memory requirements for ESPHome,
 ensuring users are well-informed for successful system setup and operation.
 
 **Overview of Changes:**

docs/addon_climate.md

@@ -23,7 +23,8 @@ and after the `remote_package` (base code), as shown bellow (for `heat` in this
 ```yaml
 substitutions:
   # Settings - Editable values
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
 
@@ -90,7 +91,8 @@ and [ESPHome Climate Thermostat - Additional actions behavior](https://esphome.i
 ```yaml
 substitutions:
   # Settings - Editable values
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
 
@@ -132,7 +134,8 @@ esp32:
 ```yaml
 substitutions:
   # Settings - Editable values
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
 
@@ -174,7 +177,8 @@ esp32:
 ```yaml
 substitutions:
   # Settings - Editable values
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
 

docs/customization.md

@@ -58,7 +58,8 @@ You should add your customizations at the end of your ESPHome yaml, as in the ex
 ```yaml
 substitutions:
   # Settings - Editable values
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
 
@@ -228,7 +229,7 @@ Creates a binary sensor to indicate either when the display is showing some page
 ```yaml
 # Is display awake?
 binary_sensor:
-  - name: ${device_name} Display state
+  - name: Display state
     id: display_state
     platform: template
     lambda: |-
@@ -240,7 +241,7 @@ You can easily invert the meaning to have a sensor for display sleeping:
 ```yaml
 # Is display sleeping?
 binary_sensor:
-  - name: ${device_name} Display sleeping
+  - name: Display sleeping
     id: display_sleeping
     platform: template
     lambda: |-
@@ -309,7 +310,7 @@ There are several ways to wake-up or put your panel to sleep, but in this exampl
 ```yaml
 button:
   # Adds a button to put the panel to sleep
-  - name: ${device_name} Sleep
+  - name: Sleep
     id: force_sleep
     platform: template
     icon: mdi:sleep
@@ -320,7 +321,7 @@ button:
             if (id(current_page).state != "screensaver") id(disp1).goto_page("screensaver");
   
   # Adds a button to wake-up the panel (similar to the existing service)
-  - name: ${device_name} Wake-up
+  - name: Wake-up
     id: force_wake_up
     platform: template
     icon: mdi:alarm
@@ -341,7 +342,7 @@ and even use this in your automation to control when your panel is on with the s
 ```yaml
 light:
   # Add the display as a light in Home Assistant
-  - name: ${device_name} Display
+  - name: Display
     id: display_light
     icon: mdi:tablet-dashboard
     platform: monochromatic

docs/install.md

@@ -96,7 +96,8 @@ Follow these steps to add a new device in the ESPHome Dashboard:
     ```yaml
     substitutions:
       # Settings - Editable values
-      device_name: "YOUR_NSPANEL_NAME" 
+      device_name: "YOUR_NSPANEL_NAME"
+      friendly_name: "Your panel's friendly name"
       wifi_ssid: !secret wifi_ssid
       wifi_password: !secret wifi_password
       nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft"  # Optional for `esp-idf` framework
@@ -443,7 +444,8 @@ To use a local copy of `nspanel_esphome.yaml`, copy the file from GitHub to your
 ```yaml
 substitutions:
   # Editable settings
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password
   nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft"

docs/nspanel_blank.md

@@ -30,7 +30,8 @@ On your ESPHome settings, you have entered a url for `nextion_update_url`, in th
 ```yaml
 substitutions:
   ###### CHANGE ME START ######
-  device_name: "YOUR_NSPANEL_NAME" 
+  device_name: "YOUR_NSPANEL_NAME"
+  friendly_name: "Your panel's friendly name"
   wifi_ssid: !secret wifi_ssid
   wifi_password: !secret wifi_password