Skip to content

Commit 35baf81

Browse files
committed
Release v2.0.0: Rename domain from stagg_ekg to fellow
BREAKING CHANGES: - Renamed integration domain from 'stagg_ekg' to 'fellow' - All entity IDs have changed (e.g., water_heater.stagg_ekg_kettle → water_heater.fellow_kettle) - Directory renamed: custom_components/stagg_ekg/ → custom_components/fellow/ Changes: - Updated manifest.json domain and version to 2.0.0 - Fixed manifest key ordering (domain, name, then alphabetical) - Updated all documentation with new entity IDs - Updated README.md, INSTALLATION.md, CONTRIBUTING.md - Updated CHANGELOG.md with migration instructions - Aligns with Home Assistant brands repository entry for 'fellow' Migration required: Users must remove old integration and reinstall
1 parent 741c5fc commit 35baf81

17 files changed

Lines changed: 80 additions & 49 deletions

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,37 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [2.0.0] - 2026-01-03
6+
7+
### Breaking Changes
8+
- **Domain renamed from `stagg_ekg` to `fellow`** to match Home Assistant brands repository and support all Fellow EKG models
9+
- **Entity IDs have changed**:
10+
- `water_heater.stagg_ekg_kettle``water_heater.fellow_kettle`
11+
- `sensor.stagg_ekg_current_temperature``sensor.fellow_current_temperature`
12+
- `sensor.stagg_ekg_target_temperature``sensor.fellow_target_temperature`
13+
- `sensor.stagg_ekg_mode``sensor.fellow_mode`
14+
- `switch.stagg_ekg_heating``switch.fellow_heating`
15+
- `switch.stagg_ekg_warming``switch.fellow_warming`
16+
- `binary_sensor.stagg_ekg_power``binary_sensor.fellow_power`
17+
- `binary_sensor.stagg_ekg_low_water_warning``binary_sensor.fellow_low_water_warning`
18+
- **Directory renamed**: `custom_components/stagg_ekg/``custom_components/fellow/`
19+
20+
### Migration Instructions
21+
1. Remove the old integration from Home Assistant (Settings → Devices & Services)
22+
2. Delete the `custom_components/stagg_ekg` folder
23+
3. Install v2.0.0 with the new `custom_components/fellow` folder
24+
4. Re-add the integration
25+
5. Update all automations, scripts, and dashboard cards to use new entity IDs
26+
27+
### Added
28+
- Added `issue_tracker` to manifest.json for better HACS compliance
29+
- GitHub Actions for HACS and Hassfest validation
30+
31+
### Fixed
32+
- Fixed HACS validation errors (removed invalid keys from hacs.json)
33+
- Fixed manifest key ordering to meet Home Assistant requirements
34+
- Integration now aligns with Home Assistant brands repository entry
35+
536
## [1.0.0] - 2025-12-27
637

738
### Added

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you find a bug or have a feature request:
1414
- Steps to reproduce (for bugs)
1515
- Expected vs actual behavior
1616
- Your Home Assistant version
17-
- Kettle firmware version (from `stagg_ekg_api.py` or integration logs)
17+
- Kettle firmware version (from `fellow_api.py` or integration logs)
1818
- Relevant logs or error messages
1919

2020
### Submitting Code
@@ -56,7 +56,7 @@ If you add features, please update:
5656
## Development Setup
5757

5858
1. Clone the repository
59-
2. Copy `custom_components/stagg_ekg` to your HA config
59+
2. Copy `custom_components/fellow` to your HA config
6060
3. Restart Home Assistant
6161
4. Add the integration with your kettle's IP
6262

@@ -66,4 +66,4 @@ Feel free to open an issue for questions or discussions.
6666

6767
## License
6868

69-
By contributing, you agree that your contributions will be licensed under the MIT License.
69+
By contributing, you agree that your contributions will be licensed under the Unlicense.

INSTALLATION.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
```bash
77
cd /config # Your Home Assistant config directory
88
mkdir -p custom_components
9-
cp -r /path/to/custom_components/stagg_ekg custom_components/
9+
cp -r /path/to/custom_components/fellow custom_components/
1010
```
1111

1212
2. **Restart Home Assistant**
@@ -67,12 +67,12 @@ You can change the unit later:
6767
After setup, you should see:
6868

