mqtt

Documentation

Index

• Variables
• type DiscoverArgs
• type FieldConfig
• type FieldWithType
• type FreepsMqttConfig
• type FreepsMqttImpl
  • func (fm *FreepsMqttImpl) Shutdown()
  • func (fm *FreepsMqttImpl) StartListening() error
• type HookMQTT
  • func (h *HookMQTT) OnGraphChanged(ctx *base.Context, addedGraphName []string, removedGraphName []string) error
• type JsonArgs
• type OpMQTT
  • func (o *OpMQTT) DiscoverTopics(ctx *base.Context, input *base.OperatorIO, args DiscoverArgs) *base.OperatorIO
  • func (o *OpMQTT) ExecuteDynamic(ctx *base.Context, fn string, fa base.FunctionArguments, ...) *base.OperatorIO
  • func (o *OpMQTT) GetDefaultConfig() interface{}
  • func (o *OpMQTT) GetDynamicArgSuggestions(fn string, arg string, otherArgs base.FunctionArguments) map[string]string
  • func (o *OpMQTT) GetDynamicFunctions() []string
  • func (o *OpMQTT) GetDynamicPossibleArgs(fn string) []string
  • func (o *OpMQTT) GetHook() interface{}
  • func (o *OpMQTT) GetSubscriptions(ctx *base.Context) *base.OperatorIO
  • func (o *OpMQTT) GraphIDSuggestions() map[string]string
  • func (o *OpMQTT) InitCopyOfOperator(ctx *base.Context, config interface{}, name string) (base.FreepsOperatorWithConfig, error)
  • func (o *OpMQTT) SetTopicTrigger(ctx *base.Context, mainInput *base.OperatorIO, args TopicTrigger) *base.OperatorIO
  • func (o *OpMQTT) Shutdown(ctx *base.Context)
  • func (o *OpMQTT) StartListening(ctx *base.Context)
  • func (o *OpMQTT) TriggerSubscriptionChange(ctx *base.Context) *base.OperatorIO
• type TopicConfig
• type TopicTrigger
  • func (tt *TopicTrigger) TopicSuggestions(o *OpMQTT) []string

Variables

var DefaultTopicConfig = TopicConfig{Topic: "#", Qos: 0, MeasurementIndex: -1, FieldIndex: -1, Fields: map[string]FieldConfig{}, TemplateToCall: "mqttaction"}

Types

type DiscoverArgs

type DiscoverArgs struct {
	DiscoverDuration *time.Duration
}

type FieldConfig

type FieldConfig struct {
	Datatype  string
	Alias     *string // name used in influx
	TrueValue *string // if datatype==bool, this is used as true value, everything else is false
}

type FieldWithType

type FieldWithType struct {
	FieldType  string
	FieldValue string
}

type FreepsMqttConfig

type FreepsMqttConfig struct {
	Enabled     bool
	Server      string // The full url of the MQTT server to connect to ex: tcp://127.0.0.1:1883
	Username    string // A username to authenticate to the MQTT server
	Password    string // Password to match username
	Topics      []TopicConfig
	ResultTopic string // Topic to publish results to; empty (default) means no publishing of results
}

type FreepsMqttImpl

type FreepsMqttImpl struct {
	Config *FreepsMqttConfig
	// contains filtered or unexported fields
}

func (*FreepsMqttImpl) Shutdown

func (fm *FreepsMqttImpl) Shutdown()

Shutdown MQTT and cancel all subscriptions

func (*FreepsMqttImpl) StartListening

func (fm *FreepsMqttImpl) StartListening() error

type HookMQTT

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

func (*HookMQTT) OnGraphChanged

func (h *HookMQTT) OnGraphChanged(ctx *base.Context, addedGraphName []string, removedGraphName []string) error

OnGraphChanged checks if subscriptions need to be changed

type JsonArgs

type JsonArgs struct {
	Measurement    string
	FieldsWithType map[string]FieldWithType
}

type OpMQTT

type OpMQTT struct {
	CR *utils.ConfigReader
	GE *freepsgraph.GraphEngine
	// contains filtered or unexported fields
}

func (*OpMQTT) DiscoverTopics

func (o *OpMQTT) DiscoverTopics(ctx *base.Context, input *base.OperatorIO, args DiscoverArgs) *base.OperatorIO

func (*OpMQTT) ExecuteDynamic

func (o *OpMQTT) ExecuteDynamic(ctx *base.Context, fn string, fa base.FunctionArguments, input *base.OperatorIO) *base.OperatorIO

func (*OpMQTT) GetDefaultConfig

func (o *OpMQTT) GetDefaultConfig() interface{}

func (*OpMQTT) GetDynamicArgSuggestions

func (o *OpMQTT) GetDynamicArgSuggestions(fn string, arg string, otherArgs base.FunctionArguments) map[string]string

func (*OpMQTT) GetDynamicFunctions

func (o *OpMQTT) GetDynamicFunctions() []string

func (*OpMQTT) GetDynamicPossibleArgs

func (o *OpMQTT) GetDynamicPossibleArgs(fn string) []string

func (*OpMQTT) GetHook

func (o *OpMQTT) GetHook() interface{}

func (*OpMQTT) GetSubscriptions

func (o *OpMQTT) GetSubscriptions(ctx *base.Context) *base.OperatorIO

GetSubscriptions returns a list of all subscriped topics

func (*OpMQTT) GraphIDSuggestions

func (o *OpMQTT) GraphIDSuggestions() map[string]string

GraphID auggestions returns suggestions for graph names

func (*OpMQTT) InitCopyOfOperator

func (o *OpMQTT) InitCopyOfOperator(ctx *base.Context, config interface{}, name string) (base.FreepsOperatorWithConfig, error)

func (*OpMQTT) SetTopicTrigger

func (o *OpMQTT) SetTopicTrigger(ctx *base.Context, mainInput *base.OperatorIO, args TopicTrigger) *base.OperatorIO

func (*OpMQTT) Shutdown

func (o *OpMQTT) Shutdown(ctx *base.Context)

func (*OpMQTT) StartListening

func (o *OpMQTT) StartListening(ctx *base.Context)

func (*OpMQTT) TriggerSubscriptionChange

func (o *OpMQTT) TriggerSubscriptionChange(ctx *base.Context) *base.OperatorIO

TriggerSubscriptionChange triggers a change in the subscriptions

type TopicConfig

type TopicConfig struct {
	Topic string // Topic to subscribe to
	Qos   int    // The QoS to subscribe to messages at
	// the topic string is split by slash; the values of the resulting array can be used as measurement and field - the index can be specified here
	MeasurementIndex int                    // index that points to the measurement in the topic-array
	FieldIndex       int                    // index that points to the field in the topic-array
	Fields           map[string]FieldConfig `json:",omitempty"`
	TemplateToCall   string                 `json:",omitempty"`
	GraphToCall      string
}

type TopicTrigger

type TopicTrigger struct {
	GraphID string
	Topic   string
}

func (*TopicTrigger) TopicSuggestions

func (tt *TopicTrigger) TopicSuggestions(o *OpMQTT) []string

TopicSuggestions returns known topics