shared

Documentation

Index

• Variables
• func UpdateConfiguration(c Configuration)
• type Configuration
  • func ReadConfig(overriddenPath string) *Configuration
• type Event

Variables

var ConfigFilePath string

ConfigFilePath is the path to the config file

Functions

func UpdateConfiguration

func UpdateConfiguration(c Configuration)

UpdateConfiguration save new config to disk

Types

type Configuration

type Configuration struct {
	// ListenerPort is the own port which hm2mqtt is listening to
	ListenerPort int
	// InterfaceID is an ID used for RPC calls
	InterfaceID int
	// HomematicURL the url points to homematic rpc
	HomematicURL string
	// BrokerURL the url points to a mqtt broker
	BrokerURL string
	// Retain mqtt messages
	Retain bool
}

Configuration is the config which is necessarily to run hm2mqtt

var Config Configuration

Config is the instance of the actual Configuration

func ReadConfig

func ReadConfig(overriddenPath string) *Configuration

ReadConfig read config from disk

type Event

type Event struct {
	MethodName   string
	SerialNumber string
	Type         string
	DataValue    string
}

Event represents one event from the rpc interface