LogoLogo
Contact Uscybus.io
Connectware 1.10.1
Connectware 1.10.1
  • Getting Started
    • Introduction
    • System Requirements
    • Connectware Admin UI
    • Basic Components of Connectware
    • Connecting your First Machine
      • Your First Service Commissioning File
  • Documentation
    • Installation and Upgrades
      • Installing Connectware
        • Installing Connectware (Kubernetes)
        • Installing Connectware (Docker)
      • Upgrading Connectware
        • Upgrading Connectware (Kubernetes)
          • Version-Specific Upgrades (Kubernetes)
        • Upgrading Connectware (Docker)
          • Version-Specific Upgrades (Docker)
      • Uninstalling Connectware
        • Uninstalling Connectware (Kubernetes)
        • Uninstalling Connectware (Docker)
      • Licensing
    • User Management
      • Users and Roles View
      • Users
      • Roles
      • Permissions
      • Password Policy Rules
      • Default Admin User
      • MQTT Users
      • Adding a MQTT Publish Prefix for Users
      • Multi-Factor Authentication
      • Single Sign-On (SS0)
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with LDAP
      • JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
    • Services
      • Service Overview
      • Service Resources View
        • Service Links View
        • Servers View
        • Containers View
        • Volumes View
        • Connections View
        • Endpoints View
        • Mappings View
      • Service Details View
      • Service Commissioning Files
        • Version
        • Description
        • Metadata
        • Parameters
        • Definitions
        • Resources
          • Cybus::Connection
          • Cybus::Container
            • Docker Problem with Network Changes
          • Cybus::Endpoint
          • Cybus::File
          • Cybus::IngressRoute
          • Cybus::Link
          • Cybus:Mapping
          • Cybus::Node
          • Cybus::Role
          • Cybus::Server
          • Cybus::User
          • Cybus::Volume
      • Setting Up and Configuring Services
        • Installing Services
        • Enabling Services
        • Updating Services
        • Disabling Services
        • Deleting Services
      • FlowSync
        • Example 1 - Node with Transaction Mode (HTTP)
        • Example 2 - Node Responds (HTTP)
        • Example 3 - Node with Error (HTTP)
        • Example 4 - Node with Timeout Error Code and Error Message (HTTP)
        • Example 5 - Full Transactional Data Flow (HTTP)
        • Example 6 - Full Transactional Data Flow (OPC UA)
      • ServiceID
      • Inter-Service Referencing
      • Deviation
      • Service Logs
        • Logs of Individual Services
        • Logs of All Services
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • Shared Subscriptions
        • Setting Up Shared Subscriptions
    • Agents
      • Agents View
      • Installing Agents
        • Installing Agents via Docker
        • Installing Agents via Docker Compose
        • Installing Agents via Kubernetes
        • Using Mutual TLS for Agents
      • Registering Agents in Connectware
      • Using Agents
      • Monitoring Agents
      • Agents in Kubernetes
        • Adding Agents Inside your Connectware Installation
        • Remote Agents with the connectware-agent Helm Chart
        • Kubernetes Cluster Requirements for the connectware-agent Helm Chart
        • Installing Connectware Agents using the connectware-agent Helm Chart
        • Installing Connectware Agents without a License Key Using the connectware-agent Helm Chart
        • Upgrading the connectware-agent Helm Chart
        • Uninstalling Connectware agents with the connectware-agent Helm chart
        • Configuration Principles for the connectware-agent Helm Chart
        • Configuring Agents with the connectware-agent Helm Chart
          • Configuring Target Connectware for the connectware-agent Helm Chart
          • Configuring Agent Persistence for the connectware-agent Helm Chart
          • Configuring Compute Resources for the connectware-agent Helm Chart
          • Using a Custom Image Registry for the connectware-agent Helm Chart
          • Configuring Image Pull Policy for the connectware-agent Helm Chart
          • Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
          • Configuring image name and version for the connectware-agent Helm chart
          • Configuring Environment Variables for the connectware-agent Helm Chart
          • Configuring Labels and Annotations for the connectware-agent Helm Chart
          • Configuring podAntiAffinity for the connectware-agent Helm Chart
          • Assigning Agents to Kubernetes Nodes for the connectware-agent Helm Chart
          • Configuring Security Context for the connectware-agent Helm Chart
          • Controlling the Name of Kubernetes Objects for the connectware-agent Helm Chart
      • Troubleshooting Agents
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
    • Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Workbench
      • Flows in Git Repositories
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
    • Backup and Restore
      • Volumes
      • User Database
    • Connectware on Kubernetes
      • Connectware Helm Chart
      • Resizing Broker Volumes in Kubernetes
      • Configuring Core Services
      • LDAP Authentication
        • Configuring LDAP Authentication
        • Enabling TLS for LDAP Authentication
        • Manual Kubernetes Secret for LDAP Authentication Bind User
        • Customizing the Search Filter for LDAP Authentication
        • Customizing the User RDN for LDAP Authentication
      • Troubleshooting Connectware on Kubernetes
    • Environment Variables
    • Industry Protocol Details
      • ADS
        • ADS Connection Properties
        • ADS Endpoint Properties
      • BACnet
        • BACnet Connection Properties
        • BACnet Endpoint Properties
      • Custom Connectors
        • Developing Custom Connectors
        • Deploying Custom Connectors
        • Using Custom Connectors
      • EtherNet/IP
        • EtherNet/Ip Connection Properties
        • EtherNet/Ip Endpoint Properties
      • FOCAS
        • FOCAS Connection Properties
        • FOCAS Endpoint Properties
      • Hottinger Baldwin Messtechnik (HBM)
        • HBM Connection Properties
        • HBM Endpoint Properties
      • Heidenhain DNC
        • Heidenhain DNC Connection Properties
        • Heidenhain DNC Endpoint Properties
      • HTTP/REST
        • HTTP/REST Connection Properties
        • HTTP/REST Endpoint Properties
      • HTTP Server/Node
        • HTTP Server Properties
        • HTTP Node Properties
      • InfluxDB
        • InfluxDB Connection Properties
        • InfluxDB Endpoint Properties
      • Kafka
        • Kafka Connection Properties
        • Kafka Endpoint Properties
      • Modbus/TCP
        • Modbus/TCP Connection Properties
        • Modbus/TCP Endpoint Properties
      • MQTT
        • MQTT Connection Properties
        • MQTT Endpoint Properties
      • MSSQL
        • Mssql Connection Properties
        • Mssql Endpoint Properties
      • OPC DA
        • OPC DA Connection Properties
        • OPC DA Endpoint Properties
      • OPC UA
        • OPC UA Client
          • OPC UA Client Connection Properties
          • OPC UA Client Endpoint Properties
        • OPC UA Server
          • OPC UA Server Properties
          • OPC UA Node Properties
        • OPC UA Object Types
        • OPC UA Server References
          • OPC UA Reference Node
          • OPC UA Object Node
      • Siemens SIMATIC S7
        • Siemens S7 Connection Properties
        • Siemens S7 Endpoint Properties
      • Shdr
        • Shdr Connection Properties
        • Shdr Endpoint Properties
      • SINUMERIK
        • SINUMERIK Connection Properties
        • SINUMERIK Endpoint Properties
      • SOPAS
        • SOPAS Connection Properties
        • SOPAS Endpoint Properties
      • SQL
        • SQL Connection Properties
        • SQL Endpoint Properties
      • Werma WIN Ethernet
        • Werma WIN Ethernet Connection Properties
        • Werma WIN Ethernet Endpoint Properties
      • Systemstate
        • Systemstate Connection Properties
        • Systemstate Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Industry Protocol Details (API)
    • Changelog
      • General changes from 0.x to 1.0
        • Upgrading from 0.x to 1.0
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • Focas Methods
  • Service Commissioning File Example

