sensor

package

v0.3.1 Latest Latest Go to latest Published: Jan 30, 2021 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.cryptic.systems/volker.raschek/flucky

Documentation ¶

Index ¶

Variables
func FilterMeasuredValuesBySensorIDs(ctx context.Context, inChannel <-chan *types.MeasuredValue, ...) <-chan *types.MeasuredValue
func FilterMeasuredValuesByTypes(ctx context.Context, inChannel <-chan *types.MeasuredValue, ...) <-chan *types.MeasuredValue
func ReadPipeline(ctx context.Context, sensors ...Sensor) (<-chan *types.MeasuredValue, <-chan error)
func ReadTickingPipeline(ctx context.Context, sensors ...Sensor) (<-chan *types.MeasuredValue, <-chan error)
type BME280
- func (bme280 *BME280) Read() ([]*types.MeasuredValue, error)
type DHT11
- func (dht11 *DHT11) Read() ([]*types.MeasuredValue, error)
type DHT22
- func (dht22 *DHT22) Read() ([]*types.MeasuredValue, error)
type DS18B20
- func (ds18b20 *DS18B20) Read() ([]*types.MeasuredValue, error)
type Sensor
- func New(sensor *types.Sensor) (Sensor, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrSensorModelNotMatched = errors.New("Sensor model not matched")
)

Functions ¶

func FilterMeasuredValuesBySensorIDs ¶ added in v0.3.0

func FilterMeasuredValuesBySensorIDs(ctx context.Context, inChannel <-chan *types.MeasuredValue, sensorIDs ...string) <-chan *types.MeasuredValue

FilterMeasuredValuesBySensorIDs filters measured values by sensor id

func FilterMeasuredValuesByTypes ¶ added in v0.3.0

func FilterMeasuredValuesByTypes(ctx context.Context, inChannel <-chan *types.MeasuredValue, measuredValueTypes ...types.MeasuredValueType) <-chan *types.MeasuredValue

FilterMeasuredValuesByTypes filters measured values by type

func ReadPipeline ¶ added in v0.3.0

func ReadPipeline(ctx context.Context, sensors ...Sensor) (<-chan *types.MeasuredValue, <-chan error)

ReadPipeline pipes for each sensor measured values until the context has been closed. The returned channels will be closed

func ReadTickingPipeline ¶ added in v0.3.0

func ReadTickingPipeline(ctx context.Context, sensors ...Sensor) (<-chan *types.MeasuredValue, <-chan error)

ReadTickingPipeline pipes for every tick on each sensor measured values until the context has been closed

Types ¶

type BME280 ¶

type BME280 struct {
	*types.Sensor
	// contains filtered or unexported fields
}

BME280 is a sensor to measure humidity and temperature.

func (*BME280) Read ¶

func (bme280 *BME280) Read() ([]*types.MeasuredValue, error)

Read measured values

type DHT11 ¶

type DHT11 struct {
	*types.Sensor
	// contains filtered or unexported fields
}

DHT11 is a sensor to measure humidity and temperature.

func (*DHT11) Read ¶

func (dht11 *DHT11) Read() ([]*types.MeasuredValue, error)

Read measured values

type DHT22 ¶

type DHT22 struct {
	*types.Sensor
	// contains filtered or unexported fields
}

DHT22 is a sensor to measure humidity and temperature.

func (*DHT22) Read ¶

func (dht22 *DHT22) Read() ([]*types.MeasuredValue, error)

Read measured values

type DS18B20 ¶

type DS18B20 struct {
	*types.Sensor
	// contains filtered or unexported fields
}

DS18B20 is a sensor to measure humidity and temperature.

func (*DS18B20) Read ¶

func (ds18b20 *DS18B20) Read() ([]*types.MeasuredValue, error)

Read measured values

type Sensor ¶

type Sensor interface {
	GetTicker() *time.Ticker

	// Read single measured values from sensor
	Read() ([]*types.MeasuredValue, error)
}

func New ¶

func New(sensor *types.Sensor) (Sensor, error)

New returns a new sensor

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL