@things-factory/integration-melsec 8.0.0 → 9.0.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-melsec",
-  "version": "8.0.0",
+  "version": "9.0.0-beta.3",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -23,8 +23,8 @@
     "clean": "npm run clean:server"
   },
   "dependencies": {
-    "@things-factory/integration-base": "^8.0.0",
+    "@things-factory/integration-base": "^9.0.0-beta.3",
     "p-queue": "^6.4.0"
   },
-  "gitHead": "07ef27d272dd9a067a9648ac7013748510556a18"
+  "gitHead": "1d7e0dd4c88f3c3f3bd311c00e4b1d1542d53634"
 }

package/server/engine/connector/index.ts

@@ -1 +0,0 @@
-import './melsec-plc'

package/server/engine/connector/melsec-plc.ts

@@ -1,211 +0,0 @@
-import net from 'net'
-import PromiseSocket from 'promise-socket'
-import PQueue from 'p-queue'
-import { sleep } from '@things-factory/utils'
-
-import { ConnectionManager, Connector, Connection } from '@things-factory/integration-base'
-
-const subHeader = '5000'
-const networkNumber = '00'
-const requireNumber = 'FF'
-const requireIoNumber = '03FF'
-const requireMultiNumber = '00'
-const readrequireLength = '0018'
-const writerequireLength = '0019'
-const writewordrequireLength = '001C'
-const reserve = '0000'
-const readCommand = '0401'
-const readWordSubCommand = '0000'
-const readCoilSubCommand = '0001'
-const writeCommand = '1401'
-const writeWordSubCommand = '0000'
-const writeSubCommand = '0001'
-const readLengthDevice = '0001'
-const writeLengthDevice = '0001'
-
-export class MelsecPLCConnector implements Connector {
-  static getWriteCoilCommand(deviceCode, writeStartDevice, writeCoilValue, writeLength) {
-    if (writeLength) {
-      writeLength = writeLength.toString().padStart(4, '0')
-    }
-
-    return (
-      subHeader +
-      networkNumber +
-      requireNumber +
-      requireIoNumber +
-      requireMultiNumber +
-      writerequireLength +
-      reserve +
-      writeCommand +
-      writeSubCommand +
-      deviceCode +
-      writeStartDevice +
-      (writeLength || writeLengthDevice) +
-      writeCoilValue
-    )
-  }
-
-  static getWriteWordCommand(deviceCode, writeStartDevice, writeWordValue) {
-    return (
-      subHeader +
-      networkNumber +
-      requireNumber +
-      requireIoNumber +
-      requireMultiNumber +
-      writewordrequireLength +
-      reserve +
-      writeCommand +
-      writeWordSubCommand +
-      deviceCode +
-      writeStartDevice +
-      writeLengthDevice +
-      writeWordValue
-    )
-  }
-
-  static getReadCoilCommand(deviceCode, readStartDevice, readLength) {
-    if (readLength) {
-      readLength = readLength.toString().padStart(4, '0')
-    }
-
-    return (
-      subHeader +
-      networkNumber +
-      requireNumber +
-      requireIoNumber +
-      requireMultiNumber +
-      readrequireLength +
-      reserve +
-      readCommand +
-      readCoilSubCommand +
-      deviceCode +
-      readStartDevice +
-      (readLength || readLengthDevice)
-    )
-  }
-
-  static getReadWordCommand(deviceCode, readStartDevice) {
-    return (
-      subHeader +
-      networkNumber +
-      requireNumber +
-      requireIoNumber +
-      requireMultiNumber +
-      readrequireLength +
-      reserve +
-      readCommand +
-      readWordSubCommand +
-      deviceCode +
-      readStartDevice +
-      readLengthDevice
-    )
-  }
-
-  async ready(connectionConfigs) {
-    await Promise.all(connectionConfigs.map(this.connect))
-
-    ConnectionManager.logger.info('mitsubishi-plc connections are ready')
-  }
-
-  async connect(config) {
-    if (ConnectionManager.getConnectionInstance(config)) {
-      return
-    }
-
-    var [host, port = 1025] = config.endpoint.split(':')
-
-    var socket = new PromiseSocket(new net.Socket())
-
-    await socket.connect(port, host)
-
-    var queue = new PQueue({ concurrency: 1 })
-    var keepalive = true
-
-    ConnectionManager.addConnectionInstance(config, {
-      request: async function (message, length, { logger }) {
-        return await queue.add(async () => {
-          while (keepalive) {
-            try {
-              /* send request message */
-              await socket.write(message)
-              logger && logger.info(`Request : ${message}`)
-              var responseCompleted = ''
-
-              if (length > 0) {
-                while (length - responseCompleted.length > 0) {
-                  logger && logger.info(`Will read ${length - responseCompleted.length}`)
-                  let response = await socket.read() // length - responseCompleted.length)
-                  if (!response) {
-                    // socket ended or closed
-                    throw new Error('socket closed')
-                  }
-                  responseCompleted += response.toString()
-                }
-              } else {
-                let response = await socket.read()
-                if (!response) {
-                  // socket ended or closed
-                  throw new Error('socket closed')
-                }
-                responseCompleted = response.toString()
-              }
-
-              logger && logger.info(`Response : ${responseCompleted}`)
-              return responseCompleted
-            } catch (e) {
-              logger.error('plc command(write-read) failed.', e)
-
-              if (keepalive) {
-                socket && socket.destroy()
-
-                socket = new PromiseSocket(new net.Socket())
-                await socket.connect(port, host)
-
-                await sleep(1000)
-              } else {
-                throw e
-              }
-            }
-          }
-
-          throw new Error(`${config.name} maybe disconnected normally`)
-        })
-      },
-      close: function () {
-        queue.clear()
-        keepalive = false
-        socket.destroy()
-      }
-    })
-
-    ConnectionManager.logger.info(`mitsubishi-plc connection(${config.name}:${config.endpoint}) is connected`)
-  }
-
-  async disconnect(connection: Connection) {
-    var { close } = ConnectionManager.removeConnectionInstance(connection)
-    close()
-
-    ConnectionManager.logger.info(`mitsubishi-plc connection(${connection.name}) is disconnected`)
-  }
-
-  get parameterSpec() {
-    return [
-      {
-        type: 'checkbox',
-        name: 'keepalive',
-        label: 'keepalive'
-      }
-    ]
-  }
-
-  get taskPrefixes() {
-    return ['melsec']
-  }
-
-  get help() {
-    return 'integration/connector/melsec-plc'
-  }
-}
-
-ConnectionManager.registerConnector('melsec-plc', new MelsecPLCConnector())