Was this helpful?

  1. Documentation
  2. Industry Protocol Details

FOCAS

PreviousEtherNet/Ip Endpoint PropertiesNextFOCAS Connection Properties

Last updated 3 months ago

Was this helpful?

This module implements FANUC’s Focas protocol connectivity allowing the user to collect different data from a FANUC CNC machine.

This protocol implementation allows the communication to such devices and provides the user the ability to create endpoints for reading and subscribing for changes on the data provided by them.

Below you can see configuration parameters and examples on how to build a commissioning file for this protocol.

Focas Methods

Available Focas methods. For full details of each method please consult the Focas documentation.

Subscribe methods

All endpoints utilizing these methods have to be defined as endpoints with the subscribe operation. The output will be provided as JSON object.

cnc_exeprgname

Reads the full path name of the program which is currently being executed in CNC.

Example output:

{ 'id': 1, 'timestamp': 1637339279827, 'value': { 'name': 'SAMPLE', 'o_num': 0 } }

cnc_rdgcode

Reads the information of CNC about the commanded G code.

Required properties:

  • type

  • block

  • numGcd

Example output:

{ 'id': 1, 'timestamp': 1637339824109, 'value': { 'code': 'G01', 'flag': 0, 'group': 0 } }

cnc_rdopnlsgnl

Reads the output signal image of software operator’s panel.

Required properties:

  • slctData

Example output:

{
    'id': 1,
    'timestamp': 1637339309823,
    'value':
        {
            'blck_del': 0,
            'datano': 16723,
            'dry_run': 0,
            'feed_hold': 0,
            'feed_ovrd': 0,
            'hndl_ax': -1,
            'hndl_mv': 0,
            'jog_ovrd': 0,
            'machn_lock': 0,
            'mem_prtct': 0,
            'mode': 2,
            'rpd_ovrd': 0,
            'sngl_blck': 0,
            'spdl_ovrd': 0,
            'type': 32767,
        },
}