6969
**Entities Created:**
70-
- `water_heater.stagg_ekg_kettle` - Main control
71-
- `sensor.stagg_ekg_current_temperature` - Current temp
72-
- `sensor.stagg_ekg_target_temperature` - Target temp
73-
- `sensor.stagg_ekg_mode` - Kettle mode
74-
- `switch.stagg_ekg_heating` - Heating control
75-
- `switch.stagg_ekg_warming` - Warming control
70+
- `water_heater.fellow_kettle` - Main control
71+
- `sensor.fellow_current_temperature` - Current temp
72+
- `sensor.fellow_target_temperature` - Target temp
73+
- `sensor.fellow_mode` - Kettle mode
74+
- `switch.fellow_heating` - Heating control
75+
- `switch.fellow_warming` - Warming control
7676

7777
## Troubleshooting
7878

@@ -86,7 +86,7 @@ After setup, you should see:
8686
### Entities not showing up
8787
1. Check the Home Assistant logs
8888
2. Go to Settings → System → Logs
89-
3. Search for "stagg_ekg"
89+
3. Search for "fellow"
9090
4. Look for error messages
9191

9292
### Temperature unit not changing
@@ -99,7 +99,7 @@ After setup, you should see:
9999

100100
### Custom Polling Interval
101101

102-
Edit `custom_components/stagg_ekg/__init__.py`:
102+
Edit `custom_components/fellow/__init__.py`:
103103

104104
```python
105105
# Change this line (default is 30 seconds)
@@ -114,7 +114,7 @@ Add to `configuration.yaml`:
114114
logger:
115115
default: info
116116
logs:
117-
custom_components.stagg_ekg: debug
117+
custom_components.fellow: debug
118118
```
119119
120120
## Uninstalling
@@ -123,7 +123,7 @@ logger:
123123
2. Find "Stagg EKG+"
124124
3. Click the three dots menu
125125
4. Select "Delete"
126-
5. Optionally, delete the `custom_components/stagg_ekg` folder
126+
5. Optionally, delete the `custom_components/fellow` folder
127127
6. Restart Home Assistant
128128

129129
## Support

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ Works with all Fellow kettles that have the HTTP CLI interface.
4545

4646
| Entity | Type | Purpose |
4747
|--------|------|---------|
48-
| `water_heater.stagg_ekg_kettle` | Water Heater | Main control interface |
49-
| `sensor.stagg_ekg_current_temperature` | Sensor | Real-time water temperature |
50-
| `sensor.stagg_ekg_target_temperature` | Sensor | Target temperature setting |
51-
| `sensor.stagg_ekg_mode` | Sensor | Operating mode (Off, Heat, Standby) |
52-
| `switch.stagg_ekg_heating` | Switch | Heating element control |
53-
| `switch.stagg_ekg_warming` | Switch | Warming mode control |
54-
| `binary_sensor.stagg_ekg_power` | Binary Sensor | Power on/off status |
55-
| `binary_sensor.stagg_ekg_low_water_warning` | Binary Sensor | Water detection alert |
48+
| `water_heater.fellow_kettle` | Water Heater | Main control interface |
49+
| `sensor.fellow_current_temperature` | Sensor | Real-time water temperature |
50+
| `sensor.fellow_target_temperature` | Sensor | Target temperature setting |
51+
| `sensor.fellow_mode` | Sensor | Operating mode (Off, Heat, Standby) |
52+
| `switch.fellow_heating` | Switch | Heating element control |
53+
| `switch.fellow_warming` | Switch | Warming mode control |
54+
| `binary_sensor.fellow_power` | Binary Sensor | Power on/off status |
55+
| `binary_sensor.fellow_low_water_warning` | Binary Sensor | Water detection alert |
5656

5757
## Installation
5858

@@ -75,7 +75,7 @@ Works with all Fellow kettles that have the HTTP CLI interface.
7575

7676
### Manual Installation
7777

