Merge pull request #1 from achetronic/feat/add-tapogo-client

feat: Add Tapogo client for KLAP management

Author: achetronic

api/v1alpha1/integrations_types.go

@@ -2,6 +2,7 @@ package v1alpha1
 
 // --
 type TapoSmartPlugSpec struct {
+	Client  string `yaml:"client"`
 	Address string `yaml:"address"`
 	Auth    struct {
 		Username string `yaml:"username" env:"TAPO_SMARTPLUG_USERNAME"`

config/samples/autoheater.yaml

@@ -59,7 +59,13 @@ spec:
 
       # Data for sending the events to TAPO P1XX devices (p100, p110, etc)
       tapoSmartPlug:
-        address: "192.168.1.100"
+        # (Optional) protocol used to communicate with Tapo plugs.
+        # TPLink tends to change completely the protocol from time to time.
+        # legacy: is used for older firmware versions and supports 'securePassthrough' protocol
+        # modern: (default) is used for newer firmware versions and supports 'KLAP' protocol
+        client: modern
+
+        address: "192.168.1.109"
 
         # (Optional) username and password for auth. It's the same used to access the app (it's accessed locally, but
         # Tapo devices are configured that way when they are set up)

go.mod

@@ -3,6 +3,7 @@ module github.com/achetronic/autoheater
 go 1.21
 
 require (
+	github.com/achetronic/tapogo v0.1.1
 	github.com/avast/retry-go v3.0.0+incompatible
 	github.com/caarlos0/env/v9 v9.0.0
 	github.com/richardjennings/tapo v0.0.1

go.sum

@@ -1,3 +1,5 @@
+github.com/achetronic/tapogo v0.1.1 h1:HbTRMUCl6rnd7Q//R/RSfT9uvJHz2ynFqyb2upbdUAw=
+github.com/achetronic/tapogo v0.1.1/go.mod h1:DVflSfbePg4SAjRy0aeMYJ0vj4Pjesw5sw6y4yP0f8w=
 github.com/avast/retry-go v3.0.0+incompatible h1:4SOWQ7Qs+oroOTQOYnAHqelpCO0biHSxpiH9JdtuBj0=
 github.com/avast/retry-go v3.0.0+incompatible/go.mod h1:XtSnn+n/sHqQIpZ10K1qAevBhOOCWBLXXy3hyiqqBrY=
 github.com/benbjohnson/clock v1.3.0 h1:ip6w0uFQkncKQ979AypyG0ER7mqUSBdKLOgAle/AT8A=

internal/integrations/taposmartplug/taposmartplug.go

@@ -1,21 +1,30 @@
 package taposmartplug
 
 import (
+	"encoding/json"
 	"errors"
 	"github.com/achetronic/autoheater/api/v1alpha1"
+	tapogotypes "github.com/achetronic/tapogo/api/types"
+	"github.com/achetronic/tapogo/pkg/tapogo"
 	"github.com/richardjennings/tapo/pkg/tapo"
+	"time"
 )
 
 const (
 	RequiredConfigFieldsMissingMessage = "some mandatory config field is missing on Tapo SmartPlug integration"
+
+	RequestRetryAttempts = 3
 )
 
 // --
 func checkConfigFields(ctx *v1alpha1.Context) (err error) {
 	tapoConfig := ctx.Config.Spec.Device.Integrations.TapoSmartPlug
 
 	// Check required fields to act
-	if tapoConfig.Address == "" || tapoConfig.Auth.Username == "" || tapoConfig.Auth.Password == "" {
+	if tapoConfig.Address == "" ||
+		tapoConfig.Auth.Username == "" ||
+		tapoConfig.Auth.Password == "" ||
+		tapoConfig.Client == "" {
 		return errors.New(RequiredConfigFieldsMissingMessage)
 	}
 
@@ -30,18 +39,51 @@ func TurnOnDevice(ctx *v1alpha1.Context) (tapoResponse map[string]interface{}, e
 		return tapoResponse, err
 	}
 
-	//
-	var tapoClient *tapo.Tapo
-
 	tapoConfig := ctx.Config.Spec.Device.Integrations.TapoSmartPlug
 
-	tapoClient, err = tapo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
-	if err != nil {
-		return tapoResponse, err
+	switch tapoConfig.Client {
+	case "legacy":
+		tapoClient, err := tapo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		tapoResponse, err = tapoClient.TurnOn()
+
+	default:
+		tapoClientNew, err := tapogo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		// New KLAP protocol throws random errors when the requests are done at speed.
+		// Retrying mostly solve the issue
+		tapoResponseNew := &tapogotypes.ResponseSpec{}
+		for retryAttempt := 0; retryAttempt < RequestRetryAttempts; retryAttempt++ {
+			tapoResponseNew, err = tapoClientNew.TurnOn()
+			if err != nil {
+				time.Sleep(time.Millisecond * 250) // Magic number 0.25s
+				continue
+			}
+			break
+		}
+
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		// Make response compatible with the global interface
+		jsonBytes, err := json.Marshal(tapoResponseNew)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		err = json.Unmarshal(jsonBytes, &tapoResponse)
+		if err != nil {
+			return tapoResponse, err
+		}
 	}
 
-	tapoResponse, err = tapoClient.TurnOn()
-
 	return tapoResponse, err
 }
 
@@ -54,16 +96,50 @@ func TurnOffDevice(ctx *v1alpha1.Context) (tapoResponse map[string]interface{},
 	}
 
 	//
-	var tapoClient *tapo.Tapo
-
 	tapoConfig := ctx.Config.Spec.Device.Integrations.TapoSmartPlug
 
-	tapoClient, err = tapo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
-	if err != nil {
-		return tapoResponse, err
+	switch tapoConfig.Client {
+	case "legacy":
+		tapoClient, err := tapo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		tapoResponse, err = tapoClient.TurnOff()
+
+	default:
+		tapoClientNew, err := tapogo.NewTapo(tapoConfig.Address, tapoConfig.Auth.Username, tapoConfig.Auth.Password)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		// New KLAP protocol throws random errors when the requests are done at speed.
+		// Retrying mostly solve the issue
+		tapoResponseNew := &tapogotypes.ResponseSpec{}
+		for retryAttempt := 0; retryAttempt < RequestRetryAttempts; retryAttempt++ {
+			tapoResponseNew, err = tapoClientNew.TurnOff()
+			if err != nil {
+				time.Sleep(time.Millisecond * 250) // Magic number 0.25s
+				continue
+			}
+			break
+		}
+
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		// Make response compatible with the global interface
+		jsonBytes, err := json.Marshal(tapoResponseNew)
+		if err != nil {
+			return tapoResponse, err
+		}
+
+		err = json.Unmarshal(jsonBytes, &tapoResponse)
+		if err != nil {
+			return tapoResponse, err
+		}
 	}
 
-	tapoResponse, err = tapoClient.TurnOff()
-
 	return tapoResponse, err
 }