homematic

Documentation

Index

• type CCU
  • func NewCCU(address string, exclude *regexp.Regexp) (*CCU, error)
• type Device
  • func NewDevice(device *homematic.Device) (*Device, error)
  • func (d *Device) Events() map[string]api.SimpleHandler
  • func (d *Device) GetValueTypes() api.FieldMap
  • func (d *Device) GetValues() map[string]interface{}
  • func (d *Device) ID() string
  • func (d *Device) IsActorItem() bool
  • func (d *Device) IsEventItem() bool
  • func (d *Device) IsSensorItem() bool
  • func (d *Device) Name() string
  • func (d *Device) SetEventTrigger(trigger func(action string, data map[string]interface{}))
  • func (d *Device) SetValues(values map[string]interface{}) error
• type Plugin
  • func (p *Plugin) Config() *core.PluginConfigDef
  • func (p *Plugin) ID() string
  • func (p *Plugin) Init(b core.Bus) error
  • func (p *Plugin) Shutdown()
  • func (p *Plugin) Version() string

Types

type CCU

type CCU struct {
	// address of CCU
	Address string
	// Regex to exclude entries from item list
	Exclude *regexp.Regexp
	// interval for state updates
	UpdateInterval time.Duration
	// contains filtered or unexported fields
}

CCU instance of homematic CCU

func NewCCU

func NewCCU(address string, exclude *regexp.Regexp) (*CCU, error)

NewCCU creates new CCU instance

type Device

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

Device of HomeMatic CCU

func NewDevice

func NewDevice(device *homematic.Device) (*Device, error)

NewDevice creates a new device

func (*Device) Events

func (d *Device) Events() map[string]api.SimpleHandler

Events returns all events that can be emitted

func (*Device) GetValueTypes

func (d *Device) GetValueTypes() api.FieldMap

GetValueTypes of switch

func (*Device) GetValues

func (d *Device) GetValues() map[string]interface{}

GetValues of switch

func (*Device) ID

func (d *Device) ID() string

ID of item

func (*Device) IsActorItem

func (d *Device) IsActorItem() bool

IsActorItem returns true if item is a actor

func (*Device) IsEventItem

func (d *Device) IsEventItem() bool

IsEventItem returns true if item is a event

func (*Device) IsSensorItem

func (d *Device) IsSensorItem() bool

IsSensorItem returns true if item is a sensor

func (*Device) Name

func (d *Device) Name() string

Name of item

func (*Device) SetEventTrigger

func (d *Device) SetEventTrigger(trigger func(action string, data map[string]interface{}))

SetEventTrigger for item event

func (*Device) SetValues

func (d *Device) SetValues(values map[string]interface{}) error

SetValues of switch

type Plugin

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

Plugin that implements homematic functionality

func (*Plugin) Config

func (p *Plugin) Config() *core.PluginConfigDef

Config returns the definition of the config interface

func (*Plugin) ID

func (p *Plugin) ID() string

ID of plugin

func (*Plugin) Init

func (p *Plugin) Init(b core.Bus) error

Init plugin

func (*Plugin) Shutdown

func (p *Plugin) Shutdown()

Shutdown called if plugin should be stopped

func (*Plugin) Version

func (p *Plugin) Version() string

Version information of plugin