Skip to content

Commit 165e6f5

Browse files
klaasnicolaasrenovate[bot]
klaasnicolaas
and
renovate[bot]
authored
Merge pull request #625 from klaasnicolaas/release/v4.2.2
* ⬆️ Lock file maintenance * ⬆️ Update dependency typescript to ~5.6.0 (#591) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update esphome/build-action action to v4.0.2 * ⬆️ Update esphome/build-action action to v4.0.3 * ⬆️ Lock file maintenance * ⬆️ Update actions/setup-node action to v4.0.4 * ⬆️ Lock file maintenance * ⬆️ Update actions/checkout action to v4.2.0 * ⬆️ Lock file maintenance (#600) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Bump NPM packages * Add Ko-fi links on docs website (#602) * Bump NPM packages * Add Ko-fi links on docs website * ⬆️ Lock file maintenance (#605) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/upload-artifact action to v4.4.1 (#608) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/checkout action to v4.2.1 (#607) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/upload-artifact action to v4.4.2 * ⬆️ Update dependency @easyops-cn/docusaurus-search-local to v0.44.6 * ⬆️ Update dependency typescript to v5.6.3 (#611) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/upload-artifact action to v4.4.3 * ⬆️ Update dependency @easyops-cn/docusaurus-search-local to ^0.45.0 (#614) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Lock file maintenance * Replace ESP install component (#618) * Remove the ESP install component code * Add esp-web-tools NPM package * Remove esp-web-tools NPM package * Add js script to Docusaurus * Refactor component code * Small refactor on global declare * Rename the file and component * Refactor text (#619) * Refactor text * Fix typo * ⬆️ Update dependency @mdx-js/react to v3.1.0 (#620) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Lock file maintenance (#621) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Add attribution for derived content from Upsy Desky documentation (#623) * Rename 'Firmware' to 'Firmware Update' in updates.yaml (#624) * Bump Home Assistant Glow to v4.2.2 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2 parents bb75c1a + 29abcbe commit 165e6f5

17 files changed

Lines changed: 1233 additions & 1253 deletions

‎.github/workflows/build-firmware.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
matrix: ${{ steps.prepare-matrix.outputs.matrix }}
3939
steps:
4040
- name: ⤵️ Check out code from GitHub
41-
uses: actions/checkout@v4.1.7
41+
uses: actions/checkout@v4.2.1
4242
- name: ⤵️ Get changed files
4343
if: github.event_name == 'pull_request'
4444
id: changes
@@ -91,7 +91,7 @@ jobs:
9191
matrix: ${{fromJson(needs.prepare.outputs.matrix)}}
9292
steps:
9393
- name: ⤵️ Check out code from GitHub
94-
uses: actions/checkout@v4.1.7
94+
uses: actions/checkout@v4.2.1
9595
- name: 🔍 Determine ref - ESPHome packages
9696
if: ${{ !contains(fromJSON('["release", "workflow_call"]'), github.event_name) }}
9797
run: |
@@ -100,7 +100,7 @@ jobs:
100100
- name: 🧪 Display changed YAML file
101101
run: cat ${{ matrix.firmware }}/${{ matrix.device }}.yaml
102102
- name: 🔨 Build firmware
103-
uses: esphome/build-action@v4.0.1
103+
uses: esphome/build-action@v4.0.3
104104
id: esphome-build
105105
with:
106106
yaml-file: ${{ matrix.firmware }}/${{ matrix.device }}.yaml
@@ -119,7 +119,7 @@ jobs:
119119
sed -i 's/${{ steps.esphome-build.outputs.name }}\(\.[a-z]*\)\.bin/\/${{ matrix.firmware }}\/${{ matrix.device }}\/${{ steps.esphome-build.outputs.name }}\1.bin/' output/${{ matrix.device }}/manifest.json
120120
cat output/${{ matrix.device }}/manifest.json
121121
- name: ⬆️ Upload firmware / device artifact
122-
uses: actions/upload-artifact@v4.4.0
122+
uses: actions/upload-artifact@v4.4.3
123123
with:
124124
name: build-${{ matrix.firmware}}-${{ matrix.device }}
125125
path: output

‎.github/workflows/deploy-firmware.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
- name: 🧪 Display structure of job
4545
run: ls -R
4646
- name: ⬆️ Upload project artifact
47-
uses: actions/upload-artifact@v4.4.0
47+
uses: actions/upload-artifact@v4.4.3
4848
with:
4949
name: ${{ matrix.project }}
5050
path: files
@@ -57,7 +57,7 @@ jobs:
5757
needs: combined-manifests
5858
steps:
5959
- name: ⤵️ Check out code from GitHub
60-
uses: actions/checkout@v4.1.7
60+
uses: actions/checkout@v4.2.1
6161
- name: ⬇️ Download all artifacts
6262
uses: actions/download-artifact@v4.1.8
6363
with:
@@ -69,7 +69,7 @@ jobs:
6969
run: ls -R
7070

7171
- name: 🏗️ Set up Node.js
72-
uses: actions/setup-node@v4.0.3
72+
uses: actions/setup-node@v4.0.4
7373
with:
7474
node-version: 20.x
7575
- name: 🏗️ Install Docusaurus dependencies

‎.github/workflows/labels.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
pull-requests: write
1919
steps:
2020
- name: ⤵️ Check out code from GitHub
21-
uses: actions/checkout@v4.1.7
21+
uses: actions/checkout@v4.2.1
2222
- name: 🚀 Run Label Syncer
2323
uses: micnncim/action-label-syncer@v1.3.0
2424
env:

‎components/updates.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ota:
88
update:
99
- platform: http_request
1010
id: update_http_request
11-
name: Firmware
11+
name: Firmware Update
1212
source: https://glow-energy.io/home-assistant-glow/manifest.json
1313

1414
http_request:

‎docs/blog/2024-01-11-fresh-new-start.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Moving forward, firmware builds will be tested on a weekly basis. This ensures t
4949

5050
---
5151

52-
That's it! If you would like to support the project you can do so through [Github sponsors](https://github.com/sponsors/klaasnicolaas). If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions) and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
52+
That's it! If you would like to support the project you can do so through [Github sponsors](https://github.com/sponsors/klaasnicolaas) or Ko-fi. If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions) and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
5353

5454
./Klaas
55+
56+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F1SW69D)

