modules

Documentation

Index

• Variables
• func Register(name string, builder ModuleBuilder)
• type HeatingModule
  • func (c *HeatingModule) Start() error
  • func (c *HeatingModule) Stop() error
• type Module
  • func NewHeatingModule(mqttClient mqtt.Client, heatingConfig []data.HeatingConfig, ...) Module
• type ModuleBuilder

Variables

var Modules = map[string]ModuleBuilder{}

Functions

func Register

func Register(name string, builder ModuleBuilder)

Register stores a builder function into the registy for external access. Register() can be called from init() on a module in this package and will automatically register a module.

Types

type HeatingModule

type HeatingModule struct {
	// contains filtered or unexported fields
}

func (*HeatingModule) Start

func (c *HeatingModule) Start() error

func (*HeatingModule) Stop

func (c *HeatingModule) Stop() error

type Module

type Module interface {
	Start() error
	Stop() error
}

Interface for the different modules being

func NewHeatingModule

func NewHeatingModule(mqttClient mqtt.Client, heatingConfig []data.HeatingConfig, config *config.Config) Module

type ModuleBuilder

type ModuleBuilder func(mqtt.Client, []data.HeatingConfig, *config.Config) Module