protocol

Documentation

Overview

Package protocol implements the LIFX LAN protocol.

This package is not designed to used directly by end users, other than to specify a protocol version when creating a new Client from the golifx package.

The currently implemented protocol versions are:

V2

Index

• type V2
  • func (p *V2) Close() error
  • func (p *V2) Discover() error
  • func (p *V2) GetDevice(id uint64) (common.Device, error)
  • func (p *V2) GetDevices() ([]common.Device, error)
  • func (p *V2) GetGroup(id string) (common.Group, error)
  • func (p *V2) GetGroups() ([]common.Group, error)
  • func (p *V2) GetLocation(id string) (common.Location, error)
  • func (p *V2) GetLocations() ([]common.Location, error)
  • func (p *V2) SetColor(color common.Color, duration time.Duration) error
  • func (p *V2) SetPower(state bool) error
  • func (p *V2) SetPowerDuration(state bool, duration time.Duration) error
  • func (p *V2) SetRetryInterval(retryInterval *time.Duration)
  • func (p *V2) SetTimeout(timeout *time.Duration)

Types

type V2

type V2 struct {
	// IP determines UDP listen address for this protocol instance
	IP net.IP
	// Port determines UDP listen port for this protocol instance
	Port int
	// Reliable enables reliable comms, requests ACKs for all operations to
	// ensure they're delivered (recommended)
	Reliable bool

	common.SubscriptionProvider
	sync.RWMutex
	// contains filtered or unexported fields
}

V2 implements the LIFX LAN protocol version 2.

func (*V2) Close

func (p *V2) Close() error

Close closes the protocol driver, no further communication with the protocol is possible

func (*V2) Discover

func (p *V2) Discover() error

Discover initiates device discovery, this may be a noop in some future protocol versions. This is called immediately when the client connects to the protocol

func (*V2) GetDevice

func (p *V2) GetDevice(id uint64) (common.Device, error)

func (*V2) GetDevices

func (p *V2) GetDevices() ([]common.Device, error)

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

func (*V2) GetGroup

func (p *V2) GetGroup(id string) (common.Group, error)

func (*V2) GetGroups

func (p *V2) GetGroups() ([]common.Group, error)

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

func (*V2) GetLocation

func (p *V2) GetLocation(id string) (common.Location, error)

func (*V2) GetLocations

func (p *V2) GetLocations() ([]common.Location, error)

GetLocations returns a slice of all locations known to the protocol, or common.ErrNotFound if no locations are currently known.

func (*V2) SetColor

func (p *V2) SetColor(color common.Color, duration time.Duration) error

SetColor changes the color globally, on all lights, transitioning over the specified duration

func (*V2) SetPower

func (p *V2) SetPower(state bool) error

SetPower sets the power state globally, on all devices

func (*V2) SetPowerDuration

func (p *V2) SetPowerDuration(state bool, duration time.Duration) error

SetPowerDuration sets the power state globally, on all devices, transitioning over the specified duration

func (*V2) SetRetryInterval

func (p *V2) SetRetryInterval(retryInterval *time.Duration)

SetRetryInterval attaches a retry interval to the protocol

func (*V2) SetTimeout

func (p *V2) SetTimeout(timeout *time.Duration)

SetTimeout attaches a timeout to the protocol