Transcript
Page 1: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

MANUAL NO.

HW1485815

YASKAWA CockpitAdd-on Application SoftwareDevelopment Manual

Upon receipt of the product and prior to initial operation, read these instructions thoroughly, andretain for future reference.

1/25

186633-1CD0

Page 2: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

HW1485815

DANGER

• Read this manual carefully and be sure to understand its contents. Any matter, including operation, usage, measures, and an item to use, not described in this manual must be regarded as "prohibited" or "improper".

NOTICE

• YASKAWA may modify this model without notice when necessary due to product improvements, modifications, or changes in specifications.

• If such modification is made, the manual number will also be revised.

• If your copy of the manual is damaged or lost, contact a YASKAWA representative to order a new copy. The representatives are listed on the back cover. Be sure to tell the representative the manual number listed on the front cover.

ii HW1485815 2/25

Page 3: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

HW1485815

Notes for Safe OperationRead this manual carefully before installation, operation, maintenance, or inspection of the YRC1000micro/YRC1000/DX200/DX100/RM100.

In this manual, the Notes for Safe Operation are classified as “DANGER”, “WARNING”, “CAUTION”, or “NOTICE”.

Even items described as “CAUTION” may result in a serious accident in some situations. At any rate, be sure to follow these important items.

DANGERIndicates an imminently hazardous situation which, if not avoided, will result in death or serious injury. Safety Signs identified by the signal word DANGER should be used sparingly and only for those situations presenting the most serious hazards.

WARNINGIndicates a potentially hazardous situation which, if not avoided, will result in death or serious injury. Hazards identified by the signal word WARNING present a lesser degree of risk of injury or death than those identified by the signal word DANGER.

CAUTIONIndicates a hazardous situation, which if not avoided, could result in minor or moderate injury. It may also be used without the safety alert symbol as an alternative to “NOTICE”.

NOTICENOTICE is the preferred signal word to address practices not related to personal injury. The safety alert symbol should not be used with this signal word. As an alternative to “NOTICE”, the word “CAUTION” without the safety alert symbol may be used to indicate a message not related to personal injury.

NOTETo ensure safe and efficient operation at all times, be sure to follow all instructions, even if not designated as “DAN-GER”, “WARNING” and “CAUTION".

iii HW1485815 3/25

Page 4: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

HW1485815

Registered TrademarkIn this manual, names of companies, corporations, or products are trademarks, registered trademarks, or brand names for each company or corporation. The indications of (R) and TM are omitted.

iv HW1485815 4/25

Page 5: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

Contents

v HW1485815

HW1485815

1 Introduction to YASKAWA Cockpit ................................................................................................. 1-1

1.1 Features ............................................................................................................................ 1-1

1.2 Specifications of the Data Analysis Add-On Function ....................................................... 1-1

1.3 Specifications of the Data Window Add-On Function ........................................................ 1-2

2 Extension Function ......................................................................................................................... 2-1

2.1 Specifications of the Data Collection Add-On Function ..................................................... 2-1

2.2 Example of Application Software Configuration Using Add-On Functions ........................ 2-2

3 Development Environment.............................................................................................................. 3-1

3.1 Configuration of the YCP Development Environment........................................................ 3-1

3.2 YCP Development Task Flow............................................................................................ 3-2

3.3 Development Environments for DA Apps and DC Apps.................................................... 3-3

3.4 Development Environment for DW Apps........................................................................... 3-3

3.5 Contents on the DVD......................................................................................................... 3-4

3.6 Adding Apps ...................................................................................................................... 3-5

3.6.1 DA Apps and DC Apps......................................................................................... 3-5

3.6.2 DW Apps .............................................................................................................. 3-5

3.6.2.1 Manifest File Creation Procedure............................................................ 3-5

4 Introduction to the Web API ............................................................................................................ 4-1

4.1 Restrictions on Web API Calls........................................................................................... 4-1

