golifx

package module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 27, 2015 License: MIT Imports: 4 Imported by: 0

README

Build Status GoDoc License-MIT

Note: This library is at a moderately early stage - everything should work, but the V2 protocol implementation needs documentation and testing.

If you have Go installed, you can install the lifx CLI application like so:

go get -u github.com/pdf/golifx/cmd/lifx

The lifx command will be available at ${GOPATH}/bin/lifx

golifx

-- import "github.com/pdf/golifx"

Package golifx provides a simple Go interface to the LIFX LAN protocol.

Based on the protocol documentation available at: http://lan.developer.lifx.com/

Also included in cmd/lifx is a small CLI utility that allows interacting with your LIFX devices on the LAN.

Usage

const (
	// VERSION of this library
	VERSION = `0.0.1`
)
func SetLogger
func SetLogger(logger common.Logger)

SetLogger allows assigning a custom levelled logger that conforms to the common.Logger interface. To capture logs generated during client creation, this should be called before creating a Client. Defaults to common.StubLogger, which does no logging at all.

type Client
type Client struct {
	sync.RWMutex
}

Client provides a simple interface for interacting with LIFX devices. Client can not be instantiated manually or it will not function - always use NewClient() to obtain a Client instance.

func NewClient
func NewClient(p protocol.Protocol) (*Client, error)

NewClient returns a pointer to a new Client and any error that occurred initializing the client, using the protocol p. It also kicks off a discovery run.

func (*Client) AddDevice
func (c *Client) AddDevice(dev common.Device) error

AddDevice is for use by protocols only. Adds dev to the client's known devices, and returns dev. Returns common.ErrDuplicate if the device is already known.

func (*Client) Close
func (c *Client) Close() error

Close signals the termination of this client, and cleans up resources

func (*Client) GetDeviceByID
func (c *Client) GetDeviceByID(id uint64) (common.Device, error)

GetDeviceByID looks up a device by it's id and returns a common.Device. May return a common.ErrNotFound error if the lookup times out without finding the device.

func (*Client) GetDeviceByLabel
func (c *Client) GetDeviceByLabel(label string) (common.Device, error)

GetDeviceByLabel looks up a device by it's label and returns a common.Device. May return a common.ErrNotFound error if the lookup times out without finding the device.

func (*Client) GetDevices
func (c *Client) GetDevices() ([]common.Device, error)

GetDevices returns a slice of all devices known to the client, or common.ErrNotFound if no devices are currently known.

func (*Client) GetLightByID
func (c *Client) GetLightByID(id uint64) (light common.Light, err error)

GetLightByID looks up a light by it's id and returns a common.Light. May return a common.ErrNotFound error if the lookup times out without finding the light, or common.ErrDeviceInvalidType if the device exists but is not a light.

func (*Client) GetLightByLabel
func (c *Client) GetLightByLabel(label string) (light common.Light, err error)

GetLightByLabel looks up a light by it's label and returns a common.Light. May return a common.ErrNotFound error if the lookup times out without finding the light, or common.ErrDeviceInvalidType if the device exists but is not a light.

func (*Client) GetLights
func (c *Client) GetLights() (lights []common.Light, err error)

GetLights returns a slice of all lights known to the client, or common.ErrNotFound if no lights are currently known.

func (*Client) GetRetryInterval
func (c *Client) GetRetryInterval() *time.Duration

GetRetryInterval returns the currently configured retry interval for operations on this client

func (*Client) GetTimeout
func (c *Client) GetTimeout() *time.Duration

GetTimeout returns the currently configured timeout period for operations on this client

func (*Client) RemoveDeviceByID
func (c *Client) RemoveDeviceByID(id uint64) error

RemoveDeviceByID is for use by protocols only. Looks up a device by it's id and removes it from the client's list of known devices, or returns common.ErrNotFound if the device is not known at this time.

func (*Client) SetColor
func (c *Client) SetColor(color common.Color, duration time.Duration) error

SetColor broadcasts a request to change the color of all devices on the network.

func (*Client) SetDiscoveryInterval
func (c *Client) SetDiscoveryInterval(interval time.Duration) error