78-
1. Download the `custom_components/stagg_ekg` folder
78+
1. Download the `custom_components/fellow` folder
7979
2. Copy it to your Home Assistant `config/custom_components/` directory
8080
3. Restart Home Assistant
8181
4. Add the integration via Settings → Devices & Services
@@ -122,7 +122,7 @@ The integration will sync the temperature unit with your kettle's LCD display.
122122
# Heat water to 95°C
123123
service: water_heater.turn_on
124124
target:
125-
entity_id: water_heater.stagg_ekg_kettle
125+
entity_id: water_heater.fellow_kettle
126126
data:
127127
temperature: 95
128128
```
@@ -139,17 +139,17 @@ automation:
139139
condition:
140140
# Only if water detected
141141
- condition: state
142-
entity_id: binary_sensor.stagg_ekg_low_water_warning
142+
entity_id: binary_sensor.fellow_low_water_warning
143143
state: "off"
144144
action:
145145
- service: water_heater.set_temperature
146146
target:
147-
entity_id: water_heater.stagg_ekg_kettle
147+
entity_id: water_heater.fellow_kettle
148148
data:
149149
temperature: 95
150150
- service: water_heater.turn_on
151151
target:
152-
entity_id: water_heater.stagg_ekg_kettle
152+
entity_id: water_heater.fellow_kettle
153153
```
154154
155155
**Water Ready Notification**
@@ -159,11 +159,11 @@ automation:
159159
trigger:
160160
- platform: template
161161
value_template: >
162-
{{ states('sensor.stagg_ekg_current_temperature')|float >=
163-
states.water_heater.stagg_ekg_kettle.attributes.temperature|float - 2 }}
162+
{{ states('sensor.fellow_current_temperature')|float >=
163+
states.water_heater.fellow_kettle.attributes.temperature|float - 2 }}
164164
condition:
165165
- condition: state
166-
entity_id: water_heater.stagg_ekg_kettle
166+
entity_id: water_heater.fellow_kettle
167167
attribute: current_operation
168168
state: "heat"
169169
action:
@@ -181,31 +181,31 @@ script:
181181
sequence:
182182
- service: water_heater.set_temperature
183183
target:
184-
entity_id: water_heater.stagg_ekg_kettle
184+
entity_id: water_heater.fellow_kettle
185185
data:
186186
temperature: 75
187187
- service: water_heater.turn_on
188188
target:
189-
entity_id: water_heater.stagg_ekg_kettle
189+
entity_id: water_heater.fellow_kettle
190190

191191
heat_black_tea:
192192
alias: "Heat for Black Tea"
193193
sequence:
194194
- service: water_heater.set_temperature
195195
target:
196-
entity_id: water_heater.stagg_ekg_kettle
196+
entity_id: water_heater.fellow_kettle
197197
data:
198198
temperature: 95
199199
- service: water_heater.turn_on
200200
target:
201-
entity_id: water_heater.stagg_ekg_kettle
201+
entity_id: water_heater.fellow_kettle
202202
```
203203
204204
### Dashboard Card
205205
206206
```yaml
207207
type: thermostat
208-
entity: water_heater.stagg_ekg_kettle
208+
entity: water_heater.fellow_kettle
209209
name: Coffee Kettle
210210
```
211211
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Control your Fellow Stagg EKG+ electric kettle from Home Assistant!
2121

2222
## Installation
2323

24-
1. Copy the `custom_components/stagg_ekg` folder to your Home Assistant `custom_components` directory
24+
1. Copy the `custom_components/fellow` folder to your Home Assistant `custom_components` directory
2525
2. Restart Home Assistant
2626
3. Go to Configuration > Integrations
2727
4. Click the "+ ADD INTEGRATION" button
@@ -40,7 +40,7 @@ Add a water heater card to your dashboard:
4040

4141
```yaml
4242
type: thermostat
43-
entity: water_heater.stagg_ekg_kettle
43+
entity: water_heater.fellow_kettle
4444
```
4545
4646
### Automation Example
@@ -56,24 +56,24 @@ automation:
5656
action:
5757
- service: water_heater.set_temperature
5858
target:
59-
entity_id: water_heater.stagg_ekg_kettle
59+
entity_id: water_heater.fellow_kettle
6060
data:
6161
temperature: 90
6262
- service: water_heater.turn_on
6363
target:
64-
entity_id: water_heater.stagg_ekg_kettle
64+
entity_id: water_heater.fellow_kettle
6565
```
6666
6767
### Sensors in Lovelace
6868
6969
```yaml
7070
type: entities
7171
entities:
72-
- entity: sensor.stagg_ekg_current_temperature
73-
- entity: sensor.stagg_ekg_target_temperature
74-
- entity: sensor.stagg_ekg_mode
75-
- entity: switch.stagg_ekg_heating
76-
- entity: switch.stagg_ekg_warming
72+
- entity: sensor.fellow_current_temperature
73+
- entity: sensor.fellow_target_temperature
74+
- entity: sensor.fellow_mode
75+
- entity: switch.fellow_heating
76+
- entity: switch.fellow_warming
7777
```
7878
7979
## Troubleshooting
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
"""Constants for the Stagg EKG integration."""
1+
"""Constants for the Fellow integration."""
22

3-
DOMAIN = "stagg_ekg"
3+
DOMAIN = "fellow"
44

55
# Configuration
66
CONF_TEMPERATURE_UNIT = "temperature_unit"

0 commit comments

Comments
 (0)