config

Documentation

Index

• type BacnetDevice
• type BacnetObject
• type BacnetSource
• type Duplicates
  • func (d *Duplicates) Cmp() cmp.Message
  • func (d *Duplicates) TrackDuplicates() bool
• type MQTTBroker
  • func (b MQTTBroker) ClientOptions() (*mqtt.ClientOptions, error)
• type MqttServiceSource
• type RawSource
  • func (r *RawSource) UnmarshalJSON(buf []byte) error
• type Root
• type SmartCoreSource
• type Source

Types

type BacnetDevice

type BacnetDevice struct {
	Name    string         `json:"name,omitempty"`
	Objects []BacnetObject `json:"objects,omitempty"`
}

type BacnetObject

type BacnetObject struct {
	ID         config.ObjectID     `json:"id"`
	Properties []config.PropertyID `json:"properties,omitempty"`
}

type BacnetSource

type BacnetSource struct {
	Source
	COV     *config.COV    `json:"cov,omitempty"`
	Devices []BacnetDevice `json:"devices,omitempty"`

	// PrintTiming when true causes the publishing for this source to print timing statistics to the log each time
	PrintTiming bool `json:"printTiming,omitempty"`
}

type Duplicates

type Duplicates struct {
	Include bool `json:"include,omitempty"`

	// Consider floating point values of consecutive publications to be equal if they are within FloatMargin of each other.
	// 1.2 and 1.22 are within 0.1 FloatMargin of each other and would be classes as duplicates.
	FloatMargin *float64 `json:"floatMargin,omitempty"`
}

func (*Duplicates) Cmp

func (d *Duplicates) Cmp() cmp.Message

func (*Duplicates) TrackDuplicates

func (d *Duplicates) TrackDuplicates() bool

type MQTTBroker

type MQTTBroker struct {
	Host         string `json:"host,omitempty"`
	Username     string `json:"username,omitempty"`
	Password     string `json:"password,omitempty"`
	PasswordFile string `json:"passwordFile,omitempty"`
}

func (MQTTBroker) ClientOptions

func (b MQTTBroker) ClientOptions() (*mqtt.ClientOptions, error)

type MqttServiceSource

type MqttServiceSource struct {
	Source

	// the names to use for rpc requests
	RpcNames []string `json:"rpcNames,omitempty"`
}

type RawSource

type RawSource struct {
	Source
	Raw json.RawMessage `json:"-"`
}

func (*RawSource) UnmarshalJSON

func (r *RawSource) UnmarshalJSON(buf []byte) error

type Root

type Root struct {
	auto.Config

	// Broker configures an MQTT broker to export data to.
	Broker *MQTTBroker `json:"broker,omitempty"`

	Sources []RawSource `json:"sources,omitempty"`
}

type SmartCoreSource

type SmartCoreSource struct {
	Source
}

type Source

type Source struct {
	Type        string      `json:"type,omitempty"`
	Name        string      `json:"name,omitempty"`
	TopicPrefix string      `json:"topicPrefix,omitempty"`
	Duplicates  *Duplicates `json:"duplicates,omitempty"`
}