bulb

package

v0.0.0-...-ba79be1 Latest Latest Go to latest Published: Nov 4, 2021 License: GPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Bulb struct {
	Addr string
}

Bulb represents all the info necessary to identify a smart light.

func (b Bulb) Connect() (*textproto.Conn, error)

Connect initializes a connection to a bulb.

func (b Bulb) Send(c Command) (resp Response, err error)

Send sends a Command to a bulb and waits for the response.

type Command struct {
	Id     int           `json:"id"`
	Method string        `json:"method"`
	Params []interface{} `json:"params"`
}

Command is a a JSON-serializable command in the Yeelight API format.

func NewCommand(id int, method string, params ...interface{}) Command

NewCommand creates a new Command.

type ParsedResponse struct {
	Id     int      `json:"id"`
	Result []string `json:"result"`
}

ParsedResponse is an already parsed smart light response.

func (p ParsedResponse) Success() bool

Success indicates whether a Command finished without errors.

type Response []byte

Response is a raw smart light response to a command.

func (r Response) Decode() (p ParsedResponse, err error)

Decode parses a Response into a ParsedResponse.