1 - Ember+ Consumer
This protocol implements a client (consumer) connection to an Ember+ Provider.
Supported Devices and Prerequisites
We can connect to all devices that implement an Ember+ provider.
The connection can currently only handle Ember+ parameters of the type string, integer, float and boolean. All other parameters are ignored during enumeration.
Configuration
On the General tab, enter IP and port of the Ember+ provider.
Parameters
Parameters are fully dynamic in an Ember+ connection. BTConnect will enumerate the Ember+ tree at startup and propagate its own parameter tree accordingly. Value types and readable/writable flags will be the same as in the Ember+ tree.
Parameter Filter
If you want to limit the Ember+ tree to certain subtrees, go to the Filter tab and enter one or more Ember paths. These are treated as subtrees, e.g. if you enter
Device
Channels
only the Ember+ nodes that start with Device/...
or Channel/...
will become
available as parameters.
Matrix Support
BTConnect provides limited support for the Ember+ Matrix Extension, allowing you to monitor and set crosspoints on matrixes provided over Ember+.
The support is “limited” by the fact that BTConnect does not have a matrix type of its own, so the Ember+ matrix must be translated into one or more string or numeric parameters.
On the General tab of the connection properties, you can choose between four different modes:
Disabled
Matrix support is disabled, matrix notes will not become available as parameters.
Write-Only (One String Parameter)
The matrix will be represented by a single write-only parameter that can be used to set or clear crosspoints.
Note
You must use numeric IDs for the crosspoints which can be looked up inEmberPlusView.exe
.
Examples:
-
Set crosspoint - source 1 to target 7:
7:1
-
For n-to-m-matrixes, set two sources (1 and 2) to target 7:
7:1,2
-
For n-to-m-matrixes, add another source to the existing set:
7:+3
-
For n-to-m-matrixes, remove a source from the existing set:
7:-3
-
Multiple commands can be sent at the same time, delimited with spaces (e.g. source 1 to target 7 and source 2 to target 8):
7:1 8:2
Simple (One String Parameter)
This is similar to Write-Only, with a single string parameter representing the matrix - but this time, it is read-write, and the value represents the current state of the matrix, in the same syntax as used for the updates above.
Extended (One Parameter per Target)
In this mode, each target in the matrix is represented by a separate read-write string parameter.
Note
This mode should only be used for matrixes with a low number of targets!You can send string values to the target nodes in order to update
crosspoints for that target, similar to the syntax above, but
with out the target:
prefix.
-
Set target to source 1:
1
-
Set target to source 1 and source 2 (n-m-matrix):
1,2
-
Add source 2 to target:
+2
-
Remove source 2 from target:
-2
In addition to the per-target parameters, a top level write-only string parameter will be available, representing the entire matrix, which accepts multi-crosspoint updates similar to Write-Only mode described above.
2 - Ember+ Provider
The Ember+ Provider connection exposes the entire BTConnect parameter tree as an Ember+ tree, to be used with third-party Ember+ consumers.
Configuration
TCP Settings
On the General tab, the following settings are available:
- Port: The default port number is 9000.
- Bind IP: Enter an IP adress here to bind to a specific local interface. Default is to listen on all interfaces.
- Keepalive Interval: Interval in seconds of keepalive requests sent to each connected consumer.
- Keepalive Timeout: The consumer connection will be terminated if no reply to a keepalive request was received within this period.
Filter
If you select a specific connection, only the parameters from that connection will be exposed through the Ember+ provider, without any prefix.
If no connection is selected, the entire parameter tree, including all
connection, will be exposed, in the form <Connection ID>/<Parameter>
.
Additionally, you can enter on or more filters, in order to limit the exposed tree to only parts of the entire parameter tree.
Values entered here are processed as Perl-compatible regular expressions.
Parameters
The Ember+ Provider connection does not provide any parameters.