Software Interface#

Introduction#

The new FlexiBowl® interface is fully web-based. To access it, simply enter the default IP address of the FlexiBowl® 192.168.1.10 in the address bar of your browser.

Communication#

The communication system is based on Input/Output variables and numeric Control Words: the external system sends a number (the ControlWord) that identifies the action to be performed and the FlexiBowl® responds with status signals and return data.

Supported protocols:

  • TCP Server

  • EtherNet/IP

  • Profinet

  • Modbus

Important

The variables, ControlWords and all the EXE, WRITE and READ commands described on this page are identical for all four communication protocols. What changes from protocol to protocol is only the way in which this data is physically exchanged:

  • EtherNet/IP, Profinet and Modbus behave the same way as each other: they exchange a cyclic I/O packet with fixed fields (see Fieldbus Transport).

  • TCP Server, on the other hand, uses text messages over a socket (see TCP Syntax).

For this reason, every practical example on this page is shown in both modes.



How a command works#

This logic is identical for all protocols: only the way in which the 4 steps are physically transmitted changes (I/O packet for fieldbus protocols, text message for TCP — see the following sections).

1

Set
ControlWord

command number
2

Set
Data_1

if required
3

Rising edge
ExecuteCW

trigger 0 → 1
4

Wait
Busy = 0

and ReturnData_1 = CW
  1. The external system sets the ControlWord with the number of the desired command.

  2. If the command requires an argument, it also sets Data_1.

  3. Sends a rising edge on ExecuteControlWord.

  4. Waits for Busy to return to 0 and for ReturnData_1 to return the ControlWord value (confirmation of correct execution).

Warning

Do not send a new command while Busy is 1. The system will ignore the command and ReturnData_1 will return the value 3 (system busy).


Input and Output Variables#

These variables are the same for all communication protocols: only the way they are exchanged changes (see Fieldbus Transport and TCP Syntax).

INPUT — Signals sent to the FlexiBowl®#

Variable

Type

Description

ControlWord

UDINT

Integer that identifies the command to be executed. Each value corresponds to a specific action (see command table).

Data_1

UDINT

Numeric argument associated with the ControlWord, when required (e.g. the speed value to be written). The meaning depends on the selected command.

ExecuteControlWord

BOOL

Trigger signal: on the rising edge (from 0 to 1) the ControlWord is read and the command is executed.

Hopper_1

BOOL

Directly activates Hopper 1, independently of the ControlWord.

Hopper_2

BOOL

Directly activates Hopper 2.

Hopper_3

BOOL

Directly activates Hopper 3.

Hopper_4

BOOL

Directly activates Hopper 4.

Reset

BOOL

On the rising edge, resets the active errors on the device.

OUTPUT — Signals sent by the FlexiBowl®#

Variable

Type

Description

Busy

BOOL

Is 1 while the FlexiBowl® is executing a command. As long as it is active, do not send new commands.

Ready

BOOL

Is 1 when the device is ready to receive new commands.

In_Error

BOOL

Is 1 if there are active errors on the device. Check ErrorCode to identify the type of error.

ReturnData_1

UDINT

Confirmation of the command received (echo). The possible values are: 0 = initial state (no command), 1 = command not interpretable, 2 = wrong Data_1 but command recognized, 3 = system busy (Busy), or the ControlWord value itself = command executed correctly.

ReturnData_2

UDINT

Contains the data requested by the read (READ) commands.

ErrorCode

UDINT

Numeric code of the active error. Is 0 if there are no errors. See the Error Codes section for the meaning of each code.

InPowerOn

BOOL

Is 1 if the device is powered and operational.

ReturnData_1 values#

Value Meaning
0 NULL — no command in progress (initial state)
1 Command not interpretable (unknown ControlWord)
2 Data_1 out of range, command recognized
3 System busy (Busy) — try again
= CW Command executed correctly

EtherNet/IP, Profinet, Modbus - FIELDBUS#

For EtherNet/IP, Profinet and Modbus, the Input and Output variables are exchanged as a cyclic I/O packet: there are no text messages, each variable occupies a fixed position in the data packet. For all detailed information on this protocol, refer to the next page.