SetDiscoveryInterval causes the client to discover devices and state every interval. You should set this to a non-zero value for any long-running process, otherwise devices will only be discovered once.

func (*Client) SetPower
func (c *Client) SetPower(state bool) error

SetPower broadcasts a request to change the power state of all devices on the network. A state of true requests power on, and a state of false requests power off.

func (*Client) SetPowerDuration
func (c *Client) SetPowerDuration(state bool, duration time.Duration) error

SetPowerDuration broadcasts a request to change the power state of all devices on the network, transitioning over the specified duration. A state of true requests power on, and a state of false requests power off. Not all device types support transitioning, so if you wish to change the state of all device types, you should use SetPower instead.

func (*Client) SetRetryInterval
func (c *Client) SetRetryInterval(retryInterval time.Duration)

SetRetryInterval sets the retry interval for operations on this client. If a timeout has been set, and the retry interval exceeds the timeout, the retry interval will be set to half the timeout

func (*Client) SetTimeout
func (c *Client) SetTimeout(timeout time.Duration)

SetTimeout sets the time that client operations wait for results before returning an error. The special value of 0 may be set to disable timeouts, and all operations will wait indefinitely, but this is not recommended.

common

-- import "github.com/pdf/golifx/common"

Package common contains common elements for the golifx client and protocols

Usage

const (
	// DefaultTimeout is the default duration after which operations time out
	DefaultTimeout = 2 * time.Second
	// DefaultRetryInterval is the default interval at which operations are
	// retried
	DefaultRetryInterval = 500 * time.Millisecond
)

var (
	// ErrNotFound not found
	ErrNotFound = errors.New(`Not found`)
	// ErrProtocol protocol error
	ErrProtocol = errors.New(`Protocol error`)
	// ErrDuplicate already exists
	ErrDuplicate = errors.New(`Already exists`)
	// ErrInvalidArgument invalid argument
	ErrInvalidArgument = errors.New(`Invalid argument`)
	// ErrClosed connection closed
	ErrClosed = errors.New(`Connection closed`)
	// ErrTimeout timed out
	ErrTimeout = errors.New(`Timed out`)
	// ErrDeviceInvalidType invalid device type
	ErrDeviceInvalidType = errors.New(`Invalid device type`)
)
func SetLogger
func SetLogger(logger Logger)

SetLogger wraps the supplied logger with a logPrefixer to denote golifx logs

type Client
type Client interface {
	AddDevice(Device) error
	RemoveDeviceByID(uint64) error
	GetTimeout() *time.Duration
	GetRetryInterval() *time.Duration
}

Client defines the interface required by protocols

type Color
type Color struct {
	Hue        uint16 // range 0 to 65535
	Saturation uint16 // range 0 to 65535
	Brightness uint16 // range 0 to 65535
	Kelvin     uint16 // range 2500° (warm) to 9000° (cool)
}

Color is used to represent the color and color temperature of a light. The color is represented as an HSB (Hue, Saturation, Brightness) value. The color temperature is represented in K (Kelvin) and is used to adjust the warmness / coolness of a white light, which is most obvious when saturation is close zero.

type Device
type Device interface {
	// Returns the ID for the device
	ID() uint64

	// Returns the label for the device
	GetLabel() (string, error)
	// Sets the label for the device
	SetLabel(label string) error

	// Returns the power state of the device, true for on, false for off
	GetPower() (bool, error)
	// Sets the power state of the device, true for on, false for off
	SetPower(state bool) error
}

Device represents a generic LIFX device

type ErrNotImplemented
type ErrNotImplemented struct {
	Method string
}

ErrNotImplemented not implemented

func (*ErrNotImplemented) Error
func (e *ErrNotImplemented) Error() string

Error satisfies the error interface

type Light
type Light interface {
	// A light is a superset of the Device interface
	Device
	// SetColor changes the color of the light, transitioning over the specified
	// duration
	SetColor(color Color, duration time.Duration) error
	// GetColor returns the current color of the light
	GetColor() (Color, error)
	// SetPowerDuration sets the power of the light, transitioning over the
	// speficied duration, state is true for on, false for off.
	SetPowerDuration(state bool, duration time.Duration) error
}