package/server/engine/index.ts

@@ -1,2 +0,0 @@
-import './connector'
-import './task'

package/server/engine/task/index.ts

@@ -1,5 +0,0 @@
-import './melsec-read-coil'
-import './melsec-wait-coil'
-import './melsec-write-coil'
-import './melsec-read-word'
-import './melsec-write-word'

package/server/engine/task/melsec-read-coil.ts

@@ -1,61 +0,0 @@
-import { ConnectionManager, TaskRegistry } from '@things-factory/integration-base'
-import { MelsecPLCConnector } from '../connector/melsec-plc'
-
-async function MelsecReadCoil(step, { logger, domain }) {
-  var {
-    connection: connectionName,
-    params: { plcAddress: address, readLength: readLength }
-  } = step
-
-  var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  if (!connection) {
-    throw new Error(`connection '${connectionName}' is not established.`)
-  }
-
-  var { request } = connection
-
-  var deviceCode = address.substring(0, 1) + '*'
-  var af_address = Number(address.substring(1)).toString()
-  var len = af_address.length
-  for (var i = 0; i < 6 - len; i++) {
-    af_address = '0' + af_address
-  }
-  var readStartDevice = af_address
-  var sendMessage = MelsecPLCConnector.getReadCoilCommand(deviceCode, readStartDevice, readLength)
-
-  // Request : 500000FF03FF000018000004010001M*0001000001
-  // Response : D00000FF03FF00000500000
-  var content = await request(sendMessage, 23, { logger }) // (22 + readLength)에서 현재 readLength는 1로 고정
-
-  // TODO readLength가 1이 아닐때 데이터 처리.
-  if (content.substring(17, 18) == '5') {
-    var data = content.substring(22, 23)
-
-    logger.info(content)
-    logger.info(`received response is ok. received: ${data}`)
-
-    return {
-      data
-    }
-  } else {
-    // error
-    throw new Error('response not applicable')
-  }
-}
-
-MelsecReadCoil.parameterSpec = [
-  {
-    type: 'string',
-    name: 'plcAddress',
-    label: 'plc_address'
-  },
-  {
-    type: 'number',
-    name: 'readLength',
-    label: 'read_length'
-  }
-]
-
-MelsecReadCoil.help = 'integration/task/melsec-read-coil'
-
-TaskRegistry.registerTaskHandler('melsec-read-coil', MelsecReadCoil)