Data packet — Input (to the FlexiBowl®)#

ControlWord

Data_1

ExecuteControlWord

Hopper_1

Hopper_2

Hopper_3

Hopper_4

Reset

(command number)

(argument)

(trigger bit 0→1)

(bit)

(bit)

(bit)

(bit)

(bit)

Data packet — Output (from the FlexiBowl®)#

Busy

Ready

In_Error

In_PowerOn

ReturnData_1

ReturnData_2

ErrorCode

(bit)

(bit)

(bit)

(bit)

(ControlWord echo)

(data read)

(error code)

Note

The write sequence is always the same: set ControlWord (and Data_1 if required) with ExecuteControlWord = 0, then bring ExecuteControlWord to 1 to generate the rising edge that starts execution.

GO TO THE DEDICATED PAGE

Complete documentation of the Fieldbus protocol (EtherNet/IP, Profinet, Modbus)

EtherNet/IP, Profinet, Modbus

Message Syntax TCP SERVER#

When TCP Server communication is used, commands are not sent as binary variables but as text strings through a socket connection on the configured port (default: 8123). For all detailed information on this protocol, refer to the next page.

Message structure#

Each message has the form:

VariableName[Value]%

The % character is the message terminator and must always be present at the end. The [Value] field contains the associated numeric data (ControlWord, status, etc.).

GO TO THE DEDICATED PAGE

Complete syntax of TCP Server messages, commands and terminators

TCP Server

Command Protocol#

The command protocol defines all the actions available through the ControlWord. The ControlWords are the same for all protocols; only the transport changes (see Fieldbus Transport and TCP Syntax). Commands are grouped into categories:

Commands EXE#

EXE commands start an immediate action on the FlexiBowl®. During execution Busy remains at 1.

Command

ControlWord

Busy during execution

ReturnData_1

Explanation

Exe Seq 1

10

YES

10

Execute Sequence 1

Exe Seq 2

11

YES

11

Execute Sequence 2

Exe Seq 3

12

YES

12

Execute Sequence 3

Exe Seq 4

13

YES

13

Execute Sequence 4

Exe Seq 5

14

YES

14

Execute Sequence 5

Exe Seq 6

15

YES

15

Execute Sequence 6

Exe Seq 7

16

YES

16

Execute Sequence 7

Exe Seq 8

17

YES

17

Execute Sequence 8

Exe Seq 9

18

YES

18

Execute Sequence 9

Exe Seq 10

19

YES

19

Execute Sequence 10

Exe Seq 11

20

YES

20

Execute Sequence 11

Exe Seq 12

21

YES

21

Execute Sequence 12

Exe Seq 13

22

YES

22

Execute Sequence 13

Exe Seq 14

23

YES

23

Execute Sequence 14

Exe Seq 15

24

YES

24

Execute Sequence 15

Exe Seq 16

25

YES

25

Execute Sequence 16

Exe Seq 17

26

YES

26

Execute Sequence 17

Exe Seq 18

27

YES

27

Execute Sequence 18

Exe Seq 19

28

YES

28

Execute Sequence 19

Exe Seq 20

29

YES

29

Execute Sequence 20

Start Jog Seq

40

YES

40

Start Jog

Stop Jog Seq

41

YES

41

Stop Jog

Reset Return Data

50

NO

0

Resets the value of ReturnData_1 and ReturnData_2, returning them to the initial state 0

Note

The Reset Return Data command (ControlWord 50) resets the value of ReturnData_1 and ReturnData_2, returning them to the initial state 0. It is useful to verify that a new command is actually received and processed.

Practical example#

To view a practical example of an EXE command over fieldbus, see the Practical Example EXE section. To view a practical example of an EXE command over TCP, see the Practical Example EXE TCP section.

Commands WRITE#

WRITE commands allow the operating parameters of the FlexiBowl® (speed, angles, times, etc.) to be modified directly from the external system, without having to access the graphical interface.

