tuyacloud

README

tuyacloud

unofficial Tuya Cloud API SDK

Status

Project is under active development, API may changes in futures.

Feature

• Go-style API design.
• Full Feature support.
  • Authorization Management
  • User Management
  • Pair Device Management
  • Device Control
  • Device Timing Management
  • Smart Home Management
  • Scene Automation
  • Data Service
  • Weather Service
  • Device Management
  • OTA
  • Device Group
  • Universal Infrared
  • Smart Door Lock
  • Body Fat Scale
  • Sleep pace
  • IPC

Install

go get github.com/ekeynow/tuyacloud

Contribute

Use issues for everything

• For a small change, just send a PR.
• For bigger changes open an issue for discussion before sending a PR.
• PR should have:
  • Test case
  • Documentation
  • Example (If it makes sense)
• You can also contribute by:
  • Reporting issues
  • Suggesting new features or enhancements
  • Improve/fix documentation

Documentation

Index

• func HmacSha256(data, key string) string
• func Timestamp() string
• type Client
  • func NewClient(endpoint Endpoint, accessID, accessKey string, opts ...Option) (c *Client)
  • func (c *Client) Do(r *http.Request) (res *http.Response, err error)
  • func (c *Client) DoAndParse(r Request, resp interface{}) (err error)
  • func (c *Client) Parse(res *http.Response, resp interface{}) error
  • func (c *Client) PlainSign(timestamp string) string
  • func (c *Client) Request(r Request) (req *http.Request, err error)
  • func (c *Client) Token() (token string, err error)
  • func (c *Client) TokenSign(token, timestamp string) string
• type Endpoint
• type Error
  • func (e Error) Error() string
• type HTTPClient
• type MemoryStore
  • func (s *MemoryStore) Refresh(c *Client) (err error)
  • func (s *MemoryStore) Token() string
• type Option
  • func WithHTTPClient(c HTTPClient) Option
  • func WithLogger(l log.Logger) Option
  • func WithMaxRetries(i uint64) Option
  • func WithTokenStore(s TokenStorage) Option
• type Request
• type RequestBody
• type Response
• type TokenRequest
  • func (t *TokenRequest) Method() string
  • func (t *TokenRequest) SetRefresh(token string)
  • func (t *TokenRequest) URL() string
• type TokenResponse
• type TokenStorage

Examples

• Client
• Error

Functions

func HmacSha256

func HmacSha256(data, key string) string

HmacSha256 for HMAC-SHA-256 sign.

func Timestamp

func Timestamp() string

Timestamp returns timestamp format for randomize.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for tuya cloud.

Example

package main

import (
	"github.com/ekeynow/tuyacloud"
	"github.com/ekeynow/tuyacloud/user"
	"github.com/go-log/log/log"
)

func main() {
	client := tuyacloud.NewClient(
		tuyacloud.APIEndpointUS,
		"1KAD46OrT9HafiKdsXeg",
		"4OHBOnWOqaEC1mWXOpVL3yV50s0qGSRC",
		tuyacloud.WithLogger(log.New()),
	)
	req := &user.QueryUserInfoRequest{
		UID: "123456",
	}
	var info user.QueryUserInfoResponse
	err := client.DoAndParse(req, &info)
	if err != nil {
		panic(err)
	}
	// Blah Blah Blah...
}

func NewClient

func NewClient(endpoint Endpoint, accessID, accessKey string, opts ...Option) (c *Client)

NewClient returns API client.

func (*Client) Do

func (c *Client) Do(r *http.Request) (res *http.Response, err error)

Do send HTTP request.

func (*Client) DoAndParse

func (c *Client) DoAndParse(r Request, resp interface{}) (err error)

DoAndParse = Do + Parse.

func (*Client) Parse

func (c *Client) Parse(res *http.Response, resp interface{}) error

Parse response body.

func (*Client) PlainSign

func (c *Client) PlainSign(timestamp string) string

PlainSign returns sign.

func (*Client) Request

func (c *Client) Request(r Request) (req *http.Request, err error)

Request to TUYA.

func (*Client) Token

func (c *Client) Token() (token string, err error)

Token returns access token.

func (*Client) TokenSign

func (c *Client) TokenSign(token, timestamp string) string

TokenSign returns token sign.

type Endpoint

type Endpoint string

Endpoint for API Call.

const (
	// APIEndpointCN prefer to China.
	APIEndpointCN Endpoint = "https://openapi.tuyacn.com"
	// APIEndpointUS prefer to America.
	APIEndpointUS Endpoint = "https://openapi.tuyaus.com"
	// APIEndpointEU prefer to Europe.
	APIEndpointEU Endpoint = "https://openapi.tuyaeu.com"
	// APIEndpointIN prefer to India.
	APIEndpointIN Endpoint = "https://openapi.tuyain.com"
)

type Error

type Error struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
}

Error info.

Example

package main

import (
	"errors"
	"fmt"

	"github.com/ekeynow/tuyacloud"
)

func main() {
	var (
		client *tuyacloud.Client
		r      tuyacloud.Request
		err    error
	)

	m := map[string]interface{}{}
	err = client.DoAndParse(r, &m)
	if err != nil {
		var apiErr tuyacloud.Error
		if errors.As(err, &apiErr) {
			fmt.Println(apiErr.Code, apiErr.Msg)
		}
	}
}

func (Error) Error

func (e Error) Error() string

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient interface.

type MemoryStore

type MemoryStore struct {
	// contains filtered or unexported fields
}

MemoryStore storage.

func (*MemoryStore) Refresh

func (s *MemoryStore) Refresh(c *Client) (err error)

Refresh token

func (*MemoryStore) Token

func (s *MemoryStore) Token() string

Token returns valid token.

type Option

type Option func(o *options)

Option settings.

func WithHTTPClient

func WithHTTPClient(c HTTPClient) Option

WithHTTPClient setup HTTPClient

func WithLogger

func WithLogger(l log.Logger) Option

WithLogger setup log.Logger interface.

func WithMaxRetries

func WithMaxRetries(i uint64) Option

WithMaxRetries setup max retries. Disable retries when i == 0.

func WithTokenStore

func WithTokenStore(s TokenStorage) Option

WithTokenStore setup token storage interface.

type Request

type Request interface {
	Method() string
	URL() string
}

Request for API call.

type RequestBody

type RequestBody interface {
	Body() interface{}
}

RequestBody for API.

type Response

type Response struct {
	Success   bool            `json:"success"`
	Code      int             `json:"code"`
	Msg       string          `json:"msg"`
	Timestamp int64           `json:"t"`
	Result    json.RawMessage `json:"result"`
}

Response body

type TokenRequest

type TokenRequest struct {
	// contains filtered or unexported fields
}

TokenRequest manages token refresh method.

func (*TokenRequest) Method

func (t *TokenRequest) Method() string

Method for Request.Method()

func (*TokenRequest) SetRefresh

func (t *TokenRequest) SetRefresh(token string)

SetRefresh refresh token.

func (*TokenRequest) URL

func (t *TokenRequest) URL() string

URL for Request.URL()

type TokenResponse

type TokenResponse struct {
	ExpireTime   int    `json:"expire_time"`
	UID          string `json:"uid"`
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
}

TokenResponse for token response from tuya server.

type TokenStorage

type TokenStorage interface {
	Token() string
	Refresh(c *Client) error
}

TokenStorage stores token.