4.2 Types of Web API Calls..................................................................................................... 4-2

4.3 Creating a Project .............................................................................................................. 4-3

4.3.1 Data Analysis Function (DA App) ......................................................................... 4-3

4.3.2 Data Collection Function (DC App) ...................................................................... 4-5

4.3.3 Data Window Function (DW App)......................................................................... 4-7

5 Registering Add-On Apps ............................................................................................................... 5-1

5.1 Add/Edit Add-Ons Page..................................................................................................... 5-1

5/25

Page 6: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

1 Introduction to YASKAWA Cockpit1.1 Features

HW1485815

1 Introduction to YASKAWA Cockpit

1.1 Features

YASKAWA Cockpit (abbreviated as "YCP" in this manual) is software that collects data from YASKAWA devices (e.g., robot controllers and machine controllers), monitors the condition and operating status of robots, creates backups of data, provides notification of alarms, and performs other various functions.

• Collects various types of robot data required for analysis and stores that data in the database.

• Using the web API provided by YCP, data analysis and data window add-on application software (called "Add-on Apps" in this manual) can be created that utilize the collected data.

• Created Add-on Apps can be added to and executed in YCP.

Fig. 1-1: Add-On Apps That Can Be Created by the Customer

1.2 Specifications of the Data Analysis Add-On Function

Data analysis Add-on Apps created by the customer can be added to and used in YCP.

Data Collection (DC) Data Analysis (DA) View Analysis Results (DW)

Data collection function Created by customer Created by customer

Solutions for improving productivity(e.g., visualization of operation rate and failure prediction)

Machinecontroller

Robotcontroller

PLC

General datacollection processing

PC (YCP)

Data analysisprocessing

GUI processing

Add-on (DA) Add-on (DW)Add-on (DC)

Database

Web API

YA

SK

AW

A p

rodu

cts

Oth

er p

rodu

cts

Table 1-1: Specifications of the Data Analysis Add-On Function

Item Specifications

Type of software that can be added

Executable filesExample: .EXE

Interface with the database Web API

Reference program(Sample program)

Programming language: C#, C++, Java, Python, etc.

1-1 HW1485815 6/25

Page 7: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

1 Introduction to YASKAWA Cockpit1.3 Specifications of the Data Window Add-On Function

HW1485815

Fig. 1-2: Configuration of the Data Analysis Add-On Function

1.3 Specifications of the Data Window Add-On Function

Data window Add-on Apps created by the customer can be added to and used in YCP.

Fig. 1-3: Configuration of the Data Window Add-On Function

General datacollection processing

Data analysis application software

Data analysisprocessing

Web API

PC (YCP)

Database

Machinecontroller

Robotcontroller

PLC

YA

SK

AW

A p

rodu

cts

Oth

er p

rodu

cts

Table 1-2: Specifications of the Data Window Add-On Function

Item Specifications

Type of software that can be added

The following files contained in a ZIP file are added to YCP.Example:.JSP (JavaServer Pages files),.CSS (stylesheets), .JS (script)

Interface with the database Web API

Reference program(Sample program)

Programming language: JSP

Web API

Data window application software

GUI processing

PC (YCP)

DatabasePLC

Robotcontroller

Machinecontroller

YA

SK

AW

A p

rodu

cts

Oth

er p

rodu

cts

General datacollection processing

Data analysisprocessing

1-2 HW1485815 7/25

Page 8: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

2 Extension Function2.1 Specifications of the Data Collection Add-On Function

HW1485815

2 Extension Function

2.1 Specifications of the Data Collection Add-On Function

Add-on Apps that collect data from non-YASKAWA devices can be added to and used in YCP.

Fig. 2-1: Configuration of the Data Collection Add-On Function

Table 2-1: Specifications of the Data Collection Add-On Function

Item Specifications

Type of software that can be added

Executable filesExample: .EXE

Interface with the database Web API

Reference program(Sample program)

