PLC | node-logix

Hierarchy

EIPSocketPool
- PLC

Implements

Index

Constructors

constructor

Properties

Accessors

Object literals

defaultOptions

Constructors

constructor

new PLC(host: IPAddress | IEIPContextOptions & IOptions, options: IEIPContextOptions & IOptions): PLC

Overrides EIPSocketPool.constructor
- Defined in PLC.ts:190
description

Create instace of PLC using EIP (EthernetIP) protocol

Parameters
- host: IPAddress | IEIPContextOptions & IOptions
- options: IEIPContextOptions & IOptions
  
  Options to set if IPAddress typeof string
Returns PLC

Properties

CIPTypes

CIPTypes: ICIPTypes = CIPTypes

Micro800

Micro800: boolean = false

Protected _closing

_closing: boolean = false

_connected

_connected: boolean = false

_connecting

_connecting: boolean = false

Protected Optional _pingMapping

_pingMapping: IPingMappings

Optional _pool

_pool: Pool<EIPSocket>

Protected Optional _replacePin

_replacePin: undefined | function

allowHalfOpen

allowHalfOpen: boolean = true

Optional arduinoMode

arduinoMode: undefined | false | true

Optional autoClose

autoClose: undefined | false | true = true

connectTimeout

connectTimeout: number = 5000

connectionPath

connectionPath: Array<number> = [0x20, 0x02, 0x24, 0x01]

connectionPathSize

connectionPathSize: number = 3

connectionSize

connectionSize: number = 508

Optional device

device: undefined | string

Optional deviceType

deviceType: undefined | number

host

host: string = ""

knownTags

knownTags: IKnownTags

port

port: number = 44818

processorSlot

processorSlot: number = 0

Optional productCode

productCode: undefined | number

Optional productName

productName: undefined | string

Optional programNames

programNames: string[]

Optional revision

revision: string | number

Optional serialNumber

serialNumber: string | number

Optional state

state: undefined | number

Optional status

status: undefined | number

structIdentifier

structIdentifier: number = 4046

Optional tagList

tagList: Array<LgxTag>

timeoutReceive

timeoutReceive: number = 15000

Optional vendor

vendor: undefined | string

vendorId

vendorId: number = 4919

Static CIPTypes

CIPTypes: CIPTypesValues = CIPTypesValues

description: get CIPTypes number foreach avaible dataType

Static ConnectionError

ConnectionError: ConnectionError = ConnectionError

Static ConnectionLostError

ConnectionLostError: ConnectionLostError = ConnectionLostError

Static ConnectionTimeoutError

ConnectionTimeoutError: ConnectionTimeoutError = ConnectionTimeoutError

Static DisconnectedError

DisconnectedError: DisconnectedError = DisconnectedError

Static ForwarOpenError

ForwarOpenError: ForwarOpenError = ForwarOpenError

Static LogixError

LogixError: LogixError = LogixError

Static RegisterSessionError

RegisterSessionError: RegisterSessionError = RegisterSessionError

Static TimeoutError

TimeoutError: any = TimeoutError

Errors

Static ValueError

ValueError: ValueError = ValueError

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

available

get available(): number

Inherited from EIPSocketPool.available
- Defined in eip-pool.ts:78
description

returns number of unused connections in the pool

property

Returns number

borrowed

get borrowed(): number

Inherited from EIPSocketPool.borrowed
- Defined in eip-pool.ts:71
description

Number of connections that are currently acquired by userland code

property

Returns number

closing

get closing(): boolean

- Defined in PLC.ts:261
property

check if socket try closing

Returns boolean

connected

get connected(): boolean

- Defined in PLC.ts:243
property

check if socket is connected

Returns boolean

connecting

get connecting(): boolean

- Defined in PLC.ts:255
property

check if socket try connecting

Returns boolean

disconnected

get disconnected(): boolean

- Defined in PLC.ts:249
property

check if socket is disconnected

Returns boolean

max

get max(): number

