diff --git a/changelog/2022.10.0.rst b/changelog/2022.10.0.rst index 0ae477b67..f1332badf 100644 --- a/changelog/2022.10.0.rst +++ b/changelog/2022.10.0.rst @@ -48,6 +48,11 @@ Release 2022.10.1 - October 26 - Fixed touch release issue using the interrupt pin :esphomepr:`3925` by :ghuser:`nielsnl68` - Add wind_speed sensor device class :esphomepr:`3941` by :ghuser:`frenck` +Release 2022.10.2 - November 1 +------------------------------ + +- Fix bluetooth_proxy not connecting :esphomepr:`3967` by :ghuser:`jesserockz` + Full list of changes -------------------- diff --git a/components/esphome.rst b/components/esphome.rst index 55f7307ec..c5a25ac38 100644 --- a/components/esphome.rst +++ b/components/esphome.rst @@ -26,7 +26,8 @@ Configuration variables: - **name** (**Required**, string): This is the name of the node. It should always be unique in your ESPHome network. May only contain lowercase - characters, digits and hyphens, and can be at most 31 characters long. + characters, digits and hyphens, and can be at most 24 characters long by default, or 31 + characters long if ``name_add_mac_suffix`` is ``false``. See :ref:`esphome-changing_node_name`. Advanced options: diff --git a/components/modbus_controller.rst b/components/modbus_controller.rst index fe7a2bb71..fe8fe9475 100644 --- a/components/modbus_controller.rst +++ b/components/modbus_controller.rst @@ -56,6 +56,9 @@ Configuration variables: - **command_throttle** (*Optional*, int): minimum time in milliseconds between 2 requests to the device. Default is 0ms Because some modbus devices limit the rate of requests the interval between sending requests to the device can be modified. +- **update_interval** (*Optional*, :ref:`config-time`): The interval that the sensors should be checked. + Defaults to 60 seconds. + Example ------- diff --git a/components/sensor/tcs34725.rst b/components/sensor/tcs34725.rst index 4def11916..58c9594b7 100644 --- a/components/sensor/tcs34725.rst +++ b/components/sensor/tcs34725.rst @@ -46,8 +46,6 @@ as the color temperature in kelvin will show `0`. name: "TCS34725 Illuminance" color_temperature: name: "TCS34725 Color Temperature" - gain: 1x - integration_time: 2.4ms glass_attenuation_factor: 1.0 address: 0x29 update_interval: 60s diff --git a/components/stepper/index.rst b/components/stepper/index.rst index 7c97a3b9e..10401e88a 100644 --- a/components/stepper/index.rst +++ b/components/stepper/index.rst @@ -273,82 +273,22 @@ Configuration variables: Home Assistant Configuration ---------------------------- -This component will not show up in the Home Assistant front-end (Overview) automatically because -Home Assistant does not support steppers natively. - -You can add the stepper component code below to your Home Assistant configuration (``configuration.yaml``) to -be able to control the stepper from the front-end. +The easiest way to control your stepper from Home Assistant is to add a ``number`` to your ESPHome +configuration. See :ref:`Number ` for more information. .. code-block:: yaml - # Add a slider control to Home Assistant to set an integer value - input_number: - stepper_control: + number: + - platform: template name: Stepper Control - initial: 0 - min: -1000 - max: 1000 + min_value: -100 + max_value: 100 step: 1 - mode: slider - - # Do something when the slider changes - automation: - - alias: Write Stepper Value to ESP - trigger: - platform: state - entity_id: input_number.stepper_control - action: - # Replace livingroom with the name you gave the ESP - - service: esphome.livingroom_control_stepper - data_template: - target: '{{ trigger.to_state.state | int }}' - -In the above code, "stepper_control" is the ID of a numeric input field. It must be unique and it is -used in the automation section as a reference name. The display name for this field is in -stepper_control's ``name`` key. - -If you want your user interface to give you more control over your stepper controller, such as -setting the acceleration, deceleration, etc, then you can add more input fields after ``stepper_control`` -but before ``automation``. They can be a simple number-entry field (mode: box) or a slider like this. -Each of these extra input fields needs an associated input parameter defined on the ESPHome device's -API service. - -The automation section tells Home Assistant what to do when the slider changes. It needs a trigger -(state of the ``stepper_control`` slider) and an action. In the trigger section, ``entity_id`` must refer -back to the configuration ID that triggers the automation. For us, that is the ``stepper_control`` -field in the ``input_number`` item. That's why the value is ``input_number.stepper_control``. - -In the action section, the service name is vital to get right: it's the glue that connects Home Automation's -front-end to the ESPHome device configuration. While you might expect the syntax to be ``esphome..``, -the correct syntax is to join the device ID to the API service ID with an underscore, -as in ``esphome.livingroom_control_stepper`` where "Livingroom" is a device in ESPHome and "control_stepper" is an -API service for that device. - -The template string is used to get the "state" value from the ``target`` field (defined in the target section) on the -``input_number`` component of the Home Assistant front-end. This value is then passed to the API service as defined in -the ESPHome device's configuration. The ``data_template`` section lists one value for each of the input parameters on -the service being called by the automation. In our case, the ESPHome device has an API service with a single parameter, -"target". If you called this "my_target", then the last line above should be ``my_target: '{{ trigger.to_state.state | int }}'``. -Getting this linkage right is very important. - -The following code needs to go in the ESPHome configuration file for this device. Above, we mention "API service" -a lot. This code is where that is defined. You may have already added it (or something similar). Note -that the input variable for the ``control_stepper`` service is called ``target``. That's what matches with the -automation configuration above. Also note that the variable ``target`` is defined as an integer. That means it -must be an integer number, not a string. - -.. code-block:: yaml - - # ESPHome configuration - api: - services: - - service: control_stepper - variables: - target: int + set_action: then: - stepper.set_target: id: my_stepper - target: !lambda 'return target;' + target: !lambda 'return x;' stepper: - platform: ... diff --git a/components/text_sensor/homeassistant.rst b/components/text_sensor/homeassistant.rst index ed9ce523b..7d514ad10 100644 --- a/components/text_sensor/homeassistant.rst +++ b/components/text_sensor/homeassistant.rst @@ -30,7 +30,7 @@ With Home Assistant 2021.6 or newer, entity state attributes can also be importe Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the text sensor. +- **name** (*Optional*, string): The name of the text sensor. - **entity_id** (**Required**, string): The entity ID to import from Home Assistant. - **attribute** (*Optional*, string): The name of the state attribute to import from the specified entity. The entity state is used when this option is omitted. diff --git a/components/time.rst b/components/time.rst index 6e418db43..2b4dee208 100644 --- a/components/time.rst +++ b/components/time.rst @@ -57,7 +57,9 @@ This powerful automation can be used to run automations at specific intervals at specific times of day. The syntax is a subset of the `crontab `__ syntax. There are two ways to specify time intervals: Either with using the ``seconds:``, ``minutes:``, ... -keys as seen below or using a cron expression like ``* /5 * * * *``. +keys as seen below or using a cron alike expression like ``* /5 * * * *``. + +Be aware normal cron implementations does not know about seconds like this esphome implementation, therefore you got 6 fields (seconds,minutes,hours,dayofmonth,month,dayofweek). Basically, the automation engine looks at your configured time schedule every second and evaluates if the automation should run. diff --git a/devices/sonoff.rst b/devices/sonoff.rst index 7287094b1..a7eaf3ce0 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -5,7 +5,7 @@ Generic Sonoff :description: Instructions for using generic Sonoff devices with ESPHome. :image: sonoff.svg -In principle ESPHome supports all Sonoff devices, but as these devices are quite cheap +ESPHome supports Sonoff devices with ESP based chips inside, but as these devices are quite cheap and shipping from China takes a long time, I've only set up dedicated guides for the :doc:`Sonoff S20 ` and :doc:`Sonoff 4CH `. diff --git a/guides/automations.rst b/guides/automations.rst index 5b2a940a4..785abdea0 100644 --- a/guides/automations.rst +++ b/guides/automations.rst @@ -845,7 +845,7 @@ This can't be used in a lambda as it would block all functioning of the device. This :ref:`condition ` allows you to check if a given script is running. In case scripts are run in ``parallel``, this condition only tells you if at least one script -of the given id is running, not how many. +of the given id is running, not how many. Not designed for use with :ref:`while `, instead try :ref:`script.wait `. .. code-block:: yaml diff --git a/guides/supporters.rst b/guides/supporters.rst index a9b7f8cc7..cccb67bad 100644 --- a/guides/supporters.rst +++ b/guides/supporters.rst @@ -219,7 +219,7 @@ Contributors - `Mickaël Le Baillif (@demikl) `__ - `Dennis (@dennisvbussel) `__ - `dentra (@dentra) `__ -- `Davide Depau (@Depau) `__ +- `Davide Depau (@depau) `__ - `dependabot[bot] (@dependabot[bot]) `__ - `Joeri Colman (@depuits) `__ - `Destix (@Destix) `__ @@ -390,6 +390,8 @@ Contributors - `imgbot[bot] (@imgbot[bot]) `__ - `ImSorryButWho (@ImSorryButWho) `__ - `Lorenzo Ortiz (@Infinitte) `__ +- `Dom (@Ing-Dom) `__ +- `Ingurum (@Ingurum) `__ - `Ivo Roefs (@Ironirc) `__ - `irtimaled (@irtimaled) `__ - `Ingo Theiss (@itn3rd77) `__ @@ -662,7 +664,6 @@ Contributors - `Otto Winter (@OttoWinter) `__ - `Ben Owen (@owenb321) `__ - `Oxan van Leeuwen (@oxan) `__ -- `Pack3tL0ss (@Pack3tL0ss) `__ - `Pablo Clemente Maseda (@paclema) `__ - `Derrick Lyndon Pallas (@pallas) `__ - `Panuruj Khambanonda (PK) (@panuruj) `__ @@ -753,7 +754,6 @@ Contributors - `sherbang (@sherbang) `__ - `Shish (@shish) `__ - `SiliconAvatar (@SiliconAvatar) `__ -- `SirSydom (@SirSydom) `__ - `Derek Hageman (@Sizurka) `__ - `Stephen Tierney (@sjtrny) `__ - `Niklas Wagner (@Skaronator) `__ @@ -896,4 +896,4 @@ Contributors - `Zack Barett (@zsarnett) `__ - `Christian Zufferey (@zuzu59) `__ -*This page was last updated October 26, 2022.* +*This page was last updated November 1, 2022.*