Class BotTunnel

Hierarchy

BotTunnel
- VirtualBotTunnel

Index

Constructors

constructor

new BotTunnel(socket: null | Socket, onHandshake: ((packetContent: string) => void)): BotTunnel
Parameters
- socket: null | Socket
- onHandshake: ((packetContent: string) => void)
  - - (packetContent: string): void
    - Parameters
      
      packetContent: string
      
      Returns void
Returns BotTunnel
- Defined in src/server/api/tcp-interface.ts:19

Properties

address

address: undefined | string

connected

connected: boolean = false

dataBuffer

dataBuffer: undefined | Buffer

emitter

emitter: EventEmitter

id

id: undefined | string

`Private` onHandshake

onHandshake: ((packetContent: string) => void)

Type declaration

- (packetContent: string): void
- Parameters
  - packetContent: string
  Returns void

`Private` socket

socket: null | Socket

Methods

getIdentifier

getIdentifier(): string
Returns string
- Defined in src/server/api/tcp-interface.ts:30

handleData

handleData(data: Buffer): void
Parameters
- data: Buffer
Returns void
- Defined in src/server/api/tcp-interface.ts:65

handleQueue

handleQueue(): void
Returns void
- Defined in src/server/api/tcp-interface.ts:75

isActive

isActive(): boolean
Returns boolean
- Defined in src/server/api/tcp-interface.ts:26

makeHello

makeHello(mac: string): {
    macAddress: string;
    type: "CLIENT_HELLO";
} | {
    config: [string, string][];
    protocol: number;
    type: "SERVER_HELLO";
} | {
    type: "PING_SEND";
} | {
    type: "PING_RESPONSE";
} | {
    type: "QUERY_VAR";
    var_id: number;
    var_type: "float" | "int32" | "uint32";
} | {
    type: "QUERY_RESPONSE";
    var_id: number;
    var_val: number;
} | Object | {
    deltaHeadingRadians: number;
    type: "TURN_BY_ANGLE";
} | {
    tileDistance: number;
    type: "DRIVE_TILES";
} | {
    type: "ACTION_SUCCESS";
} | {
    reason: string;
    type: "ACTION_FAIL";
} | {
    left: number;
    right: number;
    type: "DRIVE_TANK";
} | {
    type: "ESTOP";
}
Parameters
- mac: string
Returns {
    macAddress: string;
    type: "CLIENT_HELLO";
} | {
    config: [string, string][];
    protocol: number;
    type: "SERVER_HELLO";
} | {
    type: "PING_SEND";
} | {
    type: "PING_RESPONSE";
} | {
    type: "QUERY_VAR";
    var_id: number;
    var_type: "float" | "int32" | "uint32";
} | {
    type: "QUERY_RESPONSE";
    var_id: number;
    var_val: number;
} | Object | {
    deltaHeadingRadians: number;
    type: "TURN_BY_ANGLE";
} | {
    tileDistance: number;
    type: "DRIVE_TILES";
} | {
    type: "ACTION_SUCCESS";
} | {
    reason: string;
    type: "ACTION_FAIL";
} | {
    left: number;
    right: number;
    type: "DRIVE_TANK";
} | {
    type: "ESTOP";
}
- Defined in src/server/api/tcp-interface.ts:172

onClose

onClose(): void
Returns void
- Defined in src/server/api/tcp-interface.ts:60

onData

onData(data: Buffer): void
Parameters
- data: Buffer
Returns void
- Defined in src/server/api/tcp-interface.ts:42

onError

onError(err: Error): void
Parameters
- err: Error
Returns void
- Defined in src/server/api/tcp-interface.ts:51

send

send(packet: {
    macAddress: string;
    type: "CLIENT_HELLO";
} | {
    config: [string, string][];
    protocol: number;
    type: "SERVER_HELLO";
} | {
    type: "PING_SEND";
} | {
    type: "PING_RESPONSE";
} | {
    type: "QUERY_VAR";
    var_id: number;
    var_type: "float" | "int32" | "uint32";
} | {
    type: "QUERY_RESPONSE";
    var_id: number;
    var_val: number;
} | Object | {
    deltaHeadingRadians: number;
    type: "TURN_BY_ANGLE";
} | {
    tileDistance: number;
    type: "DRIVE_TILES";
} | {
    type: "ACTION_SUCCESS";
} | {
    reason: string;
    type: "ACTION_FAIL";
} | {
    left: number;
    right: number;
    type: "DRIVE_TANK";
} | {
    type: "ESTOP";
}): void
Parameters
- packet: {
      macAddress: string;
      type: "CLIENT_HELLO";
  } | {
      config: [string, string][];
      protocol: number;
      type: "SERVER_HELLO";
  } | {
      type: "PING_SEND";
  } | {
      type: "PING_RESPONSE";
  } | {
      type: "QUERY_VAR";
      var_id: number;
      var_type: "float" | "int32" | "uint32";
  } | {
      type: "QUERY_RESPONSE";
      var_id: number;
      var_val: number;
  } | Object | {
      deltaHeadingRadians: number;
      type: "TURN_BY_ANGLE";
  } | {
      tileDistance: number;
      type: "DRIVE_TILES";
  } | {
      type: "ACTION_SUCCESS";
  } | {
      reason: string;
      type: "ACTION_FAIL";
  } | {
      left: number;
      right: number;
      type: "DRIVE_TANK";
  } | {
      type: "ESTOP";
  }
Returns void
- Defined in src/server/api/tcp-interface.ts:142

waitForActionResponse

waitForActionResponse(): Promise<void>
Returns Promise<void>
- Defined in src/server/api/tcp-interface.ts:163

Class BotTunnel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

socket: null | Socket

onHandshake: ((packetContent: string) => void)

Parameters

packetContent: string

Returns void

Returns BotTunnel

Properties

address

connected

dataBuffer

emitter

id

Private onHandshake

Type declaration

Parameters

packetContent: string

Returns void

Private socket

Methods

getIdentifier

Returns string

handleData

Parameters

data: Buffer

Returns void

handleQueue

Returns void

isActive

Returns boolean

makeHello

Parameters

mac: string

onClose

Returns void

onData

Parameters

data: Buffer

Returns void

onError

Parameters

err: Error

Returns void

send

Parameters

Returns void

waitForActionResponse

Returns Promise<void>

Settings

Member Visibility

Theme

`Private` onHandshake

`Private` socket