Skip to content

Commit

Permalink
Merge pull request #5 from maslyankov:update/project-urls
Browse files Browse the repository at this point in the history
Update/project-urls
  • Loading branch information
maslyankov authored Dec 28, 2024
2 parents a6d573f + 2a0a528 commit 256342e
Show file tree
Hide file tree
Showing 32 changed files with 68 additions and 68 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

Existing sensor definitions can be found [here](https://github.com/kellerza/sunsynk/blob/main/src/sunsynk/definitions/). You can test your own definitions using [custom sensors](https://kellerza.github.io/sunsynk/reference/mysensors)
Existing sensor definitions can be found [here](https://github.com/maslyankov/sunsynk/blob/main/src/sunsynk/definitions/). You can test your own definitions using [custom sensors](https://sunsynk.wectrl.net/reference/mysensors)

### Your environment
- Home Assistant version: __
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-multi-mp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -273,5 +273,5 @@ jobs:
- uses: stefanzweifel/[email protected]
with:
branch: main
commit_user_email: kellerza@gmail.com
commit_user_email: m.maslyankov@me.com
commit_message: Update addon version to ${{ needs.information.outputs.version }} [no ci]
2 changes: 1 addition & 1 deletion .github/workflows/deploy-multi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -180,5 +180,5 @@ jobs:
- uses: stefanzweifel/[email protected]
with:
branch: main
commit_user_email: kellerza@gmail.com
commit_user_email: m.maslyankov@me.com
commit_message: Update addon version to ${{ needs.information.outputs.version }} [no ci]
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,28 @@ This code was developed on a [Sunsynk](https://www.sunsynk.org/) 5.5 kWh inverte
## Documentation

Refer to [https://kellerza.github.io/sunsynk/](https://kellerza.github.io/sunsynk/)
Refer to [https://sunsynk.wectrl.net/](https://sunsynk.wectrl.net/)

## Home Assistant Sunsynk Add-On

For the Add-On you require Home Assistant OS and a RS-485 adaptor to connect to your Sunsynk inverter. Sensors are read using the Modbus protocol and sent to a MQTT server. See [deployment options](https://kellerza.github.io/sunsynk/guide/deployment-options) for examples of tested hardware.
For the Add-On you require Home Assistant OS and a RS-485 adaptor to connect to your Sunsynk inverter. Sensors are read using the Modbus protocol and sent to a MQTT server. See [deployment options](https://sunsynk.wectrl.net/guide/deployment-options) for examples of tested hardware.

### Installation

1. Add this repository to your HA Supervisor

[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkellerza%2Fsunsynk)
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmaslyankov%2Fsunsynk)

`https://github.com/kellerza/sunsynk`
`https://github.com/maslyankov/sunsynk`

2. Install the Sunsynk Add-On from the **Add-On Store** and configure through the UI

![Install Sunsynk Addon](https://github.com/kellerza/sunsynk/raw/main/images/addon-install.png)
![Install Sunsynk Addon](https://github.com/maslyankov/sunsynk/raw/main/images/addon-install.png)


Below an example of the HomeAssistant Energy management dashboard using sensors from the Sunsynk.

![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/images/energy.png)
![HASS Energy management](https://github.com/maslyankov/sunsynk/raw/main/images/energy.png)

## Sunsynk Python Library
[![PyPI version](https://badge.fury.io/py/sunsynk.svg)](https://pypi.org/project/sunsynk/)
Expand Down
2 changes: 1 addition & 1 deletion hass-addon-git-push/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version: 0.1c
slug: git_push
name: Git push (experimental)
description: Simple git push backup local configuration
url: https://github.com/kellerza/sunsynk
url: https://github.com/maslyankov/sunsynk
advanced: true
arch:
- armhf
Expand Down
2 changes: 1 addition & 1 deletion hass-addon-mbusd/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Add-on for a Modbus TCP to Modbus RTU Gateway using mbusd
version: 2021.10.1
startup: services
boot: auto
url: 'https://github.com/kellerza/sunsynk'
url: 'https://github.com/maslyankov/sunsynk'
uart: true
arch:
- aarch64
Expand Down
2 changes: 1 addition & 1 deletion hass-addon-sunsynk-edge/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

<https://github.com/kellerza/sunsynk/commits/>
<https://github.com/maslyankov/sunsynk/commits/>
2 changes: 1 addition & 1 deletion hass-addon-sunsynk-edge/DOCS.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# [Online Documentation](https://kellerza.github.io/sunsynk/reference/multi-options)
# [Online Documentation](https://sunsynk.wectrl.net/reference/multi-options)
2 changes: 1 addition & 1 deletion hass-addon-sunsynk-edge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The developer version of the addon. Contains the latest changes committed to the Github repository.

<https://github.com/kellerza/sunsynk/commits/>
<https://github.com/maslyankov/sunsynk/commits/>
4 changes: 2 additions & 2 deletions hass-addon-sunsynk-edge/config.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Sunsynk/Deye Inverter Add-on (edge/dev)
version: "2c7ad42"
image: ghcr.io/kellerza/hass-addon-sunsynk-multi
image: ghcr.io/maslyankov/hass-addon-sunsynk-multi
slug: hass-addon-sunsynk-edge
description: Add-on for a Sunsynk/Deye branded Inverter
startup: services
boot: auto
url: "https://github.com/kellerza/sunsynk"
url: "https://github.com/maslyankov/sunsynk"
uart: true
init: false
arch:
Expand Down
2 changes: 1 addition & 1 deletion hass-addon-sunsynk-multi/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

<https://github.com/kellerza/sunsynk/releases>
<https://github.com/maslyankov/sunsynk/releases>
2 changes: 1 addition & 1 deletion hass-addon-sunsynk-multi/DOCS.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# [Online Documentation](https://kellerza.github.io/sunsynk/reference/multi-options)
# [Online Documentation](https://sunsynk.wectrl.net/reference/multi-options)
4 changes: 2 additions & 2 deletions hass-addon-sunsynk-multi/Dockerfile.local
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# FROM ghcr.io/kellerza/hass-addon-sunsynk-multi/armhf:edge
FROM ghcr.io/kellerza/hass-addon-sunsynk-multi/armhf:0.7.5
# FROM ghcr.io/maslyankov/hass-addon-sunsynk-multi/armhf:edge
FROM ghcr.io/maslyankov/hass-addon-sunsynk-multi/armhf:0.7.5

# Install sunsynk from local source
COPY sunsynk sunsynk
Expand Down
4 changes: 2 additions & 2 deletions hass-addon-sunsynk-multi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ It supports Home Assistant auto-discovery.

The addon supports multiple inverters and allows you to update the inverter settings.

See the docs for more info - [https://kellerza.github.io/sunsynk](https://kellerza.github.io/sunsynk/reference/multi-options)
See the docs for more info - [https://sunsynk.wectrl.net](https://sunsynk.wectrl.net/reference/multi-options)

Example of Home Assistant Energy Management, enabled by this addon.

![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/images/energy.png)
![HASS Energy management](https://github.com/maslyankov/sunsynk/raw/main/images/energy.png)

## Usage of env vars

Expand Down
4 changes: 2 additions & 2 deletions hass-addon-sunsynk-multi/config.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Sunsynk/Deye Inverter Add-on (multi)
version: "0.7.5"
image: ghcr.io/kellerza/hass-addon-sunsynk-multi/{arch}
image: ghcr.io/maslyankov/hass-addon-sunsynk-multi/{arch}
slug: hass-addon-sunsynk-multi
description: Add-on for a Sunsynk/Deye branded Inverter
startup: services
boot: auto
url: "https://github.com/kellerza/sunsynk"
url: "https://github.com/maslyankov/sunsynk"
uart: true
init: false
arch:
Expand Down
4 changes: 2 additions & 2 deletions repository.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name: Sunsynk/Deye Inverter Add-On
url: "https://github.com/kellerza/sunsynk"
maintainer: "Johann Kellerman <kellerza@gmail.com>"
url: "https://github.com/maslyankov/sunsynk"
maintainer: "Martin Maslyankov <m.maslyankov@me.com>"
6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ version = attr: sunsynk.VERSION
description = Library to interface Deye/Sunsynk Hybrid Inverters
long_description = file: README.md
long_description_content_type = text/markdown
url = https://kellerza.github.io/sunsynk/
author = Johann Kellerman
author_email = kellerza@gmail.com
url = https://sunsynk.wectrl.net/
author = Martin Maslyankov
author_email = m.maslyankov@me.com
license = MIT
license_files = LICENSE
classifiers =
Expand Down
2 changes: 1 addition & 1 deletion src/ha_addon_sunsynk_multi/a_inverter.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ async def connect(self) -> None:
if not await self.read_sensors_retry(sensors=list(SOPT.startup)):
raise ConnectionError(
f"No response on the Modbus interface {self.inv.port}, "
"see https://kellerza.github.io/sunsynk/guide/fault-finding"
"see https://sunsynk.wectrl.net/guide/fault-finding"
)
expected_ser = self.opt.serial_nr.replace("_", "")
actual_ser = str(self.inv.state[DEFS.serial])
Expand Down
4 changes: 2 additions & 2 deletions src/ha_addon_sunsynk_multi/sensor_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,15 +151,15 @@ def import_definitions() -> None:
"""A dict of all options related to sensors."""

SENSOR_GROUPS: dict[str, list[str]] = {
# https://kellerza.github.io/sunsynk/guide/energy-management
# https://sunsynk.wectrl.net/guide/energy-management
"energy_management": [
"total_battery_charge",
"total_battery_discharge",
"total_grid_export",
"total_grid_import",
"total_pv_energy",
],
# https://kellerza.github.io/sunsynk/examples/lovelace#sunsynk-power-flow-card
# https://sunsynk.wectrl.net/examples/lovelace#sunsynk-power-flow-card
"power_flow_card": [
"aux_power",
"battery_1_soc", # 3PH HV
Expand Down
2 changes: 1 addition & 1 deletion src/sunsynk/sensors.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def reg_to_value(self, regs: RegType) -> ValType:
_LOGGER.warning(
"%s: Unknown register value %s. "
"Consider extending the definition with a PR. "
"https://github.com/kellerza/sunsynk/tree/main/src/sunsynk/definitions",
"https://github.com/maslyankov/sunsynk/tree/main/src/sunsynk/definitions",
self.id,
regsm[0],
)
Expand Down
4 changes: 2 additions & 2 deletions www/docs/.vitepress/build_sitemap.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import {resolveOptions, generateSitemap} from "sitemap-ts";

function buildEnd() {
const opt = resolveOptions({
hostname: "https://kellerza.github.io/",
basePath: "/sunsynk",
hostname: "https://sunsynk.wectrl.net/",
basePath: "/",
outDir: "docs/.vitepress/dist",
exclude: ["/404"],
readable: true,
Expand Down
6 changes: 3 additions & 3 deletions www/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import imsize from "markdown-it-imsize"
export default defineConfig({
lang: "en-US",
title: "Deye/Sunsynk",
base: "/sunsynk/",
base: "/",
description: "Take control of your inverter.",
lastUpdated: true,
cleanUrls: true,
Expand Down Expand Up @@ -121,12 +121,12 @@ export default defineConfig({
],

editLink: {
pattern: "https://github.com/kellerza/sunsynk/edit/main/www/docs/:path",
pattern: "https://github.com/maslyankov/sunsynk/edit/main/www/docs/:path",
text: "Edit this page on GitHub",
},

socialLinks: [
{ icon: "github", link: "https://github.com/kellerza/sunsynk" },
{ icon: "github", link: "https://github.com/maslyankov/sunsynk" },
],

footer: {
Expand Down
8 changes: 4 additions & 4 deletions www/docs/guide/deployment-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ If the Inverter is close to your server/SBC running Home Assistant, you can use
The Sunsynk Add-on runs on the Home Assistant OS, reads the Inverter's Modbus registers over RS-485, and publishes sensor values to the MQTT server.
The architecture is shown below:

![Deployment Option](https://github.com/kellerza/sunsynk/raw/main/images/deploy.png)
![Deployment Option](https://github.com/maslyankov/sunsynk/raw/main/images/deploy.png)

2. A Modbus TCP to RTU/serial gateway

This can be another Raspberry Pi, even an old one, running the gateway software, like [mbusd](./mbusd).

You can also use a commercial Modbus gateway, like the USR-W630

![Deployment Option Gateway](https://github.com/kellerza/sunsynk/raw/main/images/deploy-gw.png)
![Deployment Option Gateway](https://github.com/maslyankov/sunsynk/raw/main/images/deploy-gw.png)

3. Extend with an MQTT gateway

This remote option runs the Sunsynk Addon close to the Inverter, and then sends MQTT messages over your network toward the MQTT server (typically on the same server as Home Assistant)

![Deployment Option MQTT](https://github.com/kellerza/sunsynk/raw/main/images/deploy-mqtt.png)
![Deployment Option MQTT](https://github.com/maslyankov/sunsynk/raw/main/images/deploy-mqtt.png)

4. Standalone in Docker

This runs the addon on its own in a docker container, without depending on Home Assistant

Read more [here](./standalone-deployment).

![Deployment Option Standalone](https://github.com/kellerza/sunsynk/raw/main/images/deploy-standalone.png)
![Deployment Option Standalone](https://github.com/maslyankov/sunsynk/raw/main/images/deploy-standalone.png)
2 changes: 1 addition & 1 deletion www/docs/guide/energy-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

You can read more Energy Management in Home Assistant [here](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/) and [here](https://www.home-assistant.io/docs/energy/).

![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/images/energy.png)
![HASS Energy management](https://github.com/maslyankov/sunsynk/raw/main/images/energy.png)

The following sensors are required as a minimum to enable the Home Assistant Energy feaure for a hybrid inverter with PV and a battery.

Expand Down
4 changes: 2 additions & 2 deletions www/docs/guide/fault-finding.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ View/update the Modbus server ID on your inverter under "Advanced Settings" / "M
Please note that this can be reset to zero after a software upgrade on your inverter, and this will stop the addon from reading data from your inverter. Resetting it to the previous value (the value the value in `MODBUS_ID` if you had this working previously), and then restarting the inverter should fix the [issue](https://powerforum.co.za/topic/15779-home-assistant-no-longer-getting-data-after-sunsynk-firmware-update-solved/).
<img src="https://github.com/kellerza/sunsynk/raw/main/images/modbus_sn.png" width="80%">
<img src="https://github.com/maslyankov/sunsynk/raw/main/images/modbus_sn.png" width="80%">
## (c) Reducing timeouts
Expand Down Expand Up @@ -65,4 +65,4 @@ but this may drop to around 0.5v with the 120 ohm load.
RS485 devices are typically multi-drop with a termination resistor on the first and last devices.
However, the RS485 BMS port may only be intended to connect to a single device.
<img src="https://github.com/kellerza/sunsynk/raw/main/images/rs485-term.jpg">
<img src="https://github.com/maslyankov/sunsynk/raw/main/images/rs485-term.jpg">
6 changes: 3 additions & 3 deletions www/docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

1. Add this repository to your HA Supervisor.

[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkellerza%2Fsunsynk)
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmaslyankov%2Fsunsynk)

`https://github.com/kellerza/sunsynk`
`https://github.com/maslyankov/sunsynk`

2. Install the "Sunsynk/Deye Inverter Add-on **(multi)**" from the **Add-On Store** and configure it through the UI.

![Install Sunsynk Addon](https://github.com/kellerza/sunsynk/raw/main/images/addon-install.png)
![Install Sunsynk Addon](https://github.com/maslyankov/sunsynk/raw/main/images/addon-install.png)

## Available addons

Expand Down
2 changes: 1 addition & 1 deletion www/docs/guide/mbusd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ That is a TCP-Server, which acts as a RTU-Client to get data from Modbus RTU-Ser

When you add the Sunsynk HASS repository, it includes a mbusd addon called "Modbus TCP to Modbus RTU Gateway Add-on".

<https://github.com/kellerza/sunsynk/tree/main/hass-addon-mbusd>
<https://github.com/maslyankov/sunsynk/tree/main/hass-addon-mbusd>
4 changes: 2 additions & 2 deletions www/docs/guide/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ An add-on to receive Sunsynk Inverter Values and push them to Home Assistant thr

It supports Home Assistant auto-discovery for the sensors and flexible scheduling when to read and when to report.

![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/images/energy.png)
![HASS Energy management](https://github.com/maslyankov/sunsynk/raw/main/images/energy.png)

For the Add-On you require Home Assistant OS and a RS-485 adaptor to connect to your Sunsynk inverter. Sensors are read using the Modbus protocol and sent to a MQTT server.

Expand Down Expand Up @@ -51,4 +51,4 @@ Please note that the addon is an example of how the library can be used and no s
- Powerforum users Bloubul7, @jacauc and Sc00bs. See [this thread](https://powerforum.co.za/topic/8646-my-sunsynk-8kw-data-collection-setup/).
- @Ivan-L for adding the writable sensors.
- @kababook & @archi for the 3-phase definitions.
- Other [contributors](https://github.com/kellerza/sunsynk/graphs/contributors)
- Other [contributors](https://github.com/maslyankov/sunsynk/graphs/contributors)
12 changes: 6 additions & 6 deletions www/docs/guide/standalone-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Adjust the `INVERTERS` section to match your inverter setup. `tcp://mbusd:502` p

## Using Pre-built Docker Images

The repo also contains prebuilt Docker images for Sunsynk Multi. You can see the different images for the various supported architectures [here](https://github.com/kellerza?tab=packages&repo_name=sunsynk).
The repo also contains prebuilt Docker images for Sunsynk Multi. You can see the different images for the various supported architectures [here](https://github.com/maslyankov?tab=packages&repo_name=sunsynk).

### Docker-Compose examples

Expand All @@ -90,7 +90,7 @@ The repo also contains prebuilt Docker images for Sunsynk Multi. You can see the
services:
sunsynk-multi:
restart: unless-stopped
image: ghcr.io/kellerza/hass-addon-sunsynk-multi:stable
image: ghcr.io/maslyankov/hass-addon-sunsynk-multi:stable
volumes:
- ${PWD}/options.yaml:/data/options.yaml
```
Expand All @@ -99,7 +99,7 @@ services:
services:
sunsynk-multi:
restart: unless-stopped
image: ghcr.io/kellerza/hass-addon-sunsynk-multi:stable
image: ghcr.io/maslyankov/hass-addon-sunsynk-multi:stable
volumes:
- ${PWD}/options.yaml:/data/options.yaml
environment:
Expand All @@ -122,12 +122,12 @@ Below are examples using the docker CLI.
docker run -d --name sunsynk-multi \
--restart unless-stopped \
-v ${PWD}/options.yaml:/data/options.yaml \
ghcr.io/kellerza/hass-addon-sunsynk-multi:stable
ghcr.io/maslyankov/hass-addon-sunsynk-multi:stable
```

### Important Information on Compatibility

You should use the `ghcr.io/kellerza/hass-addon-sunsynk-multi` image without specifying the platform, as the image is supported for all platforms. However, it is backwards compatible, meaning that even if you use `ghcr.io/kellerza/hass-addon-sunsynk-multi/armv6` on an x86 PC, it will still work. This offers flexibility when pulling images for different platforms.
You should use the `ghcr.io/maslyankov/hass-addon-sunsynk-multi` image without specifying the platform, as the image is supported for all platforms. However, it is backwards compatible, meaning that even if you use `ghcr.io/maslyankov/hass-addon-sunsynk-multi/armv6` on an x86 PC, it will still work. This offers flexibility when pulling images for different platforms.


## Using Environment Variables with Docker Compose
Expand All @@ -143,7 +143,7 @@ services:
sunsynk-mult-amd64:
restart: unless-stopped
profiles: ['sunsynk-amd64']
image: ghcr.io/kellerza/hass-addon-sunsynk-multi/amd64:stable
image: ghcr.io/maslyankov/hass-addon-sunsynk-multi/amd64:stable
environment:
MQTT_HOST: mqtt
MQTT_PORT: 1883
Expand Down
Loading

0 comments on commit 256342e

Please sign in to comment.