Programming language: C#, C++, Java, Python, etc.

Database

DeviceData collection → Store in database

Data collection application software

(Device other thanrobot controller:e.g., PLC or sensor)

Web API

PC (YCP)

2-1 HW1485815 8/25

Page 9: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

2 Extension Function2.2 Example of Application Software Configuration Using Add-On

HW1485815

Functions

2.2 Example of Application Software Configuration Using

Add-On Functions

There are many different kinds of application software configurations depending on the purpose of the system. The following diagram shows a basic example of a software configuration.

• DC App: Data collection application software

• DA App: Data analysis application software

• DW App: Data window application software

Data collection(e.g., command values, feedback values, and sensor values)

Database GUI processing(e.g., dashboardand monitoring)

OPC UA

Host system

DA App DW App

DC App

Analysis processing (e.g., fault predictionand performance analysis)

2-2 HW1485815 9/25

Page 10: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.1 Configuration of the YCP Development Environment

HW1485815

3 Development Environment

3.1 Configuration of the YCP Development Environment

Fig. 3-1: Configuration of the YCP Development Environment

Program development environment

Machine controller

Robot controller

Ethernet

Pendant

Main CPUS-

選 択

X-S+

X+

L-Y-

L+Y+

U-Z-

U+Z+

7- 7+

R-X-

R+X+

B-Y-

B+Y+

T-Z-

T+Z+

高 速

9

6

3

-.

2

5

87

4

1

0

PC(Windows 10)

Table 3-1: Elements of the YCP Development Environment

No. Device Specifications Remarks

1 Windows computer CPU: Core i7, 4CoreOperating system:Windows 10 Professional 64-bit

Prepared by customer

2 Text editor For creating the source code of the application software.

Prepared by customer

3 Web browser For viewing add-ons. Prepared by customer

4 Complier, linker, libraries, etc.

For creating the executable application software.

Prepared by customer

5 Ethernet cable For connecting the device and computer to provide communications for the developed application software.

Prepared by customer

6 Ethernet hub For connecting the computer and controllers.

Prepared by customer

7 Installation DVD For installing YCP on the Windows computer.

Provided by the manufacturer

3-1 HW1485815 10/25

Page 11: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.2 YCP Development Task Flow

HW1485815

3.2 YCP Development Task Flow

Step Task Details Reference

1. Prepare the development environment.

Install the following items on the computer (program development environment).• YCP• Sample database• Sample source code• Visual Studio for application

development

2. Develop the Add-on App using the sample source code.

1. Replace the default data and sample database created by the installer, and check the behavior of the sample from the web browser.2. Restore the sample database to the original database, and develop the application software to collect, analyze, or view the data.

chapter 4.3 “Creating a Project”

3. Load (add) the App on computer for YCP and verify it with the actual devices.

1. Connect the actual devices and collect actual data.2. Upload the DW Add-on App to YCP and check the GUI.

chapter 5 “Registering Add-On Apps”

4. Adjust the schedule for the resources, such as the CPU load.

1. Check the resources with the YCP resource monitor to determine if data is being lost due to processing delays between application software or if errors are occurring.2. Adjust the execution schedule and other functions based on the content checked with the YCP resource monitor.

3-2 HW1485815 11/25

Page 12: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.3 Development Environments for DA Apps and DC Apps

HW1485815

3.3 Development Environments for DA Apps and DC Apps

The following table gives the development environments for DA Apps and DC Apps.

3.4 Development Environment for DW Apps

The following table gives the development environment for DW Apps.

Table 3-2: Development Environments for DA Apps and DC Apps

Item Development Environment

DA App The following functions can be implemented:• Issue HTTP request and analyze HTTP response• Serialize/deserialize JSONDevelopment tool: Visual C++/C#, Eclipse (Java), etc.

DC App The following functions can be implemented:• Issue HTTP request and analyze HTTP response• Serialize/deserialize JSON• Capable of communicating with the controller for data collection

