Skip to content

Commit

Permalink
Prepare README for Hacs
Browse files Browse the repository at this point in the history
  • Loading branch information
faanskit committed Dec 28, 2023
1 parent 11b7f69 commit da006de
Showing 1 changed file with 1 addition and 34 deletions.
35 changes: 1 addition & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,50 +22,17 @@ The Daily Yield sensor also have an attribute that provides information about to
6. The integration will update the Energy sensors once per minute, the Daily Yield sensor once every fifteenth minute and the Annual Yield around 2 am every morning. This to not put too much stress on the CheckWatt servers (the yield operation is slow resource heavy)

# Installation
### HACS installation - NOT AVAILABLE
The integration will be published on Hacs but is currently not available there.
The process to publish on Hacs includes to provide branding material to Home Assistant developers. This process is started and when branding is approved, the integration will be published on Hacs and the below link will be made functional.

### HACS installation
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=faanskit&repository=ha-checkwatt&category=integration)



### Git installation
1. Make sure you have git installed on your machine.
2. Navigate to you home assistant configuration folder.
3. Create a `custom_components` folder of it does not exist, navigate down into it after creation.
4. Execute the following command: `git clone https://github.com/faanskit/ha-checkwatt.git checkwatt`
5. Restart Home-Assistant.

### Development installation
If you are a developer and want to contribute to this integration we strongly recommend to use the Home Assistant Developer environment.

Currently the process is quite technical, so basic understanding of software development and Linux are expected.

1. Install a HA developer environment: https://developers.home-assistant.io/docs/development_environment/

2. In the terminal (inside the docker container) do this:
```
cd /workspaces/core/config
mkdir custom_components
mkdir software
cd /workspaces/core/config/software/
mkdir ha-checkwatt
mkdir pyCheckwatt
cd /workspaces/core/config/software/pyCheckwatt
git init
git pull https://github.com/faanskit/pyCheckwatt.git
cd /workspaces/core/config/software/ha-checkwatt
git init
git pull https://github.com/faanskit/ha-checkwatt.git
cd /workspaces/core/config/software/ha-checkwatt/custom_components/checkwatt
ln -s ../../../pyCheckwatt/pycheckwatt .
```

## Enable the integration
Go to Settings / Devices & Services / Integrations. Click **+ ADD INTEGRATION**

Expand Down

0 comments on commit da006de

Please sign in to comment.