freepslisten

Documentation

Index

• Variables
• type ButtonWrapper
• type FieldConfig
• type FieldWithType
• type FreepsMqtt
  • func NewMqttSubscriber(cr *utils.ConfigReader, doer *freepsdo.TemplateMod) *FreepsMqtt
  • func (fm *FreepsMqtt) Shutdown()
• type FreepsMqttConfig
• type HTMLUI
  • func NewHTMLUI(modinator *freepsdo.TemplateMod) *HTMLUI
  • func (r *HTMLUI) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type JsonArgs
• type Restonator
  • func NewRestEndpoint(cr *utils.ConfigReader, doer *freepsdo.TemplateMod, cancel context.CancelFunc) *Restonator
  • func (r *Restonator) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Restonator) Shutdown(ctx context.Context)
• type TelegramCallbackResponse
• type Telegraminator
  • func NewTelegramBot(cr *utils.ConfigReader, doer *freepsdo.TemplateMod, cancel context.CancelFunc) *Telegraminator
  • func (r *Telegraminator) MainLoop()
  • func (r *Telegraminator) Respond(chat *tgbotapi.Chat, callbackData string, inputText string)
  • func (r *Telegraminator) Shutdown(ctx context.Context)
• type TemplateData
• type TopicConfig

Variables

var DefaultConfig = FreepsMqttConfig{Server: "", Username: "", Password: "", Topics: []TopicConfig{DefaultTopicConfig}}

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

Types

type ButtonWrapper

type ButtonWrapper struct {
	Button tgbotapi.InlineKeyboardButton
	Choice string
}

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 FreepsMqtt

type FreepsMqtt struct {
	Config   *FreepsMqttConfig
	Doer     *freepsdo.TemplateMod
	Callback func(string, map[string]string, map[string]interface{}) error
	// contains filtered or unexported fields
}

func NewMqttSubscriber

func NewMqttSubscriber(cr *utils.ConfigReader, doer *freepsdo.TemplateMod) *FreepsMqtt

func (*FreepsMqtt) Shutdown

func (fm *FreepsMqtt) Shutdown()

type FreepsMqttConfig

type FreepsMqttConfig struct {
	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
}

type HTMLUI

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

func NewHTMLUI

func NewHTMLUI(modinator *freepsdo.TemplateMod) *HTMLUI

NewHTMLUI creates a UI interface based on the inline template above

func (*HTMLUI) ServeHTTP

func (r *HTMLUI) ServeHTTP(w http.ResponseWriter, req *http.Request)

type JsonArgs

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

type Restonator

type Restonator struct {
	Modinator *freepsdo.TemplateMod
	// contains filtered or unexported fields
}

func NewRestEndpoint

func NewRestEndpoint(cr *utils.ConfigReader, doer *freepsdo.TemplateMod, cancel context.CancelFunc) *Restonator

func (*Restonator) ServeHTTP

func (r *Restonator) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Restonator) Shutdown

func (r *Restonator) Shutdown(ctx context.Context)

type TelegramCallbackResponse

type TelegramCallbackResponse struct {
	T string `json:",omitempty"` // TemplateActionID
	F bool   `json:",omitempty"` // Finished ?
	P int    `json:",omitempty"` // processed Args
	C string `json:",omitempty"` // last choice
	K bool   `json:",omitempty"` // request to type value instead of choosing
}

type Telegraminator

type Telegraminator struct {
	Modinator *freepsdo.TemplateMod
	// contains filtered or unexported fields
}

func NewTelegramBot

func NewTelegramBot(cr *utils.ConfigReader, doer *freepsdo.TemplateMod, cancel context.CancelFunc) *Telegraminator

func (*Telegraminator) MainLoop

func (r *Telegraminator) MainLoop()

func (*Telegraminator) Respond

func (r *Telegraminator) Respond(chat *tgbotapi.Chat, callbackData string, inputText string)

func (*Telegraminator) Shutdown

func (r *Telegraminator) Shutdown(ctx context.Context)

type TemplateData

type TemplateData struct {
	Args           map[string]string
	ModSuggestions map[string]bool
	FnSuggestions  map[string]bool
	ArgSuggestions map[string]map[string]string
	Templates      map[string]bool
	TemplateJSON   string
	Output         string
}

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
	TemplateToCall   string
}