Skip to content

Commit d422437

Browse files
committed
Update changelog.md to comply to markdown format
1 parent c9ae866 commit d422437

File tree

1 file changed

+151
-110
lines changed

1 file changed

+151
-110
lines changed

CHANGELOG.md

Lines changed: 151 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,21 @@
88
(## 0.8.4 - Not released: Fix "Gas Consumed Interval stays 0" )
99

1010
## 0.8.2/0.8.3 - Code quality improvements
11-
- Switch Smile to defusedxml from lxml (improving security)
12-
- Lint and flake recommendations fixed
13-
- Project CI changes
14-
- Bug-fix: fix use of major due to change of using semver.VersionInfo.
15-
- Add model-info: to be used in Core to provide a more correct model-name for each device.
16-
- Code improvements and increase in test-coverage.
11+
12+
- Switch Smile to defusedxml from lxml (improving security)
13+
- Lint and flake recommendations fixed
14+
- Project CI changes
15+
- Bug-fix: fix use of major due to change of using semver.VersionInfo.
16+
- Add model-info: to be used in Core to provide a more correct model-name for each device.
17+
- Code improvements and increase in test-coverage.
1718

1819
## 0.8.1 - Standardize logging for stick
1920

2021
## 0.8.0 - Merged Smile/USB module
21-
- Merge of the former network and former USB module to a single python module
22-
- Improved commit/test/CI&CD
23-
- Notifications handling for fixtures
22+
23+
- Merge of the former network and former USB module to a single python module
24+
- Improved commit/test/CI&CD
25+
- Notifications handling for fixtures
2426

2527
---
2628

@@ -33,20 +35,23 @@ Changelogs below this line are separated in the former python-plugwise USB-only
3335
## 2.0.1 - Fixes and optimizations
3436

3537
## 2.0.0 - Support for Scan devices, (un)join of new devices and experimental support for Sense
36-
- [All details](https://github.com/brefra/python-plugwise/releases/tag/2.0.0) in the release tag
38+
39+
- [All details](https://github.com/brefra/python-plugwise/releases/tag/2.0.0) in the release tag
3740

3841
## 1.2.2 - Logging level corrections
3942

4043
## 1.2.1 - Watchdog exception fix
4144

4245
## 1.2.0 - Fixes and changes
43-
- Return power usage even if it's 0
44-
- Callbacks for nodes discovered after initial scan
46+
47+
- Return power usage even if it's 0
48+
- Callbacks for nodes discovered after initial scan
4549

4650
## 1.1.1 - Rewritten connection logic
47-
- Registered node counter
48-
- Improved reliability of node discovery
49-
- Fixed negative power usage
51+
52+
- Registered node counter
53+
- Improved reliability of node discovery
54+
- Fixed negative power usage
5055

5156
## alpha - rewrite to async
5257

@@ -57,127 +62,152 @@ Changelogs below this line are separated in the former python-plugwise USB-only
5762
## formerSmile#1.5.1 - Decrease sensitivity for future updates
5863

5964
## formerSmile#1.5.0 - Add delete_notification service
60-
- Add a service to dismiss/delete the Plugwise Notification(s) from within HA Core (plugwise.delete_notification)
61-
- Improve detection of switch-groups and add group switching for the Stretch
65+
66+
- Add a service to dismiss/delete the Plugwise Notification(s) from within HA Core (plugwise.delete_notification)
67+
- Improve detection of switch-groups and add group switching for the Stretch
6268

6369
## formerSmile#1.4.0 - Stretch and switch-groups
64-
- Improve error handling, add group switching of plugs (Adam).
70+
71+
- Improve error handling, add group switching of plugs (Adam).
6572

6673
## formerSmile#1.3.0 - Only released in alpha/beta
67-
- Initial support for Stretch (v2/v3) including tests
68-
- Force gzip encoding, work-around for aiohttp-error
69-
- Improve P1 DSMR legacy support
70-
- Ensure `gateway_id` is properly defined (i.e. not `None`)
71-
- b4: Use `domain_objects` over `direct_objects` endpoints
72-
- Remove py3x internal modules (as requested per #86)
73-
- CI-handling improvements and both 3.7 and 3.8 testing
74-
- Code cleanup and output formatting improvements
74+
75+
- Initial support for Stretch (v2/v3) including tests
76+
- Force gzip encoding, work-around for aiohttp-error
77+
- Improve P1 DSMR legacy support
78+
- Ensure `gateway_id` is properly defined (i.e. not `None`)
79+
- b4: Use `domain_objects` over `direct_objects` endpoints
80+
- Remove py3x internal modules (as requested per #86)
81+
- CI-handling improvements and both 3.7 and 3.8 testing
82+
- Code cleanup and output formatting improvements
7583

7684
## formerSmile#1.2.2 - Re-fix notifications
7785

7886
## formerSmile#1.2.1 - Fix url display, cleanup and adding tests
7987

8088
## formerSmile#1.2.0 - HA-Core config_flow unique_id fixes
81-
- Fix situation where `unique_id` was set to `None` for legacy P1 DSMRs
82-
- Introduce using the (discovered) hostname as unique_id
89+
90+
- Fix situation where `unique_id` was set to `None` for legacy P1 DSMRs
91+
- Introduce using the (discovered) hostname as unique_id
8392

8493
## formerSmile#1.1.2 - Fix notifications-related bugs
8594

8695
## formerSmile#1.1.0 - Add HA-core test-fixtures, Plugwise notifications and improvement of error-detection
87-
- Add exporter for fixtures to be used by HA-core for testing plugwise
88-
- Improve `error`-detection
89-
- Expose Plugwise System notifications (i.e. warnings or errors visible in the app)
96+
97+
- Add exporter for fixtures to be used by HA-core for testing plugwise
98+
- Improve `error`-detection
99+
- Expose Plugwise System notifications (i.e. warnings or errors visible in the app)
90100

91101
## formerSmile#1.0.0 - Stable release
92-
- Just `black`ened code (Python `black`)
102+
103+
- Just `black`ened code (Python `black`)
93104

94105
## formerSmile#0.2.15 - Code cleanup
95-
- Just code improvements
106+
107+
- Just code improvements
96108

97109
## formerSmile#0.2.14 - Code cleanup
98-
- Just code improvements
110+
111+
- Just code improvements
99112

100113
## formerSmile#0.2.13 - Final legacy fix
101-
- Adjust `dwh` and `setpoint` handling
114+
115+
- Adjust `dwh` and `setpoint` handling
102116

103117
## formerSmile#0.2.12 - Fix available schema's
104-
- Thanks to report from @fsaris
105-
- Adept code to allow for change introducted by firmware 4.x
106-
118+
119+
- Thanks to report from @fsaris
120+
- Adept code to allow for change introducted by firmware 4.x
121+
107122
## formerSmile#0.2.11 - Add community requested sensors
108-
- See [65](https://github.com/plugwise/plugwise-beta/issues/65)
109-
- Add return water temperature from Auxiliary
123+
124+
- See [65](https://github.com/plugwise/plugwise-beta/issues/65)
125+
- Add return water temperature from Auxiliary
110126

111127
## formerSmile#0.2.10 - Core PR updates
112-
- Add exception for InvalidAuthentication
113-
- Revert setting heating when None
128+
129+
- Add exception for InvalidAuthentication
130+
- Revert setting heating when None
114131

115132
## formerSmile#0.2.9 - Use intended state
116-
- Change to `intended_central_heating_state`
133+
134+
- Change to `intended_central_heating_state`
117135

118136
## formerSmile#0.2.8 - Asynchronous HTTP improvement, firmware 4.x testing
119-
- Code improvement for asyncio
120-
- Added firmware 4.x test data and tests
121-
- CI/CD improve pre-commit hooks
122-
- Remove useless water sensor
123-
- Improve testing guidelines README
137+
138+
- Code improvement for asyncio
139+
- Added firmware 4.x test data and tests
140+
- CI/CD improve pre-commit hooks
141+
- Remove useless water sensor
142+
- Improve testing guidelines README
124143

125144
## formerSmile#0.2.7 - CI/CD
126-
- CI/CD Version number handling
145+
146+
- CI/CD Version number handling
127147

128148
## formerSmile#0.2.6 - New firmware support and XML handling
129-
- Improvement by contributor @sbeukers (Smile P1 v4 support)
130-
- Legacy Anna fixes and test improvements
131-
- Favour `domain_objects` over `appliances` XML-data
149+
150+
- Improvement by contributor @sbeukers (Smile P1 v4 support)
151+
- Legacy Anna fixes and test improvements
152+
- Favour `domain_objects` over `appliances` XML-data
132153

133154
## formerSmile#0.2.5 - Issuefix, cleanup and CI/CD
134-
- Fix for HVAC idle issue [#57](https://github.com/plugwise/plugwise-beta/issues/57)
135-
- Improve XML
136-
- Remove debug output
137-
- CI/CD handling
155+
156+
- Fix for HVAC idle issue [#57](https://github.com/plugwise/plugwise-beta/issues/57)
157+
- Improve XML
158+
- Remove debug output
159+
- CI/CD handling
138160

139161
## formerSmile#0.2.4 Legacy Anna fixes and Auxiliary handling
140-
- `chs` and `dhw` determined from `boiler_state`
141-
- No `chs` or `dhw` on legacy Anna
142-
- More legacy anna fixes
162+
163+
- `chs` and `dhw` determined from `boiler_state`
164+
- No `chs` or `dhw` on legacy Anna
165+
- More legacy anna fixes
143166

144167
## formerSmile#0.2.1 - Master thermostat fixes
145-
- Legacy Anna fixes
146-
- Auxiliary tests
147-
- Fix for `smt` (single master thermostat)
148-
- CI/CD Improved testing
149-
- Sensor value rounding
168+
169+
- Legacy Anna fixes
170+
- Auxiliary tests
171+
- Fix for `smt` (single master thermostat)
172+
- CI/CD Improved testing
173+
- Sensor value rounding
150174

151175
## formerSmile#0.2.0 - Second beta release
152-
- Improve sensor names
153-
- Handle `set`-commands in testing
154-
- Code style improvements (lint/black)
176+
177+
- Improve sensor names
178+
- Handle `set`-commands in testing
179+
- Code style improvements (lint/black)
155180

156181
## formerSmile#0.1.26 - Documentation and CI/CD improvements
157-
- Create further testing
158-
- Improve coverage/linting/etc.
159-
- Prepare virtualenvs (travis etc.)
160-
- Code styling/wording fixes (lint/pep)
161-
- Improve READMEs
182+
183+
- Create further testing
184+
- Improve coverage/linting/etc.
185+
- Prepare virtualenvs (travis etc.)
186+
- Code styling/wording fixes (lint/pep)
187+
- Improve READMEs
162188

163189
## formerSmile#0.1.25 - Domestic hot water and CI/CD improvements
164-
- Testing improvements
165-
- `dhw`-handling
190+
191+
- Testing improvements
192+
- `dhw`-handling
166193

167194
## formerSmile#0.1.24 - Add handling erroneous XML and/or timeouts
168-
- Favour exception raises above returning `False`
169-
- Restructure full device update accordingly
170-
- Add Plugwise Exceptions
171-
- CI/CD add tests accordingly
195+
196+
- Favour exception raises above returning `False`
197+
- Restructure full device update accordingly
198+
- Add Plugwise Exceptions
199+
- CI/CD add tests accordingly
172200

173201
## formerSmile#0.1.23 - Code quality improvements
174-
- FutureWarnings acted accordingly
202+
203+
- FutureWarnings acted accordingly
175204

176205
## formerSmile#0.1.22 - Add scheduled temperature in output
177206

178207
## formerSmile#0.1.21 - CI/CD improvements
179-
- Add heatpump-environment data and tests (thanks to @marcelveldt)
180-
- Improve `outdoor_temperature` accordingly (favour Auxiliary over Smile)
208+
209+
- Add heatpump-environment data and tests (thanks to @marcelveldt)
210+
- Improve `outdoor_temperature` accordingly (favour Auxiliary over Smile)
181211

182212
## formerSmile#0.1.20 - Fix thermostat count
183213

@@ -186,17 +216,21 @@ Changelogs below this line are separated in the former python-plugwise USB-only
186216
## formerSmile#0.1.18 - Add flame state
187217

188218
## formerSmile#0.1.17 - Code improvements
189-
- Squash device names
219+
220+
- Squash device names
190221

191222
## formerSmile#0.1.16 - Fix central components
192-
- Version skip to align with `-beta`-component
223+
224+
- Version skip to align with `-beta`-component
193225

194226
## formerSmile#0.1.12 - Introduce heatpump
195-
- Thanks to @marcelveldt and his environment
196-
- Coherent heating/cooling state
197-
227+
228+
- Thanks to @marcelveldt and his environment
229+
- Coherent heating/cooling state
230+
198231
## formerSmile#0.1.11 - Add all options for P1 DSMR
199-
- Thanks to @(tbd) and his environment
232+
233+
- Thanks to @(tbd) and his environment
200234

201235
## formerSmile#0.1.9 - Set HVAC on legacy Anna
202236

@@ -207,23 +241,26 @@ Changelogs below this line are separated in the former python-plugwise USB-only
207241
## formerSmile#0.1.6 - Fix schedules for Legacy Anna's
208242

209243
## formerSmile#0.1.2 - Code improvements and public variables
210-
- More linting
211-
- Cleanup scan_thermostat
212-
- Cleanup unused variables
213-
- Improve/standardize public variables
214-
- Tests updated accordingly
215-
- Version skip to align with `-beta`-component
244+
245+
- More linting
246+
- Cleanup scan_thermostat
247+
- Cleanup unused variables
248+
- Improve/standardize public variables
249+
- Tests updated accordingly
250+
- Version skip to align with `-beta`-component
216251

217252
## formerSmile#0.1.0 - Public beta
218253

219254
## formerSmile#0.0.57 - Review to public beta
220-
- Delete fugly sleeping
221-
- Improve binary sensors
222-
- Update tests accordingly
255+
256+
- Delete fugly sleeping
257+
- Improve binary sensors
258+
- Update tests accordingly
223259

224260
## formerSmile#0.0.56 - Documentation and code improvements
225-
- `black`
226-
- READMEs updated
261+
262+
- `black`
263+
- READMEs updated
227264

228265
## formerSmile#0.0.55 - `dhw` off for legacy Anna
229266

@@ -236,25 +273,29 @@ Changelogs below this line are separated in the former python-plugwise USB-only
236273
## formerSmile#0.0.51 - Add Anna firmware 4.x support
237274

238275
## formerSmile#0.0.43 - Thermostat finding and peak/net P1 DSMR values
239-
- Fix peak values for DSMR
240-
- Calculate net (netto) values
241-
- Thermostat finder
242-
- Add tests accordingly
276+
277+
- Fix peak values for DSMR
278+
- Calculate net (netto) values
279+
- Thermostat finder
280+
- Add tests accordingly
243281

244282
## formerSmile#0.0.40 - Legacy Anna and legacy P1 introduction
245-
- Re-introduce legacy Anna from `haanna`/`anna-ha`
246-
- Add legacy P1 DSMR
247-
- Including tests
283+
284+
- Re-introduce legacy Anna from `haanna`/`anna-ha`
285+
- Add legacy P1 DSMR
286+
- Including tests
248287

249288
## formerSmile#0.0.27 - Prepare for HA config flow and multiple devices
250-
- Add tests and location mapping
251-
- Improve handling Lisa thermostat
252-
- Improve relay (plugs) functionality
253-
- Add individual Smiles as 'hub'-components
289+
290+
- Add tests and location mapping
291+
- Improve handling Lisa thermostat
292+
- Improve relay (plugs) functionality
293+
- Add individual Smiles as 'hub'-components
254294

255295
## formerSmile#0.0.26 - Add relay (plugs) support and tests
256296

257297
## formerSmile#0.0.x - Not individually release but left in [this repo](https://github.com/plugwise/Plugwise-HA)
258298

259299
## formerSmile#x.x.x - Before that commits where made in [haanna](https://github.com/laetificat/haanna)
260-
- After mostly leaving `haanna` as a stale project (where @bouwew didn't have PyPi permissions) development was shortly split between personal repositories from both @bouwew and @CoMPaTech before we decided to fully rewrite - from scratch - it to `Plugwise-HA` which was renamed to `Plugwise_Smile` from 0.0.26 onwards.
300+
301+
- After mostly leaving `haanna` as a stale project (where @bouwew didn't have PyPi permissions) development was shortly split between personal repositories from both @bouwew and @CoMPaTech before we decided to fully rewrite - from scratch - it to `Plugwise-HA` which was renamed to `Plugwise_Smile` from 0.0.26 onwards.

0 commit comments

Comments
 (0)