Add docs for Anova f/c support (#1368)

This commit is contained in:
buxtronix 2021-08-09 06:05:41 +10:00 committed by GitHub
parent d3b03e7e37
commit c2860445c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -25,6 +25,10 @@ address of your Anova device.
You cannot use the Anova app over BLE whilst this component is connected, you You cannot use the Anova app over BLE whilst this component is connected, you
should disconnect it first. To setup a (dis-)connect switch, see :doc:`/components/switch/ble_client`. should disconnect it first. To setup a (dis-)connect switch, see :doc:`/components/switch/ble_client`.
You need to specify unit_of_measurement as 'c' or 'f'. This ensures the stick's display
uses the unit you intend. All values within ESPHome are converted to Celcius so you may
need to do conversion again within the frontend if you use Fahrenheit.
.. warning:: .. warning::
The Anova Nano is not currently supported as it uses a different BLE protocol. The Anova Nano is not currently supported as it uses a different BLE protocol.
@ -39,6 +43,7 @@ should disconnect it first. To setup a (dis-)connect switch, see :doc:`/componen
- platform: anova - platform: anova
name: "My Anova stick" name: "My Anova stick"
ble_client_id: my_anova ble_client_id: my_anova
unit_of_measurement: c
Configuration variables: Configuration variables:
------------------------ ------------------------
@ -46,6 +51,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the climate device. - **name** (**Required**, string): The name of the climate device.
- **ble_client_id** (**Required**, :ref:`config-id`): The ID of the BLE Client. - **ble_client_id** (**Required**, :ref:`config-id`): The ID of the BLE Client.
- **unit_of_measurement** (**Required**, string): Units to use on the device display. 'c' or 'f'.
- All other options from :ref:`Climate <config-climate>`. - All other options from :ref:`Climate <config-climate>`.
See Also See Also