api

Documentation

Index

• func DiscoverBridgeAddress() (address string, err error)
• func PutLamp(config Config, lamp *Lamp) (err error)
• func RegisterUser(config Config) (username string, err error)
• func SetConfig(config *Config) (err error)
• func UnregisterUser(config Config) (err error)
• type Config
  • func GetConfig() (config Config, err error)
• type Lamp
  • func GetLamp(config Config) (lamp *Lamp, err error)
• type LampState
• type NUPnP
• type RegisterError
• type RegisterResponse
• type RegisterSuccess
• type User

Functions

func DiscoverBridgeAddress

func DiscoverBridgeAddress() (address string, err error)

DiscoverBridgeAddress use meethue.com/api/nupnp to find the Philips Hue Bridge locally

func PutLamp

func PutLamp(config Config, lamp *Lamp) (err error)

PutLamp update the State of a Hue Lamp using the API

func RegisterUser

func RegisterUser(config Config) (username string, err error)

RegisterUser ask for Philips Hue Bridge to register a new username

func SetConfig

func SetConfig(config *Config) (err error)

SetConfig write te config.yml file from the config parameter

func UnregisterUser

func UnregisterUser(config Config) (err error)

UnregisterUser delete the username on config from the Philips Hue Bridge

Types

type Config

type Config struct {
	Id       int    `yaml:"id"`
	Address  string `yaml:"address"`
	Username string `yaml:"username"`
	Steps    int    `yaml:"steps"`
}

Config contain the necessary data to interact with the API

func GetConfig

func GetConfig() (config Config, err error)

GetConfig read the config.yml file in the executable directory and return it

type Lamp

type Lamp struct {
	State LampState `json:"state"`
}

Lamp hold informations of a Hue Lamp from the API

func GetLamp

func GetLamp(config Config) (lamp *Lamp, err error)

GetLamp request to the API for informations about a Hue Lamp It returns a Lamp with the current State

type LampState

type LampState struct {
	On         bool `json:"on"`
	Brightness int  `json:"bri"`
	Reachable  bool `json:"reachable"`
}

LampState represents the State of a Hue Lamp from the API

type NUPnP

type NUPnP struct {
	Address string `json:"internalipaddress"`
}

NUPnP represents the response from the search of a Hue Bridge

type RegisterError

type RegisterError struct {
	ErrorType   int    `json:"type"`
	Address     string `json:"address"`
	Description string `json:"description"`
}

RegisterError represent the data from a failed RegisterResponse

type RegisterResponse

type RegisterResponse struct {
	ErrorData   RegisterError   `json:"error"`
	SuccessData RegisterSuccess `json:"success"`
}

RegisterResponse represent the response from registering a username

type RegisterSuccess

type RegisterSuccess struct {
	Username string `json:"username"`
}

RegisterSuccess represent the data from a succeeded RegisterResponse

type User

type User struct {
	DeviceType string `json:"devicetype"`
}

User is used to register a new username