tools

Documentation

Overview

Package tools contains various tools to make it easier to use the Tado API

Index

• func Errors(errs *tado.ErrorResponse) error
• func Errors422(errs *tado.ErrorResponse422) error
• func GetHomes(ctx context.Context, client TadoClient) ([]tado.HomeBase, error)
• func HandleErrors(resp *http.Response, tadoErrors map[int]any) error
• type TadoClient

Functions

func Errors

func Errors(errs *tado.ErrorResponse) error

Errors converts the errors in ErrorResponse to a Go error

func Errors422

func Errors422(errs *tado.ErrorResponse422) error

Errors422 converts the errors in ErrorResponse422 to a Go error

func GetHomes

func GetHomes(ctx context.Context, client TadoClient) ([]tado.HomeBase, error)

GetHomes returns the list of Home ID's that are registered under the user's account.

func HandleErrors

func HandleErrors(resp *http.Response, tadoErrors map[int]any) error

HandleErrors converts an HTTP error received from the server to a generic Go error. resp should be the http.Response received, and tadoErrors a map of received Error objects by HTTP StatusCode, for example:

me, err := client.GetMeWithResponse(ctx)
if err != nil {
	return nil, fmt.Errorf("GetMeWithResponse: %w", err)
}
if me.StatusCode() != http.StatusOK {
	return nil, HandleErrors(me.HTTPResponse, map[int]any{
		http.StatusUnauthorized: me.JSON401,
	})
}

Types

type TadoClient

type TadoClient interface {
	GetMeWithResponse(ctx context.Context, reqEditors ...tado.RequestEditorFn) (*tado.GetMeResponse, error)
}