‎docs/blog/2024-07-03-release.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,12 @@ This separation ensures that the firmware files on the website are always the sa
5858

5959
This release contains some nice features / improvements that make the Home Assistant Glow more 🌟
6060

61-
If you would like to support the project, you can do so through [GitHub sponsors](https://github.com/sponsors/klaasnicolaas). If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions), and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
61+
If you would like to support the project, you can do so through [GitHub sponsors](https://github.com/sponsors/klaasnicolaas) or Ko-fi. If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions), and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
6262

6363
./Klaas
6464

65+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F1SW69D)
66+
6567
## Related links
6668

6769
- [ESPHome 2024.6](https://esphome.io/changelog/2024.6.0.html)

‎docs/blog/2024-09-06-release.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ web_server:
2727
2828
## Wrap up
2929
30-
If you would like to support the project, you can do so through [GitHub sponsors](https://github.com/sponsors/klaasnicolaas). If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions), and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
30+
If you would like to support the project, you can do so through [GitHub sponsors](https://github.com/sponsors/klaasnicolaas) or Ko-fi. If you have any questions, you can ask them via the [discussions](https://github.com/klaasnicolaas/home-assistant-glow/discussions), and if you encounter problems with the Home Assistant Glow, you can indicate this in the [issues](https://github.com/klaasnicolaas/home-assistant-glow/issues).
3131
3232
./Klaas
3333
34+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F1SW69D)
35+
3436
## Related links
3537
3638
- [ESPHome 2024.8.x - Changelog][esphome-changelog]

‎docs/docs/advanced/firmware_customization.mdx‎

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,73 @@ title: Customizing the firmware
44
description: How to adopt and customize the firmware for your own needs.
55
---
66

7-
Since the Home Assistant Glow's firmware is based on [ESPHome](https://esphome.io), making
8-
customizations to the firmware is as easy as editing some YAML. The best way to modify the
9-
firmware config is by installing the [ESPHome Dashboard](https://esphome.io/guides/getting_started_hassio.html).
7+
The Home Assistant Glow's firmware is built on [ESPHome](https://esphome.io), a platform
8+
designed for customization through simple YAML configurations. Whether you need to tweak
9+
the device's functionality or adapt it for different use cases, the process is straightforward.
10+
This guide will walk you through how to adopt the device and customize its firmware using
11+
the [ESPHome Dashboard](https://esphome.io/guides/getting_started_hassio.html).
1012

1113
## Adopting the Device
1214

13-
Once ESPHome Dashboard is running, and your Home Assistant Glow is connected to your network,
14-
it should prompt you to adopt it.
15+
Before making any changes to the firmware, you first need to adopt the device into the ESPHome.
16+
Once your ESPHome Dashboard is up and running, and the Home Assistant Glow is connected to your
17+
local network, you should see an option to adopt it.
1518

1619
<p align="left">
1720
<img src={require('@site/static/img/customization/adopt-esphome.png').default} />
1821
</p>
1922

20-
Go through the adoption flow; it will do these things:
23+
Following the adoption steps will automatically:
2124

22-
1. Create an ESPHome configuration file
23-
2. Set an API encryption key (used by Home Assistant or other native API consumers)
24-
3. Bake the Wi-Fi credentials into the firmware
25-
4. Install the new firmware to the device
25+
1. Create a unique ESPHome configuration file for your device.
26+
2. Set up a secure API encryption key, allowing communication between Home Assistant and your device.
27+
3. Embed your Wi-Fi credentials directly into the firmware, enabling automatic reconnections.
28+
4. Upload the customized firmware onto the Home Assistant Glow.
2629

2730
## Understanding the Configuration
2831

29-
### Components
32+
### Component Structure
3033

31-
To keep things maintainable and to make it easier to build firmware for different board types,
32-
each large part of the configuration is broken up into its own "components". There are currently
33-
three components, all of which are included in the base config:
34+
To make the firmware manageable and adaptable to different hardware setups, it is organized into
35+
distinct "components." Each major function of the device is isolated in its own YAML file. The
36+
base configuration includes several important components:
3437

35-
- `basis.yaml`: package related to the basic functionality of the device
36-
- `pulse_meter.yaml`: package related to the pulse meter
37-
- `status_led.yaml`: package related to the status LED
38-
- `updates.yaml`: package related to the OTA updates
38+
- **`basis.yaml`**: Handles the basic, essential functionality of the device.
39+
- **`pulse_meter.yaml`**: Manages pulse metering, useful for tracking energy usage.
40+
- **`status_led.yaml`**: Controls the status LED, allowing you to customize its behavior or color based on the device's state.
41+
- **`updates.yaml`**: Provides Over-the-Air ([OTA][ota]) update capabilities, making it easy to update firmware without physical access.
3942

40-
All of these components can be found on the [GitHub repository](https://github.com/klaasnicolaas/home-assistant-glow/tree/main/components).
43+
These components can be found in the [GitHub repository](https://github.com/klaasnicolaas/home-assistant-glow/tree/main/components).
4144

42-
## Make customizations
45+
### Making Your First Customization
4346

44-
After adopting the device, you can make customizations to the firmware by editing the YAML
45-
files. You can do this by clicking the **EDIT** button in the ESPHome dashboard. This will open
46-
the YAML editor, where you can make changes to the configuration.
47+
Once your device is adopted, you can start customizing its behavior by editing the configuration
48+
files. In the ESPHome dashboard, click on **EDIT** next to the device to open the YAML editor,
49+
where you can modify the configuration directly.
4750

4851
<p align="left">
4952
<img src={require('@site/static/img/customization/edit-device.png').default} />
5053
</p>
5154

52-
When you open the YAML editor you will see a minimal configuration of your Home Assistant Glow,
53-
if you want to make adjustments to, e.g., the [pulse_meter] component then the best way
54-
is to use an [!extend].
55+
In the YAML editor, you'll see the default configuration for your Home Assistant Glow. You can
56+
make changes here or add new functionality by extending existing components. For instance, to
57+
modify the behavior of the [pulse_meter], you could use the [!extend] feature.
58+
59+
Here's an example of adding an [internal_filter] to the pulse meter configuration:
5560

5661
```yaml title="your_glow_config.yaml"
5762
sensor:
5863
- id: !extend sensor_energy_pulse_meter
5964
internal_filter: 100ms
6065
```
6166
62-
With the above example, you will add an [internal_filter], which can be useful if high power values are measured.
63-
64-
## Related topics
67+
## Related links
6568
6669
- [ESPHome - Pulse Counter][pulse_meter]
6770
- [ESPHome - Extend][!extend]
71+
- [ESPHome - OTA Updates][ota]
6872
6973
[internal_filter]: https://esphome.io/components/sensor/pulse_counter.html?highlight=internal_filter
7074
[pulse_meter]: https://esphome.io/components/sensor/pulse_counter.html
71-
[!extend]: https://esphome.io/components/packages.html#extend
75+
[!extend]: https://esphome.io/components/packages.html#extend
76+
[ota]: https://esphome.io/components/ota/

‎docs/docs/configuration.mdx‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,42 @@ id: configuration
33
title: Configuration
44
---
55

6-
## Renaming the Device
6+
## Changing the Device Name
77

8-
By default, the name of your Home Assistant Glow in Home Assistant is `home-assistant-glow-XXXXXX`, where `XXXXXX`
9-
is derived from the MAC address of the device. This is not very descriptive, so you can change it to something more
10-
meaningful.
8+
When you first add your device to Home Assistant, it's assigned a default name like `home-assistant-glow-XXXXXX`,
9+
where `XXXXXX` is a portion of the device's MAC address. While functional, this default name isn't very user-friendly
10+
or descriptive, especially if you have multiple devices. Renaming it to something more meaningful helps with organization
11+
and makes it easier to recognize within your smart home setup.
1112

12-
In the Home Assistant UI, navigate to your Home Assistant Glow by going to [**Settings** > **Devices & Services** > **ESPHome**][esphome-devices],
13-
then select your Home Assistant Glow. You can also click the my badge below to go directly to your ESPHome devices overview page:
13+
### How to Rename Your Device
14+
15+
To change the name of your device, follow these steps:
16+
17+
1. Open the Home Assistant user interface.
18+
2. Navigate to **Settings** > **Devices & Services**.
19+
3. Under the **ESPHome** section, find and select your device. If you have multiple devices, you may need to identify it by its current name (the default format described earlier).
20+
21+
Alternatively, you can click the badge below to be taken directly to the ESPHome devices overview page:
1422

1523
[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)][esphome-devices]
1624

17-
On the device's page, press the pencil icon in the top-right to edit the name.
25+
4. Once on the device's page, locate the pencil icon in the top-right corner. Clicking this icon will allow you to edit the device name.
26+
5. Enter your preferred name, something that reflects the purpose or location of the device (e.g., “Home Assistant Glow” or “Glow Energy”). This will help you easily identify it later.
27+
6. Click **Update** to apply the changes and save the new name.
1828

1929
<p align="left">
2030
<img src={require('@site/static/img/configuration/rename-device.png').default} />
2131
</p>
2232

23-
After you've changed the name, click on **Update** to save the changes.
33+
### Renaming Entity IDs (Optional)
34+
35+
After renaming the device, Home Assistant may prompt you to rename the associated entity IDs as well. Entity IDs are used to reference your device in automations, dashboards, and other parts of Home Assistant.
36+
37+
- **If you haven't created any automations or dashboards yet**: It's generally a good idea to rename the entity IDs to match the new device name. This makes them easier to recognize and use in future configurations.
38+
- **If you already have automations or dashboards**: You may want to keep the existing entity IDs if they are already used in various setups. Renaming the entity IDs will require you to update those configurations to reference the new names. In this case, you can opt to change only the device name and leave the entity IDs as they are.
39+
40+
## Related links
2441

25-
:::info
26-
Home Assistant may ask if you want to rename the entity IDs as well. If you don't already have automations,
27-
dashboards, etc. using the entity IDs, it's probably a good idea to do that now so the entity IDs are more
28-
readable. But if you already are using the entity IDs in other places, you can opt not to rename them, and
29-
just change the name of the device.
30-
:::
42+
- [Home Assistant - Terminology](https://home-assistant.io/getting-started/concepts-terminology)
3143

3244
[esphome-devices]: https://my.home-assistant.io/redirect/integration/?domain=esphome

‎docs/docs/getting-started.mdx‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Instruction to get started with the Home Assistant Glow'
66

77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
9-
import EspInstallButton from '@site/src/components/EspInstallButton';
9+
import ESPHomeButton from '@site/src/components/ESPWebTools';
1010
import { faUsb } from '@fortawesome/free-brands-svg-icons';
1111

1212
# Get started
1313

14-
This page will guide you through setting up your new Home Assistant Glow. It will take you through the steps of setup the hardware, installing the firmware and configure the device. It should take **5-10 minutes**, but probably less.
14+
This guide will walk you through the steps needed to set up your new Home Assistant Glow. You'll go through connecting the hardware, installing the necessary software, and configuring the settings to get everything up and running smoothly.
1515

1616
## Step 1: Hardware
1717

@@ -35,7 +35,6 @@ If you would like to prototype, I can also recommend the following items:
3535
Keep in mind that besides the photodiode board there are also boards in circulation with an LDR. The expansion board is optional, but makes it easier to connect and prototype with the components.
3636
:::
3737

38-
3938
How everything should be connected can be found on the [wiring diagram](/docs/reference/diagram). Once this is done, you can proceed to step 2.
4039

4140
## Step 2: Install firmware
@@ -63,7 +62,7 @@ If your device does not appear in the list, make sure you are using a USB data c
6362
- The Home Assistant Glow is now connected to your network.
6463
6. Congratulations 🎉 You have successfully installed the firmware on your Home Assistant Glow.
6564

66-
<EspInstallButton unsupportedMessage="Provisioning via USB only works in browsers which support Web Serial, such as Chrome or Edge." />
65+
<ESPHomeButton />
6766
</TabItem>
6867
</Tabs>
6968

@@ -130,6 +129,10 @@ Congratulations 🎉 You have gone successfully through everything to get starte
130129

131130
Affiliate links are used on this website to support the Home Assistant Glow 🌟 project. Some Ad-blockers might block these links, and thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.
132131

132+
:::note
133+
This page contains content derived from the [Upsy Desky documentation](https://upsy-desky.tjhorner.dev/) by [TJ Horner](https://github.com/tjhorner). The derived content is licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en).
134+
:::
135+
133136
{/* Hardware */}
134137
[esp32-bg-shop]: https://www.banggood.com/bang/?tt=16956_12_417111_&r=https%3A%2F%2Fnl.banggood.com%2FGeekcreit-ESP32-WiFi%2Bbluetooth-Development-Board-Ultra-Low-Power-Consumption-Dual-Cores-Pins-Unsoldered-p-1214159.html
135138
[esp32-ali-shop]: https://tc.tradetracker.net/?c=15640&m=12&a=417111&r=&u=https%3A%2F%2Faliexpress.com%2Fitem%2F1005005970816555.html

0 commit comments

Comments
 (0)