https://github.com/firstof9/ha-renogy
Integration for Renogy cloud API
https://github.com/firstof9/ha-renogy
hacktoberfest home-assistant home-assistant-integration renogy
Last synced: 3 months ago
JSON representation
Integration for Renogy cloud API
- Host: GitHub
- URL: https://github.com/firstof9/ha-renogy
- Owner: firstof9
- License: apache-2.0
- Created: 2024-12-13T00:04:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T18:15:35.000Z (about 1 year ago)
- Last Synced: 2025-04-14T08:14:38.915Z (about 1 year ago)
- Topics: hacktoberfest, home-assistant, home-assistant-integration, renogy
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# renogy
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
![Project Maintenance][maintenance-shield]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]
_Component to integrate with [Renogy][renogy] connected products._
**This component will set up the following platforms.**
Platform | Description
-- | --
`binary_sensor` | On/Off sensors for various settings.
`sensor` | Show info from an Renogy's API.
## Obtaining your Renogy API Keys
You will require two keys to use this integration. The keys can be obtained at Renogy's deveopler platform here:
https://platform.renogy.com/
Once you are logged in, click on your name at the top right, and click on "API Key". From here, click on "Create New Key". The first key that will be shown is your secret key or the key that starts with `sk`. Copy paste this key because it only shows it once. Then, when you press ok, it shows you the second key or the access key or `ak` key. You can always go back and see the ak key but not the sk key. If you lose or forget the sk key, just delete it and make a new one.
You can make more than one set of keys, if you wish.
Please note that the email associated with your API account must be the same email that your hub is paired to. You can check this in the hub settings. Also, only devices that are paired to the hub will be exposed to the Renogy API. Devices that are connected directly to the DC Home App (i.e. via BT with your phone) or older Renogy apps, will not be exposed to the API.
Currently (Jan 2025), the API does not support control of devices and can only read information. This will be added to the API in the future.
## Installation via HACS (recommended)
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=firstof9&repository=ha-renogy&category=integration)
1. Follow the link [here](https://hacs.xyz/docs/faq/custom_repositories/)
2. Use the custom repo link https://github.com/firstof9/ha-renogy
3. Select the category type `integration`
4. Then once it's there (still in HACS) click the INSTALL button
5. Restart Home Assistant
6. Once restarted, in the HA UI go to `Configuration` (the ⚙️ in the lower left) -> `Devices and Services` click `+ Add Integration` and search for `renogy`
## Manual (non-HACS)
Instructions
You probably do not want to do this! Use the HACS method above unless you know what you are doing and have a good reason as to why you are installing manually
1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
2. If you do not have a `custom_components` directory (folder) there, you need to create it.
3. In the `custom_components` directory (folder) create a new folder called `renogy`.
4. Download _all_ the files from the `custom_components/renogy/` directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. Once restarted, in the HA UI go to `Configuration` (the ⚙️ in the lower left) -> `Devices and Services` click `+ Add Integration` and search for `renogy`
## Configuration is done in the UI
### Device ID Guide
When using **Hub Mode** (multiple devices connected to one BT-2 via Communication Hub):
Device Type | Standalone | Hub Mode
-------------|------------|----------
Controller | 255 | 96, 97
Battery | 255 | 48, 49, 50
Inverter | 255, 32 | 32
For **separate BT modules** (one per device), use `device_id: 255`.
## Exposed Entities
This is dependent on the type of device. Here are some examples of the entities that are exposed for the ONE Core and its connected devices.
Renogy ONE Core and connected devices:
Renogy 100 ah self-heating battery (RBT100LFP12SH-G1)
Renogy Rover 40 Li (RNG-CTRL-RVR40)
Renogy Pure Sine Wave 1000 Inverter (RINVTPGH110111S)
## Contributions are welcome!
If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
***
## TODO
- [x] Add tests
- [x] Code
- [ ] Add more tests
[renogy]: https://renogy.com/
[integration_blueprint]: https://github.com/firstof9/ha-renogy
[buymecoffee]: https://www.buymeacoffee.com/firstof9
[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/firstof9/ha-renogy.svg?style=for-the-badge
[commits]: https://github.com/firstof9/ha-renogy/commits/main
[hacs]: https://github.com/custom-components/hacs
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[exampleimg]: example.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/firstof9/ha-renogy.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-Chris%20Nowak%20%40firstof9-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/firstof9/ha-renogy.svg?style=for-the-badge
[releases]: https://github.com/firstof9/ha-renogy/releases