(supports the physical layer and protocol).Development tool: Visual C++/C#, Eclipse (Java), etc.

Table 3-3: Development Environment for DW Apps

Item Development Environment

DW App Debugging environment contained in the web browser, such as Internet Explorer and Google Chrome, or the Eclipse+ JSDT plug-in.

Web browser Debugging environment

Internet Explorer F12 developer’s toolStart with [F12]

Google Chrome Chrome DevToolsStart with [Ctrl] + [Shift] + [I]

NOTE

• DW Apps are executed in the web browser. For this reason, the source code and other parts of the DW App can be easily viewed and accessed if you use the functions in the web browser. Therefore, do not include any processing that will be problematic if leaked in the DW App, such as proprietary information or algorithms.

3-3 HW1485815 12/25

Page 13: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.5 Contents on the DVD

HW1485815

3.5 Contents on the DVD

The DVD contains the following data and documents.

Table 3-4: Contents on the DVD

Folder Item Contents

Root YCP installer —

Manual (English and Japanese)

YCP Add-On Application SoftwareDevelopment Manual

This manual provides an introduction to YCP and describes installation procedures for the development environments and development methods.

YCP Add-On Application Software Programmer's Manual

This manual describes programming procedures.

YCP Add-On Application SoftwareReference Manual

This manual describes the specifications of the web API.

Manifest file tool Manifest File Tool —

Samples Sample source code —

Sample database —

3-4 HW1485815 13/25

Page 14: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.6 Adding Apps

HW1485815

3.6 Adding Apps

3.6.1 DA Apps and DC Apps

DA Apps and DC Apps can be developed in the customer-selected programming language.

3.6.2 DW Apps

DW Apps are registered from the YASKAWA Cockpit GUI. When registering an App, select the factory, line, cell, and controller to associate with the App, and then register the DW App project file.

When registering the DW App project file, compress the DW App into a ZIP file without using any folders.The DW App must also contain a manifest file (manifest.txt).

The following section gives the procedure for creating the manifest file.

3.6.2.1 Manifest File Creation Procedure

1. On the command prompt, navigate to the location where “manifestTool.jar” has been stored, and then execute the following “java -jar manifestTool.jar” command.The Manifest File Tool will start.

2. Enter the appropriate information for Addon-Title, Addon-Version, and Addon-Vendor.

• AddOn-TitleEnter the name of the Add-on App.

• AddOn-VersionEnter the version number of the Add-on App.

• AddOn-VendorEnter the vendor of the Add-on App.

Click “Clear” to clear the information that was entered.

3-5 HW1485815 14/25

Page 15: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

3 Development Environment3.6 Adding Apps

HW1485815

3. Click “Create File”.

4. Manifest.txt will be created in the same folder as the Manifest File Tool.The content entered for Addon-Title, Addon-Version, and Addon-Vendor are displayed in the following locations on the Add/Edit Add-Ons window.

XXXXX

XXXXX

XXXXX

3-6 HW1485815 15/25

Page 16: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.1 Restrictions on Web API Calls

HW1485815

4 Introduction to the Web API

4.1 Restrictions on Web API Calls

Web API calls conform to HTTP.

The following is an example of a web API call (request).

Table 4-1: Calling the Web API

Item Specifications

Port number The default values are listed below.• HTTP: 8080• HTTPS: 8443

Methods GET, POST, PUT, DELETEThe method depends on the API call.

Request header The following header is required.• Content-Type: application/json

Character encoding UTF-8

HTTP version HTTP1.1

POST/DDMSWeb/api/saveCollectedDataContent-Type: application/json

{"title":"Hello World!", "body":"This is my first post!"}

4-1 HW1485815 16/25

Page 17: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.2 Types of Web API Calls

HW1485815

4.2 Types of Web API Calls

Over 100 types of web API calls have been prepared, including calls for accessing data in the database.For details, refer to the following manual.