package/server/engine/task/melsec-read-word.ts

@@ -1,60 +0,0 @@
-import { ConnectionManager, TaskRegistry } from '@things-factory/integration-base'
-import { MelsecPLCConnector } from '../connector/melsec-plc'
-
-async function MelsecReadWord(step, { logger, domain }) {
-  var {
-    connection: connectionName,
-    params: { plcAddress: address, signed = false }
-  } = step
-
-  var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  if (!connection) {
-    throw new Error(`connection '${connectionName}' is not established.`)
-  }
-
-  var { request } = connection
-
-  var deviceCode = address.substring(0, 1) + '*'
-  var af_address = Number(address.substring(1)).toString()
-  var len = af_address.length
-  for (var i = 0; i < 6 - len; i++) {
-    af_address = '0' + af_address
-  }
-  var readStartDevice = af_address
-  var sendMessage = MelsecPLCConnector.getReadWordCommand(deviceCode, readStartDevice)
-
-  // Request : 500000FF03FF000018000004010000D*0001010001
-  // Response : D00000FF03FF000008000003E9
-  var content = await request(sendMessage, 26, { logger })
-
-  var wordValue = content.substring(22, 26)
-  var data = parseInt(wordValue, 16)
-
-  if (signed && (data & 0x8000) > 0) {
-    data -= 0x10000
-  }
-
-  logger.info(content)
-  logger.info(`received response is ok. received: ${data}`)
-
-  return {
-    data
-  }
-}
-
-MelsecReadWord.parameterSpec = [
-  {
-    type: 'string',
-    name: 'plcAddress',
-    label: 'plc_address'
-  },
-  {
-    type: 'checkbox',
-    name: 'signed',
-    label: 'signed'
-  }
-]
-
-MelsecReadWord.help = 'integration/task/melsec-read-word'
-
-TaskRegistry.registerTaskHandler('melsec-read-word', MelsecReadWord)

package/server/engine/task/melsec-wait-coil.ts

