Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Sensor interface and Measurement type #345

Merged
merged 1 commit into from
May 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions sensor.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package drivers

// Measurement specifies a type of measurement,
// for example: temperature, acceleration, pressure.
type Measurement uint32

// Sensor measurements
const (
Voltage Measurement = 1 << iota
Temperature
Humidity
Pressure
Distance
Acceleration
AngularVelocity
MagneticField
Luminosity
Time
// Add Measurements above AllMeasurements.

// AllMeasurements is the OR of all Measurement values. It ensures all measurements are done.
AllMeasurements Measurement = (1 << 32) - 1
)

// Sensor represents an object capable of making one
// or more measurements. A sensor will then have methods
// which read the last updated measurements.
//
// Many Sensors may be collected into
// one Sensor interface to synchronize measurements.
type Sensor interface {
// Update performs IO to update the measurements of a sensor.
// It shall return error only when the sensor encounters an error that prevents it from
// storing all or part of the measurements it was called to do.
Update(which Measurement) error
}