YASKAWA Cockpit Add-on Application Software Web API Reference Manual (HW1485817)

Table 4-2: Examples of Web API Calls

Web API (HTTP) Call Description

GET /apps/{appname}/validate Validates the application software license. It returns the validation result and expiration date of the specified App.

GET /factories Retrieves the list of factories. It returns all factory keys registered to this YCP. If no factories are registered, a blank array is returned ("[]").

GET /factories/{factory-key}/lines

Retrieves the list of lines. It returns all line keys registered to the factory defined by factory-key. If no lines are registered, a blank array is returned ("[]").

GET /factories/{factory-key}/lines/{line-key}/cells

Retrieves the list of cells. It returns all cell keys registered to the factory defined by factory-key and line-key. If no cells are registered, a blank array is returned ("[]").

: :

GET /factories/{factory-key}/lines/{line-key}/cells/{cell-key}/controllers/{controller-key}/attributegroups

Retrieves the attribute group keys for the controller attributes. If there are no groups, a blank array is returned ("[]").

GET /factories/{factory-key}/lines/{line-key}/cells/{cell-key}/controllers/{controller-key}/data

Retrieves raw data related to the controller. Raw data is returned in JSON format. A sample response is contained in "Other Documents" (/apidoc/sample-getdata.html). If there is no data, a blank array is returned ("[]").

POST /factories/{factory-key}/lines/{line-key}/cells/{cell-key}/controllers/{controller-key}/data

Stores collected data (raw data) to YCP System Core. Collected data is passed in the body of a request and stored in the database.

: :

GET /factories/{factory-key}/lines/{line-key}/cells/{cell-key}/controllers/{controller-key}/data

Retrieves raw data related to the controller. Raw data is returned in JSON format. A sample response is contained in "Other Documents" (/apidoc/sample-getdata.html). If there is no data, a blank array is returned ("[]").

DELETE /factories/{factory-key}/lines/{line-key}/cells/{cell-key}/controllers/{controllerkey}/data/items/{item-key}

Deletes an item setting for collected data of the controller.

: :

4-2 HW1485815 17/25

Page 18: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

4.3 Creating a Project

4.3.1 Data Analysis Function (DA App)

The following diagram shows the configuration of a DA App.

Fig. 4-1: Configuration of a DA App

A DA App takes data collected from controllers, mechanisms, and devices in the database and analysis results, attributes, and files of other DA Apps as input, and it stores the results of executing various types of processing, such as data analysis and data processing, to the database. The App is implemented as a separate executable file from YASKAWA Cockpit.

The executable file can be implemented at the following types of application software:

• Java (.jar, .war)

• C++, C# (.exe)

• Script (.rb, .php, etc.)

Scripts require the execution environment for each type of file. For example, .rb files require Ruby to be installed on the server that will execute the file, and .php files require PHP to be installed.

YASKAWA Cockpit

Web API

Database

Web server

Standard GUI (Web contents)

Add-onGUI

Retrieve/Store/Modify Data

Data analysisapplication software

(DA App) DA App

4-3 HW1485815 18/25

Page 19: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

The following diagram shows the configuration of DA App functions.

Fig. 4-2: Configuration of DA App Functions

The web API provided by the YASKAWA Cockpit web server is used to store data to and read data from the database. Therefore, the DA App can be executed on the computer that runs YASKAWA Cockpit, and it can also be executed on a separate device (e.g., computer) connected to the network. Data processing, such as aggregating and analyzing data, can be performed using data obtained through the web API. A DA App can also have its own unique user interface.

As additional functions, the App has a scheduler that can manage the time of each function, a thread manager that can execute functions in threads, and a function to output execution results to a log.

The App also has a function to register OPC UA reference data when retrieving data stored to the database from an OPC UA server.

Information view specificto device configuration

*Device configuration: line, cell, controller, mechanism, device

GUI

