Classdefault<Broadcast>

Custom request prepared for sending to Novastar devices

Type Parameters

  • Broadcast extends boolean = false

Hierarchy (view full)

Constructors

constructor

Properties

__struct ack address broadcast? crc data destination deviceType head io length maxLength? originalLength? port rcvIndex serno source tag? timeout? baseSize

Methods

toJSON crc getOffsetOf getOffsets makeChunks raw swap

Constructors

constructor

Properties

Readonly__struct

__struct

ack

ack: ErrorType

always 0 for request and result code for response

address

address: number

register unit address

Optional Readonlybroadcast

broadcast?: Broadcast

If this is true, then do not wait for a response from the device

crc

crc: number

cyclic redundancy check

data

data: Buffer

data sent on write or empty buffer on read

destination

destination: number

destination address, usually 0 for request

deviceType

deviceType: number

target device type

head

head: 21930 | 43605

REQUEST - for requests and RESPONSE for responses

io

io: IO

I/O operation type

length

length: number

length of data requested when reading or length of data sent when writing

OptionalmaxLength

maxLength?: number

Overriding the maximum data length for this request

Optional ReadonlyoriginalLength

originalLength?: number

Preserves the size of the original request if it exceeds 65535.

port

port: number

port number

rcvIndex

rcvIndex: number

receiving card index

serno

serno: number

sequential number of the request, and the corresponding response (set automatically)

source

source: number

source address, always COMPUTER for request

Optional Readonlytag

tag?: string

For debugging and describing exceptions

Optionaltimeout

timeout?: number

Overriding the timeout for this request

Static ReadonlybaseSize

baseSize: number

Methods

toJSON

  • toJSON(): {
        ack: ErrorType;
        address: number;
        crc: number;
        data: number[];
        destination: number;
        deviceType: number;
        head: 21930 | 43605;
        io: IO;
        length: number;
        port: number;
        rcvIndex: number;
        serno: number;
        source: number;
    }

  • Returns {
        ack: ErrorType;
        address: number;
        crc: number;
        data: number[];
        destination: number;
        deviceType: number;
        head: 21930 | 43605;
        io: IO;
        length: number;
        port: number;
        rcvIndex: number;
        serno: number;
        source: number;
    }

    • ack: ErrorType
    • address: number
    • crc: number
    • data: number[]
    • destination: number
    • deviceType: number
    • head: 21930 | 43605
    • io: IO
    • length: number
    • port: number
    • rcvIndex: number
    • serno: number
    • source: number

Staticcrc

  • crc(instance, needUpdate?): number

  • Parameters

    • instance: StructInstance<{
          ack: ErrorType;
          address: number;
          crc: number;
          data: Buffer;
          destination: number;
          deviceType: number;
          head: 21930 | 43605;
          io: IO;
          length: number;
          port: number;
          rcvIndex: number;
          serno: number;
          source: number;
      }, "Packet">
    • OptionalneedUpdate: boolean

    Returns number

StaticgetOffsetOf

  • getOffsetOf(name): number

  • Parameters

    • name:
          | "head"
          | "ack"
          | "serno"
          | "source"
          | "destination"
          | "deviceType"
          | "port"
          | "rcvIndex"
          | "io"
          | "address"
          | "length"
          | "data"
          | "crc"

    Returns number

StaticgetOffsets

  • getOffsets(): Record<
        | "head"
        | "ack"
        | "serno"
        | "source"
        | "destination"
        | "deviceType"
        | "port"
        | "rcvIndex"
        | "io"
        | "address"
        | "length"
        | "data"
        | "crc", number>

  • Returns Record<
        | "head"
        | "ack"
        | "serno"
        | "source"
        | "destination"
        | "deviceType"
        | "port"
        | "rcvIndex"
        | "io"
        | "address"
        | "length"
        | "data"
        | "crc", number>

StaticmakeChunks

Staticraw

  • raw(instance): Buffer

  • Parameters

    • instance: StructInstance<{
          ack: ErrorType;
          address: number;
          crc: number;
          data: Buffer;
          destination: number;
          deviceType: number;
          head: 21930 | 43605;
          io: IO;
          length: number;
          port: number;
          rcvIndex: number;
          serno: number;
          source: number;
      }, "Packet">

    Returns Buffer

  • raw(instance): undefined | Buffer

  • Parameters

    • instance: {
          ack: ErrorType;
          address: number;
          crc: number;
          data: number[];
          destination: number;
          deviceType: number;
          head: 21930 | 43605;
          io: IO;
          length: number;
          port: number;
          rcvIndex: number;
          serno: number;
          source: number;
      }
      • ack: ErrorType
      • address: number
      • crc: number
      • data: number[]
      • destination: number
      • deviceType: number
      • head: 21930 | 43605
      • io: IO
      • length: number
      • port: number
      • rcvIndex: number
      • serno: number
      • source: number

    Returns undefined | Buffer

Staticswap

  • swap(instance, name): Buffer

  • Parameters

    • instance: StructInstance<{
          ack: ErrorType;
          address: number;
          crc: number;
          data: Buffer;
          destination: number;
          deviceType: number;
          head: 21930 | 43605;
          io: IO;
          length: number;
          port: number;
          rcvIndex: number;
          serno: number;
          source: number;
      }, "Packet">
    • name:
          | "head"
          | "ack"
          | "serno"
          | "source"
          | "destination"
          | "deviceType"
          | "port"
          | "rcvIndex"
          | "io"
          | "address"
          | "length"
          | "data"
          | "crc"

    Returns Buffer

Settings

Member Visibility

On This Page

Constructors
Properties
Methods