smartlock

Documentation

Overview

Package smartlock for Smart Door Lock interface.

Index

• Constants
• type CreateTempPwdRequest
  • func (c *CreateTempPwdRequest) Method() string
  • func (c *CreateTempPwdRequest) URL() string
• type CreateTempPwdResponse
• type DeleteTempPwdRequest
  • func (d *DeleteTempPwdRequest) Method() string
  • func (d *DeleteTempPwdRequest) URL() string
• type DeleteTempPwdResponse
• type DynamicPwdRequest
  • func (d *DynamicPwdRequest) Method() string
  • func (d *DynamicPwdRequest) URL() string
• type DynamicPwdResponse
• type IssuePasswordRequest
  • func (i *IssuePasswordRequest) Method() string
  • func (i *IssuePasswordRequest) URL() string
• type IssuePasswordResponse
• type OfflineTempPwdRequest
  • func (d *OfflineTempPwdRequest) Body() interface{}
  • func (d *OfflineTempPwdRequest) Method() string
  • func (d *OfflineTempPwdRequest) URL() string
• type OfflineTempPwdResponse
• type OpenLog
• type QueryOpenLogsRequest
  • func (q *QueryOpenLogsRequest) Method() string
  • func (q *QueryOpenLogsRequest) URL() string
• type QueryOpenLogsResponse
• type QueryTempPwdListRequest
  • func (q *QueryTempPwdListRequest) Method() string
  • func (q *QueryTempPwdListRequest) URL() string
• type QueryTempPwdListResponse
• type QueryTempPwdRequest
  • func (q *QueryTempPwdRequest) Method() string
  • func (q *QueryTempPwdRequest) URL() string
• type QueryTempPwdResponse
• type UpdateTempPwdRequest
  • func (u *UpdateTempPwdRequest) Method() string
  • func (u *UpdateTempPwdRequest) URL() string
• type UpdateTempPwdResponse

Constants

const (
	ZigbeeToBeCreate   = 1
	ZigbeeNormal       = 2
	ZigbeeFrozen       = 3
	ZigbeeDeleted      = 4
	ZigbeeCreateFailed = 5

	WiFiDeleted     = 0
	WiFiToBeIssued  = 1
	WiFiIssued      = 2
	WiFiToBeDeleted = 3
)

refer to https://developer.tuya.com/en/docs/iot/open-api/api-list/api/proprietary-category/smart-door-lock?temporary%20passwords

const (
	// OfflineTempPwdTypeMultiTime multiple uses.
	OfflineTempPwdTypeMultiTime = 0
	// OfflineTempPwdTypeOneTime single use.
	OfflineTempPwdTypeOneTime = 1
	// OfflineTempPwdTClean clear all passwords.
	OfflineTempPwdTClean = 9
)

Types

type CreateTempPwdRequest

type CreateTempPwdRequest struct {
	DeviceID      string `json:"-" validate:"required"`
	Name          string `json:"name,omitempty"`
	Password      string `json:"password" validate:"required"`
	EffectiveTime int64  `json:"effective_time" validate:"required"`
	InvalidTime   int64  `json:"invalid_time" validate:"required"`
	Phone         string `json:"phone,omitempty"`
}

CreateTempPwdRequest creates a temporary password with(out) name

func (*CreateTempPwdRequest) Method

func (c *CreateTempPwdRequest) Method() string

Method for Request.Method()

func (*CreateTempPwdRequest) URL

func (c *CreateTempPwdRequest) URL() string

URL for Request.URL()

type CreateTempPwdResponse

type CreateTempPwdResponse struct {
	ID int64 `json:"id"`
}

CreateTempPwdResponse returns temp password id.

type DeleteTempPwdRequest

type DeleteTempPwdRequest struct {
	DeviceID   string `json:"-" validate:"required"`
	PasswordID int64  `json:"-" validate:"required"`
}

DeleteTempPwdRequest delete temp password

func (*DeleteTempPwdRequest) Method

func (d *DeleteTempPwdRequest) Method() string

Method for Request.Method()

func (*DeleteTempPwdRequest) URL

func (d *DeleteTempPwdRequest) URL() string

URL for Request.URL()

type DeleteTempPwdResponse

type DeleteTempPwdResponse bool

DeleteTempPwdResponse show success or not.

type DynamicPwdRequest

type DynamicPwdRequest struct {
	DeviceID string `json:"device_id" validate:"required"`
}

DynamicPwdRequest request to a dynamic password

func (*DynamicPwdRequest) Method

func (d *DynamicPwdRequest) Method() string

Method for Request.Method()

func (*DynamicPwdRequest) URL

func (d *DynamicPwdRequest) URL() string

URL for Request.URL()

type DynamicPwdResponse

type DynamicPwdResponse struct {
	DynamicPassword string `json:"dynamic_password"`
}

DynamicPwdResponse returns a dynamic password

type IssuePasswordRequest

type IssuePasswordRequest struct {
	DeviceID string `json:"-" validate:"required"`

	PasswordID int64 `json:"password_id,omitempty"`
}

