Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EIPSocket

Hierarchy

  • Socket
    • EIPSocket

Implements

  • ReadableStream
  • Writable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _closing

_closing: boolean = false

Private _connected

_connected: boolean = false
description

Create EtherNet/IP socket to read/write tags in PLC

param

Private _context

_context: number = 0

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connecting

connecting: boolean

context

context: EIPContext

contextPointer

contextPointer: number = 0

destroyed

destroyed: boolean

id

id: number = 0

localAddress

localAddress: string

localPort

localPort: number

offset

offset: number = 0

originatorSerialNumber

originatorSerialNumber: number = 42

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Optional remoteAddress

remoteAddress: undefined | string

Optional remoteFamily

remoteFamily: undefined | string

Optional remotePort

remotePort: undefined | number

sequenceCounter

sequenceCounter: number = 1

serialNumber

serialNumber: number = 0

sessionHandle

sessionHandle: number = 0

writable

writable: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

closing

  • get closing(): boolean

connected

  • get connected(): boolean
  • description

    check if socket is connected

    Returns boolean

disconnected

  • get disconnected(): boolean
  • description

    Check if socket is disconnected

    Returns boolean

Methods

__@asyncIterator

  • __@asyncIterator(): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

_destroy

  • _destroy(error: Error | null, callback: function): void

  • Parameters

    • error: Error | null
    • callback: function
        • (error: Error | null): void

        • Parameters

          • error: Error | null

          Returns void

    Returns void

_final

  • _final(callback: function): void

  • Parameters

    • callback: function
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

Private _getAllProgramsTags

  • _getAllProgramsTags(): Promise<void>
  • description

    Requests all programs tag list and appends to taglist (LgxTag type)

    Returns Promise<void>

Private _getProgramTagList

  • _getProgramTagList(programName?: undefined | string): Promise<void>
  • description

    Requests tag list for a specific program and returns a list of LgxTag type

    Parameters

    • Optional programName: undefined | string

    Returns Promise<void>

Private _getTagList

  • _getTagList(): Promise<void>
  • description

    Requests the controller tag list and returns a list of LgxTag type

    Returns Promise<void>

Private _getUDT

  • _getUDT(): Promise<void>

Private _initial_read

  • _initial_read(baseTag: string, dt: number | null): Bluebird<boolean>
  • description

    Store each unique tag read in a dict so that we can retreive the data type or data length (for STRING) later

    Parameters

    • baseTag: string
    • dt: number | null

      dataType of tag

    Returns Bluebird<boolean>

Private _makeString

  • _makeString(string: string): Array<number>
  • description

    get packet string to send CIP data

    Parameters

    • string: string

    Returns Array<number>

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: function): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: function
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: Array<object>, callback: function): void

  • Parameters

    • chunks: Array<object>
    • callback: function
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "connect", listener: function): this
  • addListener(event: "data", listener: function): this
  • addListener(event: "drain", listener: function): this
  • addListener(event: "end", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "lookup", listener: function): this
  • addListener(event: "timeout", listener: function): this

  • events.EventEmitter

    1. close
    2. connect
    3. data
    4. drain
    5. end
    6. error
    7. lookup
    8. timeout

    Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns this

  • Parameters

    • event: "connect"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer): void

        • Parameters

          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "lookup"
    • listener: function
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

Private addPartialReadIOI

  • addPartialReadIOI(tagIOI: Buffer, elements: number): Buffer
  • description

    Add the partial read service to the tag IOI

    Parameters

    • tagIOI: Buffer
    • elements: number

    Returns Buffer

Private addReadIOI

  • addReadIOI(tagIOI: Buffer, elements: number): Buffer
  • description

    Add the read service to the tagIOI

    Parameters

    • tagIOI: Buffer
    • elements: number

    Returns Buffer

Private addWriteBitIOI

  • addWriteBitIOI(tag: string, tagIOI: Buffer, writeData: Array<any>, dataType: number): Buffer
  • description

    This will add the bit level request to the tagIOI Writing to a bit is handled in a different way than other writes

    Parameters

    • tag: string
    • tagIOI: Buffer
    • writeData: Array<any>
    • dataType: number

    Returns Buffer

