Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

config

package

Go to main page

Versions in this module

v3

v3.2.2

Apr 16, 2024

v3.2.1

Feb 22, 2024

v3.2.0

Jan 7, 2024

Changes in this version

type VictronDeviceConfig

+ func (c VictronDeviceConfig) IoLog() string

+ func (c VictronDeviceConfig) PollInterval() time.Duration

v3.1.4

Dec 20, 2023

v3.1.3

Dec 19, 2023

Changes in this version

+ const NameRegexp

+ func TransformAndValidateListUnique[I any, O Nameable](inp []I, transformer func(inp I) (ret O, err []error)) (ret []O, err []error)

+ func TransformAndValidateMapToList[I any, O any](inp map[string]I, transformer func(inp I, name string) (ret O, err []error)) (ret []O, err []error)

+ func TransformAndValidateMap[I any, O any](inp map[string]I, transformer func(inp I, name string) (ret O, err []error)) (ret map[string]O, err []error)

+ type AuthenticationConfig struct

+ func (c AuthenticationConfig) Enabled() bool

+ func (c AuthenticationConfig) HtaccessFile() string

+ func (c AuthenticationConfig) JwtSecret() []byte

+ func (c AuthenticationConfig) JwtValidityPeriod() time.Duration

+ type Config struct

+ func ReadConfig(yamlStr []byte, bypassFileCheck bool) (config Config, err []error)

+ func ReadConfigFile(exe, source string, bypassFileCheck bool) (config Config, err []error)

+ func (c Config) Authentication() AuthenticationConfig

+ func (c Config) Devices() []DeviceConfig

+ func (c Config) HttpDevices() []HttpDeviceConfig

+ func (c Config) HttpServer() HttpServerConfig

+ func (c Config) LogCommandStorageDebug() bool

+ func (c Config) LogConfig() bool

+ func (c Config) LogStateStorageDebug() bool

+ func (c Config) LogWorkerStart() bool

+ func (c Config) MarshalYAML() (interface{}, error)

+ func (c Config) Modbus() []ModbusConfig

+ func (c Config) ModbusDevices() []ModbusDeviceConfig

+ func (c Config) MqttClients() []MqttClientConfig

+ func (c Config) MqttDevices() []MqttDeviceConfig

+ func (c Config) PrintConfig() (err error)

+ func (c Config) ProjectTitle() string

+ func (c Config) Version() int

+ func (c Config) VictronDevices() []VictronDeviceConfig

+ func (c Config) Views() []ViewConfig

+ type DeviceConfig struct

+ func (c DeviceConfig) Filter() FilterConfig

+ func (c DeviceConfig) LogComDebug() bool

+ func (c DeviceConfig) LogDebug() bool

+ func (c DeviceConfig) Name() string

+ func (c DeviceConfig) RestartInterval() time.Duration

+ func (c DeviceConfig) RestartIntervalMaxBackoff() time.Duration

+ type FilterConfig struct

+ func (c FilterConfig) DefaultInclude() bool

+ func (c FilterConfig) IncludeCategories() []string

+ func (c FilterConfig) IncludeRegisters() []string

+ func (c FilterConfig) SkipCategories() []string

+ func (c FilterConfig) SkipRegisters() []string

+ type HttpDeviceConfig struct

+ func (c HttpDeviceConfig) Kind() types.HttpDeviceKind

+ func (c HttpDeviceConfig) LogDebug() bool

+ func (c HttpDeviceConfig) Password() string

+ func (c HttpDeviceConfig) PollInterval() time.Duration

+ func (c HttpDeviceConfig) Url() *url.URL

+ func (c HttpDeviceConfig) Username() string

+ type HttpServerConfig struct

+ func (c HttpServerConfig) Bind() string

+ func (c HttpServerConfig) ConfigExpires() time.Duration

+ func (c HttpServerConfig) Enabled() bool

+ func (c HttpServerConfig) FrontendExpires() time.Duration

+ func (c HttpServerConfig) FrontendPath() string

+ func (c HttpServerConfig) FrontendProxy() *url.URL

+ func (c HttpServerConfig) LogDebug() bool

+ func (c HttpServerConfig) LogRequests() bool

+ func (c HttpServerConfig) Port() int

+ type ModbusConfig struct

+ func (c ModbusConfig) BaudRate() int

+ func (c ModbusConfig) Device() string

+ func (c ModbusConfig) LogDebug() bool

+ func (c ModbusConfig) Name() string

+ func (c ModbusConfig) ReadTimeout() time.Duration

