const (
	// VERSION of this library
	VERSION = "1.0.4"
)

func SetLogger(logger common.Logger)

type Client struct {
	common.SubscriptionProvider
	sync.RWMutex
}

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

func (c *Client) Close() error

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

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

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

func (c *Client) GetGroupByID(id string) (common.Group, error)

func (c *Client) GetGroupByLabel(label string) (common.Group, error)

func (c *Client) GetGroups() (groups []common.Group, err error)

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

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

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

func (c *Client) GetLocationByID(id string) (common.Location, error)

func (c *Client) GetLocationByLabel(label string) (common.Location, error)

func (c *Client) GetLocations() (locations []common.Location, err error)

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

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

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

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

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

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

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

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

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 = 100 * 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`)
	// ErrUnsupported operation is not supported
	ErrUnsupported = errors.New(`Operation not supported`)
)

func ColorEqual(a, b Color) bool

func SetLogger(logger Logger)

type Client interface {
	GetTimeout() *time.Duration
	GetRetryInterval() *time.Duration
}

type Color struct {
	Hue        uint16 `json:"hue"`        // range 0 to 65535
	Saturation uint16 `json:"saturation"` // range 0 to 65535
	Brightness uint16 `json:"brightness"` // range 0 to 65535
	Kelvin     uint16 `json:"kelvin"`     // range 2500° (warm) to 9000° (cool)
}

func AverageColor(colors ...Color) (color Color)

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

	// GetLabel gets the label for the device
	GetLabel() (string, error)
	// SetLabel sets the label for the device
	SetLabel(label string) error
	// GetPower requests the current power state of the device, true for on,
	// false for off
	GetPower() (bool, error)
	// CachedPower returns the last known power state of the device, true for
	// on, false for off
	CachedPower() bool
	// SetPower sets the power state of the device, true for on, false for off
	SetPower(state bool) error
	// GetFirmwareVersion returns the firmware version of the device
	GetFirmwareVersion() (string, error)
	// CachedFirmwareVersion returns the last known firmware version of the
	// device
	CachedFirmwareVersion() string
	// GetProductName returns the product name of the device
	GetProductName() (string, error)

	// Device is a SubscriptionTarget
	SubscriptionTarget
}

type ErrNotImplemented struct {
	Method string
}

func (e *ErrNotImplemented) Error() string

type EventExpiredDevice struct {
	Device Device
}

type EventExpiredGroup struct {
	Group Group
}

type EventExpiredLocation struct {
	Location Location
}

type EventNewDevice struct {
	Device Device
}

type EventNewGroup struct {
	Group Group
}

type EventNewLocation struct {
	Location Location
}

type EventUpdateColor struct {
	Color Color
}

type EventUpdateLabel struct {
	Label string
}

type EventUpdatePower struct {
	Power bool
}

type Group interface {
	// ID returns a base64 encoding of the device ID
	ID() string

	// Label returns the label for the group
	GetLabel() string

	// Devices returns the devices in the group
	Devices() []Device

	// Lights returns the lights in the group
	Lights() []Light

	// Returns the power state of the group, true if any members are on, false
	// if all members off. Returns error on communication errors.
	GetPower() (bool, error)

	// Returns the average color of lights in the group. Returns error on
	// communication error.
	GetColor() (Color, error)

	// SetColor requests a change of color for all devices in the group that
	// support color changes, transitioning over the specified duration
	SetColor(color Color, duration time.Duration) error
	// SetPower sets the power of devices in the group that support power
	// changes, state is true for on, false for off.
	SetPower(state bool) error
	// SetPowerDuration sets the power of devices in the group that support
	// power changes, transitioning over the speficied duration, state is true
	// for on, false for off.
	SetPowerDuration(state bool, duration time.Duration) error

	// Device is a SubscriptionTarget
	SubscriptionTarget
}

type Light interface {
	// SetColor changes the color of the light, transitioning over the specified
	// duration
	SetColor(color Color, duration time.Duration) error
	// GetColor requests the current color of the light
	GetColor() (Color, error)
	// CachedColor returns the last known color of the light
	CachedColor() Color
	// 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 is a superset of the Device interface
	Device
}

type Location interface {
	// Location is a group
	Group
}

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{})
}

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

type Protocol interface {
	SubscriptionTarget

	// GetLocations returns a slice of all locations known to the protocol, or
	// ErrNotFound if no locations are currently known.
	GetLocations() (locations []Location, err error)
	// GetLocation looks up a location by its `id`
	GetLocation(id string) (Location, error)
	// GetGroups returns a slice of all groups known to the protocol, or
	// ErrNotFound if no locations are currently known.
	GetGroups() (locations []Group, err error)
	// GetGroup looks up a group by its `id`
	GetGroup(id string) (Group, error)
	// GetDevices returns a slice of all devices known to the protocol, or
	// ErrNotFound if no devices are currently known.
	GetDevices() (devices []Device, err error)
	// GetDevice looks up a device by its `id`
	GetDevice(id uint64) (Device, 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
	Discover() error
	// SetTimeout attaches the client timeout to the protocol
	SetTimeout(timeout *time.Duration)
	// SetRetryInterval attaches the client retry interval to the protocol
	SetRetryInterval(retryInterval *time.Duration)
	// Close closes the protocol driver, no further communication with the
	// protocol is possible
	Close() error

	// SetPower sets the power state globally, on all devices
	SetPower(state bool) error
	// SetPowerDuration sets the power state globally, on all lights, over the
	// specified duration
	SetPowerDuration(state bool, duration time.Duration) error
	// SetColor changes the color globally, on all lights, over the specified
	// duration
	SetColor(color Color, duration time.Duration) error
}

type StubLogger struct{}

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

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

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

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

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

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

type Subscription struct {
	sync.Mutex
}

func (s *Subscription) Close() error

func (s *Subscription) Events() <-chan interface{}

type SubscriptionProvider struct {
	sync.RWMutex
}

func (s *SubscriptionProvider) Close() (err error)

func (s *SubscriptionProvider) Notify(event interface{})

func (s *SubscriptionProvider) Subscribe() *Subscription

type SubscriptionTarget interface {
	Subscribe() *Subscription
	Notify(event interface{})
}