Connect IoT - IPC-CFX Driver#

IPC-CFX is an industry-developed open international standard forming the foundation/backbone of Factory of the Future applications. IPC-CFX is a plug-and-play solution that simplifies and standardizes machine-to-machine communication while also facilitating machine-to-business and business-to-machine applications.

IPC-CFX is based on IPC-2591, Connected Factory Exchange (CFX), and both are managed by the IPC 2-17 Connected Factory Initiative Subcommittee. The subcommittee ensures IPC-2591 and the IPC-CFX SDK continue to meet the growing needs of industry by releasing regular version updates.

Data Types#

These are the supported specific data types:

Table: IPC-CFX specific data types.

Protocol Parameters#

The protocol supports the following parameters, used to define the communication parameters, as well as the expected behavior of the driver:

Table: IPC-CFX specific parameters.

.net Core SDK#

This driver requires minimal version .net core sdk 2.x to work, recommended is 6.x.

If you have multiple versions of .net core installed, the driver will not know exactly which to use, so this setting is required to pinpoint exactly what to use.

Identify the installed versions#

Run the following command in a terminal/command prompt window:

dotnet --list-sdks

and you should get a result. This one is just an example:

dotnet --list-sdks
2.2.207 [C:\Program Files\dotnet\sdk]
5.0.103 [C:\Program Files\dotnet\sdk]
6.0.407 [C:\Program Files\dotnet\sdk]

if you have multiple results, select the one that starts with "6." and enter it in the netCoreSdkVersion communication parameter. Using the above result as reference, the value set would be "6.0.407". The next time the driver starts, a control file global.json will be created at the base directory of the driver with the following content:

{
    "sdk": {
        "version": "6.0.407"
    }
}

This will indicate the exact version of the .net core sdk to use when instancing a version of the driver.

Extended Parameters#

Event#

All Automation Events defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Table: IPC-CFX specific extended events.

Command#

All Automation Command defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Table: IPC-CFX specific command.

Driver Extensions#

This protocol driver provides a set of extension that allow the customization to perform actions that are independent of the Driver Definitions associated. This means you can, using customization, register events that are not present in the Driver Definition.

This is particularly useful when accessing equipment data that is shared/too complex to access using the regular mechanisms. Also useful when needing to access data whose naming convention may vary from device to device.

Objects#

The objects are structures that are either passed as parameters or returned as result values.

RegisterHandler#

Table: IPC-CFX specific handler registration.

UnregisterHandler#

Table: IPC-CFX specific handler unregistration.

Methods#

Register Event#

Notifies the protocol driver to raise the occurrences of a specific IPC-CFX message type when it occurs.

void connect.iot.driver.ipccfx.registerEvent(data: Event)

Example#

Notify connect.iot.driver.ipccfx.registerEvent

{
    "name": "EventName",
    "deviceId": "CFX.ResourcePerformance.StationStateChanged",
    "isEnabled": true,
    "properties": [
        {
            "name": "oldState",
            "deviceId": "OldState",
            "deviceType": "Integer",
            "dataType": "Integer"
        },
        {
            "name": "oldStateDuration",
            "deviceId": "OldStateDuration",
            "deviceType": "String",
            "dataType": "String"
        },
        {
            "name": "newState",
            "deviceId": "NewState",
            "deviceType": "Integer",
            "dataType": "Integer"
        },
        {
            "name": "relatedFault",
            "deviceId": "RelatedFault",
            "deviceType": "String",
            "dataType": "String"
        }
    ]
}

Unregister Event#

Notifies the protocol driver to stop raising the occurrences of a specific message when it occurs.

void connect.iot.driver.ipccfx.unregisterEvent(data: Event)

Example#

Notify connect.iot.driver.ipccfx.unregisterEvent

{
    "name": "EventName"
}

Execute Command#

Executes a custom command.

any connect.iot.driver.ipccfx.executeCommand(data: ExecuteCommand)

Example#

SendRequest connect.iot.driver.ipccfx.executeCommand

{
    "command": {
        "name": "ActivateRecipeResponse",
        "deviceId": "CFX.Production.ActivateRecipeResponse",
        "extendedData": {
            "executionMode": "SendRequest",
            "destination": "TargetHandle"
        },
        "parameters": [
            {
                "name": "result",
                "deviceId": "Result",
                "dataType": "Object",
                "deviceType": "Object",
                "extendedData": {}
            }
        ]
    },
    "parameters": {
        "result": {
            "Message": "OK",
            "Result": "Success",
            "ResultCode": 0
        }
    }
}