Private addWriteIOI

  • addWriteIOI(tagIOI: Buffer, writeData: Array<any>, dataType: number): Buffer

  • Parameters

    • tagIOI: Buffer
    • writeData: Array<any>
    • dataType: number

    Returns Buffer

address

  • address(): AddressInfo | string

  • Returns AddressInfo | string

Private buildCIPForwardOpen

  • buildCIPForwardOpen(): Buffer | never
  • description

    Forward Open happens after a connection is made, this will sequp the CIP connection parameters

    Returns Buffer | never

buildCIPUnconnectedSend

  • buildCIPUnconnectedSend(): Buffer
  • description

    build unconnected send to request tag database

    Returns Buffer

Private buildEIPHeader

  • buildEIPHeader(tagIOI: Buffer): Buffer
  • description

    The EIP Header contains the tagIOI and the commands to perform the read or write. This request will be followed by the reply containing the data

    Parameters

    • tagIOI: Buffer

    Returns Buffer

buildEIPSendRRDataHeader

  • buildEIPSendRRDataHeader(frameLen: number): Buffer

buildForwardClose

  • buildForwardClose(): Buffer
  • description

    Forward Close packet for closing the connection

    Returns Buffer

Private buildForwardClosePacket

  • buildForwardClosePacket(): Buffer
  • description

    Assemble the forward close packet

    Returns Buffer

Private buildForwardOpenPacket

  • buildForwardOpenPacket(): Buffer
  • description

    Assemble the forward open packet

    Returns Buffer

buildMultiServiceHeader

  • buildMultiServiceHeader(): Buffer
  • description

    Service header for making a multiple tag request

    Returns Buffer

Private buildRegisterSession

  • buildRegisterSession(): Buffer
  • description

    Register our CIP connection

    Returns Buffer

Private buildTagIOI

  • buildTagIOI(tagName: string, isBoolArray: boolean): Buffer
  • description

    The tag IOI is basically the tag name assembled into an array of bytes structured in a way that the PLC will understand. It's a little crazy, but we have to consider the many variations that a tag can be: @example tagName (DINT) tagName.1 (Bit of DINT) tagName.Thing (UDT) tagName[4].Thing[2].Length (more complex UDT) We also might be reading arrays, a bool from arrays (atomic), strings. Oh and multi-dim arrays, program scope tags...

    Parameters

    • tagName: string
    • isBoolArray: boolean

    Returns Buffer

buildTagListRequest

  • buildTagListRequest(programName?: undefined | string): Buffer
  • description

    Build the request for the PLC tags Program scoped tags will pass the program name for the request

    Parameters

    • Optional programName: undefined | string

    Returns Buffer

buildTemplateAttributes

  • buildTemplateAttributes(instance: number): Buffer

Private buildUnregisterSession

  • buildUnregisterSession(): Buffer

connect

  • override
    description

    connect to PLC using EIP protocol

    Returns Bluebird<EIPSocket> | any

cork

  • cork(): void

  • Returns void

destroy

  • destroy(): Bluebird<any>
  • override
    description

    Destroy and disconnect EIP socket and destroy from pool

    Returns Bluebird<any>

disconnect

  • disconnect(): Bluebird<void>
  • description

    Destroy and disconnect EIP socket

    Returns Bluebird<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close", had_error: boolean): boolean
  • emit(event: "connect"): boolean
  • emit(event: "data", data: Buffer): boolean
  • emit(event: "drain"): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean
  • emit(event: "timeout"): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"
    • had_error: boolean

    Returns boolean

  • Parameters

    • event: "connect"

    Returns boolean

  • Parameters

    • event: "data"
    • data: Buffer

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "lookup"
    • err: Error
    • address: string
    • family: string | number
    • host: string

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

end

  • end(cb?: undefined | function): void
  • end(buffer: Uint8Array | string, cb?: undefined | function): void
  • end(str: Uint8Array | string, encoding?: undefined | string, cb?: undefined | function): void

  • Parameters

    • Optional cb: undefined | function

    Returns void

  • Parameters

    • buffer: Uint8Array | string
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • str: Uint8Array | string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

extractTagPacket

  • extractTagPacket(data: Buffer, programName?: undefined | string): void

  • Parameters

    • data: Buffer
    • Optional programName: undefined | string

    Returns void

