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:
- robot control software version 2020.10 or higher
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.
- Start the robot via CONTROL.
- Exit the horstOS software (do not shut down CONTROL)
- 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:- Press ALT+F3
- Enter Mousepad in the search field and start
- 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.
- At the end, add a line with the content modbus.configuration.isEnabled=true
- 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.
| Address | Description | Details |
|---|---|---|
| 0 | Not Assigned | |
| 1-14 | Outputs | Outputs |
| 15 | Retrieve 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 |
| 20 | When 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-26 | When 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 |
| 27 | If the value is set to 1, the initialization process is canceled and immediately set back to 0. | Initialize |
| 50 | play | Program Calls |
| 51 | pause | Program Calls |
| 52 | proceed | Program Calls |
| 53 | abort | Program Calls |
| 1000 - 1127 | Freely assignable → 128 Bool Registers in horstOS | Bool-Register |
| 2000 | confirmInternalError | Safety Calls |
| 2001 | confirmChangeOperatingMode | Safety Calls |
| 2002 | confirmEmergencyStop | Safety Calls |
| 2003 | confirmSafetyStop | Safety Calls |
| 2004 | confirmExternalEmergencyStop | Safety Calls |
| 2100 | Execute option 1 on shown PopUp | Popup |
| 2101 | Execute option 2 on shown PopUp | Popup |
| 2102 | Execute option 3 on shown PopUp | Popup |
Each register entry corresponds to the data type Bool.
5.2 Details
Outputs:
| Address | |
|---|---|
| 1 | Output 1 |
| 2 | Output 2 |
| 3 | Output 3 |
| 4 | Output 4 |
| 5 | Output 5 |
| 6 | Output 6 |
| 7 | Output 7 |
| 8 | Output 8 |
| 9 | Output 10 |
| 10 | Output 10 |
| 11 | Output 11 |
| 12 | Output 12 |
| 13 | Output 13 |
| 14 | Output 14 |
| 15 | Tool Output 1 |
| 16 | Tool 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.
| Address | Command | Description |
|---|---|---|
| 50 | play | Initiates the execution of a loaded program. |
| 51 | pause | Pause an already running program |
| 52 | proceed | Paused program will be resumed. |
| 53 | abort | Terminating 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
| Address | horstOS Index |
|---|---|
| 1000 | Bool-Register 0 |
| 1001 | Bool-Register 1 |
| 1002 | Bool-Register 2 |
| ... | ... |
| 1000 + n | Bool-Register n |
| ... | ... |
| 1127 | Bool-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.
| Address | Command | Description |
|---|---|---|
| 2000 | confirmInternalError | Confirming Internal Errors |
| 2001 | confirmChangeOperatingMode | Confirmation of changing the operating mode. |
| 2002 | confirmEmergencyStop | Confirm Emergency Stop |
| 2003 | confirmSafetyStop | Confirming Safety Stop |
| 2004 | confirmExternalEmergencyStop | Confirming External Emergency Stop |
PopUp:
| Address | Command | Description |
|---|---|---|
| 2100 | Execute option 1 on shown PopUp | Documentation Popup |
| 2101 | Execute option 2 on shown PopUp | Documentation Popup |
| 2102 | Execute option 3 on shown PopUp | Documentation 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. | Description | Details |
|---|---|---|
| 0 | Not Assigned | |
| 1-16 | Inputs 1-16 | Inputs |
| 17 | Returns the value of Tool Input_1. | Inputs |
| 18 | Returns the value of Tool-Input_2 | Inputs |
| 20-25 | Returns whether Axis 1 (Register 20) to Axis 6 (Register 25) has been initialized. | Initialisierungs-Status |
| 26 | Indicates whether the initialization process is running | Initialisierungs-Status |
| 27 | Indicates whether Initialization Calls (refer to Coil (Bit Read/Write) Register 20-26) can be sent: InitializationCallisEnabled | Initialisierungs-Status |
| 50 | Programm-Status: isEnabled | Programm-Status |
| 51 | Programm-Status: isRunning | Programm-Status |
| 52 | Programm-Status: isInExececutingMode | Programm-Status |
| 500 | Emergency stop confirmation required | Safety-Status |
| 501 | Safety stop must be confirmed | Safety-Status |
| 502 | Internal error confirmation required | Safety-Status |
| 503 | Confirmation required for changing operating mode. | Safety-Status |
| 504 | Simulation Mode | Simulations-Modus |
| 505 | External emergency stop must be confirmed. | Safety-Status |
Each register entry corresponds to the data type Bool.
6.2 Inputs
| Address | Description |
|---|---|
| 1 | Input 1 |
| 2 | Input 2 |
| 3 | Input 3 |
| 4 | Input 4 |
| 5 | Input 5 |
| 6 | Input 6 |
| 7 | Input 7 |
| 8 | Input 8 |
| 9 | Input 9 |
| 10 | Input 10 |
| 11 | Input 11 |
| 12 | Input 12 |
| 13 | Input 13 |
| 14 | Input 14 |
| 15 | Input 15 |
| 16 | Input 16 |
| 17 | Tool-Input 1 |
| 18 | Tool-Input 2 |
6.3 Initialization Status
| Address | Description | Details |
|---|---|---|
| 20 | Axis 1 Initialization Status | 0= not initialized | 1= initialized |
| 21 | Axis 2 Initialization Status | 0= not initialized | 1= initialized |
| 22 | Axis 3 Initialization Status | 0= not initialized | 1= initialized |
| 23 | Axis 4 Initialization Status | 0= not initialized | 1= initialized |
| 24 | Axis 5 Initialization Status | 0= not initialized | 1= initialized |
| 25 | Axis 6 Initialization Status | 0= not initialized | 1= initialized |
| 26 | Initialization active | 0=inactive | 1=active |
| 27 | Initialization Call isEnabled | 0=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
| Address | Description | |
|---|---|---|
| 50 | isEnabled | When the program calls are usable in the external interface, the value is 1; otherwise, it is 0. |
| 51 | isRunning | Program is running |
| 52 | isInExecutingMode | Program in Playback Mode |
This results in the following statuses:
| isRunning | isInExecutingMode | Meaning |
|---|---|---|
| 0 | 0 | Program not started |
| 1 | 0 | invalid |
| 0 | 1 | Program paused |
| 1 | 1 | The program is running. |
6.5 Safety-Status
| Address | Description | |
|---|---|---|
| 500 | Emergency stop | 1 = Confirmation required. |
| 501 | Safety stop | 1 = Confirmation required |
| 502 | Internal Error | 1 = Confirmation required |
| 503 | Changing Operating Modes | 1 = Confirmation required |
| 505 | External emergency stop | 1 = Confirmation required |
6.6 Simulations-Modus
| Address | Description | |
|---|---|---|
| 504 | Simulation Mode | 0=inactive | 1=active |
7. Holding Register (Read/Write Word)
7.1 Mapping
| Register Nr. | Description | Details |
|---|---|---|
| 0 | Not specified | |
| 1-6 | Values of each axis for the variable nextJoints in tenths of degrees | Integer variable nextJoints |
| 7-9 | XYZ value of the variable nextPose in tenths of a millimeter | Integer variable nextJoints |
| 10-12 | Euler angles of the variable nextPose in tenths of a degree | Integer variable nextJoints |
| 500-511 | Floating point values for each axis in the variable nextJoints. | Float nextJoints |
| 512-517 | Float XYZ value of the variable nextPose | Float nextPose |
| 518-523 | Float Euler angles of the variable nextPose | Float nextPose |
| 524-525 | Float orientation quaternion Q0 of the variable nextPose | Float nextPose |
| 526-527 | Floating point orientation quaternion Q1 for the variable nextPose. | Float nextPose |
| 528-529 | Floating orientation quaternion Q2 of the nextPose variable. | Float nextPose |
| 530-531 | Float Orientation Quaternion Q3 of the variable nextPose | Float nextPose |
| 1000-1059 | 30 Free Assignable Integer Registers are available, where 2 registers are combined to form a 4-byte large Integer Value. | Integer Register |
| 1100-1129 | Configurable → 30 x Simple Integer Registers Required Version > 2020.12 | Simple Integer Register |
| 2000-2059 | Configurable → There are 30 Float Registers available, where 2 registers are combined to form a 4-byte large Float Value. | Float Register |
| 3000-3001 | Integer Value: Duration for automatic initialization in milliseconds (refer to coils). If -1 is specified, the duration will be set to 10 minutes. | Initialize |
| 3002-3003 | Float 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-3005 | Floating 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-3007 | Float 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-3009 | Float 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-3011 | Float 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-3013 | Floating 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-4014 | String nextProgramName | Change Activity |
| 4015 | If the Value is equal to 1, the nextProgramName will be used to load a program for the next activity. | Change Activity |
| 4500-4516 | Tool 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 |
| 5000 | global speed (0-100) | Speed slider |
7.2 Integer variable nextJoints
| Address | Description | Details | Data type |
|---|---|---|---|
| 1 | Variable nextJoints: Joint 1 | Value in ° * 10-1 | 16-Bit Integer |
| 2 | Variable nextJoints: Joint 2 | Value in ° * 10-1 | 16-Bit Integer |
| 3 | Variable nextJoints: Joint 3 | Value in ° * 10-1 | 16-Bit Integer |
| 4 | Variable nextJoints: Joint 4 | Value in ° * 10-1 | 16-Bit Integer |
| 5 | Variable nextJoints: Joint 5 | Value in ° * 10-1 | 16-Bit Integer |
| 6 | Variable nextJoints: Joint 6 | Value in ° * 10-1 | 16-Bit Integer |
Details about the number format can be found under: Data types.
7.3 Integerige Variable nextPose
| Address | Description | Details | Data type |
|---|---|---|---|
| 7 | Variable nextPose: X | Value in m * 10-4 | 16-Bit Integer |
| 8 | Variable nextPose: Y | Value in m * 10-4 | 16-Bit Integer |
| 9 | Variable nextPose: Z | Value in m * 10-4 | 16-Bit Integer |
| 10 | Variable nextPose: RX | Value in ° * 10-1 | 16-Bit Integer |
| 11 | Variable nextPose: RY | Value in ° * 10-1 | 16-Bit Integer |
| 12 | Variable nextPose: RZ | Value in ° * 10-1 | 16-Bit Integer |
Details about the number format can be found under: Data types.
7.4 Float nextJoints
| Address | Description | Details | Data type |
|---|---|---|---|
| 500 & 501 | Variable nextJoints: Joint 1 | Value in degree | Floating point number |
| 502 & 503 | Variable nextJoints: Joint 2 | Value in degree | Floating point number |
| 504 & 505 | Variable nextJoints: Joint 3 | Value in degree | Floating point number |
| 506 & 507 | Variable nextJoints: Joint 4 | Value in degree | Floating point number |
| 508 & 509 | Variable nextJoints: Joint 5 | Value in degree | Floating point number |
| 510 & 511 | Variable nextJoints: Joint 6 | Value in degree | Floating point number |
Details about the number format can be found under: Data types.
7.5 Float nextPose
| Address | Description | Details | Data type |
|---|---|---|---|
| 512 & 513 | Variable nextPose: X | Value in Meter | Floating point number |
| 514 & 515 | Variable nextPose: Y | Value in Meter | Floating point number |
| 516 & 517 | Variable nextPose: Z | Value in Meter | Floating point number |
| 518 & 519 | Variable nextPose: RX | Value in degree | Floating point number |
| 520 & 521 | Variable nextPose: RY | Value in degree | Floating point number |
| 522 & 523 | Variable nextPose: RZ | Value in degree | Floating point number |
| 524 & 525 | Variable nextPose: Q0 | Floating point number | |
| 526 & 527 | Variable nextPose: Q1 | Floating point number | |
| 528 & 529 | Variable nextPose: Q2 | Floating point number | |
| 530 & 531 | Variable nextPose: Q3 | Floating 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.
| Address | Description | Data type |
|---|---|---|
| 1000 & 1001 | Integer-Register 0 | 32-Bit Integer |
| 1002 & 1003 | Integer-Register 1 | 32-Bit Integer |
| 1004 & 1005 | Integer-Register 2 | 32-Bit Integer |
| 1006 & 1007 | Integer-Register 3 | 32-Bit Integer |
| ... | ... | ... |
| 1058 & 1059 | Integer-Register 29 | 32-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.
| Address | Description | Data type |
|---|---|---|
| 1100 | Integer-Register 0 | 16-Bit Integer |
| 1101 | Integer-Register 1 | 16-Bit Integer |
| 1102 | Integer-Register 2 | 16-Bit Integer |
| 1103 | Integer-Register 3 | 16-Bit Integer |
| ... | ... | ... |
| 1129 | Integer-Register 29 | 16-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.
| Address | Description | Data type |
|---|---|---|
| 2000 & 2001 | Float-Register 0 | Floating point number |
| 2002 & 2003 | Float-Register 1 | Floating point number |
| 2004 & 2005 | Float-Register 2 | Floating point number |
| 2006 & 2007 | Float-Register 3 | Floating point number |
| ... | ... | ... |
| 2058 & 2059 | Float-Register 29 | Floating 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 | 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
| Address | Description | Details | Data type |
|---|---|---|---|
| 5000 | Set or read the Speed Slider in horstOS. | Value ranging from 0 to 100 | 16-Bit Integer |
Details about the number format can be found under: Data types.
8. Input Register (Readonly Word)
8.1 Mapping
| Register Nr. | Description | Details |
|---|---|---|
| 0 | not assigned | |
| 1-6 | Degrees for Joints 1-6 are measured in tenths of a degree. | Current axis degrees are represented as integers. |
| 7-9 | XZY-Position of the **TCP **in tenths of a millimeter | current TCP pose is represented as integers. |
| 10-12 | XYZ Euler angles of the **TCP **in tenths of a degree | current TCP pose is represented as integers. |
| 51 | OperatingMode 0=Automatic 1=T1 2=T2, 3=isFloatingMode | OperatingMode |
| 500-511 | Float Joints 1-6 | aktuelle Achsdegree als Floating point number |
| 512-517 | Floating point representation of the XZY position of the Tool Center Point (TCP). | Current TCP pose represented as a floating-point number. |
| 518-523 | Floating point representation of the Euler angles of the Tool Center Point (TCP) | Current TCP pose represented as a floating-point number. |
| 524-531 | Floating point orientation quaternions of the TCP | Current TCP pose represented as a floating-point number. |
| 556-561 | Floating point XYZ position of the flange | current flange pose as a floating-point number |
| 562-567 | Floating-point Euler angles of the flange | current flange pose as a floating-point number |
| 568-575 | Floating-point orientation quaternions of the flange | current flange pose as a floating-point number |
| 576-581 | Float XYZ Tool-Offset | Tool-Offset |
| 582-587 | Floating-point Euler degree Tool-Offset | Tool-Offset |
| 600 | Number of days since January 1, 1990. | Date-Time |
| 601-602 | Integer number of milliseconds since the start of the day | Date-Time |
| 603-617 | horstOS version displayed in characters | horstOS-Version |
| 2100 | Indicates the ID of the displayed pop-up. Returns 0 if no pop-up is currently being shown. | Popup |
| 4000 | switch Activity ErrorCode | Activity |
| 4001 | current Activity | Activity |
| 4002-4031 | Name of the loaded program | Activity |
| 4500-4515 | Name of the current tool |
8.2 Current Axis Degrees Represented as Integers
| Address | Description | Details | Data type |
|---|---|---|---|
| 1 | Position: Joint 1 | Value in ° * 10-1 | 16-Bit Integer |
| 2 | Position: Joint 2 | Value in ° * 10-1 | 16-Bit Integer |
| 3 | Position: Joint 3 | Value in ° * 10-1 | 16-Bit Integer |
| 4 | Position: Joint 4 | Value in ° * 10-1 | 16-Bit Integer |
| 5 | Position: Joint 5 | Value in ° * 10-1 | 16-Bit Integer |
| 6 | Position: Joint 6 | Value in ° * 10-1 | 16-Bit Integer |
8.3 Current TCP Pose Represented as Integers
| Address | Description | Details | |
|---|---|---|---|
| 7 | TCP Position: X | Value in m * 10-4 | 16-Bit Integer |
| 8 | TCP Position: Y | Value in m * 10-4 | 16-Bit Integer |
| 9 | TCP Position: Z | Value in m * 10-4 | 16-Bit Integer |
| 10 | TCP Orientation: RX | Value in ° * 10-1 | 16-Bit Integer |
| 11 | TCP Orientation: RY | Value in ° * 10-1 | 16-Bit Integer |
| 12 | TCP Orientation: RZ | Value in ° * 10-1 | 16-Bit Integer |
8.4 OperatingMode
| Address | Description | Details | Data type |
|---|---|---|---|
| 51 | Operating Mode | Value 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
| Address | Description | Details | Data type |
|---|---|---|---|
| 500 & 501 | Position: Joint 1 | Value in degree | Floating point number |
| 502 & 503 | Position: Joint 2 | Value in degree | Floating point number |
| 504 & 505 | Position: Joint 3 | Value in degree | Floating point number |
| 506 & 507 | Position: Joint 4 | Value in degree | Floating point number |
| 508 & 509 | Position: Joint 5 | Value in degree | Floating point number |
| 510 & 511 | Position: Joint 6 | Value in degree | Floating point number |
8.6 Current TCP Pose Represented as a Floating-Point Number
| Address | Description | Details | Data type |
|---|---|---|---|
| 512 & 513 | TCP Position: X | Value in Meter | Floating point number |
| 514 & 515 | TCP Position: Y | Value in Meter | Floating point number |
| 516 & 517 | TCP Position: Z | Value in Meter | Floating point number |
| 518 & 519 | TCP Orientation: RX | Value in degree | Floating point number |
| 520 & 521 | TCP Orientation: RY | Value in degree | Floating point number |
| 522 & 523 | TCP Orientation: RZ | Value in degree | Floating point number |
| 524 & 525 | TCP Orientation: Q0 | Floating point number | |
| 526 & 527 | TCP Orientation: Q1 | Floating point number | |
| 528 & 529 | TCP Orientation: Q2 | Floating point number | |
| 530 & 531 | TCP Orientation: Q3 | Floating point number |
8.7 Current Flange Pose Represented as a Floating-Point Number
| Address | Description | Details | Data type |
|---|---|---|---|
| 556 & 557 | Flange Position: X | Value in Meter | Floating point number |
| 558 & 559 | Flange Position: Y | Value in Meter | Floating point number |
| 560 & 561 | Flange Position: Z | Value in Meter | Floating point number |
| 562 & 563 | Flange Orientation: RX | Value in degree | Floating point number |
| 564 & 565 | Flange Orientation: RY | Value in degree | Floating point number |
| 566 & 567 | Flange Orientation: RZ | Value in degree | Floating point number |
| 568 & 569 | Flange Orientation: Q0 | Floating point number | |
| 570 & 571 | Flange Orientation: Q1 | Floating point number | |
| 572 & 573 | Flange Orientation: Q2 | Floating point number | |
| 574 & 575 | Flange Orientation: Q3 | Floating point number |
8.8 Tool-Offset
| Address | Description | Details | Data type |
|---|---|---|---|
| 576 & 577 | Tool-Offset: X | Value in Meter | Floating point number |
| 578& 579 | Tool-Offset: Y | Value in Meter | Floating point number |
| 580 & 581 | Tool-Offset: Z | Value in Meter | Floating point number |
| 582 & 583 | Tool-Offset: RX | Value in degree | Floating point number |
| 584 & 585 | Tool-Offset: RY | Value in degree | Floating point number |
| 586 & 587 | Tool-Offset: RZ | Value in degree | Floating point number |
8.9 Date-Time
| Address | Description | Data type |
|---|---|---|
| 600 | Number of days since January 1, 1990. | 16-Bit Integer |
| 601 & 602 | Milliseconds since the start of the day | 32-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
| Address | Description | Details | Data type |
|---|---|---|---|
| 2100 | ID of the displayed PopUp | 0 when no PopUp is being displayed | 16-Bit Integer |
8.12 Activity
Address | Description | Details | Data type |
4000 | Error-Code | 16-Bit Integer | |
4001 | Displayed Activity ID | 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 ID | Description |
|---|---|
| 0 | OK Switch Activity successful. |
| 51 | OK_BUT_DONT_CLOSE Individual axes may exceed axis limits when exiting the RobotInitializationActivity. |
| 52 | INVALID_ID Invalid Activity ID passed (Activity IDs: Documentation Views in horstOS) |
| 101 | DENY Error in communication with the robot when exiting the RobotInitializationActivity. |
| 102 | EXECUTION_ACTIVE Changing the activity is not possible while the robot is in motion. |
| 201 | ALREADY_SHOWN The system is already in the selected Activity. |
| 202 | TEXT_FUNC_SHOWN The Programming Activity cannot be exited currently because a textual function is being created/edited. |
| 203 | POP_UP_SHOWN The Activity cannot be switched because a Pop-Up is currently being displayed. |
| 204 | ADD_OR_EDIT_CMD The Programming Activity cannot be exited because the "Add Action" button is active. |
| 301 | NO_PERMISION_TO_SHOW The current user role does not have access to the selected activity. |
| 302 | ON_SHOW_NOT_POSSIBL Unexpected Error. |
| 303 | INIT_NOT_POSSIBLE_IN_SIMULATION The RobotInitializationActivity cannot be accessed in simulation mode. |
| 401 | FILE_NOT_FOUND When switching to the Programming Activity : The provided string (program name) is incorrect. |
| 402 | FILE_NOT_READABLE When switching to the Programming Activity: The selected program cannot be opened due to an error. |
| 403 | HEADER_INVALID When switching to the Programming Activity : The header of the selected program is invalid. |
| 404 | DIFFERENT_PROTO When switching to the Programming Activity : The robot model stored in the selected program differs from the current robot model. |
| 405 | DIFFERENT_TOOL When switching to the Programming Activity : The tool stored in the selected program differs from the current tool. |
| 500 | ACTIVITY_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):
Axis 6
Axis 5
Axis 4
Axis 3
Axis 2
Axis 1
Manually
Each joint can be rotated by a parameterizable angle until the axis is initialized.
9.2 Automatic initialization via Modbus
Set the maximum time for initialization: Modbus Holding Register (3000 & 3001)
Starting the initialization: Modbus Coil 20
9.3 Manual initialization via Modbus
Set by how many degrees the respective axis should be rotated: Modbus Holding Register (3002 - 3013)
Starting the initialization: Modbus Coil 21 - 26