Sequence addressing logic#

Each sequence (from 1 to 20) has its own block of parameters. The ControlWord is calculated with the formula:

ControlWord = N × 100 + parameter_offset

where N is the sequence number (1–20) and offset_parametro identifies the specific parameter.

Writable parameters for each sequence#

Parameter

Offset

Range Data_1

Notes

AccelerationMove

00

1–100

Acceleration ramp of the rotary movement (%)

DecelerationMove

01

1–100

Deceleration ramp of the rotary movement (%)

SpeedMove

02

1–100

Speed of the rotary movement (%)

AngleMove

03

0–720

Rotation angle in degrees. Values 1000–1720 = negative angle (opposite direction)

AccelerationShake

04

1–100

Acceleration ramp of the shake (%)

DecelerationShake

05

1–100

Deceleration ramp of the shake (%)

CountShake

06

2–20

Number of oscillations per shake cycle

CwAngleShake

07

0–360

Clockwise rotation angle during the shake. Values 1000–1360 = negative angle

CcwAngleShake

08

0–360

Counterclockwise rotation angle during the shake. Values 1000–1360 = negative angle

SpeedShake

09

1–100

Speed of the shake (%)

FlipCount

10

0–20

Number of flips per cycle

FlipDelay

11

0–500

Pause between one flip and the next (ms)

BlowDelay

12

0–500

Pause between one blow pulse and the next (ms)

ProportionalValve_Flip

13

0–600

Flip proportional valve pressure (value /100 = Bar)

ProportionalValve_Blow

14

0–600

Blow proportional valve pressure (value /100 = Bar)

Delete all sequence

30

—

Deletes all commands from the sequence list

Emptying Sequence

40

0–1

0 = normal mode, 1 = Quick Emptying mode

Seq Add Cmd

50

FLB COMMAND

Adds a command to the sequence list

WRITE ControlWord examples#

Sequence

Parameter

Offset associated with the parameter

Formula (N x 100 + Offset)

ControlWord

SEQ 1 (N=1)

AccelerationMove

00

1 x 100 + 00

100

SEQ 1 (N=1)

SpeedMove

02

1 x 100 + 02

102

SEQ 1 (N=1)

FlipCount

10

1 x 100 + 10

110

SEQ 1 (N=1)

Emptying Sequence

40

1 x 100 + 40

140

SEQ 1 (N=1)

Seq Add Cmd

50

1 x 100 + 50

150

SEQ 2 (N=2)

AccelerationMove

00

2 x 100 + 00

200

SEQ 2 (N=2)

SpeedMove

02

2 x 100 + 02

202

SEQ 5 (N=5)

AngleMove

03

5 x 100 + 03

503

SEQ 10 (N=10)

FlipDelay

11

10 x 100 + 11

1011

SEQ 20 (N=20)

SpeedMove

02

20 x 100 + 02

2002

Tip

The formula is simple:

  • To write the speed (offset 02) of sequence 7, the ControlWord is 7 × 100 + 2 = 702.

  • To write the FlipCount (offset 10) of sequence 15, the ControlWord is 15 × 100 + 10 = 1510.

Practical example#

To view a practical example of a WRITE command over fieldbus, see the Practical Example WRITE section. To view a practical example of a WRITE command over TCP, see the Practical Example WRITE TCP section.

WRITE JOG parameters#

The Jog parameters (continuous manual operation) are configurable separately via ControlWord in block 20000.

Parameter

ControlWord

Range Data_1

Notes

AccelerationJog

20001

0–100

Jog acceleration ramp (%)

DecelerationJog

20002

0–100

Jog deceleration ramp (%)

SpeedJog

20003

0–100

Jog speed (%). Values 1000–1100 = negative speed (reverse rotation)

FlipJog_Enable

20004

0–1

0 = flip disabled, 1 = flip enabled during jog

FlipJog_Duration

20005

0–1000

Flip pulse duration (ms)

FlipJog_Pressure

20006

0–600

Flip pressure (/100 = Bar)

FlipJog_Pause

20007

0–1000