cnc_rdprgnum

Reads the program number (modal O number) of the program which is currently selected in CNC.

Example output:

{ 'id': 1, 'timestamp': 1637339187748, 'value': { 'data': 0, 'mdata': 0 } }

cnc_rdspeed

Reads the actual feed rate and the actual rotational speed of the main spindle.

Required properties:

  • dataType

Example output:

{
    'id': 1,
    'timestamp': 1637339711053,
    'value':
        {
            'actf': { 'data': 1600, 'dec': 0, 'disp': 0, 'name': 'F', 'suff': "\u0000", 'unit': 0 },
            'acts': { 'data': 751, 'dec': 0, 'disp': 1, 'name': 'S', 'suff': ' ', 'unit': 2 },
        },
}

cnc_rdspload

Reads the load information of the serial spindle.

Required properties:

  • spindleNumber

Example output:

{ 'id': 1, 'timestamp': 1637339785074, 'value': { 'data': [820, 19744, 12615, 23089, 14129, 12590, 13104, 0], 'datano': 1, 'type': 32 } }

cnc_statinfo2

Reads the status information of CNC.

Example output:

{
    'id': 1,
    'timestamp': 1637339042705,
    'value':
        {
            'alarm': 0,
            'aut': 1,
            'edit': 0,
            'emergency': 0,
            'ext_opt': 0,
            'hdck': 0,
            'motion': 1,
            'mstb': 0,
            'o3dchk': 0,
            'restart': 0,
            'run': 3,
            'tmmode': 0,
            'warning': 0,
        },
}

cnc_sysinfo

Reads system information such as kind of CNC system, Machining(M) or Turning(T), series and version of CNC system software and number of the controlled axes.

Example output:

{
    'id': 1,
    'timestamp': 1637339898044,
    'value': { 'addinfo': 2, 'axes': '03', 'cnc_type': '31', 'max_axis': 32, 'mt_type': ' M', 'series': 'G11Z', 'version': '17.1' },
}

pmc_rdpmcrng

Reads the PMC data of the specified PMC address/range.

Required properties:

  • addressType

  • dataType

  • addressStart

  • addressEnd

  • dataLength

Example output:

{ 'id': 1, 'timestamp': 1637341486343, 'value': { 'cdata': [100, 51, 34, 44, 34], 'datano_e': 30, 'datano_s': 30, 'type_a': 0, 'type_d': 0 } }

Read methods

All endpoints utilizing these methods have to be defined as endpoints with the read operation since they require input provided on the request-topic (req). The output will be provided as JSON object.

For read endpoints, additionally a correlation ID (id) can be set in the payload of the request message, to ensure the correct identification of responses to specific requests.

program_download

The program code string has to be formatted in a certain way to be processable by the method. To convert the program to this format the following steps have to be applied to the program code:

  1. Insert a leading line break ; all data before that will be ignored

  2. Replace all line breaks with

  3. Remove all space characters

  4. Remove all semicolons

The example code:

O1234 ;
G1 F0.3 W10. ;
M30 ;
%

would be converted to the string:

\nO1234\nG1F0.3W10.\nM30\n%

The program will be downloaded to the directory which is set as “Background Folder” in the Fanuc controller.

Example output:

{ 'id': 1, 'timestamp': 1637340781387 }

Service Commissioning File Example

focas-example.yml
description: >
    Sample Focas service commissioning file

metadata:
    name: Sample Focas service
    icon: https://www.cybus.io/wp-content/uploads/2017/10/for-whom1.svg
    provider: cybus
    homepage: https://www.cybus.io
    version: 1.0.0

parameters:
    focasHost:
        type: string
        default: 192.168.2.170

    focasPort:
        type: integer
        default: 8193

    initialReconnectDelay:
        type: integer
        default: 1000

    maxReconnectDelay:
        type: integer
        default: 30000

    factorReconnectDelay:
        type: integer
        default: 2

resources:
    focasConnection:
        type: Cybus::Connection
        properties:
            protocol: Focas
            connection:
                host: !ref focasHost
                port: !ref focasPort
                connectionStrategy:
                    initialDelay: !ref initialReconnectDelay
                    maxDelay: !ref maxReconnectDelay
                    incrementFactor: !ref factorReconnectDelay

    subscribeExample1:
        type: Cybus::Endpoint
        properties:
            protocol: Focas
            connection: !ref focasConnection
            subscribe:
                method: 'cnc_statinfo2'
                interval: 3000

    readExample1:
        type: Cybus::Endpoint
        properties:
            protocol: Focas
            connection: !ref focasConnection
            read:
                method: 'cnc_sysinfo'

Download the specified NC data to the controller. For this method, you will need to specify a valid G-code program (see e.g. ) in the message payload as string value of the value key and publish it on the endpoint’s request topic (req).

Connection Properties
Endpoint Properties
https://en.wikipedia.org/wiki/G-code
1KB
focas-example.yml