+ type ModbusDeviceConfig struct

+ func (c ModbusDeviceConfig) Address() byte

+ func (c ModbusDeviceConfig) Bus() string

+ func (c ModbusDeviceConfig) Kind() types.ModbusDeviceKind

+ func (c ModbusDeviceConfig) PollInterval() time.Duration

+ func (c ModbusDeviceConfig) RelayClosedLabel(name string) string

+ func (c ModbusDeviceConfig) RelayDescription(name string) string

+ func (c ModbusDeviceConfig) RelayOpenLabel(name string) string

+ type MqttClientConfig struct

+ func (c MqttClientConfig) AvailabilityClient() MqttSectionConfig

+ func (c MqttClientConfig) AvailabilityClientTopic() string

+ func (c MqttClientConfig) AvailabilityDevice() MqttSectionConfig

+ func (c MqttClientConfig) AvailabilityDeviceTopic(deviceName string) string

+ func (c MqttClientConfig) Broker() *url.URL

+ func (c MqttClientConfig) ClientId() string

+ func (c MqttClientConfig) Command() MqttSectionConfig

+ func (c MqttClientConfig) CommandTopic(deviceName, registerName string) string

+ func (c MqttClientConfig) ConnectRetryDelay() time.Duration

+ func (c MqttClientConfig) ConnectTimeout() time.Duration

+ func (c MqttClientConfig) HomeassistantDiscovery() MqttSectionConfig

+ func (c MqttClientConfig) HomeassistantDiscoveryTopic(component, nodeId, objectId string) string

+ func (c MqttClientConfig) KeepAlive() time.Duration

+ func (c MqttClientConfig) LogDebug() bool

+ func (c MqttClientConfig) LogMessages() bool

+ func (c MqttClientConfig) MaxBacklogSize() int

+ func (c MqttClientConfig) MqttDevices() []MqttClientDeviceConfig

+ func (c MqttClientConfig) Name() string

+ func (c MqttClientConfig) Password() string

+ func (c MqttClientConfig) ProtocolVersion() int

+ func (c MqttClientConfig) ReadOnly() bool

+ func (c MqttClientConfig) Realtime() MqttSectionConfig

+ func (c MqttClientConfig) RealtimeTopic(deviceName, registerName string) string

+ func (c MqttClientConfig) Structure() MqttSectionConfig

+ func (c MqttClientConfig) StructureTopic(deviceName string) string

+ func (c MqttClientConfig) Telemetry() MqttSectionConfig

+ func (c MqttClientConfig) TelemetryTopic(deviceName string) string

+ func (c MqttClientConfig) TopicPrefix() string

+ func (c MqttClientConfig) User() string

+ type MqttClientDeviceConfig struct

+ func (c MqttClientDeviceConfig) MqttTopics() []string

+ func (c MqttClientDeviceConfig) Name() string

+ type MqttDeviceConfig struct

+ func (c MqttDeviceConfig) Kind() types.MqttDeviceKind

+ type MqttDeviceSectionConfig struct

+ func (c MqttDeviceSectionConfig) Filter() FilterConfig

+ func (c MqttDeviceSectionConfig) Name() string

+ type MqttSectionConfig struct

+ func (c MqttSectionConfig) Devices() []MqttDeviceSectionConfig

+ func (c MqttSectionConfig) Enabled() bool

+ func (c MqttSectionConfig) Interval() time.Duration

+ func (c MqttSectionConfig) Qos() byte

+ func (c MqttSectionConfig) Retain() bool

+ func (c MqttSectionConfig) TopicTemplate() string

+ type Nameable interface

+ Name func() string

+ type RelayConfig struct

+ type VictronDeviceConfig struct

+ func (c VictronDeviceConfig) Device() string

+ func (c VictronDeviceConfig) Kind() types.VictronDeviceKind

+ type ViewConfig struct

+ func (c ViewConfig) Autoplay() bool

+ func (c ViewConfig) Devices() []ViewDeviceConfig

+ func (c ViewConfig) Hidden() bool

+ func (c ViewConfig) IsAllowed(user string) bool

+ func (c ViewConfig) IsPublic() bool

+ func (c ViewConfig) Name() string

+ func (c ViewConfig) Title() string

+ type ViewDeviceConfig struct

+ func (c ViewDeviceConfig) Filter() FilterConfig

+ func (c ViewDeviceConfig) Name() string

+ func (c ViewDeviceConfig) Title() string

Other modules containing this package

github.com/koestler/go-iotdevice