Merge pull request #126 from oischinger/hacs

HACS Support & release pipeline

.github/workflows/release.yaml

@@ -0,0 +1,31 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release:
+    name: Prepare release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Pack the HACS dir as a zip and upload to the release
+      - name: ZIP vicare Dir
+        run: |
+          cd /home/runner/work/vicare/vicare/custom_components/vicare
+          zip vicare.zip -r ./
+
+      - name: Upload zip to release
+        uses: svenstaro/upload-release-action@v1-release
+
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: /home/runner/work/vicare/vicare/custom_components/vicare/vicare.zip
+          asset_name: vicare.zip
+          tag: ${{ github.ref }}
+          overwrite: true
+          prerelease: true

.pre-commit-config.yaml

@@ -66,10 +66,6 @@ repos:
           - --branch=dev
           - --branch=master
           - --branch=rc
-  - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.28.0
-    hooks:
-      - id: yamllint
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v2.7.1
     hooks:

README.md

@@ -1,11 +1,45 @@
-# Home Assistant ViCare component
+# Unofficial Home Assistant custom component for Viessmann ViCare API
 
-Home Assistant component for Viessmann Vitodata service.
+[![GitHub contributors](https://img.shields.io/github/contributors/oischinger/ha_vicare)](https://github.com/thebino/rki_covid/graphs/contributors)
+![Version](https://img.shields.io/github/v/release/oischinger/ha_vicare)
+[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
 
-**This custom component contains some experimental commits. Please use the official integration if you're not interested in those**
+The `rki_covid` component is a Home Assistant custom component for monitoring and controlling [Viessmann](https://www.viessmann.family) devices through their cloud-based [ViCare API](https://developer.viessmann.com/start.html).
 
-Official integration into Home Assistant is documented here: [here](https://www.home-assistant.io/integrations/vicare)
+⚠️ **This custom component contains some experimental commits. Use at your own risk**
+
+Please check out the [Official Home Assistant ViCare integration](https://www.home-assistant.io/integrations/vicare) before installing this custom component.
+
+## Why an unofficial integration?
+
+This repo is used for early development purposes and may contain some changes that are not (yet) contributed to Home Assistant Core.
+
+## Installation
+
+### Install with HACS (recommended)
+
+1. Ensure that [HACS](https://community.home-assistant.io/t/custom-component-hacs) is installed.
+2. Search for and install the "ViCare" integration.
+3. Configure the `vicare` integration.
+4. Restart Home Assistant.
+
+#### Install manually
+
+1. Download the [latest release](https://github.com/oischinger/ha_vicare/releases/latest).
+2. Unpack the release and copy the `custom_components/vicare` directory
+   into the `<config dir>/custom_components` directory of your Home Assistant installation.
+3. Configure the `vicare` sensor.
+4. Restart Home Assistant.
+
+## Configuration
+
+#### User interface
+
+Open the `Configuration` of your Home-Assistant instance and select `Integrations`.
+Add a new integration, search and select `vicare`.
+A dialog appears to enter your [ViCare API](https://developer.viessmann.com/start.html) credentials. Please see the documentation of the [official Home Assistant ViCare integration](https://www.home-assistant.io/integrations/vicare) for further details.
 
 ## Links/Credits:
-* [Original feature request in HA community](https://community.home-assistant.io/t/viessmann-component/77873)
-* [PyViCare](https://github.com/somm15/PyViCare) Python API for accessing the ViCare API used by this project 
+
+- [Original feature request in HA community](https://community.home-assistant.io/t/viessmann-component/77873)
+- [PyViCare](https://github.com/somm15/PyViCare) Python API for accessing the ViCare API used by this project

hacs.json

@@ -0,0 +1,8 @@
+{
+  "name": "ViCare",
+  "zip_release": true,
+  "filename": "vicare.zip",
+  "homeassistant": "2023.3.6",
+  "iot_class": "Cloud Polling",
+  "render_readme": true
+}