Pause between consecutive flips (ms)

BlowJog_Enable

20008

0–1

0 = blow disabled, 1 = blow enabled during jog

BlowJog_Duration

20009

0–1000

Blow pulse duration (ms)

BlowJog_Pressure

20010

0–600

Blow pressure (/100 = Bar)

BlowJog_Pause

20011

0–1000

Pause between consecutive blows (ms)

BlowJog_Type

20012

0–2

Blow type: 0 = BLOWc, 1 = BLOWe, 2 = BLOWc+BLOWe

Backlight_1

20013

0–1

0 = off, 1 = on

Backlight_2

20014

0–1

0 = off, 1 = on


Commands READ#

READ commands allow the parameters currently configured in the FlexiBowl® to be read. The value read is returned in ReturnData_2.

READ addressing logic for sequences#

The ControlWord for reading is calculated with the formula:

ControlWord = 10000 + N × 100 + parameter_offset

where N is the sequence number (1–20) and offset_parametro is the same one used in the WRITE commands.

The readable parameters are the same as in the WRITE block, with the addition of the 10 command list slots:

Additional parameter

Offset

Description

Seq Slot 1 Cmd

50

Command at position 1 in the sequence list

Seq Slot 2 Cmd

51

Command at position 2

…

…

…

Seq Slot 10 Cmd

59

Command at position 10

READ ControlWord examples#

Sequence

Parameter

ControlWord

SEQ 1

AccelerationMove

10100

SEQ 1

SpeedMove

10102

SEQ 1

FlipCount

10110

SEQ 1

Emptying Sequence

10140

SEQ 1

Slot 1 Cmd

10150

SEQ 1

Slot 10 Cmd

10159

SEQ 5

AngleMove

10503

SEQ 10

SpeedMove

11002

SEQ 20

Emptying Sequence

12040

Tip

Quick formula: To read the speed (offset 02) of sequence 12, the ControlWord is 10000 + 12 × 100 + 2 = 11202.

Practical example#

To view a practical example of a READ command over fieldbus, see the Practical Example READ section. To view a practical example of a READ command over TCP, see the Practical Example READ TCP section.

READ JOG parameters#

The same writable JOG parameters (block 20000) can be read in block 20100:

Parameter

READ ControlWord

Range ReturnData_2

AccelerationJog

20101

0–100

DecelerationJog

20102

0–100

SpeedJog

20103

0–100 (1000–1100 = negative)

FlipJog_Enable

20104

0–1

FlipJog_Duration

20105

0–1000

FlipJog_Pressure

20106

0–600 (/100)

FlipJog_Pause

20107

0–1000

BlowJog_Enable

20108

0–1

BlowJog_Duration

20109

0–1000

BlowJog_Pressure

20110

0–600 (/100)

BlowJog_Pause

20111

0–1000

BlowJog_Type

20112

0–2

Backlight_1

20113

0–1

Backlight_2

20114

0–1


Commands HOPPER#

Hopper commands control the Bulk Feeders connected to the system (up to 4). They follow the same ControlWord/WRITE/READ logic described above, valid for all protocols, plus a dedicated TCP syntax for quick start.

Hopper WRITE commands#

Parameter

ControlWord

Range Data_1

Description

Hopper_1_Id

30001

1–100

Unique ID of hopper 1 on the network

Hopper_1_Amplitude

30002

50–220

Vibration amplitude of hopper 1

Hopper_1_Frequency

30003

40–70

Vibration frequency of hopper 1

Hopper_1_Activation_Time

30004

400–60000

Activation time of hopper 1 (ms)

Hopper_2_Id

30005

1–100

Unique ID of hopper 2

Hopper_2_Amplitude

30006

50–220

Vibration amplitude of hopper 2

Hopper_2_Frequency

30007

40–70

Vibration frequency of hopper 2

Hopper_2_Activation_Time

30008

400–60000

Activation time of hopper 2 (ms)

Hopper_3_Id

30009

1–100

Unique ID of hopper 3

Hopper_3_Amplitude

30010

50–220

