automation

Documentation

Index

• Constants
• type Action
  • func NewAction(scriptService scripts.ScriptService, ...) (action *Action, err error)
  • func (a *Action) Run(entityId *common.EntityId) (result string, err error)
• type ActionBind
  • func NewActionBind(action *Action) *ActionBind
  • func (e *ActionBind) CallAction(id common.EntityId, action string, arg map[string]interface{})
• type Automation
  • func NewAutomation(lc fx.Lifecycle, eventBus bus.Bus, scriptService scripts.ScriptService, ...) (auto Automation)
• type Condition
  • func NewCondition(scriptService scripts.ScriptService, model *m.Condition, ...) (condition *Condition, err error)
  • func (r *Condition) Check(ctx context.Context) (result string, err error)
  • func (r *Condition) Status() bool
• type ConditionBind
  • func NewConditionBind(condition *Condition) *ConditionBind
• type ConditionGroup
  • func NewConditionGroup(automation *automation, t common.ConditionType) *ConditionGroup
  • func (c *ConditionGroup) AddCondition(condition *Condition)
  • func (c *ConditionGroup) Check(entityId *common.EntityId) (state bool, err error)
• type Task
  • func NewTask(automation *automation, scriptService scripts.ScriptService, model *m.Task, ...) *Task
  • func (t *Task) CallAction(name string)
  • func (t *Task) CallTrigger(name string)
  • func (t *Task) Id() int64
  • func (t *Task) Name() string
  • func (t *Task) Start()
  • func (t *Task) Stop()
• type Trigger
  • func NewTrigger(scriptService scripts.ScriptService, taskName string, model *m.Trigger, ...) (tr *Trigger, err error)
  • func (tr *Trigger) Call()
  • func (tr *Trigger) Check(msg interface{}) (state bool, err error)
  • func (tr *Trigger) EntityId() *common.EntityId
  • func (tr *Trigger) Id() int64
  • func (tr *Trigger) Start() (err error)
  • func (tr *Trigger) Stop() (err error)
• type TriggerBind
  • func NewTriggerBind(tr *Trigger) *TriggerBind

Constants

const ActionFunc = "automationAction"

ActionFunc ...

const ConditionFunc = "automationCondition"

ConditionFunc ...

const TriggerFunc = "automationTrigger"

TriggerFunc ...

Types

type Action

type Action struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Action ...

func NewAction

func NewAction(scriptService scripts.ScriptService,
	entityManager entity_manager.EntityManager,
	model *m.Action) (action *Action, err error)

NewAction ...

func (*Action) Run

func (a *Action) Run(entityId *common.EntityId) (result string, err error)

Run ...

type ActionBind

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

Javascript Binding

Action

.callAction(entityId, action, args)

func NewActionBind

func NewActionBind(action *Action) *ActionBind

NewActionBind...

func (*ActionBind) CallAction

func (e *ActionBind) CallAction(id common.EntityId, action string, arg map[string]interface{})

CallAction ...

type Automation

type Automation interface {
	Start() (err error)
	Shutdown() (err error)
	Reload()
	AddTask(model *m.Task)
	RemoveTask(model *m.Task)
}

Automation ...

func NewAutomation

func NewAutomation(lc fx.Lifecycle,
	eventBus bus.Bus,
	scriptService scripts.ScriptService,
	entityManager entity_manager.EntityManager,
	adaptors *adaptors.Adaptors,
	pluginManager common.PluginManager) (auto Automation)

NewAutomation ...

type Condition

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

Condition ...

func NewCondition

func NewCondition(scriptService scripts.ScriptService,
	model *m.Condition,
	entityManager entity_manager.EntityManager) (condition *Condition, err error)

NewCondition ...

func (*Condition) Check

func (r *Condition) Check(ctx context.Context) (result string, err error)

Check ...

func (*Condition) Status

func (r *Condition) Status() bool

Status ...

type ConditionBind

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

ConditionBind...

func NewConditionBind

func NewConditionBind(condition *Condition) *ConditionBind

Javascript Binding

Condition

type ConditionGroup

type ConditionGroup struct {
	sync.Mutex
	// contains filtered or unexported fields
}

ConditionGroup ...

func NewConditionGroup

func NewConditionGroup(automation *automation,
	t common.ConditionType) *ConditionGroup

NewConditionGroup ...

func (*ConditionGroup) AddCondition

func (c *ConditionGroup) AddCondition(condition *Condition)

AddCondition ...

func (*ConditionGroup) Check

func (c *ConditionGroup) Check(entityId *common.EntityId) (state bool, err error)

Check ...

type Task

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

Task ...

func NewTask

func NewTask(automation *automation,
	scriptService scripts.ScriptService,
	model *m.Task,
	entityManager entity_manager.EntityManager,
	rawPlugin triggers.IGetTrigger) *Task

NewTask ...

func (*Task) CallAction

func (t *Task) CallAction(name string)

CallAction ...

func (*Task) CallTrigger

func (t *Task) CallTrigger(name string)

CallTrigger ...

func (*Task) Id

func (t *Task) Id() int64

Id ...

func (*Task) Name

func (t *Task) Name() string

Name ...

func (*Task) Start

func (t *Task) Start()

Start ...

func (*Task) Stop

func (t *Task) Stop()

Stop ...

type Trigger

type Trigger struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Trigger ...

func NewTrigger

func NewTrigger(scriptService scripts.ScriptService,
	taskName string,
	model *m.Trigger,
	rawPlugin triggers.IGetTrigger,
	cb func(entityId *common.EntityId)) (tr *Trigger, err error)

NewTrigger ...

func (*Trigger) Call

func (tr *Trigger) Call()

Call ...

func (*Trigger) Check

func (tr *Trigger) Check(msg interface{}) (state bool, err error)

Check ...

func (*Trigger) EntityId

func (tr *Trigger) EntityId() *common.EntityId

EntityId ...

func (*Trigger) Id

func (tr *Trigger) Id() int64

Id ...

func (*Trigger) Start

func (tr *Trigger) Start() (err error)

Start ...

func (*Trigger) Stop

func (tr *Trigger) Stop() (err error)

Stop ...

type TriggerBind

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

Javascript Binding

Trigger

func NewTriggerBind

func NewTriggerBind(tr *Trigger) *TriggerBind

NewTriggerBind...