automation

Documentation

Index

• Constants
• func NewTaskManager(eventBus bus.Bus, scriptService scripts.ScriptService, sup plugins.Supervisor, ...) (manager *taskManager)
• func NewTriggerManager(eventBus bus.Bus, scriptService scripts.ScriptService, sup plugins.Supervisor, ...) (manager *triggerManager)
• type Action
  • func NewAction(scriptService scripts.ScriptService, eventBus bus.Bus, model *m.Action) (action *Action, err error)
  • func (a *Action) Remove()
  • func (a *Action) Run(entityId *common.EntityId) (result string, err error)
• type ActionBind
  • func NewActionBind(action *Action) *ActionBind
• 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
  • func (r *Condition) Stop()
• type ConditionBind
  • func NewConditionBind(condition *Condition) *ConditionBind
• type ConditionGroup
  • func NewConditionGroup(t common.ConditionType) *ConditionGroup
  • func (c *ConditionGroup) AddCondition(condition *Condition)
  • func (c *ConditionGroup) Check(entityId *common.EntityId) (state bool, err error)
  • func (c *ConditionGroup) Stop()
• type Task
  • func NewTask(eventBus bus.Bus, scriptService scripts.ScriptService, model *models.Task) *Task
  • func (t *Task) Id() int64
  • func (t *Task) Name() string
  • func (t *Task) Start()
  • func (t *Task) Stop()
  • func (t *Task) Telemetry() telemetry.Telemetry
• type Trigger
  • func NewTrigger(eventBus bus.Bus, scriptService scripts.ScriptService, model *m.Trigger, ...) (tr *Trigger, err error)
  • func (tr *Trigger) Start()
  • func (tr *Trigger) Stop()
• type TriggerBind
  • func NewTriggerBind(tr *Trigger) *TriggerBind
• type TriggerSubscriber

Constants

const ActionFunc = "automationAction"

ActionFunc ...

const ConditionFunc = "automationCondition"

ConditionFunc ...

const TriggerFunc = "automationTrigger"

TriggerFunc ...

Functions

func NewTaskManager

func NewTaskManager(
	eventBus bus.Bus,
	scriptService scripts.ScriptService,
	sup plugins.Supervisor,
	adaptors *adaptors.Adaptors) (manager *taskManager)

NewTaskManager ...

func NewTriggerManager

func NewTriggerManager(eventBus bus.Bus,
	scriptService scripts.ScriptService,
	sup plugins.Supervisor,
	adaptors *adaptors.Adaptors) (manager *triggerManager)

Types

type Action

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

Action ...

func NewAction

func NewAction(scriptService scripts.ScriptService,
	eventBus bus.Bus,
	model *m.Action) (action *Action, err error)

NewAction ...

func (*Action) Remove

func (a *Action) Remove()

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...

type Automation

type Automation interface {
	Start() (err error)
	Shutdown() (err error)
	Restart()
	TaskIsLoaded(id int64) bool
	TriggerIsLoaded(id int64) bool
	TaskTelemetry(id int64) telemetry.Telemetry
}

Automation ...

func NewAutomation

func NewAutomation(lc fx.Lifecycle,
	eventBus bus.Bus,
	scriptService scripts.ScriptService,
	sup plugins.Supervisor,
	adaptors *adaptors.Adaptors) (auto Automation)

NewAutomation ...

type Condition

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

Condition ...

func NewCondition

func NewCondition(scriptService scripts.ScriptService,
	model *m.Condition) (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 ...

func (*Condition) Stop

func (r *Condition) Stop()

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(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 ...

func (*ConditionGroup) Stop

func (c *ConditionGroup) Stop()

type Task

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

Task ...

func NewTask

func NewTask(eventBus bus.Bus,
	scriptService scripts.ScriptService,
	model *models.Task) *Task

NewTask ...

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 ...

func (*Task) Telemetry

func (t *Task) Telemetry() telemetry.Telemetry

type Trigger

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

Trigger ...

func NewTrigger

func NewTrigger(
	eventBus bus.Bus,
	scriptService scripts.ScriptService,
	model *m.Trigger,
	rawPlugin triggers.IGetTrigger) (tr *Trigger, err error)

NewTrigger ...

func (*Trigger) Start

func (tr *Trigger) Start()

Start ...

func (*Trigger) Stop

func (tr *Trigger) Stop()

Stop ...

type TriggerBind

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

Javascript Binding

Trigger

func NewTriggerBind

func NewTriggerBind(tr *Trigger) *TriggerBind

NewTriggerBind...

type TriggerSubscriber

type TriggerSubscriber struct {
	Engine     scripts.EngineWatcher
	Subscriber triggers.Subscriber
}