Skip to content

Use with AI

Use with AI

Modbus ​

This article is valid for all horstOS versions as well as for horstFX.

1. Introduction ​

The data is divided into 4 different registers (Coil (Bit Read/Write), Discrete Input (Readonly Bit), Holding Register (Read/Write Word), Input Register (Readonly Word)).

A coil or discrete input register consists of one bit and can therefore have the value 0 or 1.

Holding or input registers consist of a word (16-bit). In our implementation, 2 registers are often used to represent a 32-bit data type.

1.1 Advantages ​

  • Very simple protocol
  • Modbus client (master) implementations are available in virtually every programming language. Also on common programmable logic controllers (PLC).
  • Asynchronous data transmission (no permanent connection necessary)
  • No extra hardware required (as communication runs via TCP).
  • Existing network installation (including WLAN) can be used for data transmission.

1.2 Disadvantages ​

  • Robot status must be actively queried.
  • One register is limited to 16 bits (variables usually have a space requirement of 32 bits).

32-bit registers

Info:

When storing 32-bit data types, two registers are used.

1.3 Advantages over XML-RPC ​

  • Runs on PLC

1.4 Disadvantages compared to XML-RPC ​

  • No direct return values to a function to be executed.
  • Client programming is often significantly more complex.

1.5 Advantages compared to Profinet ​

  • No additional hardware.

1.6 Disadvantages compared to Profinet

  • Not real-time capable.
  • Programming the PLC is significantly more complex.

2. Configure CONTROL ​

The HORST robot has a Modbus-TCP interface in its horstOS control software. The following explains how this interface can be activated.

Minimum requirements:

2.1 "Control" Settings ​

To activate the Modbus interface, a configuration within the CONTROL unit of the robot is required. You will need a keyboard connected to the CONTROL unit in order to perform the configuration.

Here is a step-by-step guide on how to activate the interface. Make sure to follow these steps in the correct order.

  1. Start the robot via CONTROL.
  2. Exit the horstOS software (do not shut down CONTROL)
  3. Adjust the configuration:
    In the file /home/fruitcore/fruitcore/config/config.properties, the entry modbus.configuration.isEnabled=true must be added, or its value must be set to true if the entry already exists.
    This can be done as follows, for example:
    1. Press ALT+F3
    2. Enter Mousepad in the search field and start
    3. Press the key combination CTRL+O (CTRL + O) and then CTRL+L (CTRL + L). Enter /home/fruitcore/fruitcore/config/config.properties in the pre-selected address bar and confirm with Enter.
    4. At the end, add a line with the content modbus.configuration.isEnabled=true
  4. Click on Robot-UI to restart horstOS

Existing configuration entry

Info

If the entry modbus.configuration.isEnabled already exists, please update its value to true.

3. Establish connection ​

First, the IP address must be assigned; you can use the following article to help you with this: Change IP address

The robot enclosure control accepts a Modbus connection on the Modbus standard port 502 or on port 8502. Connect to the Modbus client of your choice.

4. Data types ​

16-Bit Integer

Memory requirement : 16Bit

Number of Modbus registers = 1 (holding register or input register)

Value range: -32768 to 32767

32-Bit Integer

Memory requirement : 32Bit

Number of Modbus registers = 2 (holding register or input register)
Value range: -2147483648 to 2147483647

Floating point number

Memory requirement : 32Bit

Number of Modbus registers = 2 (holding register or input register)

Raw

Memory requirement : 16 Bit

Number of Modbus registers = 1 (holding register or input register)

Value does not represent a number. Is used when individual bits are to be set.

Bool

Memory requirement : 1Bit

Number of Modbus registers = 1 (Coil or Discrete Input)

Value 0: false

Value 1: true

String

A string consists of utf-8 characters terminated with the string end character '\0'. A Modbus holding or input register always contains two characters

5. Coil (Bit Read/Write) ​

5.1 Mapping ​

Any undefined elements are reserved.

