News CNCnetPDM About us Support  
       
  

DRIVER DEVELOPMENT KIT | FANUC

TOP

This driver development kit enables you to create your own driver for Focas enabled Fanuc controllers within minutes with minimal effort. You can quickly implement any function from the Fanuc Focas Library and output data needed for your projects.

DESCRIPTION | DOWNLOAD | LICENSING | SETUP | USAGE | INI FILE | ADJUST ITEMS | ADD ITEMS | EXAMPE: ADD PROGRAM NUMBER | DEBUG DRIVER | UPGRADE DRIVER

DESCRIPTION

The kit was built with Visual Studio 2017, you can use Visual Studio Community 2017 (free). It also was tested and can be used with other versions of Visual Studio >= 2008. Instructions can be found here.

The kit contains 3 pre-built example functions from the Fanuc Focas Library. You can modify them or add your own items:

DOWNLOAD SOFTWARE

LICENSING

The driver development kit also works with the free license of CNCnetPDM. However, in this mode you only get output for the first function in your DLL. With a valid license you are able to output the result of up to 30 functions per reading cycle, see licensing for details.

SETUP

  • If you’re using Visual Studio Community 2017 make sure that the following components are installed: Desktop Development with C++, Windows XP support for C++ and MFC and ATL support
  • Extract all contents of fanucdeveloper.zip to a folder on your PC and navigate to this folder
  • Copy customfanuc.dll from this folder to the directory where CNCnetPDM.exe is installed
  • With Visual Studio 2017 simply open the project myfanuc.sln, for other versions of Visual Studio follow these instructions
  • Compile the project once and make sure that you don’t get errors..

USAGE

You only have to modify the content of file myfanuc.cpp to implement any function from the Fanuc Focas Library. Select Solution Explorer, open section Source Files and double click myfanuc.cpp.

INI FILE

Your device driver uses an own INI file that is automatically created by customfanuc.dll if it doesn’t exist. It enables you to activate/deactivate specific items and define Tag names for them. It always automatically gets the name customfanuc with the machine number added (as defined in CNCnetPDM.ini) e.g. customfanuc_1000.ini for device number 1000.

If it doesn’t exist customfanuc.dll creates it with 3 activated entries and one deactivated template that can be used for new functions.

The INI file contains numeric section identifiers. Each identifier contains information about an acquired item. For example

[2]
Active = 1
Name = AUTNR
Comment = Automatic mode number
Output section = 1

FIG 1:    INI file section

Means item number 2 should be acquired (Active = 1) and its Tag name is AUTNR. Tag names can have up to 5 characters. Output acquired by this function should be added to section 1, you can use up to 3 sections (1,2 or 3). Each section can contain up to 256 characters. For long items e.g. axis position it is recommended to use an own section.

Once the INI file is created its content can be manually modified at runtime without the need to restart the main service.

ADJUST ITEMS

Items can be adjusted and added in class DeviceRead. Most of the Fanuc Focas function calls use a specific structure that is mentioned in the documentation. For example cnc_statinfo uses structure ODBST. So, the first thing you have to do is to include this structure and assign a name for it e.g.

DBST odbst; // Machine State structure
FIG 2:    Include and name structure

Now you can call the function with

ret = cnc_statinfo(hFanuc, &odbst); // Machine status
if (!ret) // If it worked
sprintf(m_stat.cReturn, "%d", odbst.aut);
FIG 3:    Execute function

cnc_statinfo is the function, hFanuc is the handle and &odbst is a pointer to structure ODBST. If (!ret) means: Perform the following commands if the function does NOT return anything else than EW_OK (0). If successful you can use the values returned by the function call to output them or perform additional calculations. The values are returned as structure members. ODBST is defined as

typedef struct odbst {
    short   hdck ;      /* handl retrace status */
    short   tmmode ;    /* T/M mode */
    short   aut ;       /* selected automatic mode */
    short   run ;       /* running status */
    short   motion ;    /* axis, dwell status */
    short   mstb ;      /* m, s, t, b status */
    short   emergency ; /* emergency stop status */
    short   alarm ;     /* alarm status */
    short   edit ;      /* editting status */
} ODBST ;
FIG 4:    Members of structure ODBST

In this example these values can be directly used as odbst.aut or odbst.run a.s.o in your program.

The result of a successful function call is copied to mstat.cReturn which is automatically read by customfanuc.dll and added to the output section you defined.

Output sections contain one or more items in the form of tag name + pipe delimiter | + output value. You can add the result from multiple queries to a single section. 3 sections are available each one can contain up to 256 characters.

The sections are read by the main service which then creates database records or text files that contain GROUP_ID, READING_TIME, DEVICE_NUMBER, TAG_CODE, TAG_DATA, CREATION_DATE and PROCESSING_FLAG for each item acquired e.g.:

10000000001  2017-06-29 16:38:28.000        1001    AUTNR            1          2017-06-29 16:38:28.000   2

FIG 5:    Output of records with tags and value

ADD ITEMS

It is highly recommended that you make a backup of file myfanuc.cpp (simply copy and paste it into the same folder) before adding items.

For an additional item it may be necessary to increase the number of commands in your INI file.

[GENERAL]
Commands = 6

FIG 6:    Increase number of commands

To add the program number (modal O number) of the program which is currently selected at the controller proceed as follows.

Modify the template section [5] or add a new one e.g.

[6]
Active = 1
Name = MNPRG
Comment = Main Program
Output section = 1