Inherited from EIPSocketPool.max
- Defined in eip-pool.ts:50
description

returns number of maxixmum number of connections allowed by pool

property

Returns number

min

get min(): number

Inherited from EIPSocketPool.min
- Defined in eip-pool.ts:57
description

returns number of minimum number of connections allowed by pool

property

Returns number

pending

get pending(): number

Inherited from EIPSocketPool.pending
- Defined in eip-pool.ts:64
description

returns number of callers waiting to acquire a connection

property

Returns number

pingMapping

get pingMapping(): undefined | IPingMappings
set pingMapping(pinout: undefined | IPingMappings): void

- Defined in PLC.ts:267
property

get current pin mapping

Returns undefined | IPingMappings
- Defined in PLC.ts:292
description

custom pin mapping to use with digitalWrite, digitalRead, analogWrite and analogRead functions

property

set

example

if Micro800 == true use pin mapping => { "digital" : { "output": "IO_EM_DO{dd}", "input": "IO_EM_DI{dd}" }, "analog" : { "input" : "IO_EM_AI{dd}", "output" : "IO_EM_AO{dd}" }

Parameters
- pinout: undefined | IPingMappings
Returns void

replacePin

get replacePin(): undefined | function
set replacePin(newReplacePin: undefined | function): void

- Defined in PLC.ts:273
property

get function to replace pin

Returns undefined | function
- Defined in PLC.ts:298
property

set function to replace pin, with parameters : (inputMapping,pin)

Parameters
- newReplacePin: undefined | function
Returns void

size

get size(): number

Inherited from EIPSocketPool.size
- Defined in eip-pool.ts:43
description

returns number of connections in the pool regardless of whether they are free or in use

property

Returns number

spareResourceCapacity

get spareResourceCapacity(): number

Inherited from EIPSocketPool.spareResourceCapacity
- Defined in eip-pool.ts:85
description

How many many more resources can the pool manage/create

property

Returns number

Methods

Private _checkPin

_checkPin(pin: string | number, value?: any): void | never

- Defined in PLC.ts:717
Parameters
- pin: string | number
- Optional value: any
Returns void | never

Private _getPinMapping

_getPinMapping(str: string, pin: string): Bluebird<string>

- Defined in PLC.ts:732
prinvate

description

check valid mapping

Parameters
- str: string
- pin: string
Returns Bluebird<string>

acquire

acquire(priority: number | string | function): Bluebird<any> | any

Inherited from EIPSocketPool.acquire
- Defined in eip-pool.ts:94
override

description

This function is for when you want to "borrow" a connection from the pool

Parameters
- priority: number | string | function
  
  if a Number return only socket if a function release socket on resolve o destroy on reject
Returns Bluebird<any> | any

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

analogOutRead

analogOutRead(pin: number | string, options?: ITagReadOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:512
description

read analog output pin using pin mapping

Parameters
- pin: number | string
- Default value options: ITagReadOptions = { dataType: CIPTypesValues.UINT }
Returns Bluebird<Pin | undefined>

analogRead

analogRead(pin: number | string, options?: ITagReadOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:533
description

read analog input pin using pin mapping

Parameters
- pin: number | string
- Default value options: ITagReadOptions = { dataType: CIPTypesValues.UINT }
Returns Bluebird<Pin | undefined>

analogWrite

analogWrite(pin: number | string, value: number, options?: ITagWriteOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:488
description

write analog output pin using pin mapping

Parameters
- pin: number | string
- value: number
- Default value options: ITagWriteOptions = { dataType: CIPTypesValues.UINT }
Returns Bluebird<Pin | undefined>

close

close(): Bluebird<boolean>

- Defined in PLC.ts:331
Disconet to PLC and delete sockets

Returns Bluebird<boolean>

connect

connect(ignoreIdentity?: undefined | false | true): Bluebird<boolean>

- Defined in PLC.ts:304
description

Connect with PLC

Parameters
- Optional ignoreIdentity: undefined | false | true
Returns Bluebird<boolean>

digitalOutRead

digitalOutRead(pin: number | string, options?: ITagReadOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:445
description

read digital output using pin mapping

Parameters
- pin: number | string
- Default value options: ITagReadOptions = { dataType: CIPTypesValues.BOOL }
Returns Bluebird<Pin | undefined>

digitalRead

digitalRead(pin: number | string, options?: ITagReadOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:466
description

read digital input using pin mapping

Parameters
- pin: number | string
- Default value options: ITagReadOptions = { dataType: CIPTypesValues.BOOL }
Returns Bluebird<Pin | undefined>

digitalWrite

digitalWrite(pin: number | string, value: boolean | number, options?: ITagWriteOptions): Bluebird<Pin | undefined>

- Defined in PLC.ts:419
description

write to output using pin mapping

Parameters
- pin: number | string
- value: boolean | number
- Default value options: ITagWriteOptions = {dataType: CIPTypesValues.BOOL}
Returns Bluebird<Pin | undefined>

discover

discover(timeout: number, options: IDiscoverOptions): Bluebird<LGXDevice[]>

- Defined in PLC.ts:705
Parameters
- timeout: number
  
  @default 3000
- options: IDiscoverOptions
Returns Bluebird<LGXDevice[]>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:20
Returns number

getModuleProperties

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

- Defined in PLC.ts:591
description

Get the properties of module in specified slot

Parameters
- Default value slot: number = 0
Returns Bluebird<LGXDevice>

getProgramList

getProgramList(): Promise<string[]>

- Defined in PLC.ts:582
description

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

Returns Promise<string[]>

getProgramTagList

getProgramTagList(programName: string): Bluebird<any>

- Defined in PLC.ts:572
descriptionretrieves

a program tag list from the PLC programName = "Program:ExampleProgram"

Parameters
- programName: string
Returns Bluebird<any>

getTagList

getTagList(): Bluebird<any>

- Defined in PLC.ts:565
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.

Returns Bluebird<any>

getWallClockTime

getWallClockTime(raw: boolean): Bluebird<number | Date>

- Defined in PLC.ts:601
description

get current time

Parameters
- raw: boolean
  
  get microseconds
Returns Bluebird<number | Date>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

multiRead

multiRead(tags: Array<string>): Bluebird<LgxResponse[]>

- Defined in PLC.ts:554
description

Read multiple tags in one request

Parameters
- tags: Array<string>
Returns Bluebird<LgxResponse[]>

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "connect", listener: function): this
on(event: "disconnect", listener: function): this
on(event: "found", listener: function): this
on(event: "closing", listener: function): this
on(event: "connect_error", listener: function): this
on(event: "found_error", listener: function): this
on(event: string, listener: Function): this

Overrides EIPContext.on
- Defined in PLC.ts:112
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:113
Parameters
- event: "disconnect"
- listener: function
  - - (reason: string | Error): void
    - Parameters
      - reason: string | Error
      Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:114
Parameters
- event: "found"
- listener: function
  - - (device: LGXDevice, pos: number): void
    - Parameters
      - device: LGXDevice
      - pos: number
      Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:115
Parameters
- event: "closing"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:117
Parameters
- event: "connect_error"
- listener: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:118
Parameters
- event: "found_error"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this
Overrides EIPContext.on
- Defined in PLC.ts:137
Parameters
- event: string
- listener: Function
Returns this

once

once(event: "connect", listener: function): this
once(event: "disconnect", listener: function): this
once(event: "found", listener: function): this
once(event: "connect_error", listener: function): this
once(event: "found_error", listener: function): this
once(event: "closing", listener: function): this
once(event: string, listener: Function): this

Overrides EIPContext.once
- Defined in PLC.ts:123
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:124
Parameters
- event: "disconnect"
- listener: function
  - - (reason: string | Error): void
    - Parameters
      - reason: string | Error
      Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:125
Parameters
- event: "found"
- listener: function
  - - (device: LGXDevice, pos: number): void
    - Parameters
      - device: LGXDevice
      - pos: number
      Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:130
Parameters
- event: "connect_error"
- listener: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:131
Parameters
- event: "found_error"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:135
Parameters
- event: "closing"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EIPContext.once
- Defined in PLC.ts:138
Parameters
- event: string
- listener: Function
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

read

read(tag: string, options: ITagReadOptions): Bluebird<any>

- Defined in PLC.ts:356
description

Read tag in PLC

Parameters
- tag: string
  
  Tag name to read
- options: ITagReadOptions
Returns Bluebird<any>

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

setWallClockTime

setWallClockTime(date?: Date): any

- Defined in PLC.ts:609
description

Set current time

Parameters
- Optional date: Date
Returns any

toJSON

toJSON(): object

- Defined in PLC.ts:760
override

Override toJSON method

Returns object
- Micro800: boolean
- device: undefined | string
- deviceType: undefined | number
- host: string
- productCode: undefined | number
- productName: undefined | string
- revision: undefined | string | number
- serialNumber: undefined | string | number
- state: undefined | number
- status: undefined | number
- vendor: undefined | string
- vendorId: number

toString

toString(): string

- Defined in PLC.ts:754
override

Override toSTting method

Returns string

write

write(tag: string, value: boolean | string | number | Array<number>, options?: object): Bluebird<any>

- Defined in PLC.ts:391
Parameters
- tag: string
  
  Tag name to set value
- value: boolean | string | number | Array<number>
  
  value to write in scope
- Default value options: object = {}
  
  Options to change ex: timeout, dataType
Returns Bluebird<any>

Static discover

discover(timeout?: number, options?: IDiscoverOptions): Bluebird<Array<LGXDevice>>

- Defined in PLC.ts:621
description

Query all the EIP devices on the network

Parameters
- Default value timeout: number = 200
- Optional options: IDiscoverOptions
Returns Bluebird<Array<LGXDevice>>

devices

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in E:/Nodejs/node-logix/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Object literals

Static defaultOptions

defaultOptions: object

Micro800

Micro800: boolean = false

allowHalfOpen

allowHalfOpen: boolean = true

arduinoMode

arduinoMode: boolean = true

connectTimeout

connectTimeout: number = 3000

port

port: number = 44818

pool

pool: object

Bluebird

Bluebird: Bluebird = Bluebird

evictionRunIntervalMillis

evictionRunIntervalMillis: number = 17000

fifo

fifo: boolean = false

idleTimeoutMillis

idleTimeoutMillis: number = 30000

max

max: number = 3

min

min: number = 0

priorityRange

priorityRange: number = 2

testOnBorrow

testOnBorrow: boolean = true

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

host: IPAddress | IEIPContextOptions & IOptions

options: IEIPContextOptions & IOptions

Returns PLC

Properties

CIPTypes

Micro800

Protected _closing

_connected

_connecting

Protected Optional _pingMapping

Optional _pool

Protected Optional _replacePin

allowHalfOpen

Optional arduinoMode

Optional autoClose

connectTimeout

connectionPath

connectionPathSize

connectionSize

Optional device

Optional deviceType

host

knownTags

port

processorSlot

Optional productCode

Optional productName

Optional programNames

Optional revision

Optional serialNumber

Optional state

Optional status

structIdentifier

Optional tagList

timeoutReceive

Optional vendor

vendorId

Static CIPTypes

Static ConnectionError

Static ConnectionLostError

Static ConnectionTimeoutError

Static DisconnectedError

Static ForwarOpenError

Static LogixError

Static RegisterSessionError

Static TimeoutError

Static ValueError

Static defaultMaxListeners

Accessors

available

Returns number

borrowed

Returns number

closing

Returns boolean

connected

Returns boolean

connecting

Returns boolean

disconnected

Returns boolean

max

Returns number

min

Returns number

pending

Returns number

pingMapping

Returns undefined | IPingMappings