AddressDescriptionDetails
0Not Assigned
1-14OutputsOutputs
15Retrieve the value of Tool Output 1 or set it to the desired value.Outputs

16
Returns the value of Tool Output 2 or switches it to the desired value.Outputs
20When set to 1, automatic initialization is performed for the specified number of milliseconds in the holding register.
It is immediately reset to 0.
Initialize
21-26When the value is set to 1, joint x will be rotated by the specified degree in the holding register during initialization. It is then immediately set back to 0.

Register 21: joint 1
Register 22: joint 2
Register 23: joint 3
Register 24: joint 4
Register 25: joint 5
Register 26: joint 6
Initialize
27If the value is set to 1, the initialization process is canceled and immediately set back to 0.Initialize
50playProgram Calls
51pauseProgram Calls
52proceedProgram Calls
53abortProgram Calls
1000 - 1127Freely assignable → 128 Bool Registers in horstOSBool-Register
2000confirmInternalErrorSafety Calls
2001confirmChangeOperatingModeSafety Calls
2002confirmEmergencyStopSafety Calls
2003confirmSafetyStopSafety Calls
2004confirmExternalEmergencyStopSafety Calls
2100Execute option 1 on shown PopUpPopup
2101Execute option 2 on shown PopUpPopup
2102Execute option 3 on shown PopUpPopup

Each register entry corresponds to the data type Bool.

5.2 Details ​

Outputs:

Address
1Output 1
2Output 2
3Output 3
4Output 4
5Output 5
6Output 6
7Output 7
8Output 8
9Output 10
10Output 10
11Output 11
12Output 12
13Output 13
14Output 14
15Tool Output 1
16Tool Output 2

Returns the value of outputs 1-14 or switches them to the desired value.

0 = Low, 1 = High

Initialization:

For more detailed information on the initialization process, please refer to: Robot Initialization.

Program Calls:

To execute program calls, horstOS must be in the "Programming" menu and the robot must be in automatic operating mode. The action is triggered by writing a 1 into the respective register.

AddressCommandDescription
50playInitiates the execution of a loaded program.
51pausePause an already running program
52proceedPaused program will be resumed.
53abortTerminating a running or paused program

Bool Register:

Bool registers are freely available in horstOS. By default, all registers are initialized with 0.

The registers can be accessed read or write from horstOS and via any external interface.

The textual horstOS commands are as follows (more details here Read / Write):

  • getBoolRegister(n) | read
  • setBoolRegister(n, x) | write

n = Register Index

x = Value

AddresshorstOS Index
1000Bool-Register 0
1001Bool-Register 1
1002Bool-Register 2
......
1000 + nBool-Register n
......
1127Bool-Register 127

Bool register access

Info

Accessing the Bool register in horstOS, located at Modbus-Coil Address 1000 (Bool-Register 0), can be done in Text-Based Programming using the methods getBoolRegister(0) and setBoolRegister(0, x).

Safety Calls:

When a value of 1 is set, the corresponding command is executed.

AddressCommandDescription
2000confirmInternalErrorConfirming Internal Errors
2001confirmChangeOperatingModeConfirmation of changing the operating mode.
2002confirmEmergencyStopConfirm Emergency Stop
2003confirmSafetyStopConfirming Safety Stop
2004confirmExternalEmergencyStopConfirming External Emergency Stop

PopUp:

AddressCommandDescription
2100Execute option 1 on shown PopUpDocumentation Popup
2101Execute option 2 on shown PopUpDocumentation Popup
2102Execute option 3 on shown PopUpDocumentation Popup

6. Discrete Input (Readonly Bit) ​

Discrete inputs from a client can only be read. They have a value of either 0 (false) or 1 (true).

6.1 Mapping ​

