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).
Each message has the form:
NomeVariabile[Valore]%
The % character is the message terminator and must always be present at the end. The [Valore] field contains the associated numeric data (ControlWord, status, etc.).
TCP syntax table#
Operation |
Message to send |
Response if OK |
Response if error |
|---|---|---|---|
All EXE commands |
|
|
|
All WRITE commands |
|
|
|
All READ commands |
|
|
|
Error reset |
|
|
— |
Read Busy status |
|
|
|
Read Ready status |
|
|
|
Read InError status |
|
|
|
Read InPowerOn status |
|
|
|
Read ErrorCode |
|
|
|
Note
In READ-type responses, the text [value] is replaced with the actual numeric value read by the system. For example, to read the speed of SEQ 1 (ControlWord 10102), 10102[0]% is sent and 10102[35]% is received if the speed is set to 35%.
Warning
Hopper commands via TCP (Hopper1Start%, etc.) work only when communication is active and the FlexiBowl® is not moving. Correct operation is not guaranteed if the FlexiBowl® is executing a sequence or is in jog mode.
Meaning of ReturnData_1 (or TCP response)#
Value |
Meaning |
|---|---|
|
NULL — no command in progress (initial state) |
|
Command not interpretable (unknown ControlWord) |
|
Data_1 out of range, but the command was recognized |
|
System busy (Busy) — retry after Busy returns to 0 |
Value = ControlWord |
Command executed correctly |
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 |
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 — «Execute Sequence 3»#
12[0]%RETURN IF OK: 12[0]
Example of an invalid command (e.g. sequence 9 does not exist on the device):
9[0]%RETURN IF NOT OK: 1[0]
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 — «Set the Move acceleration to 80 in Sequence 7»#
700[80]%RETURN IF OK: 700[0]
Example of an out-of-range value (acceleration 1000 not allowed, range 1–100):
700[1000]%RETURN IF NOT OK: 2[0]
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 — «Read the angle of Sequence 16»#
11603[0]%RETURN IF OK: 11603[45]
Example of an out-of-range value when writing to the same parameter (maximum angle 720°):
11603[6799]%RETURN IF NOT OK: 1[0]
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.
Quick start via TCP#
In addition to the general ControlWord syntax, the TCP Server protocol offers dedicated messages to start a hopper directly:
Operation |
Message to send |
Response |
|---|---|---|
Start Hopper 1 |
|
|
Start Hopper 2 |
|
|
Start Hopper 3 |
|
|
Start Hopper 4 |
|
|
On the fieldbus protocols (EtherNet/IP, Profinet, Modbus) the same immediate start is obtained by directly setting to 1 the Hopper_1…Hopper_4 bit of the I/O packet, without going through the ControlWord.
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 — «Enable Hopper 1»#
Via generic ControlWord:
30017[0]%RETURN IF OK: 30017[0]
Or, for start only, with the dedicated message:
Hopper1Start%RETURN: Hopper1Start *
Practical example — «Set the amplitude of Hopper 2 to 220»#
30006[220]%RETURN IF OK: 30006[0]
Example of an out-of-range value (amplitude 2200 not allowed, range 50–220):
30006[2200]%RETURN IF NOT OK: 2[0]
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 — «Read the frequency of Hopper 4»#
30115[0]%RETURN IF OK: 30115[40]
Example of a non-interpretable command (non-existent READ ControlWord):
30199[0]%RETURN IF NOT OK: 1[0]
Note
For the Quick Emptying commands, refer to the Quick Emptying Commands section
Important
For the Error Codes, refer to the Error Codes section