YOKOGAWA e-RT3 User Manual
  1. Manuals
  2. Brands
  3. YOKOGAWA Manuals
  4. Computer Hardware
  5. e-RT3
  6. User manual
YOKOGAWA e-RT3 User Manual

YOKOGAWA e-RT3 User Manual

Os image for f3rp70
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Technical
Information
OS Image for F3RP70 User's Guide
TI 34M06T02-04EN
TI 34M06T02-04EN
July. 2024 1st Edition (YK)
Yokogawa Electric Corporation

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the e-RT3 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for YOKOGAWA e-RT3

Summary of Contents for YOKOGAWA e-RT3

  • Page 1 Technical Information OS Image for F3RP70 User’s Guide TI 34M06T02-04EN TI 34M06T02-04EN July. 2024 1st Edition (YK) Yokogawa Electric Corporation...
  • Page 2 Blank Page...

  • Page 3: Table Of Contents

    Content-1 OS Image for F3RP70 User’s Guide TI 34M06T02-04EN Contents Introduction F3RP70-2L Overview ....................1-1 OS image ....................1-1 Writing the OS image file to the SD memory card and startup Procedure overview ................2-2 The SD memory card for starting ............2-4 2.2.1 Specifications of the OS image ..............
  • Page 4 Content-2 Setup procedure..................4-4 4.3.1 Preparing the operating environment ............4-4 4.3.2 Enabling OverlayFS..................4-4 4.3.3 Disabling OverlayFS ..................4-5 Usage precautions ................4-6 Appendix1 Python Module API A1.1 List of APIs ..................A1-1 A1.2 Receiving interrupts ................A1-4 A1.3 API reference for Python modules ........... A1-5 A1.3.1 I/O module ....................

  • Page 5: Registered Trademark

    This manual describes how to use the OS image provided for the OS-free CPU module. The OS-free CPU module is e-RT3 CPU module that incorporates only a boot loader. Users can develop their own system, while it takes time and effort to gain knowledge for using the module.ｚ...
  • Page 6 Blank Page...

  • Page 7: F3Rp70-2L

    F3RP70-2L Overview F3RP70-2L is one of the modules in the e-RT3 CPU modules. It incorporates a boot loader only and allows its users to construct a flexible system, including the operating system. After F3RP70-2L is turned on, the boot loader starts its operation and initializes hardware and e-RT3/FA-M3 modules.
  • Page 8 Blank Page...

  • Page 9: Writing The Os Image File To The Sd Memory Card And Startup

    Writing the OS image files to the SD memory card and startup This chapter describes the procedure for writing the OS image file to the SD memory card and startup. TI 34M06T02-04EN...

  • Page 10: Procedure Overview

    ■ Writing to an SD memory card Use the following procedure is used to write the OS image file to an SD memory card. Download the OS image ZIP file from the e-RT3 customer portal. Download “rp70_OS_Image_R211.zip” file. Extract the OS image ZIP file（DebianOS and UbuntuOS image files will be extracted）...
  • Page 11 ● Boot the OS image. The following items are required to boot and connect to OS. ・ ・ Terminal software ・ RS-232-C conversion cable (model：KM72-2N) or Ethernet cable TI 34M06T02-04EN...

  • Page 12: The Sd Memory Card For Starting

    The SD memory card for starting This section describes the SD memory card on which the selected OS image files is written. The SD memory card contains the OS file system of the operating system (OS) to be booted on the F3RP70-2L and the configuration files required to start the OS. Insert the SD memory card containing the OS image into the SD memory card slot to start up the OS with the appropriate settings for F3RP70-2L, necessary libraries, packages, etc.
  • Page 13 CPU modules. Note See Appendix 1 “Python Modules API” in this document for the Python API for e-RT3 module access. For application development in C,C++ languages, refer to “Ubuntu Image for F3RP70 User’s Guide”...
  • Page 14 CPU modules. Note For details of the above functions, refer to “e-RT3 CPU Module (SFRD□2) BSP Common Function Manual” (IM 34M06M52-02E). ● Web Maintenance Tools This tool offers features for monitoring and configuring I/O modules and internal parameters of the system provided by the OS image.

  • Page 15: User Settings

    2.2.2 User settings The following user preferences are initially set in the OS. If necessary. change the password or add or remove a user. ● Root user User name: root Password: root_ert3 ● Ordinary user User name: ert3 Password: user_ert3 2.2.3 Network settings The following network settings are initially in the OS.

  • Page 16: Check Network Status

     Check network status You can check the status with command below. # networkctl status # ifconfig TI 34M06T02-04EN...

  • Page 17: Procedure For Writing To The Sd Memory Card

    SLC or MLC type SC memory card. ● OS image file Download from our membership website “Yokogawa Customer Portal”. The OS image file can be downloaded from the “OS image file for OS-free CPU Module” page on the e-RT3 User Support Page.
  • Page 18 2-10 ● Disk image File Writing Tool Please prepare any disk image file writing tool. This subsection shows an example of using “Rawrite32”, a free software for Windows. How to install Access the following URL and click the “Download” link at the top of the Rawrite32 website.
  • Page 19 2-11 Click the “Install” button without changing any settings. The installation will begin. Fig 2.4 Rawrite32 Setup Dialog box When installation is complete, press the “Finish” button to exit the installer. Fig 2.5 Rawrite32 Installation Completion Dialog box TI 34M06T02-04EN...
  • Page 20 SD memory card while you are using F3RP70-2L. For details on the recommended standard and the use of the SD memory card slot of F3RP70-2L, refer to “4.5 SD memory card” of “e-RT3 CPU Module (F3RP7□) Hardware Manual” (IM34M06M52-01E) In the procedure described in this section, you do not have to uncompress the download file.

  • Page 21: How To Write To The Sd Memory Card

    2-13 2.3.2 How to write to the SD memory card This subsection details the writing procedure. ● Let your PC recognize an SD memory card Before starting Rawrite32, SD memory card have to be recognized by PC. ● Start Rawrite32 If you see a dialog box saying “Do you want to allow this app to make changes to your device?”...
  • Page 22 2-14 ● Select the OS image file to be written Click the “Open” button on the upper right and select the compressed OS image file you have downloaded. When the hash value is calculated and appears in the “Program messages:” field in the center of the screen, you can click the “Write to disk...” button at the bottom right of the screen.
  • Page 23 2-15 ● Write to disk Click the “Write to disk...” button on the lower right corner, and the dialog box shown will appear. Click the “Yes” button to start writing to the SD memory card. confirm dialog. Fig 2.8 Write confirmation screen TI 34M06T02-04EN...
  • Page 24 2-16 ● Confirm completion of writing The writing is complete when you see the message saying “successfully written to disk” in the “Program messages:” section as shown below. Click the “X” button in the upper right corner of the screen to exit Rawrite32. Fig 2.9 Writing completion screen Note When you perform the procedure in this section, all the data in the SD memory card...

  • Page 25: Starting From The Sd Memory Card

    Example of u-boot command to delete “rootdev” f3rp7x> setenv rootdev f3rp7x> saveenv Note For details on environment variable of u-boot, refer to “e-RT3 OS free CPU Module Startup Manual” (IM 34M06M52-25) ● Start the system With the MODE switch set to 0, turn on the power.
  • Page 26 2-18 2.4.2 Procedure for connecting to OS This subsection details connecting to F3RP70 and log-in procedure. ● What you need For serial console connection, please prepare the following items. ・ PC with terminal software already installed. ・ RS-232-C conversion cable (model:KM72-2N) ・...
  • Page 27 2-19 ● Installing a terminal software Terminal software such as “PuTTY” or “Tera Term” is needed to connect the OS. This subsection describes installing procedure of “PuTTY” as an example. Access the following URL and click “Download PuTTY” in web page. <https://www.putty.org/>...
  • Page 28 2-20 Open the downloaded file to start the installer. When the following dialog is show, Click the “Run”. Fig 2.13 Security dialog Click the “Next” Fig 2.14 PuTTY installer TI 34M06T02-04EN...
  • Page 29 2-21 Specify the install location. In this document, do not change the destination folder and click “Next”. Fig 2.15 Specify the install location If you want to create a shortcut on your desktop, enable the second item from the top. In this document, we will not make any change and click “Install” button with the same settings.
  • Page 30 The detailed procedure for connecting to the OS is described in the next section. Note For details on communication settings with terminal software, refer to “e-RT3 OS-free CPU Module Startup Manual” (IM3406M52-25E) When connecting from a serial console, a user login prompt will appear. Log In using the user account you have set or default user accounts.

  • Page 31: Serial Console Connection

    2-23 ● Serial console connection This subsection details connecting to the OS using the serial console. Startup PuTTY and set “Connection type” to “Serial”. And then set some items as follow and click “Open”. ・ Serial line: COM port name with number. ・...
  • Page 32 2-24 Turn on F3RP70-2L. Login prompt is displayed on the console after boot sequence. Log in using the user account you have set up. Fig 2.19 Login prompt of serial console Note If it is not displaying the login prompt, Just press the “Enter” key. TI 34M06T02-04EN...

  • Page 33: Ssh Connection

    2-25 ● SSH Connection This subsection details connecting to the OS using the SSH. Turn on F3RP70-2L. Set an IP address of your PC to “192.168.3.□□”. Default IP address of OS image is “192.168.3.72”. Start PuTTY and set “Connection type” to “SSH”. And the set some items as follows and click “Open”.
  • Page 34 2-26 Login prompt is displayed on the console. Log in using the user account you have set up. Fig 2.22 Login prompt of SSH connection Note If you change the settings of your computer’s network adapter according to the instructions in this manual, you may not be able to connect to the internet using that adapter.

  • Page 35: Root File System Size Expansion

    2-27 2.4.3 Root file system size expansion If you are using an SD memory card larger than 8GB and you want to use maximum size of rest of SD memory card area for Root file system. This section describes how to maximize rest of SD memory card area for Root file system.
  • Page 36 2-28 Disk /dev/mmcblk0: 29.12 GiB, 31267487744 bytes, 61069312 sectors Units: sectors of 1 * 512 = 512 bytes Sector size (logical/physical): 512 bytes / 512 bytes I/O size (minimum/optimal): 512 bytes / 512 bytes Disklabel type: dos Disk identifier: 0xe2c4fb3c Device Boot Start End Sectors Size Id Type...

  • Page 37: Application Development With Python

    For application development with Jupyter-notebook, refer to “Ubuntu Image for F3RP70 User’s Guide” (TI34M06T02-02E）. Note For application development in C,C++ languages, refer to “Ubuntu Image for F3RP70 User’s Guide” (TI34M06T02-02E）, “e-RT3 Linux BSP (SFRD12) Programing Manual” (IM34M06M52-22E) . TI 34M06T02-04EN...

  • Page 38: Development Environment

    Fig 3.1 Application development environment In the development of your application, the Local machine communicates with e-RT3 through a serial terminal or SSH connection. Therefore, you need to connect your PC to F3RP70-2L with a Serial cable or Ethernet cable.

  • Page 39: Development With Python Module

    Development with Python module 3.2.1 Overview The OS image Includes the Python module “m3io_py” is installed to access M3IO module I/O. Using this module, you can use the libraries provided for C language program development directly from Python. The library for F3HA12 Data Collection Service can be used in the same. Note For available Python API, refer to the Python module API list in the appendix of this manual.

  • Page 40: Python Sample

    3.2.3 Python sample The latest Python sample source code can be downloaded from “Yokogawa Electric Customer Portal” membership site. The downloaded file name is “sample_rp70_python_R211.tar.zip”. Note The “R211” part of the downloaded file name changes depending on the revision. Sample source code is also available at the following directories in the OS image.
  • Page 41 ・Example 3 Interrupt of Input Relay module example (e.g., F3XD32 module). # python3 test_DI_interrupt.py <unit> <slot> <pos> unit 0 ,slot 4 , XD32 pos = 2 key = 0 id = 32768 enable DI irq... waiting DI On/Off... 3 times... irq received...
  • Page 42 Blank Page...

  • Page 43: Overlay Filesystem

    Overlay Filesystem This chapter describes the functions and usage of Overlay Filesystem (OverlayFS). By working with OverlayFS enabled, you can reduce negative effects on the system of unexpected power failures. TI 34M06T02-04EN...

  • Page 44: Overview

    Overview 4.1.1 OverlayFS overview OverlayFS consists of 3 layers file system: a lower-layer, upper-layer and merged upper-lower layer file system. In the case of F3RP70-2L, the lower layer corresponds to the OS built on the SD memory card and is read-only. The file system merged with the upper layer is created on the RAM disk, and changes made after the OS is booted are written to the upper layer.

  • Page 45: Description Of Overlayfs

    Description of OverlayFS ● Features  Power interruption resistance Prevent negative effect on the system due to unexpected power interruptions that the shutdown process cannot address.  Same operation as usual Enabling OverlayFS does not affect normal operations.  Easy to use Enabling/Disabling setting can be done with simple way.

  • Page 46: Setup Procedure

    Setup procedure This section describes the OverlayFS setting procedure. ■ Environment for setting The configuration of the necessary items and devices for setting is the same as for the serial console connection described in “2.4.2 Procedure for connecting to OS” in this manual.

  • Page 47: Disabling Overlayfs

    /dev/root /.proot ext4 rw,relatime,data=ordered 0 0 /dev/mmcblk0p2 /rootfs.ro ext4 rw,relatime,data=ordered 0 0 overlay / overlay rw,relatime,lowerdir=/rootfs.ro,upperdir=/rootfs.rw/upperdir,workdir=/rootfs.rw/work 0 0 The contents displayed include “/dev/root /.proot” and ”overlay / overlay”, and in the case of SD card slot 1, “/dev/mmcblk0p2 /rootfs.ro” is included. In the case of SD card slot 2, “/dev/mmcblk1p2 /rootfs.ro”...

  • Page 48: Usage Precautions

    Usage precautions The following are precautions when operating with OverlayFS. Please read following information before use. ● Saving data While operating with OverlayFS, data cannot be saved to the SD memory card containing the OS image. If you acquire data during operation that you want to save after turning off or restarting, you must prepare another device.
  • Page 49 ● Capacity of RAM disk When booted with OverlayFS enabled, the merged upper-lower layer file system and the upper layer file system are created on the RAM disk with “tmpfs” device. For the F3RP70-2L, by default, the maximum capacity of the “tmpfs” device is 512 MB, and the total volume of the “tmpfs”...
  • Page 50 Blank Page...

  • Page 51: Appendix1. Python Module Api

    A1-1 Appendix1. Python Module API This chapter is a reference for the Python module “m3io_py” API to access the e-RT3 IO module. A1.1 List of APIs The “m3io_py” module is based on the e-RT3 Linux BSP (SFRD12) library. Note For detailed API functions, refer to “e-RT3 Linux BSP(SFRD12) Programming Manual”...
  • Page 52 A1-2 Read 16-bit data from the data register readM3InternalRegister Write 16-bit data to the data register writeM3InternalRegister Shared device Set shared device assignment information setM3SharedDataConfig Get shared device assignment information referM3SharedDataConfig Read from the (extended) shared relay in blocks readM3SharedRelay Read from the (extended) shared relay readM3SharedRelayB Write to the (extended) shared relay in blocks...
  • Page 53 A1-3 Table A1.2 List of Specialized APIs for “m3io_py” Category Subcategory Feature Function name I/O module Device access Read 16-bit data from the I/O register. Signed readM3IoRegisterS value. CPU module CPU information Read from the CPU-shared memory. Signed readM3CpuMemoryS value. PLC device Local device Read 16-bit data from the data register.

  • Page 54: A1.2 Receiving Interrupts

    A1-4 A1.2 Receiving interrupts The interrupt mechanism utilizes the message queue (inter-process communication) function of Linux. To user message queue in Python, user the “sysv-ipc” module. Please refer to the following Python sample code for details on how to use it. /usr/src/m3io_py/example/test_DI_interrupt.py /usr/src/m3io_py/example/test_DI_mask_interrupt.py TI 34M06T02-04EN...

  • Page 55: A1.3 Api Reference For Python Modules

    A1-5 A1.3 API reference for Python modules A1.3.1 I/O Module ■ Device access ● readM3InRelay Function Read from the input relay in blocks Synopsis readM3InRelay(unit, slot, pos, num, data[]) Description The function reads from the input relay in an I/O module in 16-points. “num”...
  • Page 56 A1-6 ● readM3OutRelay Function Read from the output relay in blocks Synopsis readM3OutRelay(unit, slot, pos, num, data[]) Description The function read from the output relay in an I/O module in 16 points. “num” data blocks read from the output relay with relay number “pos” in the I/O module specified by the arguments “unit”...
  • Page 57 A1-7 ● writeM3OutRelayP Function Write to the output relay Synopsis writeM3OutRelayP(unit, slot, pos, data) Description This function writes to the output relay in an I/O module in one point. Only 1-point data is written to the output relay with output relay number “pos” in the I/O module specified by the argument “unit”...
  • Page 58 A1-8 ● writeM3IoRegister Function Write 16-bit data to the I/O register. Synopsis writeM3IoRegister(unit, slot, pos, num, data[]) Description The function writes 16-bit data to the I/O register in an I/O module. The I/O module is specified in the arguments “unit” and “slot”, and the I/O register and teh data range are specified in “pos”...
  • Page 59 A1-9 ■ Mode configuration ● readM3IoModeRegister Function Read from the mode register. Synopsis readM3IoModeRegister(unit, slot, pos, num, mode[]) Description The function reads 16-bit data from the mode register in an I/O module. The I/O module is specified in the arguments “unit” and “slot”, and the mode register and the data range are specified in “pos”...
  • Page 60 A1-10 ■ Input relay interrupt ● enableM3IoIrq Function Enable interrupts (in all points) Synopsis enableM3IoIrq (unit, slot, mask[], msgQId) Description The function enables or disables interrupts for all the points from the input relay in an I/O module. The I/O module is specified in the arguments “unit” and “slot”, The data for interrupt masking is set in the argument “mask[]”...
  • Page 61 A1-11 ● enableM3IoIrqP Function Enable interrupts (in one point) Synopsis int enableM3IoIrqP (int unit, int slot, int pos, int msgQId) Description The function enables interrupts from the input relay in the I/O module specified by the argument in one point. I/O module interrupts are received by “sysv_ipc.MessageQueue.receive”...
  • Page 62 A1-12 ■ Module information ● getM3IoName Function Get the module ID Synopsis string getM3IoName (unit, slot) Description The function obtains the module ID of an I/O module. It can get the module ID (module name) of the I/O module specified in the arguments “unti” and “slot”. A The module ID is returned in the return value as a text string, or None if the module name could not be obtained.
  • Page 63 A1-13 ● getM3IoDRegAdr Function Get the offset address of the I/O space in the I/O register Synopsis getM3IoDRegAdr (unit, slot) Description The function obtains the address of the I/O register in an I/O module as an offset from the beginning of the mapping area.
  • Page 64 A1-14 ● getM3IoXSize Function Get the size of the I/O space in the input relay Synopsis getM3IoXSize (unit, slot) Description The function obtains the size of the area where the input relay in an I/O module is located. You can determine the existence or non-existence of the input relay by checking the size.

  • Page 65: A1.3.2 Cpu Module

    A1-15 A1.3.2 CPU module ■ Device access Note For details on device types specified for CPU device access, refer to “4.5 CPU device access” of “BSP Common Function Manual” (IM34M06M52-02E). ● readM3CpuDevice Function Read from the CPU device Synopsis readM3CpuDevice(cpuno, type, pos, num, data[]) Description The function reads 16-bit data from the CPU device in a CPU module.
  • Page 66 A1-16 ● readM3CpuDeviceP Function Read from the CPU relay device Synopsis readM3CpuDeviceP(cpuno, type, pos, num, data[]) Description The function reads the specified number of points of data from the CPU device in other CPU module. The argument “cpuno” specifies a CPU module, “type” specifies a device type, and “pos” and “num” specify the range in the device.
  • Page 67 A1-17 ● writeM3CpuDeviceP Function Write to the CPU relay device Synopsis Return value，error=writeM3CpuDeviceP(cpuno, type, pos, num, data[]) Description The function writes the specified number of points of data to the PLC relay device in a CPU module. The argument “cpuno” specifies a CPU module, “type” specifies in device type, and “pos” and “num” specify the range in the device.
  • Page 68 A1-18 ■ Signal notification ● enableM3CpuSignal Function Enable signal reception Synopsis enableM3CpuSignal (cpuno, msgQId) Description The function enables receiving signal notifications used to synchronize operations among CPU modules. Signal notifications send from CPU modules are received through a Linux message queue. Thus, your applications must pre-register the message queue for reception.
  • Page 69 Synopsis sendM3CpuSignal(cpuno, signal, data) Description This function sends signal notifications. They are sent to e-RT3 2.0 CPU modules specified in the argument “cpuno”. A signal notification consists of 8-byte signal “signal” and 1-word data “data”. Argument cpuno (Numeric) CPU number (1 to 4)
  • Page 70 A1-20 ■ CPU Information ● getM3CpuNumber Function Get the CPU number Synopsis getM3CpuNumber (void) Description The function obtains the slot number of the slot (1 to 4) in which this CPU module is mounted. It returns the slot number as a return value. Argument None Return value...
  • Page 71 A1-21 ● readM3CpuMemory Function Read from the CPU-shared memory Synopsis readM3CpuMemory(cpuno, pos, num, buf[]) Description The function directly reads values from the CPU-shared memory. The data is read directly from the shared memory area in the CPU module specified in the argument “cpuno”...

  • Page 72: A1.3.3 Plc Device

    A1-22 A1.3.3 PLC device ■ Local device ● setM3InternalDataTable Function Set local device assignment information Synopsis setM3InternalDataTable( location, relaySize, registerSize ) Description The function sets the number of data points in the local devices. It sets “relaySize” for the number of data points in the internal relay and “registerSize” for the number of data points in the data register.
  • Page 73 A1-23 ● readM3InternalRelayB Function Read from the internal relay Synopsis readM3InternalRelayB ( no, num, data[] ) Description The function reads from the internal relay in one point. It reads “num” points of data sets from the device with device number “no” in the internal relay “I” into “data[]”.
  • Page 74 A1-24 ● writeM3InternalRelay Function Write to the internal relay in blocks. Synopsis writeM3InternalRelay ( no, num, pBuff[] ) Description The function writes to the internal relay in 16-points. It writes “num” points of data sets in “pBuff[]” to the device starting from device number “no” in the internal relay “I”.
  • Page 75 A1-25 ■ Shared device ● setM3SharedDataConfig Function Set shared device assignment information Synopsis setM3SharedDataConfig( shdNumRelay[4], shdNumReg[4], extNumRelay[4], extNumReg[4]) Description The function assigns shared devices to CPU modules. The number of relay points must be specified in multiples of 32 an the number of register points in multiple of 2.
  • Page 76 A1-26 ● readM3SharedRelay Function Read from the (extended) shared relay in blocks Synopsis readM3SharedRelay ( no, num, pBuff[] ) Description The function reads from the (extended) shared relay in 16 points. It reads “num” points of data sets from the device with device number “no” int the (extended) shared relay “E”...
  • Page 77 A1-27 ● readM3SharedRegister Function Read 16-bit data from the (extended) shared register Synopsis readM3SharedRegister ( no, num, pBuff[] ) Description The function reads 16-bit data from the (extended) shared register. It reads “num” points of data sets from the device with device number “no” in the (extended) shared register “R”...
  • Page 78 A1-28 ● writeM3SharedRelay Function Write to the (extended) shared relay in blocks Synopsis writeM3SharedRelay ( no, num, pBuff[] ) Description The function writes to the (extended) shared relay in 16 points. It writes “num” points of data sets in “pBuff[]” to the device starting from device number “no” in the (extended) shared relay “E”.
  • Page 79 A1-29 ● writeM3SharedRegister Function Write 16-bit data to the (extended) shared register Synopsis writeM3SharedRegister ( no, num, pBuff[] ) Description The function writes 16-bit data to the (extended) shared register. It write “num” points of data sets in “pBuff[]” to the device starting from device number “no” in the (extended) shared register “R”.
  • Page 80 A1-30 ■ Link device ● referM3LinkDeviceConfig Function Get link device assignment information Synopsis referM3LinkDeviceConfig(numRelay[], numReg[] ) Description The function obtains the number of data points in the link device. Argument numRelay[] (List type) Number of points that are assigned to system numbers 1 to 8 in the link relay lnumReg[] (List type) Number of points that are assigned to system numbers 1 to 8 in the...
  • Page 81 A1-31 ● readM3LinkRelay Function Read from the link relay in blocks Synopsis readM3LinkRelay ( no, num, pBuff[] ) Description The function reads from the link relay in 16 points. It reads “num” points of data sets from the device with device number “no” in the link relay “L” into “pBuff[]”.
  • Page 82 A1-32 ● readM3LinkRegisterS Function Read 16-bit signed data from the link register Synopsis readM3LinkRegister ( no, num, pBuff[] ) Description The function reads 16-bit signed data from the link register. It reads “num” points of data sets from the device with device number “no” in the link register “W” in to “pBuff[]”.
  • Page 83 A1-33 ● writeM3LinkRegister Function Write 16-bit data to the link register Synopsis writeM3LinkRegister ( no, num, pBuff[] ) Description The function writes 16-bit data to the link register. It writes “num” points of data sets in “pBuff[]” to the device starting from device number “no” in the link register “W”.

  • Page 84: A1.3.4 System Administration

    A1-34 A1.3.4 System administration ■ LED indicator ● setM3RunLed Function Set eh state of the RUN LED Synopsis setM3RunLed(led) Description The function sets the on/off state of the RUN LED at the top front of a CPU module to the value specified in the argument “led”.
  • Page 85 A1-35 ● getM3AlmLed Function Get the state of the ALM LED Synopsis getM3AlmLed() Description The function gets the on/off state of the ALM LED at the top front of a CPU module. The state can be obtained as a return value of the function. Argument None Return value...
  • Page 86 A1-36 ● setM3U1Led Function Set the state of the U1 LED Synopsis setM3U1Led(led) Description The function sets the on/off state of the U1 LED at the top front of a CPU module to the value specified in the argument “led”. Argument led (Numeric) State of the U1 LED...
  • Page 87 A1-37 ● getM3U2Led Function Get the state of the U2 LED Synopsis getM3U2Led() Description The function gets the on/off state of the U2 LED at the top front a CPU module. The state can be obtained as a return value of the function. Argument None Return value...
  • Page 88 A1-38 ● getM3BatteryPower Function Get the battery level Synopsis getM3BatteryPower () Description The function checks the remaining capacity of the RTC and SRAM back up battery. This action is equivalent to checking the state of the BAT LED. the state can be obtained as a return value of the function.

  • Page 89: A1.3.5 Support For Fl-Net Interface Modules

    A1-39 A1.3.5 Support for FL-net interface modules ■ Initialization ● setM3FlnSysNo Function Specify the system number Synopsis setM3FlnSysNo ( flag, sysNoPos[8] ) Description The function initializes access to FL-net interface modules and registers system numbers. Run this function only once before starting link refresh or accessing to FL-net interface modules. If the automatic assignment is chosen, FL-net interface modules from the lowest to the highest slot number are assigned to the systems 1 and 2.
  • Page 90 A1-40 ● setM3FlnNode Function Set the scope of link refresh Synopsis setM3FlnNode ( sysNo, linkRfrs[16] ) Description The function sets the scope of link refresh. Use the function if you do not want to refresh some nodes on the network, You can reduce the link refresh period performed between an FL-net interface module and the CPU module.
  • Page 91 A1-41 ● getM3FlnEr Function Get upper layer operating signal error codes Synopsis getM3FlnEr ( sysNo, err[] ) The function obtains upper layer operating signal errors during link refresh. It allows you to check for Description any upper layer operating signal errors on other nodes. Argument sysNo (Numeric)
  • Page 92 A1-42 ● setM3FlnSt Function Set an upper layer operating signal error Synopsis setM3FlnSt ( state ) Description The function writes how the CPU module is running to the FL-net interface module. Use the function in combination with the “setM3FlnEr” function, which sets an upper layer operating signal error.
  • Page 93 A1-43 ■Node access ● readM3FlnNodeCom1 Function Read from common memory 1 on a node basis. Synopsis readM3FlnNodeCom1 ( sysNo, node, num, data[] ) Description The function reads data from common memory 1 on the specified node in words. It reads the specified number of words of data from the beginning of the area to which the specified node is assigned in the link relay (common memory 1).
  • Page 94 A1-44 ● writeM3FlnNodeCom1 Function Write to common memory 1 in the current node Synopsis writeM3FlnNodeCom1 ( sysNo , num, data[] ) Description The function writes data in common memory 1 in the node on which the function is run in words. It writes the specified number of words of data from the beginning of the area to which the specified node is assigned in the link relay (common memory 1).

  • Page 95: A1.3.6 Api Reference For F3Ha12 Data Acquisition Service Python Module

    A1-45 A1.3.6 API reference for F3HA12 Data Acquisition service Python module ■ Management ● LEDG_open Function Initialize API resources Synopsis LEDG_open(mode, unit, slot) Description The function initializes resources used internally by the API functions. When 0 (read/write) is specified for mode, All the API functions become available. When 1 (read) is specified for mode, the API functions for getting configuration and getting acquired data become available.
  • Page 96 A1-46 ● delete_buffer Function Release API buffer Synopsis buffer_delete() Description The function releases the buffer area used internally. ■ Configuration ● LEDG_getHaGathering Function Get a data acquisition target Synopsis return, enableChannels, enableCounter = LEDG_getHaGathering() Description The function gets whether or not analog input channels and the counter are the data acquisition target (active/inactive).

  • Page 97: Data Acquisition

    A1-47 ● LEDG_ stopHaDataGathering Function Stop data acquisition Synopsis LEDG_stopHaDataGathering() Description The function stops data acquisition. ■ Data acquisition ● LEDG_getHaDataNo Function Get the data number of acquired data Synopsis return, oldestNo, newestNo, acqLastErr ＝LEDG_getHaDataNo () Description The function gets the data number (1 origin) of the data being acquired. It gets the oldest and lates data numbers of data held by the service when the API function is called.
  • Page 98 Blank Page...

  • Page 99: Revision Information

    ■ For Questions and More Information If you have any questions, you can send an E-mail to the following address E-mail: plc_message@cs.jp.yokogawa.com ■ Written by Yokogawa Electric Corporation ■ Published by Yokogawa Electric Corporation 2-9-32 Nakacho, Musahino-shi, Tokyo, 180-8750, JAPAN TI 34M06T02-04EN...
  • Page 100 Blank Page...

This manual is also suitable for:

F3rp70-2l

Table of Contents