FIG 7:    Add an additional INI file section

Program number can be read by function cnc_rdprgnum which uses structure ODBPRO. In class DeviceReadExt add:

ODBPRO odbpro; // Program number
FIG 8:    Assign a name for structure ODBPRO

Next, add an additional switch to class DeviceReadExt:

case 6:
ret = cnc_rdprgnum(hFanuc, &odbpro); // Program Number 
if (!ret)
	sprintf(m_stat.cReturn, "%d", odbpro.mdata); // If successful add to output
break;
FIG 9:    Call function for program number

You have successfully added program number to your driver!

Note: As the program number is numeric you have to use %d as 2nd argument of the sprintf command. For text output you have to use %s. More information about these parameters can be found here.

DEBUG YOUR DRIVER

To debug your driver follow these steps:

Compile the debug version of myfanuc.dll.

Copy myfanuc.dll from the debug directory of your project to the folder where CNCnetPDM.exe is located. Make sure that customfanuc.dll and all Fanuc Focas DLL files are also in this directory. Install one of the Fanuc device drivers if not.

Change the content of section [RS232] of CNCnetPDM.ini to use customfanuc.dll e.g.:

1 = 1001;19200;8;N;1;DEV #1;192.168.1.100;8193;0;FANUC;7;6711;none;none;0;customfanuc.dll

Start CNCnetPDM and make sure it uses your new driver. You can see that because CNCnetPDM copies customfanuc.dll and adds the machine number to it e.g. customfanuc_1001.dll. If no INI file for machine 1001 exists it also creates a new INI file with 3(!) active entries e.g. customfanuc_1001.ini.

Then, check the content of the log file for your device in subfolder \log (File name = log_ + machine number + _ + date + .txt). Errors reported by the device driver are added to this file. For example ‘Error(s) reported by device 1000: INIT: Windows socket error’ means that your controller is not reachable at all.

Note:   If you have added new items or changed existing ones please adjust the INI file (number of items, sections) for the device according to your definitions in myfanuc.cpp before starting CNCnetPDM.

If your new items are missing or incorrect, stop the service, fix the error, rebuild myfanuc.dll, copy it again to the folder with CNCnetPDM.exe and adjust your INI file. Then, start CNCnetPDM.

To debug the driver set at least one breakpoint in myfanuc.cpp. A good place to start is in class DeviceReadExt in the line that starts with: switch (iPass)

In Visual Studio (with CNCnetPDM running!) click Debug -> Attach to Process, select CNCnetPDM.exe and click Attach.

As soon as the breakpoint is reached you can follow the execution of the program by clicking F10 and see the results of function calls and values of variables.

Note: If you make changes to your source code and rebuild the driver please adjust the INI file for the device (e.g. customfanuc_1001.ini) before starting to debug again.

UPGRADE DRIVER

If you already have a previous version of the driver installed and would like to upgrade to the most recent version proceed as follows:

  1. Stop any CNCnetPDM background service or foreground program that uses the device driver
  2. Delete all customfanuc_NNNN.dll (NNNN = machine number) files. If you already have created adapted INI files for specific devices do NOT delete the customfanuc_NNNN.ini files
  3. Extract customfanuc.dll from fanucdeveloper.zip into the folder where you have CNCnetPDM installed, overwrite the existing file
  4. After restarting CNCnetPDM upgraded device driver versions for all machines are automatically created.

Privacy notice

This website uses cookies. By continuing to use it you agree to our privacy policy. 

https://www.inventcom.net/support/fanuc/driver-development-kit

Support | Fanuc | Release Notes

(11/19/2023) We released an updated version of our CNCnetPDM IIoT Adapter for machines with Fanuc controls that adds new features and enhances compatibility with MS Windows 11... [read more]
Support | Fanuc | Release Notes

Support | Fanuc | Overview

CNCnetPDM for Fanuc controllers enables you to monitor machine-, process and quality data from a remote PC and integrate the data seamlessly with your business information... [read more]
Support | Fanuc | Overview

Support | Fanuc | Universal Driver

This device driver enables you to create your own set of items from the Fanuc FOCAS library , without the need for... [read more]
Support | Fanuc | Universal Driver

Support | Fanuc | Machine Data

By using the utility program FanucDataGui you can acquire and output information and performance related machine data from your FOCAS enabled Fanuc controllers. By using our... [read more]
Support | Fanuc | Machine Data

Support | Fanuc | Read Diagnosis Data

To find out reasons for errors, monitor temperatures or power consumption or read diagnostic data from spindles, servos and other components Fanuc diagnosis data is needed. This... [read more]
Support | Fanuc | Read Diagnosis Data

Support | Fanuc | Read PMC Values

For machine-data acquisition it’s often necessary to access, read and use data stored at the PLC (Fanuc: PMC) of a controller. For machines equipped with FOCAS-enabled... [read more]
Support | Fanuc | Read PMC Values

Support | Fanuc | Read Write Parameters

For various items such as cycle time, spindle & axis control or tool life management it is necessary to read parameter values from controllers. If you’d like to... [read more]
Support | Fanuc | Read Write Parameters

Support | Fanuc | Focas Library CD

FANUC FOCAS 1/2 LIBRARY CD,Version 4.15 (2018) Fanuc Part No. A02B-0207-K737: Enables you to develop customized applications for Fanuc FOCAS enabled controllers connected to a PC... [read more]
Support | Fanuc | Focas Library CD
Modified: 2023-11-28