Class BoardClient

constructor

• new BoardClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): BoardClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns BoardClient

callOptions

Readonlyname

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

getDigitalInterruptValue

• getDigitalInterruptValue(
      digitalInterruptName: string,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<number>

  Return the current value of the interrupt which is based on the type of interrupt.

  Parameters

  • digitalInterruptName: string

    The name of the digital interrupt.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

getGPIO

• getGPIO(pin: string, extra?: {}, callOptions?: CallOptions): Promise<boolean>

  Parameters

  • pin: string
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<boolean>

getPWM

• getPWM(pin: string, extra?: {}, callOptions?: CallOptions): Promise<number>

  Get the duty cycle of the given pin of a board.

  Parameters

  • pin: string

    The pin.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

  The duty cycle, which is a value from 0 to 1.

getPWMFrequency

• getPWMFrequency(
      pin: string,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<number>

  Get the PWM frequency of the given pin of a board.

  Parameters

  • pin: string

    The pin.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

readAnalogReader

• readAnalogReader(
      analogReader: string,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<ReadAnalogReaderResponse>

  Read the current value of an analog reader of a board.

  Parameters

  • analogReader: string

    The name of the analog reader.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<ReadAnalogReaderResponse>

setGPIO

• setGPIO(
      pin: string,
      high: boolean,
      extra?: {},
      callOptions?: CallOptions,
  ): 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: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

setPowerMode

• setPowerMode(
      powerMode: boardApi.PowerMode,
      duration?: Duration,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Set power mode of the board.

  Parameters

  • powerMode: boardApi.PowerMode

    The requested power mode.
  • Optionalduration: Duration

    The requested duration to stay in power mode.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

setPWM

• setPWM(
      pin: string,
      dutyCyle: number,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Set the duty cycle of the given pin of a board.

  Parameters

  • pin: string

    The pin.
  • dutyCyle: number
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

setPWMFrequency

• setPWMFrequency(
      pin: string,
      frequencyHz: number,
      extra?: {},
      callOptions?: CallOptions,
  ): 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: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

streamTicks

• streamTicks(
      interrupts: string[],
      queue: Tick[],
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Stream digital interrupt ticks on the board.

  Parameters

  • interrupts: string[]

    Names of the interrupts to stream.
  • queue: Tick[]

    Array to put the ticks in.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

writeAnalog

• writeAnalog(
      pin: string,
      value: number,
      extra?: {},
      callOptions?: CallOptions,
  ): 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: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>