Class BoardClient

A gRPC-web client for the Board component.

Hierarchy

BoardClient

Implements

Board

Index

Constructors

Properties

client name options

Accessors

Methods

doCommand getDigitalInterruptValue getGPIO getPWM getPWMFrequency getRawStatusResponse getStatus readAnalogReader setGPIO setPWM setPWMFrequency setPowerMode status writeAnalog

Constructors

constructor

new BoardClient(client: RobotClient, name: string, options?: Options): BoardClient
Parameters
- client: RobotClient
- name: string
- options: Options = {}
Returns BoardClient

Properties

`Private` client

client: BoardServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` boardService

get boardService(): BoardServiceClient
Returns BoardServiceClient

Methods

doCommand

doCommand(command: StructType): Promise<StructType>
Send/Receive arbitrary commands to the resource.
Parameters
- command: StructType
  
  The command to execute.
Returns Promise<StructType>

Implementation of Board.doCommand

getDigitalInterruptValue

getDigitalInterruptValue(digitalInteruptName: string, extra?: {}): Promise<number>
Return the current value of the interrupt which is based on the type of interrupt.
Parameters
- digitalInteruptName: string
  
  The name of the digital interrupt.
- extra: {} = {}
Returns Promise<number>

Implementation of Board.getDigitalInterruptValue

getGPIO

getGPIO(pin: string, extra?: {}): Promise<boolean>
Get the high/low state of the given pin of a board.
Parameters
- pin: string
  
  The pin.
- extra: {} = {}
Returns Promise<boolean>

Implementation of Board.getGPIO

getPWM

getPWM(pin: string, extra?: {}): Promise<number>
Get the duty cycle of the given pin of a board.

Returns
The duty cycle, which is a value from 0 to 1.
Parameters
- pin: string
  
  The pin.
- extra: {} = {}
Returns Promise<number>

Implementation of Board.getPWM

getPWMFrequency

getPWMFrequency(pin: string, extra?: {}): Promise<number>
Get the PWM frequency of the given pin of a board.
Parameters
- pin: string
  
  The pin.
- extra: {} = {}
Returns Promise<number>

Implementation of Board.getPWMFrequency

`Private` getRawStatusResponse

getRawStatusResponse(extra?: {}): Promise<StatusResponse>
Parameters
- extra: {} = {}
Returns Promise<StatusResponse>

getStatus

getStatus(extra?: {}): Promise<{
analogs: Record<string, number>;
digitalInterrupts: Record<string, number>;
}>
Get the status of the board.
Parameters
- extra: {} = {}
Returns Promise<{
analogs: Record<string, number>;
digitalInterrupts: Record<string, number>;
}>

Implementation of Board.getStatus

readAnalogReader

readAnalogReader(analogReader: string, extra?: {}): Promise<number>
Read the current value of an analog reader of a board.
Parameters
- analogReader: string
  
  The name of the analog reader.
- extra: {} = {}
Returns Promise<number>

Implementation of Board.readAnalogReader

setGPIO

setGPIO(pin: string, high: boolean, extra?: {}): Promise<void>
Set the high/low state of the given pin of a board.
Parameters
- pin: string
  
  The pin.
- high: boolean
  
  When true, set the given pin to high. When false, set the given pin to low.
- extra: {} = {}
Returns Promise<void>

Implementation of Board.setGPIO

setPWM

setPWM(pin: string, dutyCyle: number, extra?: {}): Promise<void>
Set the duty cycle of the given pin of a board.
Parameters
- pin: string
  
  The pin.
- dutyCyle: number
  
  A value from 0 to 1.
- extra: {} = {}
Returns Promise<void>

Implementation of Board.setPWM

setPWMFrequency

setPWMFrequency(pin: string, frequencyHz: number, extra?: {}): Promise<void>
Set the PWM frequency of the given pin of a board.
Parameters
- pin: string
  
  The pin.
- frequencyHz: number
  
  The PWM frequency, in hertz. 0 will use the board's default PWM frequency.
- extra: {} = {}
Returns Promise<void>

Implementation of Board.setPWMFrequency

setPowerMode

setPowerMode(name: string, powerMode: PowerMode, duration?: AsObject, extra?: {}): Promise<void>
Set power mode of the board.
Parameters
- name: string
  
  The name of the board.
- powerMode: PowerMode
  
  The requested power mode.
- Optional duration: AsObject
  
  The requested duration to stay in power mode.
- extra: {} = {}
Returns Promise<void>

Implementation of Board.setPowerMode

status

status(extra?: {}): Promise<StatusResponse>
Get the status of the board as a raw protobuf response.

Deprecated
Use getStatus instead.
Parameters
- extra: {} = {}
Returns Promise<StatusResponse>

writeAnalog

writeAnalog(pin: string, value: number, extra?: {}): Promise<void>
Write an analog value to a pin on the board.
Parameters
- pin: string
  
  The pin name.
- value: number
  
  An integer value to write.
- extra: {} = {}
Returns Promise<void>

Implementation of Board.writeAnalog

Generated using TypeDoc