@@ -1,80 +0,0 @@
-import { ConnectionManager, Context, ScenarioInstanceStatus, TaskRegistry } from '@things-factory/integration-base'
-import { sleep } from '@things-factory/utils'
-
-import { MelsecPLCConnector } from '../connector/melsec-plc'
-
-async function MelsecWaitForCoil(step, { logger, root, domain }: Context) {
-  var {
-    connection: connectionName,
-    params: { plcAddress: address, value, waitTerm = 50 }
-  } = step
-
-  var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  if (!connection) {
-    throw new Error(`connection '${connectionName}' is not established.`)
-  }
-
-  var { request } = connection
-
-  var deviceCode = address.substring(0, 1) + '*'
-  var af_address = Number(address.substring(1)).toString()
-  var len = af_address.length
-  for (var i = 0; i < 6 - len; i++) {
-    af_address = '0' + af_address
-  }
-  var readStartDevice = af_address
-  var sendMessage = MelsecPLCConnector.getReadCoilCommand(deviceCode, readStartDevice, undefined)
-
-  while (true) {
-    let state = root.getState()
-    if (state == ScenarioInstanceStatus.STARTED /* STARTED */) {
-      var content = await request(sendMessage, 23, { logger })
-
-      if (content.substring(17, 18) == '5') {
-        var coilValue = content.substring(22, 23)
-
-        if (value == coilValue) {
-          logger.info('received response is ok. required: %s, received: %s', value, coilValue)
-
-          return {
-            data: coilValue
-          }
-        } else {
-          logger.info('received response, but not accepted. required: %s, received: %s', value, coilValue)
-          await sleep(waitTerm)
-          continue
-        }
-      } else {
-        // error
-        throw new Error('response not applicable')
-      }
-    } else if (state == ScenarioInstanceStatus.STOPPED /* PAUSED */) {
-      await sleep(waitTerm)
-    } else {
-      throw new Error('scenario stopped unexpectedly')
-    }
-  }
-}
-
-MelsecWaitForCoil.parameterSpec = [
-  {
-    type: 'string',
-    name: 'plcAddress',
-    label: 'plc_address'
-  },
-  {
-    type: 'string',
-    name: 'value',
-    label: 'expected_value'
-  },
-  {
-    type: 'number',
-    name: 'waitTerm',
-    placeholder: 'milli-seconds',
-    label: 'wait_term'
-  }
-]
-
-MelsecWaitForCoil.help = 'integration/task/melsec-wait-coil'
-
-TaskRegistry.registerTaskHandler('melsec-wait-coil', MelsecWaitForCoil)

package/server/engine/task/melsec-write-coil.ts

@@ -1,99 +0,0 @@
-import { ConnectionManager, TaskRegistry } from '@things-factory/integration-base'
-import { MelsecPLCConnector } from '../connector/melsec-plc'
-
-import { sleep } from '@things-factory/utils'
-
-async function MelsecWriteCoil(step, { logger, domain }) {
-  var {
-    connection: connectionName,
-    params: { plcAddress: address, value, writeLength = 1, autoReset, delay = 50 }
-  } = step
-
-  var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  if (!connection) {
-    throw new Error(`connection '${connectionName}' is not established.`)
-  }
-
-  var { request } = connection
-
-  var w_address = address
-  var w_value = value
-  var deviceCode = w_address.substring(0, 1) + '*'
-
-  var af_address = Number(w_address.substring(1)).toString()
-  var len = af_address.length
-  for (var i = 0; i < 6 - len; i++) {
-    af_address = '0' + af_address
-  }
-  var writeStartDevice = af_address
-
-  if (w_value == 1) {
-    var writeCoilValue = '1'
-  } else {
-    var writeCoilValue = '0'
-  }
-
-  await doRequest(request, deviceCode, writeStartDevice, writeCoilValue, writeLength, logger)
-
-  if (autoReset) {
-    await sleep(delay)
-
-    await doRequest(request, deviceCode, writeStartDevice, Number(!Number(writeCoilValue)), writeLength, logger)
-  }
-
-  return {
-    data: writeCoilValue
-  }
-}
-
-async function doRequest(request, deviceCode, writeStartDevice, writeCoilValue, writeLength, logger) {
-  var sendMessage = MelsecPLCConnector.getWriteCoilCommand(deviceCode, writeStartDevice, writeCoilValue, writeLength)
-  // Request : 500000FF03FF000019000014010001M*00033300011
-  // Response : D00000FF03FF0000040000
-  var content = await request(sendMessage, 22, { logger })
-
-  // TODO writeLength 1이 아닐때 데이터 처리.
-  if (content.substring(17, 18) == '4') {
-    // ok
-    return {
-      data: writeCoilValue
-    }
-  } else {
-    // error
-    throw new Error('response not applicable')
-  }
-}
-
-MelsecWriteCoil.parameterSpec = [
-  {
-    type: 'string',
-    name: 'plcAddress',
-    placeholder: 'M0,Y1,..',
-    label: 'plc_address'
-  },
-  {
-    type: 'number',
-    name: 'writeLength',
-    label: 'write_length'
-  },
-  {
-    type: 'number',
-    name: 'value',
-    label: 'value'
-  },
-  {
-    type: 'checkbox',
-    name: 'autoReset',
-    label: 'auto_reset'
-  },
-  {
-    type: 'number',
-    name: 'delay',
-    placeholder: 'milisecodes, default is 50ms',
-    label: 'reset_delay'
-  }
-]
-
-MelsecWriteCoil.help = 'integration/task/melsec-write-coil'
-
-TaskRegistry.registerTaskHandler('melsec-write-coil', MelsecWriteCoil)

