Материал из for iRidium developers
Перейти к: навигация, поиск
Эта страница является переводом страницы Beckhoff. Перевод выполнен на 100%.

Other languages:
English • ‎русский

The driver is meant to control Beckhoff ADS equipment. To understad the driver, use the project example:

download the examples:


iRidium for Beckhoff is a set of tools for creating interfaces to control homes or offices on the basis of Beckhoff equipment.


Control panels (iOS, Android, Windows, Mac) can control Beckhoff equipment only via Beckhoff controller. Controller must be selected as Target device in TwinCat System Manager.


Adding the driver manually

To get started you add the Beckhoff driver to the project from the database iRidium:

  1. Launch iRidium Studio and create a new iRidium project
  2. Open DEVICE BASE side panel and find Beckhoff driver. Drag and drop Beckhoff to PROJECT DEVICE PANEL

Beckhoff add device.png

Adding the Beckhoff driver

Indicate the controller address in iRidium project otherwise it will not work.

Connection settings

When the driver is added to the project, specify the connection settings.

Beckhoff params.png
  • Host - IP address of the controller
  • Port port connect to the controller
  • Net ID - the ID of the Bacnet controller. To see it in the controller settings utility TwinCat System Manager
  • Send Timeout - time for request sending to Beckhoff controller in milliseconds

Change of Connection Settings

You need the possibility to change connection properties when you disconnect from the Wi-Fi network of the automation object and start using 3G or another Wi-Fi network. To maintain control of the object you need to switch from the local to public IP-address of the Internet router.

The switch is not automatic. You have to select the connection mode. For remote acces you have to make ports for controlling the automation system public. In order to do that you have o set up the Port Forwarding service on your Internet router. VPN can provide protected connection.

1 Download the template (*.js) (right-click button: "Save object as ..."), add the template in the script editor with the buttonIcon Scripts.png (+) Add Script from file

2 Set up script properties as it is shown in the example:

function Internal_1() {
IR.GetDevice('Beckhoff').SetParameters({Host: "", Port: 5001, TargetNetID: "", "SendTimeout":20});
function External_1() {
IR.GetDevice('Beckhoff').SetParameters({Host: "", Port: 5001, TargetNetID: "", "SendTimeout":20});

Copy the driver name from Projeсt Device Panel - the list of properties has to be copied from the example.

3 Select the button which will be responsible for the switch of Internal and External properties. Open Macros Editor for the Press event (Object Properties > Programming), select the Script Call command and add it by double-clicking on it. Select the name of the function which will be activated by the button:

Script call internal-external.png

Now each pressing on the button will apply the corresponding connection properties.

Commands & Feedbacks

Commands and feedback channels have to be assigned to graphic items to control equipment:

  • A command is assigned to a graphic item.
  • Feedback channel is assigned to a graphic item to display the variable state.

To assign commands or channels to graphic items use the drag&drop method.

To send a command, drag it on a graphic item. To display feedback, drag the channel on the graphic item and indicate where to output the value (Value):



To set a command or feedback set values in the following fields:

  • Target Port - the port on which you want to refer to the variable. Designation types:

Name Port


Event Logger




Additional Task 1


Additional Task 2












Canshaft Contr


System Service




  • Type - The type of the variable specified in the TwinCat System Manager when you create the channel or tag. iRidium supports the following types:

Type Length, bit Description
BOOL 1 Boolean
BYTE 8 Set of 8 bits
WORD 16 Set of 16 bits
DWORD 32 Set of 32 bits
LWORD 64 Set of 64 bits
SINT 8 Signed integer
USINT 8 Unsigned integer
INT 16 Signed integer
UINT 16 Unsigned integer
DINT 32 Signed integer
UDINT 32 Unsigned integer
LINT 64 Signed integer
ULINT 64 Unsigned integer
REAL 32 With floating point
LREAL 64 With floating point
STRING The length is set by a user String

The type of the variable in TwinCat System Manager, you can look in the settings variable

  • PLC Var Name - The variable name specified when created in TwinCat System Manager.

It's required to type point before variable name to access to global variables in GLOBAL section (physical inputs and outputs included). For example: .SwitchButton.


Setting access to Beckhoff controller from different devices at the same time

Add your IP address to the list of allowed addresses in TwinCat System Manager: SYSTEM -> Configuration -> Route Settings -> Static Routes -> Add...

  • Route Name (Target): any name
  • Ams Net Id: your IP address + 1.1 (for example,
  • Transport Type: TCP/IP
  • Address Info: your IP address

Then click Add Route, and then click Close button.

You can also use Current Routes tab, but after a controller is reloaded, your IP address will be deleted from the list of allowed addresses.
After PLC program is downloaded to the controller, the firmware has to be replaced for all the settings to restore after reboot: PLC Control -> Online -> CreateBootproject.