Register Nr.DescriptionDetails
0Not Assigned
1-16Inputs 1-16Inputs
17Returns the value of Tool Input_1.Inputs
18Returns the value of Tool-Input_2Inputs
20-25Returns whether Axis 1 (Register 20) to Axis 6 (Register 25) has been initialized.Initialisierungs-Status
26Indicates whether the initialization process is runningInitialisierungs-Status
27Indicates whether Initialization Calls (refer to Coil (Bit Read/Write) Register 20-26) can be sent: InitializationCallisEnabledInitialisierungs-Status
50Programm-Status: isEnabledProgramm-Status
51Programm-Status: isRunningProgramm-Status
52Programm-Status: isInExececutingModeProgramm-Status
500Emergency stop confirmation requiredSafety-Status
501Safety stop must be confirmedSafety-Status
502Internal error confirmation requiredSafety-Status
503Confirmation required for changing operating mode.Safety-Status
504Simulation ModeSimulations-Modus
505External emergency stop must be confirmed.Safety-Status

Each register entry corresponds to the data type Bool.

6.2 Inputs ​

AddressDescription
1Input 1
2Input 2
3Input 3
4Input 4
5Input 5
6Input 6
7Input 7
8Input 8
9Input 9
10Input 10
11Input 11
12Input 12
13Input 13
14Input 14
15Input 15
16Input 16
17Tool-Input 1
18Tool-Input 2

6.3 Initialization Status ​

AddressDescriptionDetails
20Axis 1 Initialization Status0= not initialized | 1= initialized
21Axis 2 Initialization Status0= not initialized | 1= initialized
22Axis 3 Initialization Status0= not initialized | 1= initialized
23Axis 4 Initialization Status0= not initialized | 1= initialized
24Axis 5 Initialization Status0= not initialized | 1= initialized
25Axis 6 Initialization Status0= not initialized | 1= initialized
26Initialization active0=inactive | 1=active
27Initialization Call isEnabled0=not ready for Init. Calls | 1=ready for Init. Calls

For more detailed information on the initialization process, please refer to the section on initializing the robot.

6.4 Programm-Status ​

AddressDescription
50isEnabledWhen the program calls are usable in the external interface, the value is 1; otherwise, it is 0.
51isRunningProgram is running
52isInExecutingModeProgram in Playback Mode

This results in the following statuses:

isRunningisInExecutingModeMeaning
00Program not started
10invalid
01Program paused
11The program is running.

6.5 Safety-Status ​

AddressDescription
500Emergency stop1 = Confirmation required.
501Safety stop1 = Confirmation required
502Internal Error1 = Confirmation required
503Changing Operating Modes1 = Confirmation required
505External emergency stop1 = Confirmation required

6.6 Simulations-Modus ​

AddressDescription
504Simulation Mode0=inactive | 1=active

7. Holding Register (Read/Write Word) ​

7.1 Mapping ​