package/server/engine/task/melsec-write-word.ts

@@ -1,81 +0,0 @@
-import { ConnectionManager, TaskRegistry } from '@things-factory/integration-base'
-import { access } from '@things-factory/utils'
-import { MelsecPLCConnector } from '../connector/melsec-plc'
-
-async function MelsecWriteWord(step, { data, logger, domain }) {
-  var {
-    connection: connectionName,
-    params: { plcAddress: address, accessor, value }
-  } = step
-
-  var connection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  if (!connection) {
-    throw new Error(`connection '${connectionName}' is not established.`)
-  }
-
-  var { request } = connection
-
-  var w_address = address
-  var deviceCode = w_address.substring(0, 1) + '*'
-
-  var af_address = Number(w_address.substring(1)).toString()
-  var len = af_address.length
-  for (var i = 0; i < 6 - len; i++) {
-    af_address = '0' + af_address
-  }
-  var writeStartDevice = af_address
-
-  value = accessor ? access(accessor, data) : value
-  if (isNaN(value)) {
-    throw new Error(`invalid number value : ${value}`)
-  }
-
-  var valueDefine = Number(value).toString(16)
-  var writeWordValue = ''
-
-  if (valueDefine.length == 1) {
-    writeWordValue = '000' + Number(value).toString(16)
-  } else if (valueDefine.length == 2) {
-    writeWordValue = '00' + Number(value).toString(16)
-  } else if (valueDefine.length == 3) {
-    writeWordValue = '0' + Number(value).toString(16)
-  } else if (valueDefine.length == 4) {
-    writeWordValue = Number(value).toString(16)
-  }
-
-  // Request : 500000FF03FF00001C000014010000D*00010000010001
-  // Response : D00000FF03FF0000040000
-  logger.info(`will send request value: ${value}:${writeWordValue}`)
-
-  var sendMessage = MelsecPLCConnector.getWriteWordCommand(deviceCode, writeStartDevice, writeWordValue)
-  var content = await request(sendMessage, 22, { logger })
-
-  logger.info(`received response: ${content}`)
-
-  return {
-    data: writeWordValue
-  }
-}
-
-MelsecWriteWord.parameterSpec = [
-  {
-    type: 'string',
-    name: 'plcAddress',
-    placeholder: 'M0,Y1,..',
-    label: 'plc_address'
-  },
-  {
-    type: 'scenario-step-input',
-    name: 'accessor',
-    label: 'accessor'
-  },
-  {
-    type: 'number',
-    name: 'value',
-    label: 'value'
-  }
-]
-
-MelsecWriteWord.help = 'integration/task/melsec-write-word'
-
-TaskRegistry.registerTaskHandler('melsec-write-word', MelsecWriteWord)

package/server/index.ts

@@ -1 +0,0 @@
-import './engine'