Moved example.yaml to the root dir, in line with the recommendations from the ESPHome external components guide.

CHANGELOG.md

@@ -6,10 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Changed
+- The GitHub repository structure has been updated, in order to make it compatible with
+  the new `external_components` feature of ESPHome v1.18.0. From now on, the code from this
+  repository no longer has to be downloaded and installed manually. The `example.yaml` has
+  been updated for using this new feature.
 - A fix has been implemented to prevent the lamp from being disconnected from Home Assistant
   a lot (resulting in the lamp becoming unavailable).
   Fixes [issue #19](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/19).
-  ESPHome v?.?.? or higher is required for making this fix work.
+  ESPHome v1.18.0 or higher is required for making this fix work.
 - Transitions are now fully suppressed when in night light mode. In that mode, LED output
   levels are too low for producing good looking transitions.
   Fixes [issue #10](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/10).
@@ -20,6 +24,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - New documentation section: Technical details (it's all about the internals)
 
+### Removed
+- The known issue documentation page has been removed, now we have a fix for the disconnect issues
+  in ESPHome v1.18.0.
+
 ## [1.0.0-RC1]
 ### Changed
 - The documentation has been restructured.

README.md

@@ -45,7 +45,7 @@ aspect of the lamp and to integrate the lamp in your Home Assistant setup.
 For those who have experience with flashing ESPHome onto devices:
 
 * Make sure you are using ESPHome 1.18.0 or newer.
-* Copy `[doc/example.yaml](doc/example.yaml)` to `<CONFIG_DIR>/<NODE_NAME>.yaml`.
+* Copy `[example.yaml](example.yaml)` to `<CONFIG_DIR>/<NODE_NAME>.yaml`.
 * Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)).
 * Compile the `firmware.bin` file and download it to the device to which you have connected your
   serial to USB adapter.

doc/configuration.md

@@ -3,7 +3,7 @@
 # Configuration guide
 
 I think, the best starting point for creating your own yaml configuration, is to look at the
-[example.yaml](example.yaml) file from the project documentation. This configuration was written
+[example.yaml](../example.yaml) file from the project documentation. This configuration was written
 with the functionality of the original firmware in mind and it makes use of all available options.
 This configuration guide can be used to fill in the blanks.
 
@@ -33,7 +33,7 @@ I do mention the platform configuration here for completeness sake, but **genera
 to add the following configuration option to your yaml file**. It is loaded automatically by the
 components that need it, and the GPIO + I2C configurations are fully prepared to work for the
 Bedside Lamp 2 wiring out of the box. Therefore, you will not find this piece of configuration in
-the [example.yaml](example.yaml).
+the [example.yaml](../example.yaml).
 
 Having said that, here are the configuration options:
 
@@ -126,7 +126,7 @@ mode. In this ESPHome firmware, setting the brightness to its lowest value trigg
 mode. This makes things a lot easier to control.
 
 It is possible to control the night light mode separately. An example of this can be found in the
-[example.yaml](example.yaml), in which holding the power button is bound to activating the night
+[example.yaml](../example.yaml), in which holding the power button is bound to activating the night
 light.
 
 ### light.disco_on Action
@@ -169,7 +169,7 @@ switch to the next preset within the active preset group. The same button can be
 while, to switch to the other preset group.
 
 In your light configuration, you can mimic this behavior (in fact: it is done so in the
-[example.yaml](example.yaml)) by means of the presets system. This system consists of two parts:
+[example.yaml](../example.yaml)) by means of the presets system. This system consists of two parts:
 
 * Defining presets
 * Activating presets from automations

doc/installation.md

@@ -12,7 +12,7 @@ the code manually. This leverages the external components feature that was intro
 version 1.18.0. Therefore, you must use ESPHome version 1.18.0 or later.
 
 Before you can compile the firmware, you will have to create the YAML configuration file for your
-device. You can take the [example.yaml](example.yaml) from this repository as a starting point, and
+device. You can take the [example.yaml](../example.yaml) from this repository as a starting point, and
 modify that one to your needs. Detailed information about the YAML configuration options can be
 found in the [Configuration guide](configuration.md).
 

doc/testplan.md

@@ -13,7 +13,7 @@ been introduced.
 * Remove the cached framework package: 
   `/bin/rm -fR ~/.platformio/packages/framework-arduinoespressif32` 
 
-* Copy `doc/example.yaml` to a clean build directory, and update the first two sections for the
+* Copy `[example.yaml](../example.yaml)` to a clean build directory, and update the first two sections for the
   local setup (substitutions, wifi, api, ota).
 
 * Use `esphome example.yaml compile` to build the code.

doc/example.yaml → example.yaml

@@ -59,7 +59,7 @@ logger:
 external_components:
   - source:
       type: git
-      url: https://github.com/mmakaay/xiaomi_bslamp2
+      url: https://github.com/mmakaay/esphome-xiaomi_bslamp2
       ref: main
 
 # A special platform package is used for enabling unicore and disabling the