Skip to content

Commit

Permalink
Updated README and added info.md for HACS
Browse files Browse the repository at this point in the history
  • Loading branch information
erikkastelec committed Feb 18, 2021
1 parent 5db4846 commit f6fa63f
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 8 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
[![buy me a coffee](https://img.shields.io/badge/If%20you%20like%20it-Buy%20me%20a%20coffee-yellow.svg?style=for-the-badge)](https://www.buymeacoffee.com/erikkastelec)
[![License](https://img.shields.io/github/license/toreamun/amshan-homeassistant?style=for-the-badge)](LICENSE)

# hass-WEM-Portal

Custom component for retrieving sensor information from Weishaupt WEM Portal.
Component uses webscraping to get all the sensor data from the Weishaupt WEM Portal (Expert view) and makes it available in [Home Assistant](https://home-assistant.io/).
<!--[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)-->
Component uses webscraping to get all the sensor data from the Weishaupt WEM Portal (Expert view) and makes it available
in [Home Assistant](https://home-assistant.io/).

## Installation

### HACS (preferred method)

- In [HACS](https://github.com/hacs/default) Store search for erikkastelec/hass-WEM-Portal and install it
- Activate the component by adding configuration into your `configuration.yaml` file.

## Manual installation
Create a directory called `wemportaal` in the `<config directory>/custom_components/` directory on your Home Assistant instance. Install this component by copying all files in `/custom_components/wemportal/` folder from this repo into the new `<config directory>/custom_components/wemportal/` directory you just created.
### Manual install

Create a directory called `wemportal` in the `<config directory>/custom_components/` directory on your Home Assistant
instance. Install this component by copying all files in `/custom_components/wemportal/` folder from this repo into the
new `<config directory>/custom_components/wemportal/` directory you just created.

This is how your custom_components directory should look like:

Expand All @@ -19,7 +33,6 @@ custom_components
│ └── wemportalapi.py
```


## Configuration
Entities specified under resources are added to home-assistant.
Make sure to copy the exact name of the entity from the config example below, as some of them are misspelled (they are also misspelled on the Weishaupt WEM Portal).
Expand Down Expand Up @@ -103,4 +116,4 @@ logger:
default: warn
logs:
custom_components.wemportal: debug
```
```
2 changes: 1 addition & 1 deletion custom_components/wemportal/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"documentation": "https://github.com/erikkastelec/hass-WEM-Portal",
"issue_tracker": "https://github.com/erikkastelec/hass-WEM-Portal/issues",
"dependencies": [],
"version": "1.0.0",
"version": "1.0.1",
"codeowners": [
"@erikkastelec"
],
Expand Down
1 change: 0 additions & 1 deletion hacs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"name": "Weishaupt WEM Portal",
"render_readme": "true",
"domains": [
"sensor"
],
Expand Down
98 changes: 98 additions & 0 deletions info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# hass-WEM-Portal

[![buy me a coffee](https://img.shields.io/badge/If%20you%20like%20it-Buy%20me%20a%20coffee-yellow.svg?style=for-the-badge)](https://www.buymeacoffee.com/erikkastelec)

Custom component for retrieving sensor information from Weishaupt WEM Portal.
Component uses webscraping to get all the sensor data from the Weishaupt WEM Portal (Expert view) and makes it available
in [Home Assistant](https://home-assistant.io/).

## Configuration

Entities specified under resources are added to home-assistant.
Make sure to copy the exact name of the entity from the config example below, as some of them are misspelled (they are
also misspelled on the Weishaupt WEM Portal).

Configuration variables:

- `username`: Email address used for login into WEM Portal
- `password`: : Email address used for login into WEM Portal
- `scan_interval (Optional)`: Defines update frequency. Optional and in seconds (defaults to 15 min, minimum value is 5
min).
- `resources`: list of entities, which will be added to home-assistant

Add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
sensor:
- platform: wemportal
#scan_interval: 900
username: your_username
password: your_password
resources:
- heating_circuit_1-outside_temperature
- heating_circuit_1-long_term_outside
- heating_circuit_1-room_temperature
- heating_circuit_1-flow_set_temperature
- heating_circuit_1-flow_temperature
- heating_circuit_1-version_R130
- heating_circuit_2-outside_temperature
- heating_circuit_2-outside_average
- heating_circuit_2-long_term_outside
- heating_circuit_2-room_setpoint
- heating_circuit_2-flow_temperature
- heating_circuit_2-pump
- heating_circuit_2-flow_set_temperature
- heating_circuit_2-version_WWP-EM-HK
- heat_pump-hot_water_temperature
- heat_pump-power_requirement
- heat_pump-dynamic_switching
- heat_pump-LWT
- heat_pump-return_temperature
- heat_pump-pump_speed
- heat_pump-volume_flow
- heat_pump-change_valve
- heat_pump-version_WWP-SG
- heat_pump-version_CPU
- heat_pump-set_frequency_compressor
- heat_pump-frequency_compressor
- heat_pump-outside_OAT
- heat_pump-heat_exchanger_ODU_entry
- heat_pump-OMT
- heat_pump-outside_CTT
- heat_pump-hydraulic_unit_ICT
- heat_pump-hydraulic_unit_IRT
- heat_pump-operating_hours_compresso
- heat_pump-switchings_compressor
- heat_pump-switching_defrost
- heat_pump-variant
- 2.WEZ-EP_1
- 2.WEZ-EP_2
- 2.WEZ-operating_hours_E1
- 2.WEZ-operating_hours_E2
- 2.WEZ-switchings_E1
- 2.WEZ-switching_E2
- statistics-consuption_day
- statistics-consuption_months
- statistics-consuption_year
- statistics-heat_consuption_day
- statistics-heat_consuption_month
- statistics-heat_consuption_year
- statistics-hot_water_consuption_day
- statistics-hot_water_consuption_mont
- statistics-hot_water_consuption_year
- statistics-cool_consuption_day
- statistics-cool_consuption_month
- statistics-cool_consuption_year
```
## Troubleshooting
Please set your logging for the custom_component to debug:
```yaml
logger:
default: warn
logs:
custom_components.wemportal: debug
```

0 comments on commit f6fa63f

Please sign in to comment.