Class Droid

Client for controlling your droid.

Hierarchy

Droid

Index

Constructors

constructor

Properties

Accessors

initialized

Methods

Constructors

constructor

new Droid(): Droid

Returns Droid

Properties

Private Optional notifications

notifications?: W3CBluetoothRemoteGATTCharacteristic

Channel to listen for notifications on.

Private Optional writer

writer?: W3CBluetoothRemoteGATTCharacteristic

Channel to write messages on.

Accessors

initialized

get initialized(): boolean

- Defined in src/droid.ts:93
Whether this droid has been connected to or not.

Returns boolean

Methods

connect

connect(): Promise<Droid>

- Defined in src/droid.ts:62
Pair with the droid over Bluetooth. You will hear a confirmation sound from the droid if this is successful.

Returns Promise<Droid>

Private initialize

initialize(): Promise<Droid>

- Defined in src/droid.ts:170
Send the initialization commands to the droid.

Returns Promise<Droid>

listen

listen(onChange: DroidEventHandler): Droid

- Defined in src/droid.ts:47
Listen for events from the droid using an event handler.

Parameters
- onChange: DroidEventHandler
Returns Droid

move

move(direction: DroidDirection, motor: DroidMotor, power: DroidPower): Promise<Droid>

- Defined in src/droid.ts:100
Move one of the droid's motors.

Parameters
- direction: DroidDirection
- motor: DroidMotor
- power: DroidPower
Returns Promise<Droid>

moveBackward

moveBackward(power: DroidPower): Promise<void>

- Defined in src/droid.ts:122
Move all motors backward at the given speed.

Parameters
- power: DroidPower
Returns Promise<void>

moveForward

moveForward(power: DroidPower): Promise<void>

- Defined in src/droid.ts:111
Move all motors forward at the given speed.

Parameters
- power: DroidPower
Returns Promise<void>

play

play(bank: DroidSoundBank, slot: DroidSoundSlot): Promise<void>

- Defined in src/droid.ts:160
Play a sound from the droid.

Parameters
- bank: DroidSoundBank
- slot: DroidSoundSlot
Returns Promise<void>

Private send

send(command: string): Promise<Droid>

- Defined in src/droid.ts:196
Send a command to the droid over Bluetooth.

Parameters
- command: string
Returns Promise<Droid>

stop

stop(): Promise<void>

- Defined in src/droid.ts:153
Stop all motors.

Returns Promise<void>

turnLeft

turnLeft(power: DroidPower): Promise<void>

- Defined in src/droid.ts:133
Turn left by moving the first and third motors forward.

Parameters
- power: DroidPower
Returns Promise<void>

turnRight

turnRight(power: DroidPower): Promise<void>

- Defined in src/droid.ts:143
Turn right by moving the second and third motors forward.

Parameters
- power: DroidPower
Returns Promise<void>

Static connect

connect(): Promise<Droid>

- Defined in src/droid.ts:38
Connect to your droid with a new client instance.

Returns Promise<Droid>

Generated using TypeDoc