Register Nr.DescriptionDetails
0Not specified
1-6Values of each axis for the variable nextJoints in tenths of degreesInteger variable nextJoints
7-9XYZ value of the variable nextPose in tenths of a millimeterInteger variable nextJoints
10-12Euler angles of the variable nextPose in tenths of a degreeInteger variable nextJoints
500-511Floating point values for each axis in the variable nextJoints.Float nextJoints
512-517Float XYZ value of the variable nextPoseFloat nextPose
518-523Float Euler angles of the variable nextPoseFloat nextPose
524-525Float orientation quaternion Q0 of the variable nextPoseFloat nextPose
526-527Floating point orientation quaternion Q1 for the variable nextPose.Float nextPose
528-529Floating orientation quaternion Q2 of the nextPose variable.Float nextPose
530-531Float Orientation Quaternion Q3 of the variable nextPoseFloat nextPose
1000-105930 Free Assignable Integer Registers are available, where 2 registers are combined to form a 4-byte large Integer Value.Integer Register
1100-1129Configurable →
30 x Simple Integer Registers
Required Version > 2020.12
Simple Integer Register
2000-2059Configurable →
There are 30 Float Registers available, where 2 registers are combined to form a 4-byte large Float Value.
Float Register
3000-3001Integer Value: Duration for automatic initialization in milliseconds (refer to coils).
If -1 is specified, the duration will be set to 10 minutes.
Initialize
3002-3003Float value indicating the degree by which Axis 1 should rotate during explicit initialization of an axis (see coils). Negative values are also possible.Initialize
3004-3005Floating point value indicating the degree by which Axis 2 should rotate during the explicit initialization of an axis (refer to coils). Negative values are also acceptable.Initialize
3006-3007Float value indicating the degree by which Axis 3 should rotate during the explicit initialization of an axis (refer to coils). Negative values are also accepted.Initialize
3008-3009Float value indicating the degree by which Axis 4 should rotate during the explicit initialization of an axis (refer to coils). Negative values are also accepted.Initialize
3010-3011Float value specifying the degree by which Axis 5 should rotate during explicit initialization of an axis (refer to coils). Negative values are also accepted.Initialize
3012-3013Floating point value indicating the degree by which Axis 6 should rotate during the explicit initialization of an axis (refer to coils). Negative values are also accepted.Initialize
4000-4014String nextProgramNameChange Activity
4015If the Value is equal to 1, the nextProgramName will be used to load a program for the next activity.Change Activity
4500-4516Tool Change
This section includes 15 registers for each character of the tool string and 1 register for status/response. It is required to use a version later than 2021.07 for this functionality.
Tool Change
5000global speed (0-100)Speed slider

7.2 Integer variable nextJoints ​

AddressDescriptionDetailsData type
1Variable nextJoints: Joint 1Value in ° * 10-116-Bit Integer
2Variable nextJoints: Joint 2Value in ° * 10-116-Bit Integer
3Variable nextJoints: Joint 3Value in ° * 10-116-Bit Integer
4Variable nextJoints: Joint 4Value in ° * 10-116-Bit Integer
5Variable nextJoints: Joint 5Value in ° * 10-116-Bit Integer
6Variable nextJoints: Joint 6Value in ° * 10-116-Bit Integer

Details about the number format can be found under: Data types.

7.3 Integerige Variable nextPose ​

AddressDescriptionDetailsData type
7Variable nextPose: XValue in m * 10-416-Bit Integer
8Variable nextPose: YValue in m * 10-416-Bit Integer
9Variable nextPose: ZValue in m * 10-416-Bit Integer
10Variable nextPose: RXValue in ° * 10-116-Bit Integer
11Variable nextPose: RYValue in ° * 10-116-Bit Integer
12Variable nextPose: RZValue in ° * 10-116-Bit Integer

Details about the number format can be found under: Data types.

7.4 Float nextJoints ​

AddressDescriptionDetailsData type
500 & 501Variable nextJoints: Joint 1Value in degreeFloating point number
502 & 503Variable nextJoints: Joint 2Value in degreeFloating point number
504 & 505Variable nextJoints: Joint 3Value in degreeFloating point number
506 & 507Variable nextJoints: Joint 4Value in degreeFloating point number
508 & 509Variable nextJoints: Joint 5Value in degreeFloating point number
510 & 511Variable nextJoints: Joint 6Value in degreeFloating point number

Details about the number format can be found under: Data types.

7.5 Float nextPose ​

AddressDescriptionDetailsData type
512 & 513Variable nextPose: XValue in MeterFloating point number
514 & 515Variable nextPose: YValue in MeterFloating point number
516 & 517Variable nextPose: ZValue in MeterFloating point number
518 & 519Variable nextPose: RXValue in degreeFloating point number
520 & 521Variable nextPose: RYValue in degreeFloating point number
522 & 523Variable nextPose: RZValue in degreeFloating point number
524 & 525Variable nextPose: Q0Floating point number
526 & 527Variable nextPose: Q1Floating point number
528 & 529Variable nextPose: Q2Floating point number
530 & 531Variable nextPose: Q3Floating point number