getBytes

  • getBytes(data: Buffer): Bluebird<[number, Buffer]>

  • send and receive data

    Parameters

    • data: Buffer

    Returns Bluebird<[number, Buffer]>

getIdentity

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getModuleProperties

  • getModuleProperties(slot?: number): Bluebird<LGXDevice>
  • description

    Request the properties of a module in a particular slot

    Parameters

    • Default value slot: number = 0

    Returns Bluebird<LGXDevice>

getProgramTagList

  • getProgramTagList(programName: string): Promise<undefined | Error | LgxTag[]>

  • @description Retrieves a program tag list from the PLC programName = "Program:ExampleProgram"

    Parameters

    • programName: string

    Returns Promise<undefined | Error | LgxTag[]>

getProgramsList

  • getProgramsList(): Promise<Array<string> | undefined>
  • description

    Retrieves a program names list from the PLC Sanity check: checks if programNames is empty and runs _getTagList

    Returns Promise<Array<string> | undefined>

Private getReplyValues

  • getReplyValues(tag: string, elements: number, data: any): Promise<Array<any>>
  • description

    Gather up all the values in the reply/replies

    Parameters

    • tag: string
    • elements: number
    • data: any

    Returns Promise<Array<any>>

getTagList

  • getTagList(allTags?: boolean): Promise<Array<LgxTag> | undefined>
  • description

    Retrieves the tag list from the PLC Optional parameter allTags set to True If is set to False, it will return only controller otherwise controller tags and program tags.

    Parameters

    • Default value allTags: boolean = true

    Returns Promise<Array<LgxTag> | undefined>

getTemplate

  • getTemplate(instance: number, dataLen: number): Promise<Buffer>
  • description

    Get the members of a UDT so we can get it

    Parameters

    • instance: number
    • dataLen: number

    Returns Promise<Buffer>

getTemplateAttribute

  • getTemplateAttribute(instance: number): Bluebird<Buffer>
  • description

    Get the attributes of a UDT

    Parameters

    • instance: number

    Returns Bluebird<Buffer>

getWallClockTime

  • getWallClockTime(raw: boolean): Promise<number | Date>
  • description

    Requests the PLC clock time

    Parameters

    • raw: boolean

    Returns Promise<number | Date>

isPaused

  • isPaused(): boolean

  • Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

multiParser

  • multiParser(tags: Array<string>, data: Buffer): Array<any>
  • description

    Takes multi read reply data and returns an array of the values

    Parameters

    • tags: Array<string>

      Tags list to get read

    • data: Buffer

    Returns Array<any>

multiReadTag

  • multiReadTag(tags: Array<string>): Bluebird<Array<LgxResponse>>
  • description

    Processes the multiple read request

    Parameters

    • tags: Array<string>

    Returns Bluebird<Array<LgxResponse>>

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "close", listener: function): this
  • on(event: "connect", listener: function): this
  • on(event: "data", listener: function): this
  • on(event: "drain", listener: function): this
  • on(event: "end", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "lookup", listener: function): this
  • on(event: "timeout", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns this

  • Parameters

    • event: "connect"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer): void

        • Parameters

          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "lookup"
    • listener: function
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "close", listener: function): this
  • once(event: "connect", listener: function): this
  • once(event: "data", listener: function): this
  • once(event: "drain", listener: function): this
  • once(event: "end", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: "lookup", listener: function): this
  • once(event: "timeout", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns this

  • Parameters

    • event: "connect"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer): void

        • Parameters

          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "lookup"
    • listener: function
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

Private parseReply

  • parseReply(tag: string, elements: number, data: Buffer | Array<number | string | boolean> | boolean | string): Promise<Buffer | Array<number | string | boolean> | boolean | string>
  • description

    Gets the replies from the PLC In the case of BOOL arrays and bits of a word, we do some reformating

    Parameters

    • tag: string
    • elements: number
    • data: Buffer | Array<number | string | boolean> | boolean | string

    Returns Promise<Buffer | Array<number | string | boolean> | boolean | string>

pause

  • pause(): this

  • Returns this

