v1

package
v0.1.338 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2024 License: Apache-2.0 Imports: 19 Imported by: 9

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	PowerMode_name = map[int32]string{
		0: "POWER_MODE_UNSPECIFIED",
		1: "POWER_MODE_NORMAL",
		2: "POWER_MODE_OFFLINE_DEEP",
	}
	PowerMode_value = map[string]int32{
		"POWER_MODE_UNSPECIFIED":  0,
		"POWER_MODE_NORMAL":       1,
		"POWER_MODE_OFFLINE_DEEP": 2,
	}
)

Enum value maps for PowerMode.

View Source 
var BoardService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.component.board.v1.BoardService",
	HandlerType: (*BoardServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetGPIO",
			Handler:    _BoardService_SetGPIO_Handler,
		},
		{
			MethodName: "GetGPIO",
			Handler:    _BoardService_GetGPIO_Handler,
		},
		{
			MethodName: "PWM",
			Handler:    _BoardService_PWM_Handler,
		},
		{
			MethodName: "SetPWM",
			Handler:    _BoardService_SetPWM_Handler,
		},
		{
			MethodName: "PWMFrequency",
			Handler:    _BoardService_PWMFrequency_Handler,
		},
		{
			MethodName: "SetPWMFrequency",
			Handler:    _BoardService_SetPWMFrequency_Handler,
		},
		{
			MethodName: "DoCommand",
			Handler:    _BoardService_DoCommand_Handler,
		},
		{
			MethodName: "ReadAnalogReader",
			Handler:    _BoardService_ReadAnalogReader_Handler,
		},
		{
			MethodName: "WriteAnalog",
			Handler:    _BoardService_WriteAnalog_Handler,
		},
		{
			MethodName: "GetDigitalInterruptValue",
			Handler:    _BoardService_GetDigitalInterruptValue_Handler,
		},
		{
			MethodName: "SetPowerMode",
			Handler:    _BoardService_SetPowerMode_Handler,
		},
		{
			MethodName: "GetGeometries",
			Handler:    _BoardService_GetGeometries_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamTicks",
			Handler:       _BoardService_StreamTicks_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "component/board/v1/board.proto",
}

BoardService_ServiceDesc is the grpc.ServiceDesc for BoardService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_component_board_v1_board_proto protoreflect.FileDescriptor

Functions

func RegisterBoardServiceHandler 

func RegisterBoardServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterBoardServiceHandler registers the http handlers for service BoardService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterBoardServiceHandlerClient 

func RegisterBoardServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BoardServiceClient) error

RegisterBoardServiceHandlerClient registers the http handlers for service BoardService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "BoardServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "BoardServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "BoardServiceClient" to call the correct interceptors.

func RegisterBoardServiceHandlerFromEndpoint 

func RegisterBoardServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterBoardServiceHandlerFromEndpoint is same as RegisterBoardServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterBoardServiceHandlerServer 

func RegisterBoardServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BoardServiceServer) error

RegisterBoardServiceHandlerServer registers the http handlers for service BoardService to "mux". UnaryRPC :call BoardServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterBoardServiceHandlerFromEndpoint instead.

func RegisterBoardServiceServer 

func RegisterBoardServiceServer(s grpc.ServiceRegistrar, srv BoardServiceServer)

Types

type BoardServiceClient 

