Add ABB Terra AC (#3442)

charger/abb.go

@@ -0,0 +1,216 @@
+package charger
+
+// LICENSE
+
+// Copyright (c) 2022 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 (
+	"encoding/binary"
+	"fmt"
+
+	"github.com/evcc-io/evcc/api"
+	"github.com/evcc-io/evcc/util"
+	"github.com/evcc-io/evcc/util/modbus"
+	"github.com/evcc-io/evcc/util/sponsor"
+)
+
+// ABB charger implementation
+type ABB struct {
+	log  *util.Logger
+	conn *modbus.Connection
+}
+
+const (
+	abbRegSerial    = 0x4000 // Serial Number 4 unsigned RO available
+	abbRegFirmware  = 0x4004 // Firmware version 2 unsigned RO available
+	abbRegErrorCode = 0x4008 // Error Code 2 unsigned RO available
+	abbRegStatus    = 0x400C // Charging state 2 unsigned RO available
+	abbRegCurrents  = 0x4010 // Charging current phases 6 0.001 A unsigned RO available
+	abbRegPower     = 0x401C // Active power 2 1 W unsigned RO available
+	abbRegEnergy    = 0x401E // Energy delivered in charging session 2 1 Wh unsigned RO available
+	abbRegCurrent   = 0x4100 // Set charging current limit 2 0.001 A unsigned WO available
+	abbRegPhases    = 0x4102 // Set charging phase 1 unsigned WO Not support
+	abbRegStartStop = 0x4105 // Start/Stop Charging Session 1 unsigned WO available
+)
+
+func init() {
+	registry.Add("abb", NewABBFromConfig)
+}
+
+// NewABBFromConfig creates a ABB charger from generic config
+func NewABBFromConfig(other map[string]interface{}) (api.Charger, error) {
+	cc := modbus.TcpSettings{
+		ID: 1,
+	}
+
+	if err := util.DecodeOther(other, &cc); err != nil {
+		return nil, err
+	}
+
+	return NewABB(cc.URI, cc.ID)
+}
+
+// NewABB creates ABB charger
+func NewABB(uri string, slaveID uint8) (api.Charger, error) {
+	conn, err := modbus.NewConnection(uri, "", "", 0, modbus.Tcp, slaveID)
+	if err != nil {
+		return nil, err
+	}
+
+	if !sponsor.IsAuthorized() {
+		return nil, api.ErrSponsorRequired
+	}
+
+	log := util.NewLogger("abb")
+	conn.Logger(log.TRACE)
+
+	wb := &ABB{
+		log:  log,
+		conn: conn,
+	}
+
+	return wb, err
+}
+
+// Status implements the api.Charger interface
+func (wb *ABB) Status() (api.ChargeStatus, error) {
+	b, err := wb.conn.ReadHoldingRegisters(abbRegStatus, 2)
+	if err != nil {
+		return api.StatusNone, err
+	}
+
+	switch s := b[1] & 0x7f; s {
+	case 0: // State A: Idle
+		return api.StatusA, nil
+	case 1: // State B1: EV Plug in, pending authorization
+		return api.StatusB, nil
+	case 2: // State B2: EV Plug in, EVSE ready for charging(PWM)
+		return api.StatusB, nil
+	case 3: // State C1: EV Ready for charge, S2 closed(no PWM)
+		return api.StatusB, nil
+	case 5: // State C2: Charging Contact closed, energy delivering
+		return api.StatusC, nil
+	default: // Other
+		return api.StatusNone, fmt.Errorf("invalid status: %0x", s)
+	}
+}
+
+// Enabled implements the api.Charger interface
+func (wb *ABB) Enabled() (bool, error) {
+	b, err := wb.conn.ReadHoldingRegisters(abbRegStatus, 2)
+	if err != nil {
+		return false, err
+	}
+
+	return b[0] == 0, nil
+}
+
+// Enable implements the api.Charger interface
+func (wb *ABB) Enable(enable bool) error {
+	var b uint16
+	if !enable {
+		b = 1
+	}
+
+	_, err := wb.conn.WriteSingleRegister(abbRegStartStop, b)
+
+	return err
+}
+
+// MaxCurrent implements the api.Charger interface
+func (wb *ABB) MaxCurrent(current int64) error {
+	return wb.MaxCurrentMillis(float64(current))
+}
+
+var _ api.ChargerEx = (*ABB)(nil)
+
+// MaxCurrent implements the api.ChargerEx interface
+func (wb *ABB) MaxCurrentMillis(current float64) error {
+	b := make([]byte, 4)
+	binary.BigEndian.PutUint32(b, uint32(current*1e3))
+
+	_, err := wb.conn.WriteMultipleRegisters(abbRegCurrent, 2, b)
+	return err
+}
+
+var _ api.Meter = (*ABB)(nil)
+
+// CurrentPower implements the api.Meter interface
+func (wb *ABB) CurrentPower() (float64, error) {
+	b, err := wb.conn.ReadHoldingRegisters(abbRegPower, 2)
+	if err != nil {
+		return 0, err
+	}
+
+	return float64(binary.BigEndian.Uint32(b)), err
+}
+
+var _ api.MeterEnergy = (*ABB)(nil)
+
+// TotalEnergy implements the api.MeterEnergy interface
+func (wb *ABB) TotalEnergy() (float64, error) {
+	b, err := wb.conn.ReadHoldingRegisters(abbRegEnergy, 2)
+	if err != nil {
+		return 0, err
+	}
+
+	return float64(binary.BigEndian.Uint32(b)) / 1e3, err
+}
+
+var _ api.MeterCurrent = (*ABB)(nil)
+
+// Currents implements the api.MeterCurrent interface
+func (wb *ABB) Currents() (float64, float64, float64, error) {
+	b, err := wb.conn.ReadHoldingRegisters(abbRegCurrents, 6)
+	if err != nil {
+		return 0, 0, 0, err
+	}
+
+	var curr [3]float64
+	for l := 0; l < 3; l++ {
+		curr[l] = float64(binary.BigEndian.Uint32(b[4*l:4*(l+1)])) / 1e3
+	}
+
+	return curr[0], curr[1], curr[2], nil
+}
+
+var _ api.ChargePhases = (*ABB)(nil)
+
+// Phases1p3p implements the api.ChargePhases interface
+func (wb *ABB) Phases1p3p(phases int) error {
+	var b uint16 = 1
+	if phases != 1 {
+		b = 2 // 3p
+	}
+
+	_, err := wb.conn.WriteSingleRegister(abbRegPhases, b)
+	return err
+}
+
+var _ api.Diagnosis = (*ABB)(nil)
+
+// Diagnose implements the api.Diagnosis interface
+func (wb *ABB) Diagnose() {
+	if b, err := wb.conn.ReadHoldingRegisters(abbRegSerial, 4); err == nil {
+		fmt.Printf("\tSerial:\t%x\n", b)
+	}
+	if b, err := wb.conn.ReadHoldingRegisters(abbRegFirmware, 2); err == nil {
+		fmt.Printf("\tFirmware:\t%x\n", b)
+	}
+	if b, err := wb.conn.ReadHoldingRegisters(abbRegErrorCode, 2); err == nil {
+		fmt.Printf("\tError code:\t%x\n", b)
+	}
+}

templates/definition/charger/abb.yaml

@@ -0,0 +1,14 @@
+template: abb
+products:
+  - brand: ABB
+    description:
+      generic: Terra AC
+capabilities: ["1p3p"]
+requirements:
+  evcc: ["sponsorship"]
+params:
+  - name: modbus
+    choice: ["tcpip"]
+render: |
+  type: abb
+  {{- include "modbus" . }}

templates/docs/charger/abb_0.yaml

@@ -0,0 +1,15 @@
+product:
+  brand: ABB
+  description: Terra AC
+capabilities: ["1p3p"]
+requirements: ["sponsorship"]
+render:
+  - default: |
+      type: template
+      template: abb      
+
+      # Modbus TCP
+      modbus: tcpip
+      id: 1
+      host: 192.0.2.2 # Hostname
+      port: 502 # Port

templates/evcc.io/brands.json

@@ -1,5 +1,6 @@
 {
  "Chargers": [
+  "ABB",
   "ABL",
   "Alfen",
   "Alphatec",