ci: release with release-please

.github/workflows/release.yml

@@ -1,14 +1,29 @@
-name: Publish to PyPI
+name: Release
 
+# Publish from the release-please run
 on:
   push:
-    tags: ['v[0-9]*.[0-9]*.[0-9]*']   # bumpversion tags, e.g. v2.6.0
+    branches: [master]
 
 permissions:
   contents: read
 
 jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write          # autorelease: pending/tagged labels on the Release PR
+      pull-requests: write
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+
   tests:
+    needs: release-please
+    if: needs.release-please.outputs.release_created == 'true'
     uses: ./.github/workflows/tests.yml
 
   build:

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.5.8"
+}

CHANGELOG.md

@@ -0,0 +1,225 @@
+# Changelog
+
+## [2.5.8](https://github.com/blebox/blebox_uniapi/compare/v2.5.7...v2.5.8) (2026-10-01)
+
+### Features
+
+* support tankSensor ([#204](https://github.com/blebox/blebox_uniapi/issues/204)) ([2f93dac](https://github.com/blebox/blebox_uniapi/commit/2f93dac7ad020cd504921e7f5c710e6a4549ed21))
+
+### Bug Fixes
+
+* query both info endpoints in OTA check ([#203](https://github.com/blebox/blebox_uniapi/issues/203)) ([a6683c4](https://github.com/blebox/blebox_uniapi/commit/a6683c4cf92e932278d2ed653bae05bc9b56230b))
+
+## [2.5.7](https://github.com/blebox/blebox_uniapi/compare/v2.5.6...v2.5.7) (2026-08-12)
+
+### Bug Fixes
+
+* handle sensor state and thermoBox safety off ([#202](https://github.com/blebox/blebox_uniapi/issues/202)) ([1321ce5](https://github.com/blebox/blebox_uniapi/commit/1321ce505fa3864276a5408ab6b30e8c6d45e9fa))
+
+## [2.5.6](https://github.com/blebox/blebox_uniapi/compare/v2.5.5...v2.5.6) (2026-08-06)
+
+### Features
+
+* expose gateBox extra button output as a button entity ([#201](https://github.com/blebox/blebox_uniapi/issues/201)) ([eb72cb4](https://github.com/blebox/blebox_uniapi/commit/eb72cb434eb132a18cf1c365ae5fc129640ad5f7))
+* expose product on Box for HASS device model display ([#200](https://github.com/blebox/blebox_uniapi/issues/200)) ([7ff36de](https://github.com/blebox/blebox_uniapi/commit/7ff36deb0eaf60c69171716fba6309a40986ddcd))
+
+### Bug Fixes
+
+* log caught API-call exceptions at debug instead of error ([#198](https://github.com/blebox/blebox_uniapi/issues/198)) ([f25183e](https://github.com/blebox/blebox_uniapi/commit/f25183e83db0a7ac8773861c588c5b64fca88e2c))
+
+## [2.5.5](https://github.com/blebox/blebox_uniapi/compare/v2.5.4...v2.5.5) (2026-06-09)
+
+### Features
+
+* add support for CO2Sensor ([#195](https://github.com/blebox/blebox_uniapi/issues/195)) ([ac05dfc](https://github.com/blebox/blebox_uniapi/commit/ac05dfc05c62fcc8c5b29df1015195bab03da428))
+* add voltage measurement support for switchBox ([#194](https://github.com/blebox/blebox_uniapi/issues/194)) ([964adf6](https://github.com/blebox/blebox_uniapi/commit/964adf632424807e2d40cc3128fa79d6e8e6050b))
+* add is_calibrated property to Shutter and is_slider guard ([#193](https://github.com/blebox/blebox_uniapi/issues/193)) ([5f0be49](https://github.com/blebox/blebox_uniapi/commit/5f0be498f94ce7db49f3ba03b47fb2a7b88376f4))
+* add reactive energy sensors for energyMeter ([#192](https://github.com/blebox/blebox_uniapi/issues/192)) ([19de0f5](https://github.com/blebox/blebox_uniapi/commit/19de0f5786b0e9a6696415dd606cf89be4d68396))
+
+## [2.5.4](https://github.com/blebox/blebox_uniapi/compare/v2.5.3...v2.5.4) (2026-05-25)
+
+### Features
+
+* add OTA firmware update support via Update feature ([#191](https://github.com/blebox/blebox_uniapi/issues/191)) ([b3bfbf6](https://github.com/blebox/blebox_uniapi/commit/b3bfbf671335443294691ce72b719b57196b534d))
+* add new ShutterBox control types and tilt properties ([#190](https://github.com/blebox/blebox_uniapi/issues/190)) ([a977239](https://github.com/blebox/blebox_uniapi/commit/a977239fbe233c880110b66dc58cb0cd75568fa6))
+* add temperature sensors to thermoBox ([#189](https://github.com/blebox/blebox_uniapi/issues/189)) ([775510e](https://github.com/blebox/blebox_uniapi/commit/775510ec628994a4be8725bcf33a167da31e68f6))
+
+### Bug Fixes
+
+* RGBWW brightness and channel ordering ([#188](https://github.com/blebox/blebox_uniapi/issues/188)) ([02251d9](https://github.com/blebox/blebox_uniapi/commit/02251d944fca3991a341bcd1fdcffdfda60435ff))
+* color mode logic to restore last color value correctly ([#187](https://github.com/blebox/blebox_uniapi/issues/187)) ([dfbf3bd](https://github.com/blebox/blebox_uniapi/commit/dfbf3bd79c4bc8a0629cb48af2ec75a428ce0fd3))
+* add sensor_id and name parameters to Open and Input binary sensor classes ([#186](https://github.com/blebox/blebox_uniapi/issues/186)) ([1c308d9](https://github.com/blebox/blebox_uniapi/commit/1c308d9263534efc12c2acc17f745ff6b125e45f))
+
+## [2.5.3](https://github.com/blebox/blebox_uniapi/compare/v2.5.2...v2.5.3) (2026-05-08)
+
+### Features
+
+* add support for openSensor as both generic and binary sensor ([#184](https://github.com/blebox/blebox_uniapi/issues/184)) ([a4e0a64](https://github.com/blebox/blebox_uniapi/commit/a4e0a6437b1baecdfb6fb750166fd5861180c4a5))
+* add index and name properties to sensors, switches and lights ([#185](https://github.com/blebox/blebox_uniapi/issues/185)) ([20faf7a](https://github.com/blebox/blebox_uniapi/commit/20faf7ad60600b3ff34af90a2bf1f21ed0163155))
+* add support for inputSensor ([#183](https://github.com/blebox/blebox_uniapi/issues/183)) ([cb08d4a](https://github.com/blebox/blebox_uniapi/commit/cb08d4a8cf19df1d47d886b6f486975133d910e3))
+
+### Bug Fixes
+
+* ensure sensible_on_value returns list for MONO mode ([#182](https://github.com/blebox/blebox_uniapi/issues/182)) ([bc3a78c](https://github.com/blebox/blebox_uniapi/commit/bc3a78ce11e7dad475b3be8b563757911fdfb8c2))
+
+## [2.5.2](https://github.com/blebox/blebox_uniapi/compare/v2.5.1...v2.5.2) (2026-04-24)
+
+### Features
+
+* add is_position_inverted to expose position convention per device type ([#181](https://github.com/blebox/blebox_uniapi/issues/181)) ([be63c03](https://github.com/blebox/blebox_uniapi/commit/be63c035388d240867d1d94a3109974f0e5ab951))
+
+## 2.5.1 (2026-04-21)
+
+* fix: multisensor current and energy sensor scales
+
+## 2.5.0 (2024-08-20)
+
+* feature: expose sensor_id in sensors and alias in all features by @swistakm in https://github.com/blebox/blebox_uniapi/pull/176
+
+## 2.4.2 (2024-06-04)
+
+* fix: add missing support for active power sensors on switchbox/switchboxd devices by @swistakm in https://github.com/blebox/blebox_uniapi/pull/175
+
+## 2.4.1 (2024-06-04)
+
+* fix: rectify ambiguity around powerConsumption and wind sensor types
+
+## 2.4.0 (2024-06-03)
+
+* Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163
+* Order in BOX_TYPES by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/164
+* Feature: smart meter by @swistakm in https://github.com/blebox/blebox_uniapi/pull/168
+* Smartmeter by @pvsti in https://github.com/blebox/blebox_uniapi/pull/170
+* fix: resolve regressions in cover and climate due to jmespath introduction by @swistakm in https://github.com/blebox/blebox_uniapi/pull/173
+
+## 2.3.0 (2024-03-13)
+
+* feat: add new methods to cover feature enabling handling of tilt open/close actions by @swistakm in https://github.com/blebox/blebox_uniapi/pull/154
+* add support for flood sensing for multisensors as binary moisture sensor by @swistakm in https://github.com/blebox/blebox_uniapi/pull/153
+* feat/fix: Add Ruff and Pre-commit Configuration, Resolve Undefined Name by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/158
+* gatebox and shutterbox improvements: by @swistakm in https://github.com/blebox/blebox_uniapi/pull/156
+* BleBox Multisensor Illuminance Integration by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/161
+
+## 2.2.2 (2024-02-07)
+
+* fixed wind reading units to get proper raw m/s value (division by 10, see PR #150)
+
+## 2.2.1 (2024-01-26)
+
+* fixed support for power measurement capabilities of switchBox and switchBoxD devices
+
+## 2.2.0 (2023-08-29)
+
+* added last_reset to energy sensor class
+* added BasicAuth support to http client
+
+## 2.1.4 (2023-01-03)
+
+* added tilt position support for `cover.Shutter`
+* added `Wind` for wind sensor of multisensors
+* added `Energy` sensor class for power consumption tracking
+* implementing `default_api_level` for
+  * dimmerBox
+  * wLightBox
+  * wLightBoxS
+
+## 2.1.3 (2022-10-27)
+
+* thermoBox boost mode doesn't corrupt state
+
+## 2.1.2 (2022-10-17)
+
+* fixed CCT, CCTx2 modes for wLightBox v1 & v2
+
+## 2.1.1 (2022-10-11)
+
+* added support for thermoBox devices:
+  * added thermoBox config to `BOX_TYPE_CONFIG`
+  * `Climate` uses factory method implementation
+  * added test coverage
+
+## 2.1.0 (2022-08-05)
+
+* added support for multiSensor API:
+  * `airQuality` moved to sensor module
+  * new binary_sensor module, introducing `Rain` class
+
+## 2.0.2 (2022-07-06)
+
+* added `query_string` property in `Button` class
+* fixed test assertions after changes in error raised ValueError
+
+## 2.0.1 (2022-06-01)
+
+* used `ValueError` type instead of `BadOnValueError` in methods:
+  * evaluate_brightness_from_rgb
+  * apply_brightness
+  * normalise_elements_of_rgb
+  * _set_last_on_value
+  * async_on
+
+## 2.0.0 (2022-06-21)
+
+* extended support for color modes in wLightBox devices
+* initial support for tvLiftBox device
+* major backward-incompatible architectural changes to enable dynamic configuration of devices
+* removed products.py module and replaced with factory method on Box class
+* general overhaul of public interfaces
+
+## 1.3.3 (2021-05-12)
+
+* fix support for wLightBoxS with wLightBox API
+* fix state detection in gateBox
+
+## 1.3.2 (2020-04-2)
+
+* use proper module-level logger by default
+* fix formatting
+
+## 1.3.1 (2020-04-2)
+
+* never skip command requests
+* improve error messages
+
+## 1.2.0 (2020-03-30)
+
+* expose device info
+* always add ip/port in connection errors
+* fixed gateController support
+* support for sauna min/max temp
+
+## 1.1.0 (2020-03-24)
+
+* fix bad wLightBox API path
+* wrap api calls in semaphore (to serialize reqests to each box)
+* throttle updates to 2/second (to avoid unnecessary requests)
+* rework error handling and hierarchy (for cleaner usage)
+* use actual device name (to help recognize the device)
+* handle asyncio.TimeoutError (to handle timeout-related errors nicely)
+* properly re-raise exceptions (to avoid lengthy call stacktraces)
+* rename wLightBoxS feature to "brightness"
+
+## 1.1.0 (2020-03-24)
+
+* fix switchBox support
+* fix minimum position handling
+* drop Python 3.6 support (still may work)
+* misc fixes, cleanup and increased test coverage
+
+## 1.0.0 (2020-03-24)
+
+* Fixed wLightBox issues
+* Fixed wLightBoxS issues
+* Fixed shutterBox issues
+* Handle unknown shutterBox position
+* Improved error handling + lots of new diagnostics
+* Increased tests and test coverage (almost 100%)
+* Lots of rework
+
+## 0.1.1 (2020-03-15)
+
+* Fixed switchBox support (newer API versions)
+
+## 0.1.0 (2020-03-10)
+
+* First release on PyPI.

CONTRIBUTING.rst

@@ -101,10 +101,14 @@ Before you submit a pull request, check that it meets these guidelines:
 1. The pull request should include tests.
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/gadgetmobile/blebox_uniapi/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+   feature to the list in README.md.
+3. The pull request should work for Python 3.9, 3.10 and 3.11.
+4. The title follows `Conventional Commits`_: ``fix:`` (patch), ``feat:``
+   (minor), ``feat!:`` (major). It becomes the CHANGELOG.md entry. Titles
+   without these prefixes (``docs:``, ``chore:``, ``ci:``, ...) or with no
+   prefix are left out of the changelog.
+
+.. _Conventional Commits: https://www.conventionalcommits.org/
 
 Tips
 ----
@@ -117,16 +121,8 @@ $ pytest tests.test_blebox_uniapi
 Deploying
 ---------
 
-A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
-Then run::
-
-$ bump2version patch # possible: major / minor / patch
-$ git push --follow-tags
-
-bump2version bumps the version in setup.py, blebox_uniapi/__init__.py and
-setup.cfg, commits the change and creates a matching git tag (e.g. v2.6.0).
-Pushing the tag triggers the "Publish to PyPI" GitHub Actions workflow
-(.github/workflows/release.yml), which first runs lint + tests, then builds and
-uploads to PyPI via Trusted Publishing (OIDC) from the blebox/blebox_uniapi repo.
-The publish step only runs if the tests pass.
+Squash-merge pull requests, fixing the title in the commit message if needed.
+release-please keeps an open "chore(master): release X.Y.Z" pull request with
+the version bump and CHANGELOG.md entry. Merging it creates the tag and GitHub
+release, runs the tests and publishes to PyPI. Pushing a tag by hand releases
+nothing.