Details about the number format can be found under: Data types.

7.6 Integer Register ​

In horstOS, there are 64 Integer Registers available, with access to the first 30 Integer Registers via Modbus. These Registers allow for storing and reading 32-bit Integers. By default, all Registers are initialized to 0. Accessing the Registers from horstOS involves using the following methods: read/write.

AddressDescriptionData type
1000 & 1001Integer-Register 032-Bit Integer
1002 & 1003Integer-Register 132-Bit Integer
1004 & 1005Integer-Register 232-Bit Integer
1006 & 1007Integer-Register 332-Bit Integer
.........
1058 & 1059Integer-Register 2932-Bit Integer

Details about the number format can be found under: Data types.

To access the Integer Register in horstOS, which is situated after the Holding Register Address 1000 & 1001 (Integer-Register 0), you can utilize the getIntRegister(0) and setIntRegister(0, x) methods in your textual programming.

7.7 Simple Integer Register ​

The Integer Registers can also be accessed through simple Modbus registers. It is important to consider the maximum value range for data types. Setting a value outside this range in horstOS can result in Over/Underflows, leading to inaccurately read values.

AddressDescriptionData type
1100Integer-Register 016-Bit Integer
1101Integer-Register 116-Bit Integer
1102Integer-Register 216-Bit Integer
1103Integer-Register 316-Bit Integer
.........
1129Integer-Register 2916-Bit Integer

Details about the number format can be found under: Data types.

Accessing the Integer Register in horstOS, located after the Holding Register Address 1100 (Integer-Register 0), can be done in textual programming using the methods getIntRegister(0) and setIntRegister(0, x).

7.8 Float Register ​

In horstOS, there are 64 Integer Registers available, with access to the first 30 Integer Registers via Modbus. These Registers allow for storing and retrieving 32-bit floating-point numbers. By default, all Registers are initialized to 0.0. Accessing the Registers in horstOS involves using the following methods: read/write.

AddressDescriptionData type
2000 & 2001Float-Register 0Floating point number
2002 & 2003Float-Register 1Floating point number
2004 & 2005Float-Register 2Floating point number
2006 & 2007Float-Register 3Floating point number
.........
2058 & 2059Float-Register 29Floating point number

Details about the number format can be found under: Data types.

Accessing the Float Register in horstOS, located after the Holding Register Address 2000 & 2001 (Float-Register 0), can be done in textual programming using the methods getFloatRegister(0) and setFloatRegister(0, x).

7.9 Initialization ​

Address

Description

Details

Data type

3002 & 3003

Degree indicating the rotation Axis 1 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Refer to 'Robot initialization' for more information.

Floating point number

3004 & 3005

Degree indicating the rotation Axis 2 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Floating point number

3006 & 3007

Degree indicating the rotation Axis 3 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Floating point number

3008 & 3009

Degree indicating the rotation Axis 4 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Floating point number

3010 & 3011

Degree indicating the rotation Axis 5 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Floating point number

3012 & 3013

Degree indicating the rotation Axis 6 should undergo during the explicit initialization of an axis. Negative values are also accepted.

Floating point number

Details about the number format can be found under: Data types.

Each axis is individually initialized and rotated by a specified degree value. To start the initialization of an axis, the corresponding start bit must be set (refer to Coil (Bit Read/Write) Register 21-26). The degree value can be positive or negative. It must be noted that for a safe initialization from any position, the minimum initialization angle must not be less than a certain value. Additionally, the actual angle traveled by the robot may vary within an axis-specific tolerance from the specified initialization angle. The minimum initialization angles and their corresponding tolerances are presented in the following table:

 

Axis 1

Axis 2

Axis 3

Axis 4

Axis 5

Axis 6

min. degree   [°]

max. tolerance[°]

min. degree   [°]

max. tolerance [°]

min. degree   [°]

max. tolerance [°]

min. degree   [°]

max. tolerance [°]