Vibration amplitude of hopper 3

Hopper_3_Frequency

30011

40–70

Vibration frequency of hopper 3

Hopper_3_Activation_Time

30012

400–60000

Activation time of hopper 3 (ms)

Hopper_4_Id

30013

1–100

Unique ID of hopper 4

Hopper_4_Amplitude

30014

50–220

Vibration amplitude of hopper 4

Hopper_4_Frequency

30015

40–70

Vibration frequency of hopper 4

Hopper_4_Activation_Time

30016

400–60000

Activation time of hopper 4 (ms)

Hopper_1_Enable

30017

—

Enable hopper 1 (immediate action)

Hopper_1_Disable

30018

—

Disable hopper 1 (immediate action)

Hopper_2_Enable

30019

—

Enable hopper 2

Hopper_2_Disable

30020

—

Disable hopper 2

Hopper_3_Enable

30021

—

Enable hopper 3

Hopper_3_Disable

30022

—

Disable hopper 3

Hopper_4_Enable

30023

—

Enable hopper 4

Hopper_4_Disable

30024

—

Disable hopper 4

Note

In the training material, ControlWord 30005 (Hopper_2_Id) mistakenly reported the same range as Amplitude (50–220). In this table it has been corrected to 1–100, consistent with Hopper_1_Id, Hopper_3_Id and Hopper_4_Id. Verify this value against the firmware/datasheet before publishing the page.

Practical example#

To view a practical example of a WRITE HOPPER command over fieldbus, see the Practical Example WRITE HOPPER section. To view a practical example of a WRITE HOPPER command over TCP, see the Practical Example WRITE HOPPER TCP section.

Hopper READ commands#

Parameter

READ ControlWord

Range ReturnData_2

Notes

Hopper_1_Id

30101

1–100

Hopper_1_Amplitude

30102

50–220

Hopper_1_Frequency

30103

40–70

Hopper_1_Activation_Time

30104

400–60000

Hopper_2_Id

30105

1–100

Hopper_2_Amplitude

30106

50–220

Hopper_2_Frequency

30107

40–70

Hopper_2_Activation_Time

30108

400–60000

Hopper_3_Id

30109

1–100

Hopper_3_Amplitude

30110

50–220

Hopper_3_Frequency

30111

40–70

Hopper_3_Activation_Time

30112

400–60000

Hopper_4_Id

30113

1–100

Hopper_4_Amplitude

30114

50–220

Hopper_4_Frequency

30115

40–70

Hopper_4_Activation_Time

30116

400–60000

Hopper_1_Ready

30117

0–1

0 = not ready, 1 = ready

Hopper_2_Ready

30118

0–1

0 = not ready, 1 = ready

Hopper_3_Ready

30119

0–1

0 = not ready, 1 = ready

Hopper_4_Ready

30120

0–1

0 = not ready, 1 = ready

Hopper_1_InVibration

30121

0–1

0 = stopped, 1 = vibrating

Hopper_2_InVibration

30122

0–1

0 = stopped, 1 = vibrating

Hopper_3_InVibration

30123

0–1

0 = stopped, 1 = vibrating

Hopper_4_InVibration

30124

0–1

0 = stopped, 1 = vibrating

Hopper_1_Enabled

30125

0–1

0 = disabled, 1 = enabled

Hopper_2_Enabled

30126

0–1

0 = disabled, 1 = enabled

Hopper_3_Enabled

30127

0–1

0 = disabled, 1 = enabled

Hopper_4_Enabled

30128

0–1

0 = disabled, 1 = enabled

Practical example#

To view a practical example of a READ HOPPER command over fieldbus, see the Practical Example READ HOPPER section. To view a practical example of a READ HOPPER command over TCP, see the Practical Example READ HOPPER TCP section.


Quick Emptying commands — EMPTYING#

The Emptying function allows the FlexiBowl® plate to be emptied by running up to 4 dedicated sequences, each with its own number of loops. These commands also follow the same ControlWord logic, valid for all protocols.

EXE Commands#

Command

ControlWord

