-
Notifications
You must be signed in to change notification settings - Fork 110
/
powersensor.go
73 lines (62 loc) · 2.43 KB
/
powersensor.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Package powersensor defines the interfaces of a powersensor
package powersensor
import (
"context"
pb "go.viam.com/api/component/powersensor/v1"
"go.viam.com/rdk/data"
"go.viam.com/rdk/resource"
"go.viam.com/rdk/robot"
)
func init() {
resource.RegisterAPI(API, resource.APIRegistration[PowerSensor]{
RPCServiceServerConstructor: NewRPCServiceServer,
RPCServiceHandler: pb.RegisterPowerSensorServiceHandlerFromEndpoint,
RPCServiceDesc: &pb.PowerSensorService_ServiceDesc,
RPCClient: NewClientFromConn,
})
data.RegisterCollector(data.MethodMetadata{
API: API,
MethodName: voltage.String(),
}, newVoltageCollector)
data.RegisterCollector(data.MethodMetadata{
API: API,
MethodName: current.String(),
}, newCurrentCollector)
data.RegisterCollector(data.MethodMetadata{
API: API,
MethodName: power.String(),
}, newPowerCollector)
data.RegisterCollector(data.MethodMetadata{
API: API,
MethodName: readings.String(),
}, newReadingsCollector)
}
// SubtypeName is a constant that identifies the component resource API string "power_sensor".
const SubtypeName = "power_sensor"
// API is a variable that identifies the component resource API.
var API = resource.APINamespaceRDK.WithComponentType(SubtypeName)
// Named is a helper for getting the named PowerSensor's typed resource name.
func Named(name string) resource.Name {
return resource.NewName(API, name)
}
// A PowerSensor reports information about voltage, current and power.
type PowerSensor interface {
resource.Sensor
resource.Resource
Voltage(ctx context.Context, extra map[string]interface{}) (float64, bool, error)
Current(ctx context.Context, extra map[string]interface{}) (float64, bool, error)
Power(ctx context.Context, extra map[string]interface{}) (float64, error)
}
// FromDependencies is a helper for getting the named PowerSensor from a collection of
// dependencies.
func FromDependencies(deps resource.Dependencies, name string) (PowerSensor, error) {
return resource.FromDependencies[PowerSensor](deps, Named(name))
}
// FromRobot is a helper for getting the named PowerSensor from the given Robot.
func FromRobot(r robot.Robot, name string) (PowerSensor, error) {
return robot.ResourceFromRobot[PowerSensor](r, Named(name))
}
// NamesFromRobot is a helper for getting all PowerSensor names from the given Robot.
func NamesFromRobot(r robot.Robot) []string {
return robot.NamesByAPI(r, API)
}