Light represents a LIFX light device

type Logger
type Logger interface {
	// Debugf handles debug level messages
	Debugf(format string, args ...interface{})
	// Infof handles info level messages
	Infof(format string, args ...interface{})
	// Warnf handles warn level messages
	Warnf(format string, args ...interface{})
	// Errorf handles error level messages
	Errorf(format string, args ...interface{})
	// Fatalf handles fatal level messages, and must exit the application
	Fatalf(format string, args ...interface{})
	// Panicf handles debug level messages, and must panic the application
	Panicf(format string, args ...interface{})
}

Logger represents a minimal levelled logger

var (
	// Log holds the global logger used by golifx, can be set via SetLogger() in
	// the golifx package
	Log Logger
)
type StubLogger
type StubLogger struct{}

StubLogger satisfies the Logger interface, and simply does nothing with received messages

func (*StubLogger) Debugf
func (l *StubLogger) Debugf(format string, args ...interface{})

Debugf handles debug level messages

func (*StubLogger) Errorf
func (l *StubLogger) Errorf(format string, args ...interface{})

Errorf handles error level messages

func (*StubLogger) Fatalf
func (l *StubLogger) Fatalf(format string, args ...interface{})

Fatalf handles fatal level messages, exits the application

func (*StubLogger) Infof
func (l *StubLogger) Infof(format string, args ...interface{})

Infof handles info level messages

func (*StubLogger) Panicf
func (l *StubLogger) Panicf(format string, args ...interface{})

Panicf handles debug level messages, and panics the application

func (*StubLogger) Warnf
func (l *StubLogger) Warnf(format string, args ...interface{})

Warnf handles warn level messages

Documentation

Overview

Package golifx provides a simple Go interface to the LIFX LAN protocol.

Based on the protocol documentation available at: http://lan.developer.lifx.com/

Also included in cmd/lifx is a small CLI utility that allows interacting with your LIFX devices on the LAN.

Index

Examples

Constants

View Source 
const (
	// VERSION of this library
	VERSION = `0.0.4`
)

Variables

This section is empty.

Functions

func SetLogger 

func SetLogger(logger common.Logger)

SetLogger allows assigning a custom levelled logger that conforms to the common.Logger interface. To capture logs generated during client creation, this should be called before creating a Client. Defaults to common.StubLogger, which does no logging at all.

Types

type Client 

type Client struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Client provides a simple interface for interacting with LIFX devices. Client can not be instantiated manually or it will not function - always use NewClient() to obtain a Client instance.

func NewClient 

func NewClient(p protocol.Protocol) (*Client, error)

NewClient returns a pointer to a new Client and any error that occurred initializing the client, using the protocol p. It also kicks off a discovery run.

Example (V2)

Instantiating a new client with protocol V2 

package main

import (
	"github.com/pdf/golifx"
	"github.com/pdf/golifx/protocol"
)

func main() {
	client, err := golifx.NewClient(&protocol.V2{})
	if err != nil {
		panic(err)
	}
	client.GetLightByLabel(`lightLabel`)
}

Output:
Example (V2port)

When using protocol V2, it's possible to choose an alternative client port. This is not recommended unless you need to use multiple client instances at the same time. 

package main

import (
	"github.com/pdf/golifx"
	"github.com/pdf/golifx/protocol"
)

func main() {
	client, err := golifx.NewClient(&protocol.V2{Port: 56701})
	if err != nil {
		panic(err)
	}
	client.GetLightByLabel(`lightLabel`)
}

Output:

func (*Client) AddDevice 

func (c *Client) AddDevice(dev common.Device) error

AddDevice is for use by protocols only. Adds dev to the client's known devices, and returns dev. Returns common.ErrDuplicate if the device is already known.

func (*Client) Close 

func (c *Client) Close() error

Close signals the termination of this client, and cleans up resources

func (*Client) GetDeviceByID 

func (c *Client) GetDeviceByID(id uint64) (common.Device, error)

GetDeviceByID looks up a device by it's id and returns a common.Device. May return a common.ErrNotFound error if the lookup times out without finding the device.

func (*Client) GetDeviceByLabel 

