From f5b68e0029435efe9fddc0f6ba9ab9e8c86154d6 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 2 Dec 2024 07:59:15 +0100 Subject: [PATCH] Remove configuration keys from docs (#36089) --- source/_integrations/balboa.markdown | 5 +---- source/_integrations/bang_olufsen.markdown | 4 ---- source/_integrations/cambridge_audio.markdown | 4 +--- source/_integrations/denonavr.markdown | 6 ------ source/_integrations/fritzbox.markdown | 12 +++--------- source/_integrations/ifttt.markdown | 8 -------- source/_integrations/jellyfin.markdown | 1 - source/_integrations/lamarzocco.markdown | 6 ------ source/_integrations/laundrify.markdown | 4 +--- source/_integrations/motioneye.markdown | 10 ---------- source/_integrations/nmap_tracker.markdown | 9 --------- source/_integrations/octoprint.markdown | 19 ++----------------- source/_integrations/onkyo.markdown | 6 ------ source/_integrations/rabbitair.markdown | 8 ++------ source/_integrations/reolink.markdown | 14 +++++--------- source/_integrations/tedee.markdown | 4 ---- source/_integrations/venstar.markdown | 13 +------------ source/_integrations/zwave_me.markdown | 6 ------ 18 files changed, 16 insertions(+), 123 deletions(-) diff --git a/source/_integrations/balboa.markdown b/source/_integrations/balboa.markdown index 7543373ff1d..64778abf60e 100644 --- a/source/_integrations/balboa.markdown +++ b/source/_integrations/balboa.markdown @@ -44,16 +44,13 @@ Balboa Spa Client integration is not compatible with ControlMySpa™ cloud API u {% configuration_basic %} host: description: "Hostname or IP address of your Balboa Spa Wifi Device, e.g., `192.168.1.58`." - required: true - type: string {% endconfiguration_basic %} {% include integrations/option_flow.md %} + {% configuration_basic %} sync_time: description: Sync the Spa's internal clock with Home Assistant daily - type: boolean - default: false {% endconfiguration_basic %} ## Known limitations diff --git a/source/_integrations/bang_olufsen.markdown b/source/_integrations/bang_olufsen.markdown index 099948bddd0..584cdad1fb0 100644 --- a/source/_integrations/bang_olufsen.markdown +++ b/source/_integrations/bang_olufsen.markdown @@ -40,12 +40,8 @@ and any other [Mozart](https://support.bang-olufsen.com/hc/en-us/articles/247669 {% configuration_basic %} IP Address: description: The IP address of your device. Can be found by navigating to the device on the [Bang & Olufsen app](https://www.bang-olufsen.com/en/dk/story/apps) and selecting `Settings` → `About` → `IP address`. - required: true - type: string Device model: description: The model name of your Bang & Olufsen device. This is used to determine some capabilities of the device. If the device is not in the list yet, choose a product similar to yours. - required: true - type: string {% endconfiguration_basic %} ## Data updates diff --git a/source/_integrations/cambridge_audio.markdown b/source/_integrations/cambridge_audio.markdown index 26a991535f4..a52567c4825 100644 --- a/source/_integrations/cambridge_audio.markdown +++ b/source/_integrations/cambridge_audio.markdown @@ -46,9 +46,7 @@ use a different protocol and are not currently supported. {% configuration_basic %} Host: - description: The IP address of your device can be found by navigating to the device on the [StreamMagic app](https://www.cambridgeaudio.com/usa/en/products/streammagic) and selecting `Settings` → `IP address`. - required: true - type: string + description: The IP address of your device can be found by navigating to the device on the [StreamMagic app](https://www.cambridgeaudio.com/usa/en/products/streammagic) and selecting `Settings` → `IP address`. {% endconfiguration_basic %} ## Data updates diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown index 4a11ba7d9fd..f3ed085c50c 100644 --- a/source/_integrations/denonavr.markdown +++ b/source/_integrations/denonavr.markdown @@ -134,14 +134,8 @@ zone3: description: Specifies if zone 3 should be activated. Zones are displayed as additional media players with the same functionality as the Main Zone of the device supports. Some receivers do not support a second zone. update_audyssey: description: Specifies if Audyssey settings should be updated. This can take up to 10 seconds for some receivers. - required: false - default: false - type: boolean use_telnet: description: Specifies if a telnet connection should be used to receive device status updates. Using telnet provides realtime updates (local push) for many values but each receiver is limited to a single connection. If you enable this setting, no other connection to your device can be made via telnet. This will be set to true for new installations of the integration but false for existing installs to prevent compatibility issues. - required: false - default: true - type: boolean {% endconfiguration_basic %} A few notes: diff --git a/source/_integrations/fritzbox.markdown b/source/_integrations/fritzbox.markdown index 89a13a01ca8..6dbee7dce1b 100644 --- a/source/_integrations/fritzbox.markdown +++ b/source/_integrations/fritzbox.markdown @@ -63,17 +63,11 @@ If you still want to use the predefined user, please note that as of FRITZ!OS 7. {% configuration_basic %} Host: - description: "The hostname or IP address of your FRITZ!Box router." - required: true - type: string + description: "The hostname or IP address of your FRITZ!Box router." Username: - description: "Name of the user to connect Home Assistant to your FRITZ!Box (_see [prerequisites](#prerequisites)_)" - required: true - type: string + description: "Name of the user to connect Home Assistant to your FRITZ!Box (_see [prerequisites](#prerequisites)_)" Password: - description: "Password for the user to connect Home Assistant to your FRITZ!Box (_see [prerequisites](#prerequisites)_)" - required: true - type: string + description: "Password for the user to connect Home Assistant to your FRITZ!Box (_see [prerequisites](#prerequisites)_)" {% endconfiguration_basic %} ## Data fetching and limitations diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index 065c535ca09..f4d1addc39e 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -87,20 +87,12 @@ You can use **Developer Tools** to test your [Webhooks](https://ifttt.com/maker_ {% configuration_basic %} event: description: The name of the event to send. - required: true - type: string value1: description: Generic field to send data via the event. - required: false - type: string value2: description: Generic field to send data via the event. - required: false - type: string value3: description: Generic field to send data via the event. - required: false - type: string {% endconfiguration_basic %} When your screen looks like this, select the **Perform action** button. diff --git a/source/_integrations/jellyfin.markdown b/source/_integrations/jellyfin.markdown index 0804c2b9cce..378ceed096a 100644 --- a/source/_integrations/jellyfin.markdown +++ b/source/_integrations/jellyfin.markdown @@ -64,5 +64,4 @@ Password: {% configuration_basic %} Audio Codec: description: Sets the audio encoding codec to a Jellyfin API supported codec (aac, mp3, vorbis, wma) - required: false {% endconfiguration_basic %} diff --git a/source/_integrations/lamarzocco.markdown b/source/_integrations/lamarzocco.markdown index 6f295c38b6a..1a914b71732 100644 --- a/source/_integrations/lamarzocco.markdown +++ b/source/_integrations/lamarzocco.markdown @@ -46,16 +46,10 @@ By default, this integration will query your machine every 30 seconds for an upd {% configuration_basic %} Username: description: "Your username you use to log into the La Marzocco app." - required: true - type: string Password: description: "Password you use to log into the La Marzocco app." - required: true - type: string Host: description: "IP address of your machine in your local network. If not set, no local connections will be used." - required: false - type: boolean {% endconfiguration_basic %} {% include integrations/option_flow.md %} diff --git a/source/_integrations/laundrify.markdown b/source/_integrations/laundrify.markdown index 593e412f9fb..338e6c3a182 100644 --- a/source/_integrations/laundrify.markdown +++ b/source/_integrations/laundrify.markdown @@ -40,8 +40,6 @@ Your code will expire within 60 minutes after activation. Make sure to configure {% include integrations/config_flow.md %} {% configuration_basic %} -code: +Code: description: "Auth Code that can be obtained in the laundrify App (see above), e.g., `123-456`." - required: true - type: string {% endconfiguration_basic %} diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown index 512fb2cbc09..f3d00f908b7 100644 --- a/source/_integrations/motioneye.markdown +++ b/source/_integrations/motioneye.markdown @@ -27,24 +27,14 @@ and visualization of multiple types of cameras. {% configuration_basic %} url: description: The URL of the motionEye server itself -- **not** the URL for the camera stream(s) that it makes available. - required: true - type: string admin_username: description: The username of the motionEye administrative account, used for changing camera settings. - required: true - type: string admin_password: description: The password of the motionEye administrative account. - required: true - type: string surveillance_username: description: The username of the motionEye surveillance user, used to authenticate video streams. - required: true - type: string surveillance_password: description: The password of the motionEye surveillance account. - required: true - type: string {% endconfiguration_basic %} {% include integrations/option_flow.md %} diff --git a/source/_integrations/nmap_tracker.markdown b/source/_integrations/nmap_tracker.markdown index 249202270a9..82073194858 100644 --- a/source/_integrations/nmap_tracker.markdown +++ b/source/_integrations/nmap_tracker.markdown @@ -32,21 +32,12 @@ An example of how the Nmap scanner can be customized: {% configuration_basic %} Network addresses to scan: description: Network range to scan using [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). In the example above it will scan addresses from `192.168.1.1` to `192.168.1.254`. - required: true - type: string Minimum number of minutes between scans of active devices: description: Frequency of the scans. The lower the number, the quicker it will detect devices connected and disconnected usually at the cost of the devices battery life. The example above will scan every minute. - required: true - type: integer Network addresses to exclude from scanning: description: A comma-separated list of IP addresses not to scan. The above example will skip `192.168.1.8`. - required: false - type: string Raw configurable scan options for Nmap: description: Nmap command line parameters which can be used to configure how Nmap scans the network. For more details see [Nmap reference guide](https://nmap.org/book/man.html). - required: false - type: string - default: -F T4 --min-rate 10 --host-timeout 5s {% endconfiguration_basic %} See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_integrations/octoprint.markdown b/source/_integrations/octoprint.markdown index abbe2801372..03893304c7c 100644 --- a/source/_integrations/octoprint.markdown +++ b/source/_integrations/octoprint.markdown @@ -29,35 +29,20 @@ ha_integration_type: integration {% configuration_basic %} username: description: Username for the server. - required: true - type: string host: - description: Address of the server, e.g., 192.168.1.32. - required: true - type: string + description: Address of the server, e.g., `192.168.1.32`. port: description: Port of the server. - required: false - type: string - default: 80 path: description: URL path of the server - required: false - type: string - default: / ssl: description: Whether to use SSL or not when communicating. - required: false - type: boolean - default: false verify ssl: description: Should the SSL certificate be validated. - required: false - type: boolean - default: false {% endconfiguration_basic %} ### API key + For the integration to work, please check that in Octoprint, the [Discovery Plugin](https://docs.octoprint.org/en/master/bundledplugins/discovery.html) is enabled and in the **Settings** -> **Printer Notifications** menu that **Enable popups** is checked. The Octoprint integration will attempt to register itself via the [Application Keys Plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, log in to Octoprint as the user whose credentials you just entered in Home Assistant, and select **Allow** on the prompt. diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown index 7356985af33..d38700f9472 100644 --- a/source/_integrations/onkyo.markdown +++ b/source/_integrations/onkyo.markdown @@ -25,13 +25,10 @@ Please be aware that you need to enable "Network Standby" for this integration t {% configuration_basic %} Host: description: Hostname or IP address of the device, for example:`192.168.1.2`. - type: string Volume Resolution: description: Number of steps it takes for the receiver to go from the lowest to the highest possible volume. Possible values are 50, 80, 100, 200. For older Onkyo receivers, this typically is 80; newer Onkyo receivers use 200. - type: integer Input sources: description: List of input sources supported by the receiver. - type: list {% endconfiguration_basic %} The above settings can also be adjusted later. To do this, click the three-dot menu on the integration entry and select **Reconfigure**. @@ -41,11 +38,8 @@ The above settings can also be adjusted later. To do this, click the three-dot m {% configuration_basic %} Max Volume: description: Maximum volume limit as a percentage. Often the maximum volume of the receiver is far too loud. Setting this will set Home Assistant's 100% volume to be this setting on the amp, i.e., if you set this to 50%, when you set Home Assistant to be 100%, then your receiver will be set to 50% of its maximum volume. - default: 100 - type: integer Input sources: description: Mappings of input sources to their names. - type: list {% endconfiguration_basic %} ### Zones diff --git a/source/_integrations/rabbitair.markdown b/source/_integrations/rabbitair.markdown index 3f449eabcbe..df444f3d367 100644 --- a/source/_integrations/rabbitair.markdown +++ b/source/_integrations/rabbitair.markdown @@ -49,11 +49,7 @@ In some cases the access token may not be available right away, then you will se {% configuration_basic %} host: - description: "Hostname or IP address of the device." - required: true - type: string + description: Hostname or IP address of the device. access_token: - description: "Access Token that can be obtained in the Rabbit Air app." - required: true - type: string + description: Access Token that can be obtained in the Rabbit Air app. {% endconfiguration_basic %} diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown index aff92f3dd49..0e8c82d7555 100644 --- a/source/_integrations/reolink.markdown +++ b/source/_integrations/reolink.markdown @@ -43,22 +43,18 @@ A brand new Reolink camera needs to be connected to the network and initialized. - The password used for the Reolink device can only contain characters `a-z, A-Z, 0-9 or @$*~_-+=!?.,:;'()[]`. Other special characters will cause encoding issues in the video streams used by this integration and are, therefore, not allowed. When using an incompatible special character in the password, the integration will prompt you to change the password. {% include integrations/config_flow.md %} + {% configuration_basic %} Host: - description: "The hostname or IP address of your Reolink device. For example: '192.168.1.25'. You can find it in your router or in the Reolink app under **Settings** -> **Device** (top icon) -> **Networkinformation** -> **IP-address**. Normally, the Reolink device is automatically discovered, and you do not need to provide this." - required: false - type: string + description: "The hostname or IP address of your Reolink device. For example: '192.168.1.25'. You can find it in your router or in the Reolink app under **Settings** -> **Device** (top icon) -> **Networkinformation** -> **IP-address**. Normally, the Reolink device is automatically discovered, and you do not need to provide this." Username: - description: "Username to log in to the Reolink device itself. Not the Reolink cloud account." - required: true - type: string + description: "Username to log in to the Reolink device itself. Not the Reolink cloud account." Password: - description: "Password to log in to the Reolink device itself. Not the Reolink cloud account." - required: true - type: string + description: "Password to log in to the Reolink device itself. Not the Reolink cloud account." {% endconfiguration_basic %} {% include integrations/option_flow.md %} + {% configuration_basic %} Protocol: description: Switch between RTSP, RTMP, or FLV streaming protocol. RTSP supports 4K streams (h265 encoding) while RTMP and FLV do not. FLV is the least demanding on the camera. diff --git a/source/_integrations/tedee.markdown b/source/_integrations/tedee.markdown index 3597d886986..0c254a7385b 100644 --- a/source/_integrations/tedee.markdown +++ b/source/_integrations/tedee.markdown @@ -40,12 +40,8 @@ The integration will try to configure webhooks to receive near-real-time push up {% configuration_basic %} Host: description: "The IP address of your bridge. You can find it in your router or in the Tedee app under **Bridge Settings** -> **Local API**." - required: false - type: string Local Access Token: description: "The local access token for your bridge. You can find it in the Tedee app under **Bridge Settings** -> **Local API**." - required: false - type: string {% endconfiguration_basic %} ## Supported devices diff --git a/source/_integrations/venstar.markdown b/source/_integrations/venstar.markdown index f65443755f8..02b395010fc 100644 --- a/source/_integrations/venstar.markdown +++ b/source/_integrations/venstar.markdown @@ -79,24 +79,13 @@ If the local API is successfully enabled on the thermostat, you should see some {% configuration_basic %} host: - description: Address of your thermostat, e.g., 192.168.1.32. - required: true - type: string + description: Address of your thermostat, e.g., `192.168.1.32`. username: description: Username for the thermostat. - required: false - type: string password: description: Password for the thermostat. - required: false - type: string pin: description: Pin for Lockscreen (required if lock screen enabled) - required: false - type: string ssl: description: Whether to use SSL or not when communicating. - required: false - type: boolean - default: false {% endconfiguration_basic %} diff --git a/source/_integrations/zwave_me.markdown b/source/_integrations/zwave_me.markdown index ad4d306c0d6..79f88938ce0 100644 --- a/source/_integrations/zwave_me.markdown +++ b/source/_integrations/zwave_me.markdown @@ -43,16 +43,10 @@ This integration allows you to control a Z-Wave network via the [Z-Wave.Me Z-Way {% include integrations/config_flow.md %} {% configuration_basic %} - URL: description: The IP address with the port of the Z-Way server. The IP address can be prefixed with wss:// if HTTPS should be used instead of HTTP (when using find.z-wave.me remote access service or public IP with SSL). - required: true - type: string API Token: description: Z-Way API access token of the Z-Way server. To get the token go to the Z-Way user interface Smart Home UI > Menu > Settings > Users > Administrator > API token. - required: true - type: string - {% endconfiguration_basic %} When connecting via find.z-wave.me remote access service you need to use a token with a global scope (log-in to Z-Way via [find.z-wave.me](https://find.z-wave.me) for this).