Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
StephanU committed Nov 21, 2023
1 parent 474a020 commit a2435bf
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 15 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,22 @@ This project is a work in progress. No guarantee to work until 1.0.0
[![hacs][hacsbadge]][hacs]
[![Project Maintenance][maintenance-shield]][user_profile]

<!--[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]-->
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

**This component will set up the following platforms.**

| Platform | Description |
| -------------- | ------------------------------------------------- |
| `climate` | Thermostats (called roomtemps in MyGekko) |
| `cover` | Covers (called blinds in MyGekko) |
| `light` | Lights |
| `switch` | Switches (called loads in MyGekko) |
| `water_heater` | Water Heater (called hotwater_systems in MyGekko) |
| Platform | Description |
| -------------- | ------------------------------------------------------------------ |
| `climate` | Thermostats (called roomtemps in MyGekko) |
| `cover` | Covers (called blinds in MyGekko) |
| `light` | Lights |
| `switch` | Switches (called loads in MyGekko) |
| `water_heater` | Water Heater (called hotwater_systems in MyGekko) |
| `sensor` | MyGekko energy_cost metrics and alarms_logics are added as sensors |
| `scene` | MyGekko actions are added as scenes |

## Installation

Expand Down
Binary file added custom_components/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added custom_components/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added custom_components/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 11 additions & 7 deletions info.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@

**This component will set up the following platforms.**

| Platform | Description |
| --------------- | ----------------------------------- |
| `binary_sensor` | Show something `True` or `False`. |
| `sensor` | Show info from API. |
| `switch` | Switch something `True` or `False`. |
| Platform | Description |
| -------------- | ------------------------------------------------------------------ |
| `climate` | Thermostats (called roomtemps in MyGekko) |
| `cover` | Covers (called blinds in MyGekko) |
| `light` | Lights |
| `switch` | Switches (called loads in MyGekko) |
| `water_heater` | Water Heater (called hotwater_systems in MyGekko) |
| `sensor` | MyGekko energy_cost metrics and alarms_logics are added as sensors |
| `scene` | MyGekko actions are added as scenes |

![example][exampleimg]

Expand All @@ -30,7 +34,7 @@

## Configuration is done in the UI

<!---->
The integration currently only supports access via the MyGekko server, so you need a MyGekko Plus subscription.

## Credits

Expand All @@ -41,7 +45,7 @@ Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [in
---

[integration_blueprint]: https://github.com/custom-components/integration_blueprint
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
[buymecoffee]: https://www.buymeacoffee.com/stephanu
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/stephanu/mygekko.svg?style=for-the-badge
[commits]: https://github.com/stephanu/mygekko/commits/main
Expand Down

0 comments on commit a2435bf

Please sign in to comment.