App settings

DA App

Aggregation/statistical analysis/learning

Retrieve analytical model

Thread Manager Log Output

Execute analytical model

etc

etc

Web API calls

Event notification

Retrieve data Register data

Retrieve deviceconfiguration information etc

SchedulerOPC UA Reference Data Registration

4-4 HW1485815 19/25

Page 20: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

4.3.2 Data Collection Function (DC App)

The following diagram shows the configuration of a DC App.

Fig. 4-3: Configuration of a DC App

A DC App collects data related to controllers, mechanisms, and devices, and transmits the collected data to the database. The App is implemented as a separate executable file from YASKAWA Cockpit.

The executable file can be implemented at the following types of application software:

• Java (.jar, .war)

• C++, C# (.exe)

• Script (.js, .rb, .php, etc.)

Store data

Data collectionapplication software

(DC App) DC App

Collect data

Database

YASKAWA Cockpit

Web API

Web server

Standard GUI(Web contents)

Add-onGUI

4-5 HW1485815 20/25

Page 21: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

The following diagram shows the configuration of DC App functions.

Fig. 4-4: Configuration of DC App Functions

To collect data from controllers, mechanisms, and devices, the DC App must be compatible with the communications medium and protocol for each controller, mechanism, and device. The web API provided by the YASKAWA Cockpit web server is used to store data to and read data from the database. Therefore, the DC App can be executed on the computer that runs YASKAWA Cockpit, and it can also be executed on a separate device (e.g., computer) connected to the network. A DC App can also have its own unique user interface.

As additional functions, the App has a scheduler that can manage the time of each function, a thread manager that can execute functions in threads, and a function to output execution results to a log.

The App also has a function to register OPC UA reference data when retrieving data stored to the database from an OPC UA server.

DC App

Controller access

Robot controller connection

Machine controller connectionetc

Information view specificto device configuration

*Device configuration: line, cell, controller, mechanism, device

GUI

App settings

Thread Manager Log Output

etc

Web API calls

Event notification

Retrieve data Register data

Retrieve deviceconfiguration information etc

SchedulerOPC UA Reference Data Registration

4-6 HW1485815 21/25

Page 22: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

4.3.3 Data Window Function (DW App)

The following diagram shows the configuration of a DW App.

Fig. 4-5: Configuration of a DW App

A DW App can be associated with factories, lines, cells, or controllers to visualize data (collected data, analysis results, attributes, and files) stored in the database.

When a DW App is registered in YASKAWA Cockpit, it is stored to the file system. To use a DW App, access the YASKAWA Cockpit GUI from a web browser, and click the menu of the DW App from the page on the level at which the DW App has been associated. When the DW App is started, the App stored in storage is loaded, rendered, and executed in the web browser.

Therefore, DW Apps can use the following features and documents supported as standard by the web browser.

• HTML documents (.html and .jsp)

• Images (.jpg, .png, .gif, etc.)

• Stylesheets (.css)

• JavaScript (.js)

YASKAWA Cockpit

Web API

Web server

Standard GUI(Web contents)

Add-onGUI

Web browser

Retrieve/Store/Modify DataLoad contents

GUI(Web contents)

Add-onGUI

DW App

DW App

Database

Operating systemFile system

4-7 HW1485815 22/25

Page 23: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

4 Introduction to the Web API4.3 Creating a Project

HW1485815

The following diagram shows the configuration of DW App functions.

Fig. 4-6: Configuration of DW App Functions

You can create a GUI that accesses and modifies data (collected data, analysis results, attributes, and files) held in YASKAWA Cockpit by calling the web API using JavaScript.

Information view specificto device configuration•Analysis data•Stored controller data

*Device configuration: line, cell, controller, mechanism, device

GUI

App settings

DW App

Log Output

etc

Web API calls

Event notification

Retrieve data Register data

Retrieve deviceconfiguration information

etc

4-8 HW1485815 23/25