Busy during execution

ReturnData_1

Explanation

Start Emptying

45

YES (Emptying active)

45

Starts Quick Emptying

Stop Emptying

46

YES (Emptying active)

46

Stops Quick Emptying

Emptying Active

47

NO

47

Checks whether Quick Emptying is active

WRITE Commands#

Command

ControlWord

Range Data_1

Busy during execution

ReturnData_1

FirstSequence

20200

1–20

NO

20200

FirstLoop

20201

0–500

NO

20201

SecondSequence

20202

1–20

NO

20202

SecondLoop

20203

0–500

NO

20203

ThirdSequence

20204

1–20

NO

20204

ThirdLoop

20205

0–500

NO

20205

FourthSequence

20206

1–20

NO

20206

FourthLoop

20207

0–500

NO

20207

READ Commands#

Command

ControlWord

Busy during execution

ReturnData_1

Range ReturnData_2

FirstSequence

20300

NO

20300

1–20

FirstLoop

20301

NO

20301

0–500

SecondSequence

20302

NO

20302

1–20

SecondLoop

20303

NO

20303

0–500

ThirdSequence

20304

NO

20304

1–20

ThirdLoop

20305

NO

20305

0–500

FourthSequence

20306

NO

20306

1–20

FourthLoop

20307

NO

20307

0–500

Note

FirstSequence…FourthSequence indicate which of the 20 programmed sequences is executed in each of the 4 steps of the Quick Emptying; FirstLoop…FourthLoop indicate how many times that step is repeated.


Error Codes#

Warning

In the presence of an error, the In_Error LED turns on and the system will not execute new motion commands until the reset. Before performing the reset, identify and resolve the cause of the error.

General Codes#

ErrorCode

Description

1

The jog movement did not trigger any action on the motor

2

Motor not connected

3

EtherNet/IP selected but not connected

4

The motor did not reach operating power within the preset time

5

Motor movement requested, but the motor is not powered

6

Digital I/O module error: module missing

7

Digital I/O module error: configuration error

8

Digital I/O module error: general error

Driver Error Codes#

CodeHexErrorDescription
500x7500EtherCAT communication error
510xFF01Drive Over CurrentExcessive motor current
520xFF02Drive Over VoltageExcessive DC bus voltage
530xFF03Drive Over TemperatureDriver temperature too high
540xFF04Reserved
550xFF05Drive Internal Voltage ErrorInternal voltage error
560xFF06Position ErrorPositioning error
570xFF07Motor Encoder DisconnectedEncoder not connected or faulty
580xFF0ARegen FailedError in the regeneration circuit
590xFF0BSafe Torque Off (STO)Safety function active
600xFF0CReserved
610xFF0DBad FPGAInternal error of the driver FPGA
620xFF0EParameter Read FailedParameter read failed
630xFF0FMotor Encoder Multi-turn ErrorMulti-turn encoder error
640xFF10Motor Stall ProtectionMotor stall protection active
650xFF11Drive Power Module Over TemperaturePower module overheated
660xFF31N LimitNegative position limit reached
670xFF32P LimitPositive position limit reached
680xFF33N&P LimitBoth position limits reached
690xFF34Current FoldbackCurrent reduction for thermal protection
700xFF35Move @ DisabledAttempted movement with the driver disabled
710xFF36Drive Low VoltageInsufficient DC bus voltage
720xFF37Blank Q SegmentUndefined trajectory segment
730xFF38Velocity LimitSpeed limit exceeded
740xFF39Drive Power Phase LostLoss of a power supply phase
750xFF3AEmergency StopEmergency stop active
760xFF3BAbs. Encoder BatteryAbsolute encoder battery low or missing
770xFF3CAbs. Position Lost WarningAbsolute position loss warning
780xFF3DAbs. Position OverflowAbsolute position overflow
790xFF3EMotor Over TemperatureExcessive motor temperature
800xFF3FDrive Voltage WarningDriver voltage out of range warning
810xFF41Save FailedParameter saving failed
820xFFFFOther ErrorGeneric unclassified error