Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cube

Hierarchy

  • Cube

Index

Constructors

constructor

  • new Cube(peripheral: Peripheral): Cube
  • Create a new cube instance

    Parameters

    • peripheral: Peripheral

      a noble's peripheral object

    Returns Cube

Properties

Static TOIO_SERVICE_ID

TOIO_SERVICE_ID: "10b201005b3b45719508cf3efcd7bbae" = "10b201005b3b45719508cf3efcd7bbae"

UUID of cube BLE service

Accessors

address

  • get address(): string

id

  • get id(): string

Methods

connect

  • connect(): Promise<Cube>

getBLEProtocolVersion

  • getBLEProtocolVersion(): Promise<string>

getBatteryStatus

  • getBatteryStatus(): Promise<object>

getButtonStatus

  • getButtonStatus(): Promise<object>

getCollisionStatus

  • getCollisionStatus(): Promise<object>

getSlopeStatus

  • getSlopeStatus(): Promise<object>

move

  • move(left: number, right: number, duration?: number): Promise<void> | void
  • Move cube

    Parameters

    • left: number

      [-100, 100] speed of left motor

    • right: number

      [100, 100] speed of right motor

    • Default value duration: number = 0

      [0, 2550] duration in millisecond. 0 means endless.

    Returns Promise<void> | void

    Promise object

off

  • off<E>(event: E, listener: any): this
  • Type parameters

    • E: keyof Event

    Parameters

    • event: E
    • listener: any

    Returns this

on

  • on<E>(event: E, listener: any): this
  • Type parameters

    • E: keyof Event

    Parameters

    • event: E
    • listener: any

    Returns this

playPresetSound

  • playPresetSound(soundId: number): void
  • Play preset sound

    Parameters

    • soundId: number

      [0 - 10] id of preset sound

    Returns void

playSound

  • playSound(operations: SoundOperation[], repeatCount?: number): Promise<void> | void
  • Play sound

    Parameters

    • operations: SoundOperation[]

      list of buzzer information (duration and note name)

    • Default value repeatCount: number = 0

      the number of repeat, 0 means eternal loop.

    Returns Promise<void> | void

    Promise object

stop

  • stop(): void

stopSound

  • stopSound(): void

turnOffLight

  • turnOffLight(): void

turnOnLight

turnOnLightWithScenario

  • turnOnLightWithScenario(operations: LightOperation[], repeatCount?: number): Promise<void> | void
  • Turn on a light

    Parameters

    • operations: LightOperation[]

      list of LED information (duration and color)

    • Default value repeatCount: number = 0

      the number of repeat, 0 means eternal loop.

    Returns Promise<void> | void

    Promise object

Generated using TypeDoc