pipe

  • pipe<T>(destination: T, options?: undefined | object): T

  • Type parameters

    • T: WritableStream

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "connect", listener: function): this
  • prependListener(event: "data", listener: function): this
  • prependListener(event: "drain", listener: function): this
  • prependListener(event: "end", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: "lookup", listener: function): this
  • prependListener(event: "timeout", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns this

  • Parameters

    • event: "connect"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer): void

        • Parameters

          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "lookup"
    • listener: function
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "connect", listener: function): this
  • prependOnceListener(event: "data", listener: function): this
  • prependOnceListener(event: "drain", listener: function): this
  • prependOnceListener(event: "end", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "lookup", listener: function): this
  • prependOnceListener(event: "timeout", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns this

  • Parameters

    • event: "connect"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer): void

        • Parameters

          • data: Buffer

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "lookup"
    • listener: function
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

push

  • push(chunk: any, encoding?: undefined | string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string

    Returns boolean

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(size?: undefined | number): any

  • Parameters

    • Optional size: undefined | number

    Returns any

Private readTag

readTemplateService

  • readTemplateService(instance: number, dataLen: number): Buffer

  • Parameters

    • instance: number
    • dataLen: number

    Returns Buffer

recv_data

  • recv_data(): Bluebird<Buffer>
  • description

    listen data received from PLC

    Returns Bluebird<Buffer>

ref

  • ref(): void

  • Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: "close", listener: function): this
  • removeListener(event: "data", listener: function): this
  • removeListener(event: "end", listener: function): this
  • removeListener(event: "readable", listener: function): this
  • removeListener(event: "error", listener: function): this
  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

send

  • send(data: Buffer): Bluebird<boolean>

  • send data to socket and wait response

    Parameters

    • data: Buffer

    Returns Bluebird<boolean>

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setEncoding

  • setEncoding(encoding?: undefined | string): this

  • Parameters

    • Optional encoding: undefined | string

    Returns this

setKeepAlive

  • setKeepAlive(enable?: undefined | false | true, initialDelay?: undefined | number): this

  • Parameters

    • Optional enable: undefined | false | true
    • Optional initialDelay: undefined | number

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setNoDelay

  • setNoDelay(noDelay?: undefined | false | true): this

  • Parameters

    • Optional noDelay: undefined | false | true

    Returns this

setTimeout

  • setTimeout(timeout: number, callback?: undefined | function): this

  • Parameters

    • timeout: number
    • Optional callback: undefined | function

    Returns this

setWallClockTime

  • setWallClockTime(date?: Date): Promise<boolean>

  • Parameters

    • Default value date: Date = new Date()

    Returns Promise<boolean>

toString

  • toString(): string

uncork

  • uncork(): void

  • Returns void

unpipe

  • unpipe(destination?: NodeJS.WritableStream): this

  • Parameters

    • Optional destination: NodeJS.WritableStream

    Returns this

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: any, encoding?: BufferEncoding): void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

wordsToBits

  • wordsToBits(tag: string, value: Array<number>, count?: number): Array<boolean>
  • property
    description

    Convert words to a list of true/false

    Parameters

    • tag: string
    • value: Array<number>
    • Default value count: number = 0

    Returns Array<boolean>

wrap

  • wrap(oldStream: ReadableStream): this

  • Parameters

    • oldStream: ReadableStream

    Returns this

write

  • write(buffer: Uint8Array | string, cb?: undefined | function): boolean
  • write(str: Uint8Array | string, encoding?: undefined | string, cb?: undefined | function): boolean

  • Parameters

    • buffer: Uint8Array | string
    • Optional cb: undefined | function

    Returns boolean

  • Parameters

    • str: Uint8Array | string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns boolean

Private writeTag

  • writeTag(tag: string, value: any, options?: ITagWriteOptions): Bluebird<boolean>

  • Parameters

    • tag: string
    • value: any
    • Default value options: ITagWriteOptions = {}

      @param {Number} dataType @param {Boolean} emitEvent emit event if value change

    Returns Bluebird<boolean>

Static buildListIdentity

  • buildListIdentity(): Buffer
  • description

    Build the list identity request for discovering Ethernet I/P devices on the network

    Returns Buffer

Static createClient

Static from

  • from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

  • A utility method for creating Readable Streams out of iterators.

    Parameters

    • iterable: Iterable<any> | AsyncIterable<any>
    • Optional options: ReadableOptions

    Returns Readable

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc