Class BotTunnelAbstract

Hierarchy

Constructors

constructor

Properties

connected dataBuffer

Methods

getIdentifier handleData handleQueue isActive onClose onData onError processPacket send

Constructors

constructor

Properties

connected

connected: boolean = false

dataBuffer

dataBuffer: undefined | Buffer

Methods

Abstract getIdentifier

handleData

  • Sets up the data buffer for it to be handled by the queue

    Parameters

    • data: Buffer

      data to be handled

    Returns Promise<void>

handleQueue

  • handles the incoming data and check if it is valid

    emits result for further handling

    Returns

    • nothing if nothing happened and nothing if something happened

    Returns Promise<void>

Abstract isActive

onClose

onData

  • log when data comes in

    Parameters

    • data: Buffer

      the incoming data

    Returns Promise<void>

onError

  • log errors and update connection status

    Parameters

    • err: Error

      the error message

    Returns void

Abstract processPacket

Abstract send

  • send packets to robot. promise resolves when the robot acknowledges that the action is complete

    Returns

    • the packet id

    Parameters

    • packet: {
          macAddress: string;
          type: CLIENT_HELLO;
      } | {
          config: {};
          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;
      }

      packet to send

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc