config

Documentation

Index

• Constants
• type BigCacheConfig
  • func NewBigCacheConfig(configFilePath string) *BigCacheConfig
• type CSVMappingConfig
  • func NewCSVMappingConfig(configFilePath string) []CSVMappingConfig
• type CanBusMapperConfig
  • func NewCanBusMapperConfig(configFilePath string) CanBusMapperConfig
• type CanBusMappingConfig
  • func NewCanBusMappingConfig(configFilePath string) []CanBusMappingConfig
• type CollectorConfig
  • func NewCollectorConfig(configFilePath string) *CollectorConfig
• type JSONMappingConfig
  • func NewJSONMappingConfig(configFilePath string) []JSONMappingConfig
• type MQTTConfig
  • func NewMQTTConfig(configFilePath string) *MQTTConfig
• type MapperConfig
  • func NewMapperConfig(configFilePath string) MapperConfig
• type MappingConfig
• type ModbusMappingsConfig
  • func NewModbusMappingsConfig(configFilePath string) []ModbusMappingsConfig
• type PostgresqlConfig
  • func NewPostgresqlConfig(configFilePath string) *PostgresqlConfig
• type RegisterGroupConfig
  • func NewRegisterGroupsConfig(configFilePath string) []RegisterGroupConfig
• type SignalKConfig
  • func NewSignalKConfig(configFilePath string) *SignalKConfig
  • func (c *SignalKConfig) WithVersion(version string) *SignalKConfig

Constants

const (
	// NMEA0183Type is used to identify the data as NMEA 0183 data
	NMEA0183Type = "nmea0183"
	// ModbusType is used to identify the data as Modbus data
	ModbusType = "modbus"
	// CSVType is used to identify the data as comma seperated values data
	CSVType = "csv"
	// JSONType is used to identify the data as json messages
	JSONType = "json"

	CanBusType = "canbus"

	ParityMap string = "NOE" // None, Odd, Even
)

const (
	Coils = iota + 1
	DiscreteInputs
	HoldingRegisters
	InputRegisters
)

Types

type BigCacheConfig

type BigCacheConfig struct {
	LifeWindow       int `mapstructure:"lifeWindow"`       // time after which entry can be evicted, value in seconds
	HardMaxCacheSize int `mapstructure:"hardMaxCacheSize"` // cache will not allocate more memory than this limit, value in MB
}

func NewBigCacheConfig

func NewBigCacheConfig(configFilePath string) *BigCacheConfig

type CSVMappingConfig

type CSVMappingConfig struct {
	BeginsWith    string `mapstructure:"beginsWith"`
	MappingConfig `mapstructure:",squash"`
}

func NewCSVMappingConfig

func NewCSVMappingConfig(configFilePath string) []CSVMappingConfig

type CanBusMapperConfig

type CanBusMapperConfig struct {
	MapperConfig `mapstructure:",squash"`
	DbcFile      string `mapstructure:"dbcFile"`
}

func NewCanBusMapperConfig

func NewCanBusMapperConfig(configFilePath string) CanBusMapperConfig

type CanBusMappingConfig

type CanBusMappingConfig struct {
	MappingConfig `mapstructure:",squash"`
	Name          string `mapstructure:"name"`
	Origin        string `mapstructure:"origin"`
}

func NewCanBusMappingConfig

func NewCanBusMappingConfig(configFilePath string) []CanBusMappingConfig

type CollectorConfig

type CollectorConfig struct {
	Name         string   `mapstructure:"name"`
	URL          *url.URL `mapstructure:"_"`
	URLString    string   `mapstructure:"url"`
	Listen       bool     `mapstructure:"listen"`
	BaudRate     int      `mapstructure:"baudRate"`
	DataBits     int      `mapstructure:"dataBits"`
	StopBits     int      `mapstructure:"stopBits"`
	Parity       int      `mapstructure:"_"`
	ParityString string   `mapstructure:"parity"`
	Protocol     string   `mapstructure:"protocol"`
}

func NewCollectorConfig

func NewCollectorConfig(configFilePath string) *CollectorConfig

type JSONMappingConfig

type JSONMappingConfig struct {
	MappingConfig `mapstructure:",squash"`
}

func NewJSONMappingConfig

func NewJSONMappingConfig(configFilePath string) []JSONMappingConfig

type MQTTConfig

type MQTTConfig struct {
	URLString        string `mapstructure:"url"`
	Username         string `mapstructure:"username"`
	Password         string `mapstructure:"password"`
	Interval         int    `mapstructure:"interval"`         // interval to flush the cache in seconds, ignored for reader
	HardMaxCacheSize int    `mapstructure:"hardMaxCacheSize"` // maximum size of the cache in MBs, cache will be flushed when size is reached, ignored for reader
}

func NewMQTTConfig

func NewMQTTConfig(configFilePath string) *MQTTConfig

type MapperConfig

type MapperConfig struct {
	Context  string `mapstructure:"context"`
	Protocol string `mapstructure:"protocol"`
}

func NewMapperConfig

func NewMapperConfig(configFilePath string) MapperConfig

type MappingConfig

type MappingConfig struct {
	Expression         string `mapstructure:"expression"`
	CompiledExpression *vm.Program
	Path               string `mapstructure:"path"`
}

type ModbusMappingsConfig

type ModbusMappingsConfig struct {
	MappingConfig            `mapstructure:",squash"`
	Slave                    uint8  `mapstructure:"slave"`
	FunctionCode             uint16 `mapstructure:"functionCode"`
	Address                  uint16 `mapstructure:"address"`
	NumberOfCoilsOrRegisters uint16 `mapstructure:"numberOfCoilsOrRegisters"`
}

func NewModbusMappingsConfig

func NewModbusMappingsConfig(configFilePath string) []ModbusMappingsConfig

type PostgresqlConfig

type PostgresqlConfig struct {
	URLString string `mapstructure:"url"`
}

func NewPostgresqlConfig

func NewPostgresqlConfig(configFilePath string) *PostgresqlConfig

type RegisterGroupConfig

type RegisterGroupConfig struct {
	Slave                  uint8         `mapstructure:"slave"`
	FunctionCode           uint16        `mapstructure:"functionCode"`
	Address                uint16        `mapstructure:"address"`
	NumberOfCoilsRegisters uint16        `mapstructure:"numberOfCoilsOrRegisters"`
	PollingInterval        time.Duration `mapstructure:"pollingInterval"`
}

func NewRegisterGroupsConfig

func NewRegisterGroupsConfig(configFilePath string) []RegisterGroupConfig

type SignalKConfig

type SignalKConfig struct {
	URLString        string            `mapstructure:"url"`
	URL              *url.URL          `mapstructure:"_"`
	Version          string            `mapstructure:"_"`
	SelfContext      string            `mapstructure:"self_context"`
	PostgresqlConfig *PostgresqlConfig `mapstructure:"_"`
	BigCacheConfig   *BigCacheConfig   `mapstructure:"_"`
}

func NewSignalKConfig

func NewSignalKConfig(configFilePath string) *SignalKConfig

func (*SignalKConfig) WithVersion

func (c *SignalKConfig) WithVersion(version string) *SignalKConfig