Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandEncoder

This class lets us encode byte sequences in an easy to use manner and then view multiple different representations of them later (i.e. as usigned 8bit integers, hex strings, as byte-words etc.)

Hierarchy

  • CommandEncoder

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

hasHeader

hasHeader: boolean = false

values

values: CommandValue[] = []

Methods

addASCIIArray

  • addASCIIArray(value: string): void

  • Parameters

    • value: string

    Returns void

addUInt16

  • addUInt16(value: number): void

  • Parameters

    • value: number

    Returns void

addUInt8

  • addUInt8(value: number): void

  • Parameters

    • value: number

    Returns void

byteCount

  • byteCount(): number

  • Returns number

getSequence

  • getSequence(): number

  • Returns number

setHeader

  • setHeader(sid: number, cid: number): void

  • Request headers all follow a known format

    1. sid
    2. cid
    3. sequence byte ( for associating request to response, will be set before command is sent )
    4. length byte ( of data payload, will also be automatically filled when the command is serialized )

    Parameters

    • sid: number
    • cid: number

    Returns void

setSequence

  • setSequence(seq: number): void

  • Parameters

    • seq: number

    Returns void

updateLength

  • updateLength(): void

  • Returns void

Generated using TypeDoc