Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModbusGeneral

IModbus have api and monitoring data variable. These elements are related to Modbus communication function.

api-version

1

user

Hierarchy

Index

Methods

Methods

delModbusMultiSignal

  • delModbusMultiSignal(symbol: string): Promise<boolean>

  • Deletes the user-defined-input/output signal of target equipment in order to use ModbusRTU (FC15 (multiple coils)/16 (multiple holding registers)).

    summary

    사용자가 정의한 Modbus I/O 신호를 삭제

    api-version

    1

    user

    Parameters

    • symbol: string

      I/O name- I/O id of 26 byte

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

    Remarks

    • Multiple I/O which are set as identifiers are deleted at once.
    • FC15: multiple coils/ FC16: multiple holding registers

delModbusSignal

  • delModbusSignal(symbol: string): Promise<boolean>

  • Deletes the Modbus Input/Output signal information which was registered in advance at the robot controller.

    summary

    Deleting Modbus I/O signal information registered in advance in the robot controller

    api-version

    1

    user

    Parameters

    • symbol: string

      Name of registered modbus signal

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

getModbusInput

  • getModbusInput(symbol: string): Promise<number>

  • This is a function to check the signal of the Modbus I/O signal contact in the robot controller.

    api-version

    1

    user

    Parameters

    • symbol: string

      I/O name- Modbus I/O signal name (31 bytes)

    Returns Promise<number>

    Return Fulfills with Modbus I/O signal.

    Remarks

    • I/O name item is the signal name of user-defined 31 byte Modbus I/O. In order to define Modbus I/O signal, minimum three information is needed including IP address of Modbus equipment, Register type, and register number etc., but because for programming and monitoring, it is impossible to use and identify the signal by using all of these, user-defined name is made and used.

queryModbusDataList

setModbusMultiOutput

  • setModbusMultiOutput(symbol: string, registerCount: number, registerValue: number[]): Promise<boolean>

  • Controls and changes multi way printout of the user-defined-input/output signal in order to use ModbusRTU communication because of the characteristic of the I/O extension and synchronization target.

    summary

    Modbus I/O 신호의 다중 출력을 제어 및 변경

    api-version

    1

    user

    Parameters

    • symbol: string

      I/O id of 26 byte

    • registerCount: number

      Number of I/O output (maximum 100)

    • registerValue: number[]

      Array of I/O output values

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

setModbusOutput

  • setModbusOutput(symbol: string, value: number): Promise<boolean>

  • Outputs signal to the Modbus Input/Output signal contact at the robot controller.

    api-version

    1

    user

    Parameters

    • symbol: string

      Name of modbus

    • value: number

      Modbus digital I/O: 0 or 1,
      Modbus analog I/O: data

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

setModbusOutputs

  • setModbusOutputs(count: number, registerList: ModbusInfo[]): Promise<boolean>

  • Sets multiple Modbus output signal at once at the robot controller.

    summary

    Modbus I/O 출력 신호 여러 개를 한번에 설정

    api-version

    1

    user

    Parameters

    • count: number

      number of output signals (up to 8)

    • registerList: ModbusInfo[]

      array of setting data pair(Name, Value)

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

Generated using TypeDoc