Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @novastar/codec

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ArrayLike

ArrayLike: unknown[] | Buffer | string

Variables

Const COMPUTER

COMPUTER: 254 = 0xfe

For a request, this is the source (sender) address; for a response, the destination address

Const Packet

Packet: StructConstructor<{ ack: ErrorType; address: number; crc: number; data: Buffer; destination: number; deviceType: DeviceType; head: 43605 | 21930; io: IO; length: number; port: number; rcvIndex: number; serno: number; source: number }, "Packet"> & CRC<StructConstructor<{ ack: ErrorType; address: number; crc: number; data: Buffer; destination: number; deviceType: DeviceType; head: 43605 | 21930; io: IO; length: number; port: number; rcvIndex: number; serno: number; source: number }, "Packet">> = ...
function

Constructor for creating and processing binary packages used when communicating with novastar devices

see

Packet

see

https://sarakusha.github.io/typed-struct/interfaces/StructConstructor.html

Const REQUEST

REQUEST: 43605 = 0xaa55

Request header

Const RESPONSE

RESPONSE: 21930 = 0x55aa

Response header

Session

Session: SessionStatic
function

Session

Functions

decodeUIntLE

  • decodeUIntLE(data: Packet): number

  • Converts a data property of type Buffer of length 1, 2, or 4 bytes to an unsigned integer.

    Parameters

    • data: Packet

      Buffer 1, 2 or 4 bytes long to convert

    Returns number

delay

  • delay(ms: number): Promise<void>

encodeUIntLE

  • encodeUIntLE(value: number, size: number): Buffer

  • Stores a non-negative number in a buffer of the specified length

    Parameters

    • value: number

      Non-negative integer

    • size: number

      Buffer size (1, 2, 4 bytes)

    Returns Buffer

isPacket

  • isPacket(packet: unknown): packet is Packet

notEmpty

  • notEmpty<TValue>(value: undefined | null | void | TValue): value is TValue

  • 'Not Empty' type guard

    Type parameters

    • TValue

    Parameters

    • value: undefined | null | void | TValue

    Returns value is TValue

printBuffer

  • printBuffer(buffer: Buffer): string

series

  • series<T, R>(array: readonly T[], action: (item: T, index: number, arr: readonly T[], results: readonly R[]) => Promise<R>): Promise<R[]>

  • Performs an asynchronous operation sequentially on all elements of an array

    Type parameters

    • T

    • R

    Parameters

    • array: readonly T[]
    • action: (item: T, index: number, arr: readonly T[], results: readonly R[]) => Promise<R>
        • (item: T, index: number, arr: readonly T[], results: readonly R[]): Promise<R>

        • Parameters

          • item: T
          • index: number
          • arr: readonly T[]
          • results: readonly R[]

          Returns Promise<R>

    Returns Promise<R[]>

Generated using TypeDoc