http

Documentation

Index

• type Command
• type HttpGdo
  • func Initialize(config map[string]interface{}) (HttpGdo, error)
  • func NewHttpGdo(config map[string]interface{}) (HttpGdo, error)

Types

type Command

type Command struct {
	Name                string `yaml:"name"` // e.g. `open` or `close`
	Endpoint            string `yaml:"endpoint"`
	HttpMethod          string `yaml:"http_method"`
	Body                string `yaml:"body"`
	RequiredStartState  string `yaml:"required_start_state"`  // if set, garage door will not operate if current state does not equal this
	RequiredFinishState string `yaml:"required_finish_state"` // if set, garage door will monitor the door state compared to this value to determine success
	Timeout             int    `yaml:"timeout"`               // time to wait for garage door to operate if monitored
}

type HttpGdo

type HttpGdo interface {
	SetGarageDoor(string) error
	ProcessShutdown()
}

func Initialize

func Initialize(config map[string]interface{}) (HttpGdo, error)

func NewHttpGdo

func NewHttpGdo(config map[string]interface{}) (HttpGdo, error)