func (c *Client) GetDeviceByLabel(label string) (common.Device, error)

GetDeviceByLabel looks up a device by it's label and returns a common.Device. May return a common.ErrNotFound error if the lookup times out without finding the device.

func (*Client) GetDevices 

func (c *Client) GetDevices() ([]common.Device, error)

GetDevices returns a slice of all devices known to the client, or common.ErrNotFound if no devices are currently known.

func (*Client) GetLightByID 

func (c *Client) GetLightByID(id uint64) (light common.Light, err error)

GetLightByID looks up a light by it's id and returns a common.Light. May return a common.ErrNotFound error if the lookup times out without finding the light, or common.ErrDeviceInvalidType if the device exists but is not a light.

func (*Client) GetLightByLabel 

func (c *Client) GetLightByLabel(label string) (light common.Light, err error)

GetLightByLabel looks up a light by it's label and returns a common.Light. May return a common.ErrNotFound error if the lookup times out without finding the light, or common.ErrDeviceInvalidType if the device exists but is not a light.

func (*Client) GetLights 

func (c *Client) GetLights() (lights []common.Light, err error)

GetLights returns a slice of all lights known to the client, or common.ErrNotFound if no lights are currently known.

func (*Client) GetRetryInterval 

func (c *Client) GetRetryInterval() *time.Duration

GetRetryInterval returns the currently configured retry interval for operations on this client

func (*Client) GetTimeout 

func (c *Client) GetTimeout() *time.Duration

GetTimeout returns the currently configured timeout period for operations on this client

func (*Client) RemoveDeviceByID 

func (c *Client) RemoveDeviceByID(id uint64) error

RemoveDeviceByID is for use by protocols only. Looks up a device by it's id and removes it from the client's list of known devices, or returns common.ErrNotFound if the device is not known at this time.

func (*Client) SetColor 

func (c *Client) SetColor(color common.Color, duration time.Duration) error

SetColor broadcasts a request to change the color of all devices on the network.

func (*Client) SetDiscoveryInterval 

func (c *Client) SetDiscoveryInterval(interval time.Duration) error

SetDiscoveryInterval causes the client to discover devices and state every interval. You should set this to a non-zero value for any long-running process, otherwise devices will only be discovered once.

func (*Client) SetPower 

func (c *Client) SetPower(state bool) error

SetPower broadcasts a request to change the power state of all devices on the network. A state of true requests power on, and a state of false requests power off.

func (*Client) SetPowerDuration added in v0.0.2 

func (c *Client) SetPowerDuration(state bool, duration time.Duration) error

SetPowerDuration broadcasts a request to change the power state of all devices on the network, transitioning over the specified duration. A state of true requests power on, and a state of false requests power off. Not all device types support transitioning, so if you wish to change the state of all device types, you should use SetPower instead.

func (*Client) SetRetryInterval 

func (c *Client) SetRetryInterval(retryInterval time.Duration)

SetRetryInterval sets the retry interval for operations on this client. If a timeout has been set, and the retry interval exceeds the timeout, the retry interval will be set to half the timeout

func (*Client) SetTimeout 

func (c *Client) SetTimeout(timeout time.Duration)

SetTimeout sets the time that client operations wait for results before returning an error. The special value of 0 may be set to disable timeouts, and all operations will wait indefinitely, but this is not recommended.

Source Files

View all Source files

Directories

Path Synopsis
cmd
lifx
Command lifx allows basic performing operations on LIFX devices over the LAN
 Command lifx allows basic performing operations on LIFX devices over the LAN
Package common contains common elements for the golifx client and protocols
 Package common contains common elements for the golifx client and protocols
Package protocol implements the LIFX LAN protocol.
 Package protocol implements the LIFX LAN protocol.
v2/device
Package device implements a LIFX LAN protocol version 2 device.
 Package device implements a LIFX LAN protocol version 2 device.
v2/packet
Package packet implements a LIFX LAN protocol version 2 packet.
 Package packet implements a LIFX LAN protocol version 2 packet.
v2/shared
Package shared contains shared elements of the LIFX LAN protocol version 2.
 Package shared contains shared elements of the LIFX LAN protocol version 2.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.