evcc-io/charger/victron.go

package charger

// LICENSE

// Copyright (c) evcc.io (andig, naltatis, premultiply)

// This module is NOT covered by the MIT license. All rights reserved.

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import (
	"context"
	"encoding/binary"
	"errors"
	"fmt"

	"github.com/evcc-io/evcc/api"
	"github.com/evcc-io/evcc/api/implement"
	"github.com/evcc-io/evcc/util"
	"github.com/evcc-io/evcc/util/modbus"
	"github.com/spf13/cast"
)

// Victron charger implementation
type Victron struct {
	implement.Caps
	conn *modbus.Connection
	regs victronRegs
}

type victronRegs struct {
	Mode              uint16
	Energy            uint16
	Power             uint16
	Status            uint16
	SetCurrent        uint16
	Enabled           uint16
	PhaseSwitch       uint16
	ThreePhaseEnabled uint16
	isGX              bool
}

var (
	victronGX = victronRegs{
		Mode:       3815,
		Energy:     3816,
		Power:      3821,
		Status:     3824,
		SetCurrent: 3825,
		Enabled:    3826,
		isGX:       true,
	}

	victronEVCS = victronRegs{
		Mode:              5009,
		Energy:            5021,
		Power:             5014,
		Status:            5015,
		SetCurrent:        5016,
		Enabled:           5010,
		PhaseSwitch:       5055,
		ThreePhaseEnabled: 5100,
		isGX:              false,
	}
)

func init() {
	registry.AddCtx("victron", NewVictronGXFromConfig)
	registry.AddCtx("victron-evcs", NewVictronEVCSFromConfig)
}

// NewVictronGXFromConfig creates a Victron charger from generic config
func NewVictronGXFromConfig(ctx context.Context, other map[string]any) (api.Charger, error) {
	return NewVictronFromConfig(ctx, other, victronGX)
}

// NewVictronEVCSFromConfig creates a Victron charger from generic config
func NewVictronEVCSFromConfig(ctx context.Context, other map[string]any) (api.Charger, error) {
	return NewVictronFromConfig(ctx, other, victronEVCS)
}

// NewVictronFromConfig creates a Victron charger from generic config
func NewVictronFromConfig(ctx context.Context, other map[string]any, regs victronRegs) (api.Charger, error) {
	cc := modbus.TcpSettings{
		ID: cast.ToUint8(regs.isGX) * 100,
	}

	if err := util.DecodeOther(other, &cc); err != nil {
		return nil, err
	}

	return NewVictron(ctx, cc, regs)
}

// NewVictron creates Victron charger
func NewVictron(ctx context.Context, settings modbus.TcpSettings, regs victronRegs) (api.Charger, error) {
	conn, err := settings.Connection(ctx)
	if err != nil {
		return nil, err
	}

	log := util.NewLogger("victron")
	conn.Logger(log.TRACE)

	wb := &Victron{
		Caps: implement.New(),
		conn: conn,
		regs: regs,
	}

	b, err := wb.conn.ReadHoldingRegisters(wb.regs.Mode, 1)
	if err != nil {
		return nil, err
	}

	if binary.BigEndian.Uint16(b) != 0 {
		return nil, errors.New("charger must be in manual mode")
	}

	if !regs.isGX {
		b, err := wb.conn.ReadHoldingRegisters(wb.regs.ThreePhaseEnabled, 1)
		if err != nil {
			return nil, err
		}

		if binary.BigEndian.Uint16(b) == 1 {
			implement.Has(wb, implement.PhaseSwitcher(wb.phases1p3p))
			implement.Has(wb, implement.PhaseGetter(wb.getPhases))
		}
	}

	return wb, nil
}

// Status implements the api.Charger interface
func (wb *Victron) Status() (api.ChargeStatus, error) {
	b, err := wb.conn.ReadHoldingRegisters(wb.regs.Status, 1)
	if err != nil {
		return api.StatusNone, err
	}

	u := binary.BigEndian.Uint16(b)
	switch u {
	case 0, 1, 2, 3:
		return api.ChargeStatusString(string('A' + rune(u)))
	case 5, 6, 21:
		return api.StatusB, nil
	default:
		return api.StatusNone, fmt.Errorf("invalid status: %d", u)
	}
}

// Enabled implements the api.Charger interface
func (wb *Victron) Enabled() (bool, error) {
	b, err := wb.conn.ReadHoldingRegisters(wb.regs.Enabled, 1)
	if err != nil {
		return false, err
	}

	return binary.BigEndian.Uint16(b) != 0, nil
}

// Enable implements the api.Charger interface
func (wb *Victron) Enable(enable bool) error {
	var u uint16
	if enable {
		u = 1
	}

	_, err := wb.conn.WriteSingleRegister(wb.regs.Enabled, u)
	return err
}

// MaxCurrent implements the api.Charger interface
func (wb *Victron) MaxCurrent(current int64) error {
	_, err := wb.conn.WriteSingleRegister(wb.regs.SetCurrent, uint16(current))
	return err
}

var _ api.Meter = (*Victron)(nil)

// CurrentPower implements the api.Meter interface
func (wb *Victron) CurrentPower() (float64, error) {
	b, err := wb.conn.ReadHoldingRegisters(wb.regs.Power, 1)
	if err != nil {
		return 0, err
	}

	return float64(binary.BigEndian.Uint16(b)), nil
}

var _ api.ChargeRater = (*Victron)(nil)

// ChargedEnergy implements the api.MeterEnergy interface
func (wb *Victron) ChargedEnergy() (float64, error) {
	b, err := wb.conn.ReadHoldingRegisters(wb.regs.Energy, 1+cast.ToUint16(wb.regs.isGX))
	if err != nil {
		return 0, err
	}

	if wb.regs.isGX {
		return float64(binary.BigEndian.Uint32(b)) / 100, nil
	}

	return float64(binary.BigEndian.Uint16(b)) / 100, nil
}

// phases1p3p implements the api.PhaseSwitcher interface
func (wb *Victron) phases1p3p(phases int) error {
	// register 5055: 1 = single phase, 0 = three phase
	var u uint16
	if phases == 1 {
		u = 1
	}

	_, err := wb.conn.WriteSingleRegister(wb.regs.PhaseSwitch, u)
	return err
}

// getPhases implements the api.PhaseGetter interface
func (wb *Victron) getPhases() (int, error) {
	b, err := wb.conn.ReadHoldingRegisters(wb.regs.PhaseSwitch, 1)
	if err != nil {
		return 0, err
	}

	if binary.BigEndian.Uint16(b) == 1 {
		return 1, nil
	}
	return 3, nil
}