sensor

Documentation

Index

• Variables
• type Sensor
• type Sensors
  • func (s *Sensors) UniqueClusters() cluster.Clusters
  • func (s *Sensors) UnmarshalYAML(value *yaml.Node) error
• type Simple
  • func (s *Simple) AppConfig() []appconfig.ConfigValue
  • func (s *Simple) ApplyOverlay(overlay *devicetree.DeviceTree) error
  • func (s *Simple) Clusters() cluster.Clusters
  • func (s *Simple) Label() string
  • func (s *Simple) String() string
  • func (s *Simple) Template() string
• type WithExtenders

Variables

var SensorLabelFn = func(s Sensor) string {
	sensorCounter += 1
	cleanLabel := strings.ReplaceAll(strings.ToLower(fmt.Sprintf("%T_", s)), ".", "_")
	return strings.TrimPrefix(cleanLabel, "*") + strconv.Itoa(sensorCounter)
}

SensorLabelFn returns a unique label for a sensor.

Types

type Sensor

type Sensor interface {
	// Stringer is for human-readable name
	fmt.Stringer
	// Label returns unique label value for the sensor.
	// Generally this method should not be defined by user,
	// intstead it will be defined in embedded `*base.Base`
	Label() string
	Template() string
	cluster.Provider
	appconfig.Provider
	devicetree.Applier
}

type Sensors

type Sensors []Sensor

func (*Sensors) UniqueClusters

func (s *Sensors) UniqueClusters() cluster.Clusters

UniqueClusters will return all unique clusters across all the sensors. Clusters might be configured for a specific sensor, so this method is mostly useful to *know* which clusters are available.

func (*Sensors) UnmarshalYAML

func (s *Sensors) UnmarshalYAML(value *yaml.Node) error

type Simple

type Simple struct {
	SensorName       string
	SensorLabel      string
	SensorTemplate   string
	SensorClusters   cluster.Clusters
	SensorAppConfig  []appconfig.ConfigValue
	SensorAppOverlay func(*devicetree.DeviceTree) error
}

func (*Simple) AppConfig

func (s *Simple) AppConfig() []appconfig.ConfigValue

func (*Simple) ApplyOverlay

func (s *Simple) ApplyOverlay(overlay *devicetree.DeviceTree) error

func (*Simple) Clusters

func (s *Simple) Clusters() cluster.Clusters

func (*Simple) Label

func (s *Simple) Label() string

func (*Simple) String

func (s *Simple) String() string

func (*Simple) Template

func (s *Simple) Template() string

type WithExtenders

type WithExtenders interface {
	Extenders() []generator.Extender
}