An open API service indexing awesome lists of open source software.

https://github.com/tefinger/hass-brematic

Custom component for Home Assistant to support Brematic devices
https://github.com/tefinger/hass-brematic

433mhz brematic brennenstuhl custom-component gateway hacktoberfest hass home-assistant intertechno

Last synced: about 2 months ago
JSON representation

Custom component for Home Assistant to support Brematic devices

Awesome Lists containing this project

README

          

![GitHub release](https://img.shields.io/github/release/tefinger/hass-brematic.svg)
![GitHub](https://img.shields.io/github/license/tefinger/hass-brematic.svg)
![Maintenance](https://img.shields.io/maintenance/yes/2099.svg)
![project stage](https://img.shields.io/badge/project%20stage-work%20in%20progress-green.svg)
![GitHub commit activity](https://img.shields.io/github/commit-activity/y/tefinger/hass-brematic.svg)

# Custom component: Brematic
Custom component for Home Assistant to support Brematic devices.

# Supported devices
## Gateways
- Brennenstuhl (*)
- Intertechno
- ConnAir

## Devices
- Brennenstuhl RCS1000N (*)
- Brennenstuhl RCR1000N
- Elro AB440SA
- Intertechno CMR300 (*)
- Intertechno CMR500 (*)
- Intertechno CMR1000 (*)
- Intertechno ITR300
- Intertechno ITR3500
- Intertechno PAR1500

(*) Tested devices

# Installation
There are two ways for installing this custom component. Manually or by using [custom_updater](https://github.com/custom-components/custom_updater).

## Manual installation
- Download this repository to your machine
- Copy the folder `brematic` to `/custom_components/`

## Custom updater
- Make sure you have [custom_updater](https://github.com/custom-components/custom_updater) installed and running
- Add the url for the brematic component to your custom_updater configuration like this:
```yaml
custom_updater:
component_urls:
- https://raw.githubusercontent.com/tefinger/hass-brematic/master/custom_updater.json
```

# Configuration
Add the brematic platform as a `switch` to your `configuration.yaml` file.

```yaml
switch:
- platform: brematic
host: '10.0.3.2'
system_code: '01010'
gateway_type: 'Brennenstuhl'
switches:
power_outlet:
unit_code: '00010'
friendly_name: Power Outlet
floor_lamp:
unit_code: '11111'
unit_type: 'RCS1000N'
smartphone_charger:
unit_code: '010101'
friendly_name: 'Smartphone Camera'
value_template: '{{ is_state("binary_sensor.huawei_is_charging", "on") }}'
```
**Please note:** only `switch` is supported. If you want to control your power outlet as a `light` please refer to the [light switch](https://www.home-assistant.io/components/light.switch/) component.

## Configuration variables

- **host**
  *(string) (Required)* Ip address or hostname of the gateway
- **system_code**
  *(string) (Required)* System code you use for your devices
- **gateway_type**
  *(string) (Optional)* Type of the gateway (`Brennenstuhl`, `Intertechno`)
   default: `Brennenstuhl`
- **switches**
  *(map) (Required)* The array that contains all switches
- **identifier**
  *(map) (Required)* Name of the command switch as slug. Multiple entries are possible.
- **unit_code**
  *(string) (Required)* Unit code of the device
- **unit_type**
  *(string) (Optional)* Type of the unit (`RCS1000N`, `RCR1000N`, `AB440SA`, `CMR300`, `CMR500`, `CMR1000`, `ITR300`, `ITR3500`, `PAR1500`)
   default: `RCS1000N`
- **friendly_name**
  *(string) (Optional)* Friendly name of the device
- **value_template**
  *(string) (Optional)* [Template](https://www.home-assistant.io/docs/configuration/templating/) for assuming switch state

# Authors & contributors
The original setup of this repository is by [Tobias Efinger](https://github.com/tefinger).

For a full list of all authors and contributors, check the [contributor's page](https://github.com/tefinger/hass-brematic/graphs/contributors).

# Credits
Thanks to [d-Rickyy-b](https://github.com/d-Rickyy-b) for the awesome [pyBrematic](https://github.com/d-Rickyy-b/pyBrematic) package which is used in this component.

# License
MIT License

Copyright (c) 2021 Tobias Efinger

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.