Page 24: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

5 Registering Add-On Apps5.1 Add/Edit Add-Ons Page

5-1

HW1485815

HW1485815

5 Registering Add-On Apps

5.1 Add/Edit Add-Ons Page

Fig. 5-1: Add/Edit Add-Ons Page

"Add"

Use this button to display the following page on which you can add an add-on.

Fig. 5-2: Add-On Page

• UI NameSpecify the name of the add-on.

• DescriptionSpecify a comment about the add-on.

• Zip FileThis can be used to upload the add-on module.

• Register UI to Select the target that will display the add-on.

"Edit"

Use this button to edit the content registered for the applicable add-on.

"Delete"

Use this button to delete the applicable add-on.

Delete3

Edit2

Add1

1

2

3

24/25

Page 25: YASKAWA Cockpit Add-on Application Software Development … 2019. 1. 17. · 1 Introduction to YASKAWA Cockpit 1.1 Features 1-1 HW1485815 HW1485815 1 Introduction to YASKAWA Cockpit

YASKAWA CockpitAdd-on Application SoftwareDevelopment Manual

HEAD OFFICE2-1 Kurosakishiroishi, Yahatanishi-ku, Kitakyushu 806-0004, JapanPhone +81-93-645-7703 Fax +81-93-645-7802

100 Automation Way, Miamisburg, OH 45342, U.S.A. Phone +1-937-847-6200 Fax +1-937-847-6277

YASKAWA America Inc. (Motoman Robotics Division)

Yaskawastrasse 1, 85391 Allershausen, GermanyPhone +49-8166-90-100 Fax +49-8166-90-103

YASKAWA Europe GmbH Robotics Divsion )

Phone +82-2-784-7844 Fax +82-2-784-8495

151 Lorong Chuan, #04-02A, New Tech Park, Singapore 556741Phone +65-6282-3003 Fax +65-6289-3003

YASKAWA Electric (Singapore) PTE Ltd.

No7 Yongchang North Road, Beijing E&T Development Area China 100176Phone +86-10-6788-2858 Fax +86-10-6788-2878

YASKAWA SHOUGANG ROBOT Co. Ltd.

#426, Udyog Vihar, Phase- IV, Gurgaon, Haryana, IndiaFax +91-124-475-8542Phone +91-124-475-8500

YASKAWA India Private Ltd. (Robotics Division)

YASKAWA Electric (China) Co., Ltd.22F, One Corporate Avenue, No.222, Hubin Road, Huangpu District, Shanghai 200021, ChinaPhone +86-21-5385-2200 Fax 86-21-5385-3299

YASKAWA Electric (Thailand) Co., Ltd.59,1st-5th Floor, Flourish Building, Soi Ratchadapisek 18,Ratchadapisek Road, Huaykwang, Bangkok 10310, THAILANDPhone +66-2-017-0099 Fax +66-2-017-0199

12F, No.207, Sec. 3, Beishin Rd., Shindian District, New Taipei City 23143, TaiwanFax +886-2-8913-1513Phone +886-2-8913-1333

YASKAWA Electric Taiwan Corporation

Secure Building-Gedung B Lantai Dasar & Lantai 1 JI. Raya Protokol Halim Perdanakusuma, Jakarta 13610, Indonesia

Fax +62-21-2982-6741Phone +62-21-2982-6470

PT. YASKAWA Electric Indonesia

Phone +46-480-417-800 Fax +46-486-414-10

YASKAWA Nordic ABVerkstadsgatan 2, Box 504 ,SE-385 25 Torsas, Sweden

35F, Three IFC, 10 Gukjegeumyung-ro, Yeongdeungpo-gu, Seoul, Korea 07326YASKAWA Electric Korea Corporation

HW1485815

C 2018 YASKAWA ELECTRIC CORPORATION

December 2018 18-12

Published by YASKAWA

MANUAL NO.

25/25


Top Related