type BoardServiceClient interface {
	SetGPIO(ctx context.Context, in *SetGPIORequest, opts ...grpc.CallOption) (*SetGPIOResponse, error)
	// GetGPIO gets the high/low state of the given pin of a board of the underlying robot.
	GetGPIO(ctx context.Context, in *GetGPIORequest, opts ...grpc.CallOption) (*GetGPIOResponse, error)
	// PWM gets the duty cycle of the given pin of a board of the underlying robot.
	PWM(ctx context.Context, in *PWMRequest, opts ...grpc.CallOption) (*PWMResponse, error)
	// SetPWM sets the given pin of a board of the underlying robot to the given duty cycle.
	SetPWM(ctx context.Context, in *SetPWMRequest, opts ...grpc.CallOption) (*SetPWMResponse, error)
	// PWMFrequency gets the PWM frequency of the given pin of a board of the underlying robot.
	PWMFrequency(ctx context.Context, in *PWMFrequencyRequest, opts ...grpc.CallOption) (*PWMFrequencyResponse, error)
	// SetPWMFrequency sets the given pin of a board of the underlying robot to the given PWM frequency. 0 will use the board's default PWM frequency.
	SetPWMFrequency(ctx context.Context, in *SetPWMFrequencyRequest, opts ...grpc.CallOption) (*SetPWMFrequencyResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(ctx context.Context, in *v1.DoCommandRequest, opts ...grpc.CallOption) (*v1.DoCommandResponse, error)
	// ReadAnalogReader reads off the current value of an analog reader of a board of the underlying robot.
	ReadAnalogReader(ctx context.Context, in *ReadAnalogReaderRequest, opts ...grpc.CallOption) (*ReadAnalogReaderResponse, error)
	// WriteAnalog writes the value to the analog writer of the board.
	WriteAnalog(ctx context.Context, in *WriteAnalogRequest, opts ...grpc.CallOption) (*WriteAnalogResponse, error)
	// GetDigitalInterruptValue returns the current value of the interrupt which is based on the type of interrupt.
	GetDigitalInterruptValue(ctx context.Context, in *GetDigitalInterruptValueRequest, opts ...grpc.CallOption) (*GetDigitalInterruptValueResponse, error)
	// StreamTicks starts a stream of ticks for the given digital interrupts.
	StreamTicks(ctx context.Context, in *StreamTicksRequest, opts ...grpc.CallOption) (BoardService_StreamTicksClient, error)
	// `SetPowerMode` sets the power consumption mode of the board to the requested setting for the given duration.
	SetPowerMode(ctx context.Context, in *SetPowerModeRequest, opts ...grpc.CallOption) (*SetPowerModeResponse, error)
	// GetGeometries returns the geometries of the component in their current configuration.
	GetGeometries(ctx context.Context, in *v1.GetGeometriesRequest, opts ...grpc.CallOption) (*v1.GetGeometriesResponse, error)
}

BoardServiceClient is the client API for BoardService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewBoardServiceClient 

func NewBoardServiceClient(cc grpc.ClientConnInterface) BoardServiceClient

type BoardServiceServer 

type BoardServiceServer interface {
	SetGPIO(context.Context, *SetGPIORequest) (*SetGPIOResponse, error)
	// GetGPIO gets the high/low state of the given pin of a board of the underlying robot.
	GetGPIO(context.Context, *GetGPIORequest) (*GetGPIOResponse, error)
	// PWM gets the duty cycle of the given pin of a board of the underlying robot.
	PWM(context.Context, *PWMRequest) (*PWMResponse, error)
	// SetPWM sets the given pin of a board of the underlying robot to the given duty cycle.
	SetPWM(context.Context, *SetPWMRequest) (*SetPWMResponse, error)
	// PWMFrequency gets the PWM frequency of the given pin of a board of the underlying robot.
	PWMFrequency(context.Context, *PWMFrequencyRequest) (*PWMFrequencyResponse, error)
	// SetPWMFrequency sets the given pin of a board of the underlying robot to the given PWM frequency. 0 will use the board's default PWM frequency.
	SetPWMFrequency(context.Context, *SetPWMFrequencyRequest) (*SetPWMFrequencyResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
	// ReadAnalogReader reads off the current value of an analog reader of a board of the underlying robot.
	ReadAnalogReader(context.Context, *ReadAnalogReaderRequest) (*ReadAnalogReaderResponse, error)
	// WriteAnalog writes the value to the analog writer of the board.
	WriteAnalog(context.Context, *WriteAnalogRequest) (*WriteAnalogResponse, error)
	// GetDigitalInterruptValue returns the current value of the interrupt which is based on the type of interrupt.
	GetDigitalInterruptValue(context.Context, *GetDigitalInterruptValueRequest) (*GetDigitalInterruptValueResponse, error)
	// StreamTicks starts a stream of ticks for the given digital interrupts.
	StreamTicks(*StreamTicksRequest, BoardService_StreamTicksServer) error
	// `SetPowerMode` sets the power consumption mode of the board to the requested setting for the given duration.
	SetPowerMode(context.Context, *SetPowerModeRequest) (*SetPowerModeResponse, error)
	// GetGeometries returns the geometries of the component in their current configuration.
	GetGeometries(context.Context, *v1.GetGeometriesRequest) (*v1.GetGeometriesResponse, error)
	// contains filtered or unexported methods
}

BoardServiceServer is the server API for BoardService service. All implementations must embed UnimplementedBoardServiceServer for forward compatibility

type BoardService_StreamTicksClient added in v0.1.274 

type BoardService_StreamTicksClient interface {
	Recv() (*StreamTicksResponse, error)
	grpc.ClientStream
}

type BoardService_StreamTicksServer added in v0.1.274 

type BoardService_StreamTicksServer interface {
	Send(*StreamTicksResponse) error
	grpc.ServerStream
}

type GetDigitalInterruptValueRequest 

type GetDigitalInterruptValueRequest struct {
	BoardName            string `protobuf:"bytes,1,opt,name=board_name,json=boardName,proto3" json:"board_name,omitempty"`
	DigitalInterruptName string `protobuf:"bytes,2,opt,name=digital_interrupt_name,json=digitalInterruptName,proto3" json:"digital_interrupt_name,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDigitalInterruptValueRequest) Descriptor deprecated 

func (*GetDigitalInterruptValueRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDigitalInterruptValueRequest.ProtoReflect.Descriptor instead.

func (*GetDigitalInterruptValueRequest) GetBoardName 

func (x *GetDigitalInterruptValueRequest) GetBoardName() string

func (*GetDigitalInterruptValueRequest) GetDigitalInterruptName 

func (x *GetDigitalInterruptValueRequest) GetDigitalInterruptName() string

func (*GetDigitalInterruptValueRequest) GetExtra 

func (x *GetDigitalInterruptValueRequest) GetExtra() *structpb.Struct

func (*GetDigitalInterruptValueRequest) ProtoMessage 

func (*GetDigitalInterruptValueRequest) ProtoMessage()

func (*GetDigitalInterruptValueRequest) ProtoReflect 

func (x *GetDigitalInterruptValueRequest) ProtoReflect() protoreflect.Message

func (*GetDigitalInterruptValueRequest) Reset 

func (x *GetDigitalInterruptValueRequest) Reset()

func (*GetDigitalInterruptValueRequest) String 

func (x *GetDigitalInterruptValueRequest) String() string

type GetDigitalInterruptValueResponse 

type GetDigitalInterruptValueResponse struct {
	Value int64 `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDigitalInterruptValueResponse) Descriptor deprecated 

func (*GetDigitalInterruptValueResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDigitalInterruptValueResponse.ProtoReflect.Descriptor instead.

func (*GetDigitalInterruptValueResponse) GetValue 

func (x *GetDigitalInterruptValueResponse) GetValue() int64

func (*GetDigitalInterruptValueResponse) ProtoMessage 

func (*GetDigitalInterruptValueResponse) ProtoMessage()

func (*GetDigitalInterruptValueResponse) ProtoReflect 

func (x *GetDigitalInterruptValueResponse) ProtoReflect() protoreflect.Message

func (*GetDigitalInterruptValueResponse) Reset 

func (x *GetDigitalInterruptValueResponse) Reset()

func (*GetDigitalInterruptValueResponse) String 

func (x *GetDigitalInterruptValueResponse) String() string

type GetGPIORequest 

type GetGPIORequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin  string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGPIORequest) Descriptor deprecated 

func (*GetGPIORequest) Descriptor() ([]byte, []int)

Deprecated: Use GetGPIORequest.ProtoReflect.Descriptor instead.

func (*GetGPIORequest) GetExtra 

func (x *GetGPIORequest) GetExtra() *structpb.Struct

func (*GetGPIORequest) GetName 

func (x *GetGPIORequest) GetName() string

func (*GetGPIORequest) GetPin 

func (x *GetGPIORequest) GetPin() string

func (*GetGPIORequest) ProtoMessage 

func (*GetGPIORequest) ProtoMessage()

func (*GetGPIORequest) ProtoReflect 

func (x *GetGPIORequest) ProtoReflect() protoreflect.Message

func (*GetGPIORequest) Reset 

func (x *GetGPIORequest) Reset()

func (*GetGPIORequest) String 

func (x *GetGPIORequest) String() string

type GetGPIOResponse 

type GetGPIOResponse struct {
	High bool `protobuf:"varint,1,opt,name=high,proto3" json:"high,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGPIOResponse) Descriptor deprecated 

func (*GetGPIOResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetGPIOResponse.ProtoReflect.Descriptor instead.

func (*GetGPIOResponse) GetHigh 

func (x *GetGPIOResponse) GetHigh() bool

func (*GetGPIOResponse) ProtoMessage 

func (*GetGPIOResponse) ProtoMessage()

func (*GetGPIOResponse) ProtoReflect 

func (x *GetGPIOResponse) ProtoReflect() protoreflect.Message

func (*GetGPIOResponse) Reset 

func (x *GetGPIOResponse) Reset()

func (*GetGPIOResponse) String 

func (x *GetGPIOResponse) String() string

type PWMFrequencyRequest 

type PWMFrequencyRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin  string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*PWMFrequencyRequest) Descriptor deprecated 

func (*PWMFrequencyRequest) Descriptor() ([]byte, []int)

Deprecated: Use PWMFrequencyRequest.ProtoReflect.Descriptor instead.

func (*PWMFrequencyRequest) GetExtra 

func (x *PWMFrequencyRequest) GetExtra() *structpb.Struct

func (*PWMFrequencyRequest) GetName 

func (x *PWMFrequencyRequest) GetName() string

func (*PWMFrequencyRequest) GetPin 

func (x *PWMFrequencyRequest) GetPin() string

func (*PWMFrequencyRequest) ProtoMessage 

func (*PWMFrequencyRequest) ProtoMessage()

func (*PWMFrequencyRequest) ProtoReflect 

func (x *PWMFrequencyRequest) ProtoReflect() protoreflect.Message

func (*PWMFrequencyRequest) Reset 

func (x *PWMFrequencyRequest) Reset()

func (*PWMFrequencyRequest) String 

func (x *PWMFrequencyRequest) String() string

type PWMFrequencyResponse 

type PWMFrequencyResponse struct {
	FrequencyHz uint64 `protobuf:"varint,1,opt,name=frequency_hz,json=frequencyHz,proto3" json:"frequency_hz,omitempty"`
	// contains filtered or unexported fields
}

func (*PWMFrequencyResponse) Descriptor deprecated 

func (*PWMFrequencyResponse) Descriptor() ([]byte, []int)

Deprecated: Use PWMFrequencyResponse.ProtoReflect.Descriptor instead.

func (*PWMFrequencyResponse) GetFrequencyHz 

func (x *PWMFrequencyResponse) GetFrequencyHz() uint64

func (*PWMFrequencyResponse) ProtoMessage 

func (*PWMFrequencyResponse) ProtoMessage()

func (*PWMFrequencyResponse) ProtoReflect 

func (x *PWMFrequencyResponse) ProtoReflect() protoreflect.Message

func (*PWMFrequencyResponse) Reset 

func (x *PWMFrequencyResponse) Reset()

func (*PWMFrequencyResponse) String 

func (x *PWMFrequencyResponse) String() string

type PWMRequest 

type PWMRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin  string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*PWMRequest) Descriptor deprecated 

func (*PWMRequest) Descriptor() ([]byte, []int)

Deprecated: Use PWMRequest.ProtoReflect.Descriptor instead.

func (*PWMRequest) GetExtra 

func (x *PWMRequest) GetExtra() *structpb.Struct

func (*PWMRequest) GetName 

func (x *PWMRequest) GetName() string

func (*PWMRequest) GetPin 

func (x *PWMRequest) GetPin() string

func (*PWMRequest) ProtoMessage 

func (*PWMRequest) ProtoMessage()

func (*PWMRequest) ProtoReflect 

func (x *PWMRequest) ProtoReflect() protoreflect.Message

func (*PWMRequest) Reset 

func (x *PWMRequest) Reset()

func (*PWMRequest) String 

func (x *PWMRequest) String() string

type PWMResponse 

type PWMResponse struct {
	DutyCyclePct float64 `protobuf:"fixed64,1,opt,name=duty_cycle_pct,json=dutyCyclePct,proto3" json:"duty_cycle_pct,omitempty"` // 0-1
	// contains filtered or unexported fields
}

func (*PWMResponse) Descriptor deprecated 

func (*PWMResponse) Descriptor() ([]byte, []int)

Deprecated: Use PWMResponse.ProtoReflect.Descriptor instead.

func (*PWMResponse) GetDutyCyclePct 

func (x *PWMResponse) GetDutyCyclePct() float64

func (*PWMResponse) ProtoMessage 

func (*PWMResponse) ProtoMessage()

func (*PWMResponse) ProtoReflect 

func (x *PWMResponse) ProtoReflect() protoreflect.Message

func (*PWMResponse) Reset 

func (x *PWMResponse) Reset()

func (*PWMResponse) String 

func (x *PWMResponse) String() string

type PowerMode added in v0.1.90 

type PowerMode int32
const (
	PowerMode_POWER_MODE_UNSPECIFIED  PowerMode = 0
	PowerMode_POWER_MODE_NORMAL       PowerMode = 1
	PowerMode_POWER_MODE_OFFLINE_DEEP PowerMode = 2
)

func (PowerMode) Descriptor added in v0.1.90 

func (PowerMode) Descriptor() protoreflect.EnumDescriptor

func (PowerMode) Enum added in v0.1.90 

func (x PowerMode) Enum() *PowerMode

func (PowerMode) EnumDescriptor deprecated added in v0.1.90 

func (PowerMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use PowerMode.Descriptor instead.

func (PowerMode) Number added in v0.1.90 

func (x PowerMode) Number() protoreflect.EnumNumber

func (PowerMode) String added in v0.1.90 

func (x PowerMode) String() string

func (PowerMode) Type added in v0.1.90 

func (PowerMode) Type() protoreflect.EnumType

type ReadAnalogReaderRequest 

type ReadAnalogReaderRequest struct {
	BoardName        string `protobuf:"bytes,1,opt,name=board_name,json=boardName,proto3" json:"board_name,omitempty"`
	AnalogReaderName string `protobuf:"bytes,2,opt,name=analog_reader_name,json=analogReaderName,proto3" json:"analog_reader_name,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadAnalogReaderRequest) Descriptor deprecated 

func (*ReadAnalogReaderRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadAnalogReaderRequest.ProtoReflect.Descriptor instead.

func (*ReadAnalogReaderRequest) GetAnalogReaderName 

func (x *ReadAnalogReaderRequest) GetAnalogReaderName() string

func (*ReadAnalogReaderRequest) GetBoardName 

func (x *ReadAnalogReaderRequest) GetBoardName() string

func (*ReadAnalogReaderRequest) GetExtra 

func (x *ReadAnalogReaderRequest) GetExtra() *structpb.Struct

func (*ReadAnalogReaderRequest) ProtoMessage 

func (*ReadAnalogReaderRequest) ProtoMessage()

func (*ReadAnalogReaderRequest) ProtoReflect 

func (x *ReadAnalogReaderRequest) ProtoReflect() protoreflect.Message

func (*ReadAnalogReaderRequest) Reset 

func (x *ReadAnalogReaderRequest) Reset()

func (*ReadAnalogReaderRequest) String 

func (x *ReadAnalogReaderRequest) String() string

type ReadAnalogReaderResponse 

type ReadAnalogReaderResponse struct {
	Value    int32   `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	MinRange float32 `protobuf:"fixed32,2,opt,name=min_range,json=minRange,proto3" json:"min_range,omitempty"`
	MaxRange float32 `protobuf:"fixed32,3,opt,name=max_range,json=maxRange,proto3" json:"max_range,omitempty"`
	StepSize float32 `protobuf:"fixed32,4,opt,name=step_size,json=stepSize,proto3" json:"step_size,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadAnalogReaderResponse) Descriptor deprecated 

func (*ReadAnalogReaderResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadAnalogReaderResponse.ProtoReflect.Descriptor instead.

func (*ReadAnalogReaderResponse) GetMaxRange added in v0.1.295 

func (x *ReadAnalogReaderResponse) GetMaxRange() float32

func (*ReadAnalogReaderResponse) GetMinRange added in v0.1.295 

func (x *ReadAnalogReaderResponse) GetMinRange() float32

func (*ReadAnalogReaderResponse) GetStepSize added in v0.1.295 

func (x *ReadAnalogReaderResponse) GetStepSize() float32

func (*ReadAnalogReaderResponse) GetValue 

func (x *ReadAnalogReaderResponse) GetValue() int32

func (*ReadAnalogReaderResponse) ProtoMessage 

func (*ReadAnalogReaderResponse) ProtoMessage()

func (*ReadAnalogReaderResponse) ProtoReflect 

func (x *ReadAnalogReaderResponse) ProtoReflect() protoreflect.Message

func (*ReadAnalogReaderResponse) Reset 

func (x *ReadAnalogReaderResponse) Reset()

func (*ReadAnalogReaderResponse) String 

func (x *ReadAnalogReaderResponse) String() string

type SetGPIORequest 

type SetGPIORequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin  string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	High bool   `protobuf:"varint,3,opt,name=high,proto3" json:"high,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*SetGPIORequest) Descriptor deprecated 

func (*SetGPIORequest) Descriptor() ([]byte, []int)

Deprecated: Use SetGPIORequest.ProtoReflect.Descriptor instead.

func (*SetGPIORequest) GetExtra 

func (x *SetGPIORequest) GetExtra() *structpb.Struct

func (*SetGPIORequest) GetHigh 

func (x *SetGPIORequest) GetHigh() bool

func (*SetGPIORequest) GetName 

func (x *SetGPIORequest) GetName() string

func (*SetGPIORequest) GetPin 

func (x *SetGPIORequest) GetPin() string

func (*SetGPIORequest) ProtoMessage 

func (*SetGPIORequest) ProtoMessage()

func (*SetGPIORequest) ProtoReflect 

func (x *SetGPIORequest) ProtoReflect() protoreflect.Message

func (*SetGPIORequest) Reset 

func (x *SetGPIORequest) Reset()

func (*SetGPIORequest) String 

func (x *SetGPIORequest) String() string

type SetGPIOResponse 

type SetGPIOResponse struct {
	// contains filtered or unexported fields
}

func (*SetGPIOResponse) Descriptor deprecated 

func (*SetGPIOResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetGPIOResponse.ProtoReflect.Descriptor instead.

func (*SetGPIOResponse) ProtoMessage 

func (*SetGPIOResponse) ProtoMessage()

func (*SetGPIOResponse) ProtoReflect 

func (x *SetGPIOResponse) ProtoReflect() protoreflect.Message

func (*SetGPIOResponse) Reset 

func (x *SetGPIOResponse) Reset()

func (*SetGPIOResponse) String 

func (x *SetGPIOResponse) String() string

type SetPWMFrequencyRequest 

type SetPWMFrequencyRequest struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin         string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	FrequencyHz uint64 `protobuf:"varint,3,opt,name=frequency_hz,json=frequencyHz,proto3" json:"frequency_hz,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*SetPWMFrequencyRequest) Descriptor deprecated 

func (*SetPWMFrequencyRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetPWMFrequencyRequest.ProtoReflect.Descriptor instead.

func (*SetPWMFrequencyRequest) GetExtra 

func (x *SetPWMFrequencyRequest) GetExtra() *structpb.Struct

func (*SetPWMFrequencyRequest) GetFrequencyHz 

func (x *SetPWMFrequencyRequest) GetFrequencyHz() uint64

func (*SetPWMFrequencyRequest) GetName 

func (x *SetPWMFrequencyRequest) GetName() string

func (*SetPWMFrequencyRequest) GetPin 

func (x *SetPWMFrequencyRequest) GetPin() string

func (*SetPWMFrequencyRequest) ProtoMessage 

func (*SetPWMFrequencyRequest) ProtoMessage()

func (*SetPWMFrequencyRequest) ProtoReflect 

func (x *SetPWMFrequencyRequest) ProtoReflect() protoreflect.Message

func (*SetPWMFrequencyRequest) Reset 

func (x *SetPWMFrequencyRequest) Reset()

func (*SetPWMFrequencyRequest) String 

func (x *SetPWMFrequencyRequest) String() string

type SetPWMFrequencyResponse 

type SetPWMFrequencyResponse struct {
	// contains filtered or unexported fields
}

func (*SetPWMFrequencyResponse) Descriptor deprecated 

func (*SetPWMFrequencyResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetPWMFrequencyResponse.ProtoReflect.Descriptor instead.

func (*SetPWMFrequencyResponse) ProtoMessage 

func (*SetPWMFrequencyResponse) ProtoMessage()

func (*SetPWMFrequencyResponse) ProtoReflect 

func (x *SetPWMFrequencyResponse) ProtoReflect() protoreflect.Message

func (*SetPWMFrequencyResponse) Reset 

func (x *SetPWMFrequencyResponse) Reset()

func (*SetPWMFrequencyResponse) String 

func (x *SetPWMFrequencyResponse) String() string

type SetPWMRequest 

type SetPWMRequest struct {
	Name         string  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin          string  `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	DutyCyclePct float64 `protobuf:"fixed64,3,opt,name=duty_cycle_pct,json=dutyCyclePct,proto3" json:"duty_cycle_pct,omitempty"` // 0-1
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*SetPWMRequest) Descriptor deprecated 

func (*SetPWMRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetPWMRequest.ProtoReflect.Descriptor instead.

func (*SetPWMRequest) GetDutyCyclePct 

func (x *SetPWMRequest) GetDutyCyclePct() float64

func (*SetPWMRequest) GetExtra 

func (x *SetPWMRequest) GetExtra() *structpb.Struct

func (*SetPWMRequest) GetName 

func (x *SetPWMRequest) GetName() string

func (*SetPWMRequest) GetPin 

func (x *SetPWMRequest) GetPin() string

func (*SetPWMRequest) ProtoMessage 

func (*SetPWMRequest) ProtoMessage()

func (*SetPWMRequest) ProtoReflect 

func (x *SetPWMRequest) ProtoReflect() protoreflect.Message

func (*SetPWMRequest) Reset 

func (x *SetPWMRequest) Reset()

func (*SetPWMRequest) String 

func (x *SetPWMRequest) String() string

type SetPWMResponse 

type SetPWMResponse struct {
	// contains filtered or unexported fields
}

func (*SetPWMResponse) Descriptor deprecated 

func (*SetPWMResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetPWMResponse.ProtoReflect.Descriptor instead.

func (*SetPWMResponse) ProtoMessage 

func (*SetPWMResponse) ProtoMessage()

func (*SetPWMResponse) ProtoReflect 

func (x *SetPWMResponse) ProtoReflect() protoreflect.Message

func (*SetPWMResponse) Reset 

func (x *SetPWMResponse) Reset()

func (*SetPWMResponse) String 

func (x *SetPWMResponse) String() string

type SetPowerModeRequest added in v0.1.90 

type SetPowerModeRequest struct {

	// name of board
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Requested power mode
	PowerMode PowerMode `` /* 128-byte string literal not displayed */
	// Requested duration to stay in `power_mode`
	Duration *durationpb.Duration `protobuf:"bytes,3,opt,name=duration,proto3,oneof" json:"duration,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*SetPowerModeRequest) Descriptor deprecated added in v0.1.90 

func (*SetPowerModeRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetPowerModeRequest.ProtoReflect.Descriptor instead.

func (*SetPowerModeRequest) GetDuration added in v0.1.90 

func (x *SetPowerModeRequest) GetDuration() *durationpb.Duration

func (*SetPowerModeRequest) GetExtra added in v0.1.90 

func (x *SetPowerModeRequest) GetExtra() *structpb.Struct

func (*SetPowerModeRequest) GetName added in v0.1.90 

func (x *SetPowerModeRequest) GetName() string

func (*SetPowerModeRequest) GetPowerMode added in v0.1.90 

func (x *SetPowerModeRequest) GetPowerMode() PowerMode

func (*SetPowerModeRequest) ProtoMessage added in v0.1.90 

func (*SetPowerModeRequest) ProtoMessage()

func (*SetPowerModeRequest) ProtoReflect added in v0.1.90 

func (x *SetPowerModeRequest) ProtoReflect() protoreflect.Message

func (*SetPowerModeRequest) Reset added in v0.1.90 

func (x *SetPowerModeRequest) Reset()

func (*SetPowerModeRequest) String added in v0.1.90 

func (x *SetPowerModeRequest) String() string

type SetPowerModeResponse added in v0.1.90 

type SetPowerModeResponse struct {
	// contains filtered or unexported fields
}

func (*SetPowerModeResponse) Descriptor deprecated added in v0.1.90 

func (*SetPowerModeResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetPowerModeResponse.ProtoReflect.Descriptor instead.

func (*SetPowerModeResponse) ProtoMessage added in v0.1.90 

func (*SetPowerModeResponse) ProtoMessage()

func (*SetPowerModeResponse) ProtoReflect added in v0.1.90 

func (x *SetPowerModeResponse) ProtoReflect() protoreflect.Message

func (*SetPowerModeResponse) Reset added in v0.1.90 

func (x *SetPowerModeResponse) Reset()

func (*SetPowerModeResponse) String added in v0.1.90 

func (x *SetPowerModeResponse) String() string

type Status added in v0.1.289 

type Status struct {
	Analogs           map[string]int32 `` /* 156-byte string literal not displayed */
	DigitalInterrupts map[string]int64 `` /* 201-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Status) Descriptor deprecated added in v0.1.289 

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetAnalogs added in v0.1.289 

func (x *Status) GetAnalogs() map[string]int32

func (*Status) GetDigitalInterrupts added in v0.1.289 

func (x *Status) GetDigitalInterrupts() map[string]int64

func (*Status) ProtoMessage added in v0.1.289 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect added in v0.1.289 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset added in v0.1.289 

func (x *Status) Reset()

func (*Status) String added in v0.1.289 

func (x *Status) String() string

type StreamTicksRequest added in v0.1.274 

type StreamTicksRequest struct {

	// Board name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Name of digital interrupts to recieve ticks from
	PinNames []string `protobuf:"bytes,2,rep,name=pin_names,json=pinNames,proto3" json:"pin_names,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamTicksRequest) Descriptor deprecated added in v0.1.274 

func (*StreamTicksRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamTicksRequest.ProtoReflect.Descriptor instead.

func (*StreamTicksRequest) GetExtra added in v0.1.274 

func (x *StreamTicksRequest) GetExtra() *structpb.Struct

func (*StreamTicksRequest) GetName added in v0.1.274 

func (x *StreamTicksRequest) GetName() string

func (*StreamTicksRequest) GetPinNames added in v0.1.274 

func (x *StreamTicksRequest) GetPinNames() []string

func (*StreamTicksRequest) ProtoMessage added in v0.1.274 

func (*StreamTicksRequest) ProtoMessage()

func (*StreamTicksRequest) ProtoReflect added in v0.1.274 

func (x *StreamTicksRequest) ProtoReflect() protoreflect.Message

func (*StreamTicksRequest) Reset added in v0.1.274 

func (x *StreamTicksRequest) Reset()

func (*StreamTicksRequest) String added in v0.1.274 

func (x *StreamTicksRequest) String() string

type StreamTicksResponse added in v0.1.274 

type StreamTicksResponse struct {

	// name of interrupt
	PinName string `protobuf:"bytes,1,opt,name=pin_name,json=pinName,proto3" json:"pin_name,omitempty"`
	// Time in nanoseconds of a tick
	Time uint64 `protobuf:"varint,2,opt,name=time,proto3" json:"time,omitempty"`
	// Value high or low of the tick
	High bool `protobuf:"varint,3,opt,name=high,proto3" json:"high,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamTicksResponse) Descriptor deprecated added in v0.1.274 

func (*StreamTicksResponse) Descriptor() ([]byte, []int)

Deprecated: Use StreamTicksResponse.ProtoReflect.Descriptor instead.

func (*StreamTicksResponse) GetHigh added in v0.1.274 

func (x *StreamTicksResponse) GetHigh() bool

func (*StreamTicksResponse) GetPinName added in v0.1.274 

func (x *StreamTicksResponse) GetPinName() string

func (*StreamTicksResponse) GetTime added in v0.1.274 

func (x *StreamTicksResponse) GetTime() uint64

func (*StreamTicksResponse) ProtoMessage added in v0.1.274 

func (*StreamTicksResponse) ProtoMessage()

func (*StreamTicksResponse) ProtoReflect added in v0.1.274 

func (x *StreamTicksResponse) ProtoReflect() protoreflect.Message

func (*StreamTicksResponse) Reset added in v0.1.274 

func (x *StreamTicksResponse) Reset()

func (*StreamTicksResponse) String added in v0.1.274 

func (x *StreamTicksResponse) String() string

type UnimplementedBoardServiceServer 

type UnimplementedBoardServiceServer struct {
}

UnimplementedBoardServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedBoardServiceServer) DoCommand added in v0.1.79 

func (UnimplementedBoardServiceServer) DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)

func (UnimplementedBoardServiceServer) GetDigitalInterruptValue 

func (UnimplementedBoardServiceServer) GetDigitalInterruptValue(context.Context, *GetDigitalInterruptValueRequest) (*GetDigitalInterruptValueResponse, error)

func (UnimplementedBoardServiceServer) GetGPIO 

func (UnimplementedBoardServiceServer) GetGPIO(context.Context, *GetGPIORequest) (*GetGPIOResponse, error)

func (UnimplementedBoardServiceServer) GetGeometries added in v0.1.129 

func (UnimplementedBoardServiceServer) GetGeometries(context.Context, *v1.GetGeometriesRequest) (*v1.GetGeometriesResponse, error)

func (UnimplementedBoardServiceServer) PWM 

func (UnimplementedBoardServiceServer) PWM(context.Context, *PWMRequest) (*PWMResponse, error)

func (UnimplementedBoardServiceServer) PWMFrequency 

func (UnimplementedBoardServiceServer) PWMFrequency(context.Context, *PWMFrequencyRequest) (*PWMFrequencyResponse, error)

func (UnimplementedBoardServiceServer) ReadAnalogReader 

func (UnimplementedBoardServiceServer) ReadAnalogReader(context.Context, *ReadAnalogReaderRequest) (*ReadAnalogReaderResponse, error)

func (UnimplementedBoardServiceServer) SetGPIO 

func (UnimplementedBoardServiceServer) SetGPIO(context.Context, *SetGPIORequest) (*SetGPIOResponse, error)

func (UnimplementedBoardServiceServer) SetPWM 

func (UnimplementedBoardServiceServer) SetPWM(context.Context, *SetPWMRequest) (*SetPWMResponse, error)

func (UnimplementedBoardServiceServer) SetPWMFrequency 

func (UnimplementedBoardServiceServer) SetPWMFrequency(context.Context, *SetPWMFrequencyRequest) (*SetPWMFrequencyResponse, error)

func (UnimplementedBoardServiceServer) SetPowerMode added in v0.1.90 

func (UnimplementedBoardServiceServer) SetPowerMode(context.Context, *SetPowerModeRequest) (*SetPowerModeResponse, error)

func (UnimplementedBoardServiceServer) StreamTicks added in v0.1.274 

func (UnimplementedBoardServiceServer) StreamTicks(*StreamTicksRequest, BoardService_StreamTicksServer) error

func (UnimplementedBoardServiceServer) WriteAnalog added in v0.1.208 

func (UnimplementedBoardServiceServer) WriteAnalog(context.Context, *WriteAnalogRequest) (*WriteAnalogResponse, error)

type UnsafeBoardServiceServer 

type UnsafeBoardServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeBoardServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BoardServiceServer will result in compilation errors.

type WriteAnalogRequest added in v0.1.207 

type WriteAnalogRequest struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pin   string `protobuf:"bytes,2,opt,name=pin,proto3" json:"pin,omitempty"`
	Value int32  `protobuf:"varint,3,opt,name=value,proto3" json:"value,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteAnalogRequest) Descriptor deprecated added in v0.1.207 

func (*WriteAnalogRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteAnalogRequest.ProtoReflect.Descriptor instead.

func (*WriteAnalogRequest) GetExtra added in v0.1.207 

func (x *WriteAnalogRequest) GetExtra() *structpb.Struct

func (*WriteAnalogRequest) GetName added in v0.1.207 

func (x *WriteAnalogRequest) GetName() string

func (*WriteAnalogRequest) GetPin added in v0.1.207 

func (x *WriteAnalogRequest) GetPin() string

func (*WriteAnalogRequest) GetValue added in v0.1.207 

func (x *WriteAnalogRequest) GetValue() int32

func (*WriteAnalogRequest) ProtoMessage added in v0.1.207 

func (*WriteAnalogRequest) ProtoMessage()

func (*WriteAnalogRequest) ProtoReflect added in v0.1.207 

func (x *WriteAnalogRequest) ProtoReflect() protoreflect.Message

func (*WriteAnalogRequest) Reset added in v0.1.207 

func (x *WriteAnalogRequest) Reset()

func (*WriteAnalogRequest) String added in v0.1.207 

func (x *WriteAnalogRequest) String() string

type WriteAnalogResponse added in v0.1.207 

type WriteAnalogResponse struct {
	// contains filtered or unexported fields
}

func (*WriteAnalogResponse) Descriptor deprecated added in v0.1.207 

func (*WriteAnalogResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteAnalogResponse.ProtoReflect.Descriptor instead.

func (*WriteAnalogResponse) ProtoMessage added in v0.1.207 

func (*WriteAnalogResponse) ProtoMessage()

func (*WriteAnalogResponse) ProtoReflect added in v0.1.207 

func (x *WriteAnalogResponse) ProtoReflect() protoreflect.Message

func (*WriteAnalogResponse) Reset added in v0.1.207 

func (x *WriteAnalogResponse) Reset()

func (*WriteAnalogResponse) String added in v0.1.207 

func (x *WriteAnalogResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.