devicectl

Documentation

Overview

Package devicectl for Device Control

Index

• type ControlDeviceRequest
  • func (s *ControlDeviceRequest) Method() string
  • func (s *ControlDeviceRequest) URL() string
• type ControlDeviceResponse
• type DeviceCommand
• type DeviceFunction
• type Function
• type QueryCategoryFunctionRequest
  • func (s *QueryCategoryFunctionRequest) Method() string
  • func (s *QueryCategoryFunctionRequest) URL() string
• type QueryCategoryFunctionResponse
• type QueryDeviceFunctionRequest
  • func (s *QueryDeviceFunctionRequest) Method() string
  • func (s *QueryDeviceFunctionRequest) URL() string
• type QueryDeviceFunctionResponse
• type QueryDeviceStatusRequest
  • func (s *QueryDeviceStatusRequest) Method() string
  • func (s *QueryDeviceStatusRequest) URL() string
• type QueryDeviceStatusResponse
• type QuerySpecificationsRequest
  • func (s *QuerySpecificationsRequest) Method() string
  • func (s *QuerySpecificationsRequest) URL() string
• type QuerySpecificationsResponse

Types

type ControlDeviceRequest

type ControlDeviceRequest struct {
	DeviceID string          `url:"-" validate:"required" json:"-"`        // device id
	Commands []DeviceCommand `url:"-" validate:"required" json:"commands"` // commands
}

func (*ControlDeviceRequest) Method

func (s *ControlDeviceRequest) Method() string

Method for Request.Method()

func (*ControlDeviceRequest) URL

func (s *ControlDeviceRequest) URL() string

URL for Request.URL()

type ControlDeviceResponse

type ControlDeviceResponse bool

type DeviceCommand

type DeviceCommand struct {
	Code  string      `json:"code"`
	Value interface{} `json:"value"`
}

type DeviceFunction

type DeviceFunction struct {
	Code   string `json:"code"`   // code
	Type   string `json:"type"`   // type
	Values string `json:"values"` // value ranges
	Name   string `json:"name"`   // Instruction name
	Desc   string `json:"desc"`   // description
}

type Function

type Function struct {
	Code   string `json:"code"`   // code
	Type   string `json:"type"`   // type
	Values string `json:"values"` // value range
}

type QueryCategoryFunctionRequest

type QueryCategoryFunctionRequest struct {
	Category string `url:"-" validate:"required" json:"-"` // category name
}

func (*QueryCategoryFunctionRequest) Method

func (s *QueryCategoryFunctionRequest) Method() string

Method for Request.Method()

func (*QueryCategoryFunctionRequest) URL

func (s *QueryCategoryFunctionRequest) URL() string

URL for Request.URL()

type QueryCategoryFunctionResponse

type QueryCategoryFunctionResponse Function

type QueryDeviceFunctionRequest

type QueryDeviceFunctionRequest struct {
	DeviceID string `url:"-" validate:"required" json:"-"` // Device id
}

func (*QueryDeviceFunctionRequest) Method

func (s *QueryDeviceFunctionRequest) Method() string

Method for Request.Method()

func (*QueryDeviceFunctionRequest) URL

func (s *QueryDeviceFunctionRequest) URL() string

URL for Request.URL()

type QueryDeviceFunctionResponse

type QueryDeviceFunctionResponse struct {
	Category  string           `json:"category"`  // Category
	Functions []DeviceFunction `json:"functions"` // Functions
}

type QueryDeviceStatusRequest

type QueryDeviceStatusRequest struct {
	DeviceID string `url:"-" validate:"required" json:"-"` // device id
}

func (*QueryDeviceStatusRequest) Method

func (s *QueryDeviceStatusRequest) Method() string

Method for Request.Method()

func (*QueryDeviceStatusRequest) URL

func (s *QueryDeviceStatusRequest) URL() string

URL for Request.URL()

type QueryDeviceStatusResponse

type QueryDeviceStatusResponse []DeviceCommand

type QuerySpecificationsRequest

type QuerySpecificationsRequest struct {
	DeviceID string `url:"-" validate:"required" json:"-"` // device id
}

func (*QuerySpecificationsRequest) Method

func (s *QuerySpecificationsRequest) Method() string

Method for Request.Method()

func (*QuerySpecificationsRequest) URL

func (s *QuerySpecificationsRequest) URL() string

URL for Request.URL()

type QuerySpecificationsResponse

type QuerySpecificationsResponse struct {
	Category  string   `json:"category"`  // Product category
	Functions Function `json:"functions"` // Instruction set
	Status    Function `json:"status"`    // State set
}