rules

Documentation

Overview

Package rules defines the generic rules engine.

Index

• type Command
  • func (c *Command) ToMsg() msgbus.Message
  • func (c *Command) Validate() error
• type Rule
  • func Default() []Rule
• type Rules
• type Signal
  • func (s Signal) Eval(input string) bool

Types

type Command

type Command struct {
	Topic   string
	Payload string
}

Command is an MQTT message to send to take action.

Most commands shall respect the Homie convention. https://github.com/marvinroger/homie

func (*Command) ToMsg

func (c *Command) ToMsg() msgbus.Message

ToMsg converts the command to a MQTT Message.

func (*Command) Validate

func (c *Command) Validate() error

Validate ensures the command is valid.

type Rule

type Rule struct {
	Signal Signal
	Cmd    Command
}

Rule defines a signal that triggers a command.

func Default

func Default() []Rule

Default returns default rules that can be set on a fresh instance.

type Rules

type Rules map[string]Rule

Rules is named rules.

type Signal

type Signal string

Signal defines what signal triggers this rule.

TODO(maruel): Define the language.

func (Signal) Eval

func (s Signal) Eval(input string) bool

Eval evaluates if a signal is a trigger for this rule.