Skip to content
This repository has been archived by the owner on Feb 2, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dannerph authored Mar 12, 2020
1 parent 92448fc commit 08bd6f6
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Solcast [[Home Assistant](https://www.home-assistant.io/) Component]
This custom component integrates the Solcast API into Home Assistant.

## Basic Installation/Configuration Instructions:
## Basic Installation/Configuration Instructions
Copy content of custom_components to your local custom_components folder and add the following lines to your configuration.

#### Rooftop Site Configuration:
Expand All @@ -14,4 +14,32 @@ Rooftop site configuration variables:
* **api_key**: Your API key from Solcast.
* **resource_id**: The rooftop site resouce_id from Solcast.
<hr>
## Available service calls
```yaml
update_forecast:
description: >
Fetches the forecasts from Solcast.
update_history:
description: >
Fetches historical data from Solcast.
push_measurement:
desciption: >
Pushes PV measurements to Solcast for model fine tuning.
fields:
total_power:
desciption: >
The total power of the PV system for the given period.
example: 1.23456
period:
desciption: >
The period of the total power (e.g. PT5M, PT15M, PT30M, ...)
example: PT5M
period_end:
desciption: >
The end period of the total power in UTC timezone
example: 2018-02-02T03:30:00.0000000Z
```

0 comments on commit 08bd6f6

Please sign in to comment.