Package com.viam.component.board.v1

Interface BoardServiceGrpc.AsyncService

All Known Implementing Classes:

BoardServiceGrpc.BoardServiceImplBase

Enclosing class:

BoardServiceGrpc

public static interface BoardServiceGrpc.AsyncService

 BoardService services all Boards associated with a robot
 

Method Summary

Modifier and Type	Method	Description
default void	doCommand(Common.DoCommandRequest request, io.grpc.stub.StreamObserver<Common.DoCommandResponse> responseObserver)	DoCommand sends/receives arbitrary commands
default void	getDigitalInterruptValue(Board.GetDigitalInterruptValueRequest request, io.grpc.stub.StreamObserver<Board.GetDigitalInterruptValueResponse> responseObserver)	GetDigitalInterruptValue returns the current value of the interrupt which is based on the type of interrupt.
default void	getGeometries(Common.GetGeometriesRequest request, io.grpc.stub.StreamObserver<Common.GetGeometriesResponse> responseObserver)	GetGeometries returns the geometries of the component in their current configuration.
default void	getGPIO(Board.GetGPIORequest request, io.grpc.stub.StreamObserver<Board.GetGPIOResponse> responseObserver)	GetGPIO gets the high/low state of the given pin of a board of the underlying robot.
default void	pWM(Board.PWMRequest request, io.grpc.stub.StreamObserver<Board.PWMResponse> responseObserver)	PWM gets the duty cycle of the given pin of a board of the underlying robot.
default void	pWMFrequency(Board.PWMFrequencyRequest request, io.grpc.stub.StreamObserver<Board.PWMFrequencyResponse> responseObserver)	PWMFrequency gets the PWM frequency of the given pin of a board of the underlying robot.
default void	readAnalogReader(Board.ReadAnalogReaderRequest request, io.grpc.stub.StreamObserver<Board.ReadAnalogReaderResponse> responseObserver)	ReadAnalogReader reads off the current value of an analog reader of a board of the underlying robot.
default void	setGPIO(Board.SetGPIORequest request, io.grpc.stub.StreamObserver<Board.SetGPIOResponse> responseObserver)
default void	setPowerMode(Board.SetPowerModeRequest request, io.grpc.stub.StreamObserver<Board.SetPowerModeResponse> responseObserver)	`SetPowerMode` sets the power consumption mode of the board to the requested setting for the given duration.
default void	setPWM(Board.SetPWMRequest request, io.grpc.stub.StreamObserver<Board.SetPWMResponse> responseObserver)	SetPWM sets the given pin of a board of the underlying robot to the given duty cycle.
default void	setPWMFrequency(Board.SetPWMFrequencyRequest request, io.grpc.stub.StreamObserver<Board.SetPWMFrequencyResponse> responseObserver)	SetPWMFrequency sets the given pin of a board of the underlying robot to the given PWM frequency.
default void	streamTicks(Board.StreamTicksRequest request, io.grpc.stub.StreamObserver<Board.StreamTicksResponse> responseObserver)	StreamTicks starts a stream of ticks for the given digital interrupts.
default void	writeAnalog(Board.WriteAnalogRequest request, io.grpc.stub.StreamObserver<Board.WriteAnalogResponse> responseObserver)	WriteAnalog writes the value to the analog writer of the board.

Method Details

setGPIO

default void setGPIO(Board.SetGPIORequest request,
 io.grpc.stub.StreamObserver<Board.SetGPIOResponse> responseObserver)

getGPIO

default void getGPIO(Board.GetGPIORequest request,
 io.grpc.stub.StreamObserver<Board.GetGPIOResponse> responseObserver)

 GetGPIO gets the high/low state of the given pin of a board of the underlying robot.
 

pWM

default void pWM(Board.PWMRequest request,
 io.grpc.stub.StreamObserver<Board.PWMResponse> responseObserver)

 PWM gets the duty cycle of the given pin of a board of the underlying robot.
 

setPWM

default void setPWM(Board.SetPWMRequest request,
 io.grpc.stub.StreamObserver<Board.SetPWMResponse> responseObserver)

 SetPWM sets the given pin of a board of the underlying robot to the given duty cycle.
 

pWMFrequency

default void pWMFrequency(Board.PWMFrequencyRequest request,
 io.grpc.stub.StreamObserver<Board.PWMFrequencyResponse> responseObserver)

 PWMFrequency gets the PWM frequency of the given pin of a board of the underlying robot.
 

setPWMFrequency

default void setPWMFrequency(Board.SetPWMFrequencyRequest request,
 io.grpc.stub.StreamObserver<Board.SetPWMFrequencyResponse> responseObserver)

 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.
 

doCommand

default void doCommand(Common.DoCommandRequest request,
 io.grpc.stub.StreamObserver<Common.DoCommandResponse> responseObserver)

 DoCommand sends/receives arbitrary commands
 

readAnalogReader

default void readAnalogReader(Board.ReadAnalogReaderRequest request,
 io.grpc.stub.StreamObserver<Board.ReadAnalogReaderResponse> responseObserver)

 ReadAnalogReader reads off the current value of an analog reader of a board of the underlying robot.
 

writeAnalog

default void writeAnalog(Board.WriteAnalogRequest request,
 io.grpc.stub.StreamObserver<Board.WriteAnalogResponse> responseObserver)

 WriteAnalog writes the value to the analog writer of the board.
 

getDigitalInterruptValue

default void getDigitalInterruptValue(Board.GetDigitalInterruptValueRequest request,
 io.grpc.stub.StreamObserver<Board.GetDigitalInterruptValueResponse> responseObserver)

 GetDigitalInterruptValue returns the current value of the interrupt which is based on the type of interrupt.
 

streamTicks

default void streamTicks(Board.StreamTicksRequest request,
 io.grpc.stub.StreamObserver<Board.StreamTicksResponse> responseObserver)

 StreamTicks starts a stream of ticks for the given digital interrupts.
 

setPowerMode

default void setPowerMode(Board.SetPowerModeRequest request,
 io.grpc.stub.StreamObserver<Board.SetPowerModeResponse> responseObserver)

 `SetPowerMode` sets the power consumption mode of the board to the requested setting for the given duration.
 

getGeometries

default void getGeometries(Common.GetGeometriesRequest request,
 io.grpc.stub.StreamObserver<Common.GetGeometriesResponse> responseObserver)

 GetGeometries returns the geometries of the component in their current configuration.