IssuePasswordRequest sync password(s) to device.

func (*IssuePasswordRequest) Method

func (i *IssuePasswordRequest) Method() string

Method for Request.Method()

func (*IssuePasswordRequest) URL

func (i *IssuePasswordRequest) URL() string

URL for Request.URL()

type IssuePasswordResponse

type IssuePasswordResponse bool

IssuePasswordResponse shows success or not.

type OfflineTempPwdRequest

type OfflineTempPwdRequest struct {
	DeviceID string `json:"-" validate:"required"`

	EffectiveTime int64  `json:"effective_time" validate:"required"`
	InvalidTime   int64  `json:"invalid_time" validate:"required"`
	Name          string `json:"name"`
	Type          int    `json:"type"`
	Lang          string `json:"lang" validate:"required"`
}

OfflineTempPwdRequest request to a offline temp password

func (*OfflineTempPwdRequest) Body

func (d *OfflineTempPwdRequest) Body() interface{}

Body struct.

func (*OfflineTempPwdRequest) Method

func (d *OfflineTempPwdRequest) Method() string

Method for Request.Method()

func (*OfflineTempPwdRequest) URL

func (d *OfflineTempPwdRequest) URL() string

URL for Request.URL()

type OfflineTempPwdResponse

type OfflineTempPwdResponse struct {
	OfflineTempPassword string `json:"offline_temp_password"`
}

OfflineTempPwdResponse returns a offline temp password

type OpenLog

type OpenLog struct {
	Status struct {
		Code  string `json:"code"`
		Value string `json:"value"`
	} `json:"status"`
	UpdateTime int64 `json:"update_time"`
}

OpenLog details of open action.

type QueryOpenLogsRequest

type QueryOpenLogsRequest struct {
	DeviceID string `url:"-" validate:"required"`

	PageNo    int   `url:"page_no" validate:"required"`
	PageSize  int   `url:"page_size" validate:"required"`
	StartTime int64 `url:"start_time" validate:"required"`
	EndTime   int64 `url:"end_time"  validate:"required"`
}

QueryOpenLogsRequest returns a list of logs.

func (*QueryOpenLogsRequest) Method

func (q *QueryOpenLogsRequest) Method() string

Method for Request.Method()

func (*QueryOpenLogsRequest) URL

func (q *QueryOpenLogsRequest) URL() string

URL for Request.URL()

type QueryOpenLogsResponse

type QueryOpenLogsResponse struct {
	Total  int       `json:"total"`
	Status []OpenLog `json:"status"`
}

QueryOpenLogsResponse returns a list if OpenLog

type QueryTempPwdListRequest

type QueryTempPwdListRequest struct {
	DeviceID string `json:"device_id" validate:"required"`
}

QueryTempPwdListRequest returns a list of temp passwords

func (*QueryTempPwdListRequest) Method

func (q *QueryTempPwdListRequest) Method() string

Method for Request.Method()

func (*QueryTempPwdListRequest) URL

func (q *QueryTempPwdListRequest) URL() string

URL for Request.URL()

type QueryTempPwdListResponse

type QueryTempPwdListResponse []QueryTempPwdResponse

QueryTempPwdListResponse return a list of QueryTempPwdResponse

type QueryTempPwdRequest

type QueryTempPwdRequest struct {
	DeviceID   string `json:"device_id" validate:"required"`
	PasswordID int64  `json:"password_id" validate:"required"`
}

QueryTempPwdRequest returns temp passwords info.

func (*QueryTempPwdRequest) Method

func (q *QueryTempPwdRequest) Method() string

Method for Request.Method()

func (*QueryTempPwdRequest) URL

func (q *QueryTempPwdRequest) URL() string

URL for Request.URL()

type QueryTempPwdResponse

type QueryTempPwdResponse struct {
	PasswordID    int64  `json:"password_id"`
	Name          string `json:"name"`
	Phase         int    `json:"phase"`
	EffectiveTime int64  `json:"effective_time"`
	InvalidTime   int64  `json:"invalid_time"`
	Phone         string `json:"phone"`
}

QueryTempPwdResponse returns temp password information.

type UpdateTempPwdRequest

type UpdateTempPwdRequest struct {
	DeviceID   string `json:"-" validate:"required"`
	PasswordID int64  `json:"-" validate:"required"`

	Phone         string `json:"phone,omitempty"`
	EffectiveTime int64  `json:"effective_time,omitempty"`
	InvalidTime   int64  `json:"invalid_time,omitempty"`
	Name          string `json:"name,omitempty"`
	Password      string `json:"password,omitempty"`
}

UpdateTempPwdRequest updates temp password.

func (*UpdateTempPwdRequest) Method

func (u *UpdateTempPwdRequest) Method() string

Method for Request.Method()

func (*UpdateTempPwdRequest) URL

func (u *UpdateTempPwdRequest) URL() string

URL for Request.URL()

type UpdateTempPwdResponse

type UpdateTempPwdResponse bool

UpdateTempPwdResponse show success or not.