min. degree   [°]

max. tolerance [°]

min. degree   [°]

max. tolerance [°]

HORST 600

14

2

20

2

20

2

20

2

20

2

20

2

HORST 900

14

2

42

init_degree * 3+ 2

28

init_degree * 2+ 2

20

2

20

2

20

2

HORST 1000

14

2

42

init_degree * 3 + 2

28

init_degree * 2 + 2

20

2

20

2

20

2

HORST 1400

14

2

42

init_degree * 3 + 2

28

init_degree * 2 + 2

20

2

20

2

20

2

The larger angle tolerances of H900, H1000 and H1400 in axes 2 and 3 result from the dynamic transmission ratio of the four-bar chain.

7.10 Change Activity ​

Address

Description

Details

Data type

4000

nextProgramName

character 0 & 1

String

4001

nextProgramName

character 2 & 3

4002

nextProgramName

character 4 & 5

...

...

...

4014

nextProgramName

character 28 & 29

4015

next Activity ID

see Switching views with XML-RPC

16-Bit Integer

Details about the number format can be found under: Data types.

Once the next Activity ID is set, horstOS switches to the desired activity. During this process, an error code can be set in the Input Register (Readonly Word)-Activity, which should be checked thoroughly.

The string nextProgramName is only considered when switching to the Programming-Activity.

7.11 Change Tool ​

Available starting from version 2021.07, the tool change feature is only accessible in the Homescreen Activity.

To switch tools, you need to input the corresponding tool name in Registers 4500-4515. By setting Register 4516 ToolChange to 1, the tool change process will be executed. To verify the tool change, you can then read the ToolChange Register: a value of 0 indicates a successful tool change, while a value of 1 signifies an error occurred, and the tool was not switched.

Possible errors could include:

  • Tool not found (incorrect tool name)

  • not in Homescreen Activity

Address

Description

Details

Data type

4500

nextToolName

character 0 & 1

String

4501

nextToolName

character 2 & 3

...

...

...

4515

nextToolName

character 29 & 30

4516

ToolChange

Write 1 → Tool change

Read 1 → Error during tool change

Read 0 → Successful tool change

16-Bit Integer

7.12 Speed Slider ​

AddressDescriptionDetailsData type
5000Set or read the Speed Slider in horstOS.Value ranging from 0 to 10016-Bit Integer

Details about the number format can be found under: Data types.

8. Input Register (Readonly Word) ​

8.1 Mapping ​

Register Nr.DescriptionDetails
0not assigned
1-6Degrees for Joints 1-6 are measured in tenths of a degree.Current axis degrees are represented as integers.
7-9XZY-Position of the **TCP **in tenths of a millimetercurrent TCP pose is represented as integers.
10-12XYZ Euler angles of the **TCP **in tenths of a degreecurrent TCP pose is represented as integers.
51OperatingMode
0=Automatic 1=T1 2=T2, 3=isFloatingMode
OperatingMode
500-511Float Joints 1-6aktuelle Achsdegree als Floating point number
512-517Floating point representation of the XZY position of the Tool Center Point (TCP).Current TCP pose represented as a floating-point number.
518-523Floating point representation of the Euler angles of the Tool Center Point (TCP)Current TCP pose represented as a floating-point number.
524-531Floating point orientation quaternions of the TCPCurrent TCP pose represented as a floating-point number.
556-561Floating point XYZ position of the flangecurrent flange pose as a floating-point number
562-567Floating-point Euler angles of the flangecurrent flange pose as a floating-point number
568-575Floating-point orientation quaternions of the flangecurrent flange pose as a floating-point number
576-581Float XYZ Tool-OffsetTool-Offset
582-587Floating-point Euler degree Tool-OffsetTool-Offset
600Number of days since January 1, 1990.Date-Time
601-602Integer number of milliseconds since the start of the dayDate-Time
603-617horstOS version displayed in charactershorstOS-Version
2100Indicates the ID of the displayed pop-up. Returns 0 if no pop-up is currently being shown.Popup
4000switch Activity ErrorCodeActivity
4001current ActivityActivity
4002-4031Name of the loaded programActivity
4500-4515Name of the current tool

