throttling

Documentation

Index

• Constants
• Variables
• func NewSensor(ctx context.Context, deps resource.Dependencies, conf resource.Config, ...) (sensor.Sensor, error)
• type ComponentConfig
  • func (conf *ComponentConfig) Validate(path string) ([]string, error)
• type Config
  • func (c *Config) Close(ctx context.Context) error
  • func (c *Config) Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)
  • func (c *Config) Ready(ctx context.Context, extra map[string]interface{}) (bool, error)
  • func (c *Config) Reconfigure(ctx context.Context, _ resource.Dependencies, conf resource.Config) error

Constants

const (
	Undervolt               = "undervolt"
	ArmFrequencyCapped      = "armFrequencyCapped"
	CurrentlyThrottled      = "currentlyThrottled"
	SoftTempLimitActive     = "softTempLimitActive"
	UnderVoltOccurred       = "undervoltOccurred"
	ArmFrequencyCapOccurred = "armFrequencyCapOccurred"
	ThrottlingOccurred      = "throttlingOccurred"
	SoftTempLimitOccurred   = "softTempLimitOccurred"
)

Variables

var (
	Model       = resource.NewModel("viam-soleng", "raspi", "throttling")
	API         = sensor.API
	PrettyName  = "Raspberry Pi Throttling Sensor"
	Description = "A sensor that reports the throttling state of the Raspberry Pi."
	Version     = utils.Version
)

Functions

func NewSensor

func NewSensor(ctx context.Context, deps resource.Dependencies, conf resource.Config, logger logging.Logger) (sensor.Sensor, error)

Types

type ComponentConfig

type ComponentConfig struct {
}

func (*ComponentConfig) Validate

func (conf *ComponentConfig) Validate(path string) ([]string, error)

type Config

type Config struct {
	resource.Named
	// contains filtered or unexported fields
}

func (*Config) Close

func (c *Config) Close(ctx context.Context) error

func (*Config) Readings

func (c *Config) Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)

func (*Config) Ready

func (c *Config) Ready(ctx context.Context, extra map[string]interface{}) (bool, error)

func (*Config) Reconfigure

func (c *Config) Reconfigure(ctx context.Context, _ resource.Dependencies, conf resource.Config) error