Class RobotSocket

Represents a connection to a physical robot.

Hierarchy

RobotSocket

Index

Constructors

Properties

Methods

drive turn turnAndDrive

Constructors

constructor

new RobotSocket(tunnel: BotTunnel): RobotSocket
Parameters
- tunnel: BotTunnel
Returns RobotSocket
- Defined in src/server/robot/robot-socket.ts:7

Properties

`Private` tunnel

tunnel: BotTunnel

Methods

drive

drive(tileDistance: number): Promise<void>
Send a packet to the robot indicating distance to drive. Returns a promise that finishes when the robot finishes the action.
Parameters
- tileDistance: number
  
  The distance to drive forward or backwards by. 1 is defined as the length of a tile.
Returns Promise<void>
- Defined in src/server/robot/robot-socket.ts:22

turn

turn(deltaHeading: number): Promise<void>
Send a packet to the robot indicating angle to turn. Returns a promise that finishes when the robot finishes the action.
Parameters
- deltaHeading: number
  
  A relative heading to turn by, in radians. May be positive or negative.
Returns Promise<void>
- Defined in src/server/robot/robot-socket.ts:33

turnAndDrive

turnAndDrive(deltaHeading?: number, distance?: number): Promise<void>
Parameters
- deltaHeading: number = 0
- distance: number = 0
Returns Promise<void>
- Defined in src/server/robot/robot-socket.ts:9

Generated using TypeDoc