8.2 Current Axis Degrees Represented as Integers ​

AddressDescriptionDetailsData type
1Position: Joint 1Value in ° * 10-116-Bit Integer
2Position: Joint 2Value in ° * 10-116-Bit Integer
3Position: Joint 3Value in ° * 10-116-Bit Integer
4Position: Joint 4Value in ° * 10-116-Bit Integer
5Position: Joint 5Value in ° * 10-116-Bit Integer
6Position: Joint 6Value in ° * 10-116-Bit Integer

8.3 Current TCP Pose Represented as Integers ​

AddressDescriptionDetails
7TCP Position: XValue in m * 10-416-Bit Integer
8TCP Position: YValue in m * 10-416-Bit Integer
9TCP Position: ZValue in m * 10-416-Bit Integer
10TCP Orientation: RXValue in ° * 10-116-Bit Integer
11TCP Orientation: RYValue in ° * 10-116-Bit Integer
12TCP Orientation: RZValue in ° * 10-116-Bit Integer

8.4 OperatingMode ​

AddressDescriptionDetailsData type
51Operating ModeValue 0: Automatic-Mode
Value 1: T1-Mode
Value 2: T2-Mode
Value 3: floating Mode
Raw

8.5 Current Axis Degrees Represented as Floating-Point Numbers ​

AddressDescriptionDetailsData type
500 & 501Position: Joint 1Value in degreeFloating point number
502 & 503Position: Joint 2Value in degreeFloating point number
504 & 505Position: Joint 3Value in degreeFloating point number
506 & 507Position: Joint 4Value in degreeFloating point number
508 & 509Position: Joint 5Value in degreeFloating point number
510 & 511Position: Joint 6Value in degreeFloating point number

8.6 Current TCP Pose Represented as a Floating-Point Number ​

AddressDescriptionDetailsData type
512 & 513TCP Position: XValue in MeterFloating point number
514 & 515TCP Position: YValue in MeterFloating point number
516 & 517TCP Position: ZValue in MeterFloating point number
518 & 519TCP Orientation: RXValue in degreeFloating point number
520 & 521TCP Orientation: RYValue in degreeFloating point number
522 & 523TCP Orientation: RZValue in degreeFloating point number
524 & 525TCP Orientation: Q0Floating point number
526 & 527TCP Orientation: Q1Floating point number
528 & 529TCP Orientation: Q2Floating point number
530 & 531TCP Orientation: Q3Floating point number

8.7 Current Flange Pose Represented as a Floating-Point Number ​

AddressDescriptionDetailsData type
556 & 557Flange Position: XValue in MeterFloating point number
558 & 559Flange Position: YValue in MeterFloating point number
560 & 561Flange Position: ZValue in MeterFloating point number
562 & 563Flange Orientation: RXValue in degreeFloating point number
564 & 565Flange Orientation: RYValue in degreeFloating point number
566 & 567Flange Orientation: RZValue in degreeFloating point number
568 & 569Flange Orientation: Q0Floating point number
570 & 571Flange Orientation: Q1Floating point number
572 & 573Flange Orientation: Q2Floating point number
574 & 575Flange Orientation: Q3Floating point number

8.8 Tool-Offset ​

AddressDescriptionDetailsData type
576 & 577Tool-Offset: XValue in MeterFloating point number
578& 579Tool-Offset: YValue in MeterFloating point number
580 & 581Tool-Offset: ZValue in MeterFloating point number
582 & 583Tool-Offset: RXValue in degreeFloating point number
584 & 585Tool-Offset: RYValue in degreeFloating point number
586 & 587Tool-Offset: RZValue in degreeFloating point number

8.9 Date-Time ​

