Skip to content

Commit

Permalink
Update README.md (#55)
Browse files Browse the repository at this point in the history
* Update Readme to better reflect the current state.
* Update dependencies to relative versions
  • Loading branch information
SukramJ authored Nov 25, 2021
1 parent b4b6358 commit f46256f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,18 @@

### This project is still in early development!

`hahomematic` is a Python 3 (>= 3.6) module for [Home Assistant](https://www.home-assistant.io/) to interact with [HomeMatic](https://www.eq-3.com/products/homematic.html) and [homematic IP](https://www.homematic-ip.com/en/start.html) devices. Some other devices (f.ex. Bosch, Intertechno) might be supported as well.

No 3rd party Python dependencies are required.
`hahomematic` is a Python 3 (>= 3.8) module for [Home Assistant](https://www.home-assistant.io/) to interact with [HomeMatic](https://www.eq-3.com/products/homematic.html) and [homematic IP](https://www.homematic-ip.com/en/start.html) devices. Some other devices (f.ex. Bosch, Intertechno) might be supported as well.

This is intended to become the successor of [pyhomematic](https://github.com/danielperna84/pyhomematic).

## Project goal and features

[pyhomematic](https://github.com/danielperna84/pyhomematic) has the requirement to manually add support for devices to make them usable in [Home Assistant](https://www.home-assistant.io/). With `hahomematic` it is planned to automatically create entities for each parameter on each channel on every device (if it supports events). To achieve this, all paramsets (`VALUES`) are fetched (and cached for quick successive startups). Eventually it will expose pretty much __all__ parameters, like [ioBroker](https://www.iobroker.net/) does.
[pyhomematic](https://github.com/danielperna84/pyhomematic) has the requirement to manually add support for devices to make them usable in [Home Assistant](https://www.home-assistant.io/). `hahomematic` automatically create entities for each parameter on each channel on every device (if it not black listed). To achieve this, all paramsets (`VALUES`) are fetched (and cached for quick successive startups).
[Homematic Devices supported by custom entities](https://github.com/danielperna84/hahomematic/wiki/Homematic-Devices-supported-by-custom-entity)

On top of that it will be allowed to add custom device-classes to implement more complex entities (__additionally__ to the auto-generated entities) if it makes sense for a device. Much like the [devicetypes](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) of [pyhomematic](https://github.com/danielperna84/pyhomematic). This will be needed for thermostats, lights, covers etc..
On top of that it is possible to add custom entity-classes to implement more complex entities, if it makes sense for a device. Much like the [devicetypes](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) of [pyhomematic](https://github.com/danielperna84/pyhomematic). This will be needed for thermostats, lights, covers, climate, lock etc..

Helpers for automatic re-connecting after a restart of the CCU are provided as well. How they are used depends on the application that integrates `hahomematic`.
Helpers for automatic re-connecting after a restart of the CCU are provided as well.

## Requirements

Expand All @@ -23,4 +22,4 @@ Due to a bug in previous version of the CCU2 / CCU3, `hahomematic` requires at l
- CCU2: 2.53.27
- CCU3: 3.53.26

More information about this bug can be found here: https://github.com/jens-maus/RaspberryMatic/issues/843. Other CCU-like platforms that leverage the buggy version of the `HmIPServer` aren't supported as well.
More information about this bug can be found here: https://github.com/jens-maus/RaspberryMatic/issues/843. Other CCU-like platforms that leverage the buggy version of the `HmIPServer` aren't supported as well.
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def readme():

PACKAGES = find_packages(exclude=["tests", "tests.*", "dist", "build"])

REQUIRES = ["aiohttp==3.8.0", "voluptuous==0.12.2"]
REQUIRES = ["aiohttp>=3.8.0", "voluptuous>=0.12.2"]

setup(
name=PACKAGE_NAME,
Expand All @@ -29,14 +29,14 @@ def readme():
include_package_data=True,
zip_safe=False,
platforms="any",
python_requires=">=3.6",
python_requires=">=3.8",
install_requires=REQUIRES,
keywords=["home", "assistant", "homematic"],
classifiers=[
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.8",
"Topic :: Home Automation",
],
)

0 comments on commit f46256f

Please sign in to comment.