CommandFusion Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Joins ======

CommandFusion software uses a method of data assignment and object identification called 'Joins'. Joins are basically a way of assigning a value to a particular GUI object (or multiple objects). You can think of a join as the ID of a GUI object such as a [[software:gui-designer:buttons|Button]], [[software:gui-designer:sliders|Slider]], etc.\\

Joins are divided into four data types:
  - Digital
  - Analog
  - Serial
  - List

===== Digital Joins =====

A digital join has two possible values, 0 or 1 (off or on, low of high, active or inactive). This boolean data type allows button interaction, such as detecting [[software:gui-designer:buttons|button]] press/release and toggling the button, as well as showing/hiding [[software:gui-designer:subpage|subpages]] and performing page flips.

Within guiDesigner, digital join numbers will appear on a blue background above the object the join is assigned to when 'View > Display Object Join Numbers' is enabled. 

The image below gives shows how a basic digital join system can work. Please note that this is only showing one of many possible ways that digital joins can work.

{{:software:gui-designer:digital_joins.png?nolink|}}

In the system shown above we are turning a projector on and getting feedback from the projector which updates the button state. It would work as follows:
  - The inactive button with a digital join of 20 is touched
  - This sends a power toggle command, via the TCP socket to the projector
  - The projector turns on and sends feedback data via the TCP socket
  - The feedback data is processed to see if it is feedback data which relates to the power state of the projector
  - If it is, then the feedback processing you programmed into iViewer captures the power state. If the power state is high (on) then it updates any object with a digital join of 20 to active, if the power state is low (off) then is updates the button state to inactive
===== Analog Joins =====

An analog join has an integer value ranging from 0 (zero) to 65535. This whole integer data type allows for [[software:gui-designer:gauges|gauge]] and [[software:gui-designer:sliders|slider]] interactions, such as setting a gauge level or sending a level when adjusting a slider.\\
It can also be used to adjust the Interval of [[software:gui-designer:timers|Page Timers]].

Within guiDesigner, analog join numbers will appear on a red background above the object the join is assigned to when 'View > Display Object Join Numbers' is enabled.

The image below gives shows how a basic analog join system can work. Please note that this is only showing one of many possible ways that analog joins can work.

{{:software:gui-designer:analog_joins.png?nolink|}}

In the system shown above we are adjusting the volume level on an AV Receiver and getting feedback from the Receiver which updates the slider value to reflect the current level. This means that if the level is changed from another GUI or on the unit directly, the level is updated automatically. It would work as follows:
  - The slider with an analog of 20 is dragged to the desired level
  - This sends a volume level command, via the TCP socket to the AV receiver
  - The AV receiver adjusts its level as per the command sent and feedback data is replied via the TCP socket
  - The feedback data is processed to see if it relates to the volume level of the AV Receiver
  - If it does, then the feedback processing you programmed into iViewer captures the volume level. The slider is automatically updated to show the volume level that the AV Receiver is currently set to

===== Serial Joins =====

A serial join has a string value, with no length limitation set on the CommandFusion end (a Control System being used may have it's own string length restrictions however).
This string data type allows showing dynamic text, dynamic images URLs, webview URLs, etc.
A serial join value can also be set using [[software:gui-designer:input-field|Input Fields]] within iViewer.

Within guiDesigner, serial join numbers will appear on a black background above the object the join is assigned to when 'View > Display Object Join Numbers' is enabled.

The image below gives shows how a basic serial join system can work. Please note that this is only showing one of many possible ways that serial joins can work.

{{:software:gui-designer:serial_joins.png?nolink|}}

In the system shown above we are touching a button which sends a command to the AV Receiver to go to the next input. The AV Receiver would then send feedback to the GUI, automatically showing the name of the input on the button. It would work as follows:
  - The button with a serial join of 20 is touched
  - This sends a next input command, via the TCP socket to the AV receiver
  - The AV Receiver switches its input as per the command sent and feedback data is replied via the TCP socket
  - The feedback data is processed to see if it relates to the input name of the AV Receiver
  - If it does, then the feedback processing you programmed into iViewer captures the input name. The button text updates to show the input name that the AV Receiver is currently set to

===== List Joins =====

A list join is used to identify a List object.

Within guiDesigner, list join numbers will appear on a dark red background above the object the join is assigned to when 'View > Display Object Join Numbers' is enabled.

The image below gives shows how a basic list join system can work. Please note that this is only showing one of many possible ways that list joins can work.

{{:software:gui-designer:list-joins.png?nolink|}}

===== Join Numbers =====
The actual number used can be in the range from 0 to 999999999. The same join number and join type can be assigned to multiple objects in your GUI, and they will all react to a change of the join value.

A join number of zero (0) is a special case, which means "no join assigned". By default all objects are assigned a zero join.
CommandFusion Wiki

User Tools

Site Tools

Page Tools