AddressDescriptionData type
600Number of days since January 1, 1990.16-Bit Integer
601 & 602Milliseconds since the start of the day32-Bit Integer

8.10 horstOS-Version ​

Address

Description

Details

Data type

603

horstOS-Version

character 0 & 1

String

604

horstOS-Version

character 2 & 3

607

horstOS-Version

character 4 & 5

608

horstOS-Version

character 6 & 7

   

617

horstOS-Version

character 28 & 29

8.11 PopUp ​

AddressDescriptionDetailsData type
2100ID of the displayed PopUp0 when no PopUp is being displayed16-Bit Integer

8.12 Activity ​

Address

Description

Details

Data type

4000

Error-Code

refer to the following table

16-Bit Integer

4001

Displayed Activity ID

See the documentation for views in horstOS.

16-Bit Integer

4002

Name of the loaded program (Displayed only in the Programming-Activity)

Character 0 & 1

String

4003

Character 2 & 3

4004

Character 4 & 5

4005

Character 6 & 7

....

....

4031

Character 28 & 29

Switch Error Codes:

Error IDDescription
0OK
Switch Activity successful.
51OK_BUT_DONT_CLOSE
Individual axes may exceed axis limits when exiting the RobotInitializationActivity.
52INVALID_ID
Invalid Activity ID passed (Activity IDs: Documentation Views in horstOS)
101DENY
Error in communication with the robot when exiting the RobotInitializationActivity.
102EXECUTION_ACTIVE
Changing the activity is not possible while the robot is in motion.
201ALREADY_SHOWN
The system is already in the selected Activity.
202TEXT_FUNC_SHOWN
The Programming Activity cannot be exited currently because a textual function is being created/edited.
203POP_UP_SHOWN
The Activity cannot be switched because a Pop-Up is currently being displayed.
204ADD_OR_EDIT_CMD
The Programming Activity cannot be exited because the "Add Action" button is active.
301NO_PERMISION_TO_SHOW
The current user role does not have access to the selected activity.
302ON_SHOW_NOT_POSSIBL
Unexpected Error.
303INIT_NOT_POSSIBLE_IN_SIMULATION
The RobotInitializationActivity cannot be accessed in simulation mode.
401FILE_NOT_FOUND
When switching to the Programming Activity : The provided string (program name) is incorrect.
402FILE_NOT_READABLE
When switching to the Programming Activity: The selected program cannot be opened due to an error.
403HEADER_INVALID
When switching to the Programming Activity : The header of the selected program is invalid.
404DIFFERENT_PROTO
When switching to the Programming Activity : The robot model stored in the selected program differs from the current robot model.
405DIFFERENT_TOOL
When switching to the Programming Activity : The tool stored in the selected program differs from the current tool.
500ACTIVITY_SWITCH_GOING_ON
Activity switch is currently in progress.

8.13 Tool ​

Address

Description

Details

Data type

4500

Name of the current tool

Character 0 & 1

String

4500

Name of the current tool

Character 2 & 3

...

...

...

4500

Name of the current tool

Character 29 & 30

9. Robot Initialization ​

9.1 Introduction ​

There are 2 types of initialization.

  • Automatic

    • each axis is initialized one after the other with an automatic direction (always to 0 point of the axis)

    • Initialization sequence (already initialized axes are skipped):

      1. Axis 6

      2. Axis 5

      3. Axis 4

      4. Axis 3

      5. Axis 2

      6. Axis 1

  • Manually

  • Each joint can be rotated by a parameterizable angle until the axis is initialized.

9.2 Automatic initialization via Modbus ​

  1. Set the maximum time for initialization: Modbus Holding Register (3000 & 3001)

  2. Starting the initialization: Modbus Coil 20

9.3 Manual initialization via Modbus ​

  1. Set by how many degrees the respective axis should be rotated: Modbus Holding Register (3002 - 3013)

  2. Starting the initialization: Modbus Coil 21 - 26