https://github.com/wolffshots/phocus

Communication app to fetch data from an inverter over serial and output to mqtt
https://github.com/wolffshots/phocus

golang homeassistant inverter mqtt phocos serial

Last synced: 3 months ago
JSON representation

Communication app to fetch data from an inverter over serial and output to mqtt

• Host: GitHub
• URL: https://github.com/wolffshots/phocus
• Owner: wolffshots
• License: zlib
• Created: 2022-11-07T08:22:22.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T22:38:21.000Z (4 months ago)
• Last Synced: 2024-10-02T05:21:04.332Z (3 months ago)
• Topics: golang, homeassistant, inverter, mqtt, phocos, serial
• Language: Go
• Homepage:
• Size: 406 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# phocus

![Worklow Status](https://github.com/wolffshots/phocus/actions/workflows/go.yml/badge.svg)

[![Go Reference](https://pkg.go.dev/badge/github.com/wolffshots/phocus.svg)](https://pkg.go.dev/github.com/wolffshots/phocus/v2)

[![codecov](https://codecov.io/github/wolffshots/phocus/branch/main/graph/badge.svg?token=641UGV72AY)](https://codecov.io/github/wolffshots/phocus)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ae8e8489462c460ab79c61fc2f8d10e9)](https://app.codacy.com/gh/wolffshots/phocus/dashboard)

A generic set of packages and app to speak to a device via serial and

relay the responses to an MQTT broker in a way that Home Assistant expects

Primarily built to communicate with Phocos branded inverters but

the only thing you should need to change to use other inverters is

the structure of the messages and the populating of the queue

## Installation

### Ubuntu/systemd

If you don't need to differ from the default setup then it should be as simple as:

#### Minimal dependencies

1. Install the latest executable directly and customise the config

(the script should create the `config.json`

for you to customise if you don't do it beforehand)

    ```sh

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wolffshots/phocus/HEAD/install_prebuilt.sh)"

    ```

2. (Re)start the service

    ```sh

    sudo systemctl daemon-reload && sudo systemctl restart phocus

    ```

#### Build from source

1. Clone the repo

    ```sh

    git clone https://github.com/wolffshots/phocus.git

    ```

2. Create a `config.json` file from `config.json.example` and customise

your settings (`install.sh` will just prompt you to do this in the next step

if you don't)

3. Run the install script

(which builds the app then will ask for your password to put it

in the correct place and makes a service file for it linked to `phocus.service` )

    ```sh

    cd phocus && ./install.sh

    ```

4. (Re)start the service

    ```sh

    sudo systemctl daemon-reload && sudo systemctl restart phocus

    ```

## Updating

### From latest binary

Just run this command again:

```sh

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wolffshots/phocus/HEAD/install_prebuilt.sh)"

```

### From source

To update you should just be able to pull/checkout the newer version,

call `./install.sh` and restart the app with `sudo service phocus restart`