Tesira DSP Essentials Plugin (c) 2023

Warning

INVALID TAGS BREAK THIS RELEASE
Do not update Biamp FW independent of Crestron Software and Essentials

Important

Biamp FW v4.7.2 requires Essentials v1.15.5, or newer

Biamp FW v.4.7.2 includes a change of "deprecated SSH ciphers" which eliminates the ability to connect over SSH using Essentials v1.15.4 and prior. Essentials v1.15.5 is compiled with the latest Crestron libraries, which are rleied upon for the SSH connection and resolves the issue.

License

Provided under MIT license

Overview

The Tesira plugin provides device control over the Biamp Tesira family of DSPs with regards to the most commonly used and requested attriute and control types.

Compatibility

This plugin has been tested with both Crestron 3-Series and 4-Series processors. It implements all available essentials interfaces relevant to a device of this type. This includes but is not limited to AudioCodecBase, IHasDspPresets, IBasicVolumeWithFeedback, IRoutingWithFeedback and IDeviceInfoProvider. Documentation for which controls implement each interface will be documented in each relevant controls section. Additionally, every component implements IKeyed and all devices are added to the DeviceManager unpon instantiation.

Cloning Instructions

After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below.

Dependencies

The Essentials libraries are required. They referenced via nuget. You must have nuget.exe installed and in the PATH environment variable to use the following command. Nuget.exe is available at nuget.org.

Installing Dependencies

To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: nuget install .\packages.config -OutputDirectory .\packages -excludeVersion. To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.

Feature Notes

Version 2.0.0+ now offers developers the opportunity to individually bridge each control rather than the entire DSP object. This should lead to more flexibility in development. In documentation below, all references to the original object type will be referred to as Legacy, while new object data will be referred to as Standalone

When utilizing a standalone object within a Eisc bridge, it is addressed utilizing first the name of the base device, followed by a pair of two hyphens, then the key of the component.

It is exceptionally important that all keys are unique. In a future version, it's likely that this naming convention will become more verbose, but as of now, to prevent key names from being ridiculously long, I've opted to trust users to police themselves.

For a parent device with a key of dsp-1 and a component with the key of Fader01, the Standalone component key is dsp-1--Fader01.

The only exception to this rule is for the Base Standalone object, which has a key suffix of DeviceInfo

[!IMPORTANT]Important to note this version of the plugin currently implements both eiscApi and EiscApiAdvanced as valid bridge types**

"type": "eiscApiAdvanced"

Installation

This plugin is provided as a published nuget package for your convenience.

Place the *.cplz file in the /users/programxx/plugins folder, and restart your program.

Controls and Configs

DeviceInfo

This object is built by default with a Biamp Tesira DSP and provides a method to send hardware-specific data across the bridge to SIMPL

This data is only accessible by linking the device to the bridge. The component key is always DeviceInfo - therefore when a Biamp Tesira DSP with the key dsp-1 is instantiated, a DeviceInfo component with the key of dsp-1--DeviceInfo will be added to the DeviceManager and will be accessible to any Essentials Bridge.

This device will also allow a direct passthru connection to the device if necessary and a method by which to trigger control resubscription.

If you do not choose to bridge a Standalone object, limited data is available on the Legacy object.

This control implements Essentials interfaces IDeviceInfoProvider and IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
1	1	R	Device Online
N/A	1	W	Resubscribe Controls

Analogs

None

Serials

Legacy Join	Standalone Join	Type (RW)	Description
N/A	1	R	Device Name
N/A	2	RW	Command Passthrough
N/A	3	R	Serial Number
N/A	4	R	Firmware Version
N/A	5	R	Hostname
N/A	6	R	IP Address
N/A	7	R	MAC Address

Config Notes

This configuration matches a standard essentials device configuration at the base level, with only the type being different. This may have the type tesira, tesiraforte, tesiraserver, tesiradsp, or tesira-dsp.

{    
    "key": "TesiraDsp-1",
    "name": "TesiraDspTesting",
    "type": "tesiraDsp",
    "group": "dsp",
    "properties": {
        "control": {
            "endOfLineString": "\n",
            "deviceReadyResponsePattern": "",
            "method": "ssh",
            "tcpSshProperties": {
                "address": "10.11.50.191",
                "port": 22,
                "autoReconnect": true,
                "AutoReconnectIntervalMs": 10000,
                "username": "default",
                "password": "default"
            }
        }
    }
}

Level / Mute

Controls objects with the attribute type of "level" or "mute" and subscribes to them as necessary.

This component only reports the level of the audio signal relative the the adjustable range

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + fader bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This Control implements Essentials interfaces IKeyed and IBasicVolumeWithFeedback

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
200	6	R	Channel Visible
400	5	RW	Mute Toggle
600	3	RW	Mute On
800	4	RW	Mute Off
1000	1	W	Volume Up
1200	2	W	Volume Down

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
200	1	RW	Volume Level
400	2	R	Icon (0 - Level, 1 - Mic)
600	3	R	ControlType (0 Mute/Level, 1 LevelOnly, 2 MuteOnly)
800	4	R	Permissions (Pass From Config)

Serials

Legacy Join	Standalone Join	Type (RW)	Description
200	1	R	Control Label (Pass From Config)

Config Example

All Level/Mute configs must be part of a dictionary called faderControlBlocks.

"faderControlBlocks": {
    "LevelControl01": {
        "enabled": true,
        "isMic": false,
        "hasLevel": true,
        "hasMute": true,
        "index1" : 1,
        "index2" : 0,
        "label": "Room",
        "levelInstanceTag": "ROOMVOL",
        "muteInstanceTag": "ROOMVOL",
        "unmuteOnVolChange" : true,
        "incrementAmount" : "2.0",
        "permissions" : 0,
        "bridgeIndex" : 1
    }
}

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. isMic - drives the icon feedback. hasLevel - in conjunction with hasMute, sets the ControlType. hasMute - in conjunction with hasStatus, sets the ControlType. index1 - Index 1 of the control point. index2 - Index 2 of the control point. levelInstanceTag - Instance tag of the level control. muteInstanceTag - Instance tag of the mute control. unmuteOnVolChange - if true, will unmute a muted control when the level increases. incrementAmount - the value in decimals by which a mute increment or decrement command will manipulate the level. permissions - Passed directly across the eisc as the Permissions value. bridgeIndex - The index of the control on a Legacy object

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--LevelControl01.

Switcher

Note

Version 2.5.0 added the ability to configure SourceSelectors and Routers as different objects. It is recommended to use this mechanism in new projects.

Controls objects with the attribute type of sourceSelection and subscribes to them as necessary; input is not subscribed to.

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + fader bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interfaces IKeyed and IRoutingWithFeedback

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
150	1	W	Poll

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
150	1	RW	Source Selection

Serials

Legacy Join	Standalone Join	Type (RW)	Description
150	1	R	Control Label (Pass From Config)
N/A	2	R	Source List XSIG (If Configured) or Routed Source

Config Example

All sourceSelector and router configs must be part of a dictionary called switcherControlBlocks. Router configs require that the "type" be set to "router"

"switcherControlBlocks" : {
    "SwitcherControl01" : {
        "enabled" : true,
        "label" : "switcher01",
        "index1" : 1
        "switcherInstanceTag" : "SourceSelector1",
        "type": "router",
        "bridgeIndex" : 1,
        "showRoutedStringFeedback": true,
        "pollIntervalMs" : 90000,
        "switcherInputs" : {
            "1" : {"label": "Input1" },
            "2" : {"label": "Input2" },
        },
        "switcherOutputs" : {
            "1" : { "label": "Output1" },
            "2" : { "label": "Output2" },
        }
    }
}

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. index1 - Index 1 of the control point. type - Valid Types are sourceSelector or router switcherInstanceTag - Instance tag of the sourceSelection control bridgeIndex - The index of the control on a Legacy object switcherInputs - This is a dictionary of labels for inputs of the switcher. The keys must be integers. switcherOutputs - This is a dictionary of labels for outputs of the switcher. This is earmarked for future usage. The keys must be integers.

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--SwitcherControl01.

Router

Controls objects with the attribute type of input. No Subscriptions available on this control block

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + fader bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interfaces IKeyed and IRoutingWithFeedback

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
150	1	W	Poll

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
150	1	RW	Source Selection

Serials

Legacy Join	Standalone Join	Type (RW)	Description
150	1	R	Control Label (Pass From Config)
N/A	2	R	Source List XSIG (If Configured) or Routed Source

Config Example

All sourceSelector and router configs must be part of a dictionary called routerControlBlocks.

{
    "routerControlBlocks" : {
        "RouterControl01" : {
            "enabled" : true,
            "label" : "switcher01",
            "index1" : 1,
            "routerInstanceTag" : "Router1",
            "bridgeIndex" : 1,
            "showRoutedStringFeedback": true,
            "pollIntervalMs" : 90000,
            "routerInputs" : {
                "1" : {"label": "Input1" },
                "2" : {"label": "Input2" },
            },
            "routerOutput" : {
                "label": "Output1" 
            }
        }
    }
}

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. index1 - Index of the output number on the router that you wish to control. routerInstanceTag - Instance tag of the router input selection control bridgeIndex - The index of the control on a Legacy object routerInputs - This is a dictionary of labels for inputs of the router block. The keys must be integers. routerOutput - This is an object defining the label of the associated output. This is earmarked for future usage.

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--RouterControl01.

SourceSelector

Controls and subscribes to objects with the attribute type of sourceSelector.

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + fader bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interfaces IKeyed and IRoutingWithFeedback

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
150	1	W	Poll

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
150	1	RW	Source Selection

Serials

Legacy Join	Standalone Join	Type (RW)	Description
150	1	R	Control Label (Pass From Config)
N/A	2	R	Source List XSIG (If Configured) or Routed Source

Config Example

All sourceSelector and router configs must be part of a dictionary called routerControlBlocks.

{
    "sourceSelectorControlBlocks" : {
        "sourceSelectorControl01" : {
            "enabled" : true,
            "label" : "sourceSelector01",
            "index1" : 1,
            "sourceSelectorInstanceTag" : "SourceSelector1",
            "bridgeIndex" : 1,
            "showRoutedStringFeedback": true,
            "pollIntervalMs" : 90000,
            "sourceSelectorInputs" : {
                "1" : {"label": "Input1" },
                "2" : {"label": "Input2" },
            }
        }
    }
}

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. index1 - Index of the output number on the sourceSelector that you wish to control. sourceSelectorInstanceTag - Instance tag of the sourceSelection control bridgeIndex - The index of the control on a Legacy object sourceSelectorInputs - This is a dictionary of labels for inputs of the source selector block. The keys must be integers.

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--sourceSelectorControl01.

State

Controls objects with the attribute type of "state" and subscribes to them as necessary.

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + fader bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interface IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
1300	1	RW	State Toggle
1450	2	RW	State On
1600	3	RW	State Off

Analogs

None

Serials

Legacy Join	Standalone Join	Type (RW)	Description
1300	1	R	Control Label (Pass From Config)

Config Example

All state configs must be part of a dictionary called stateControlBlocks.

{
    "stateControlBlocks" : {
        "StateControl1" : {
            "enabled" : true,
            "label" : "State01",
            "stateInstanceTag" : "LogicState1",
            "subscriptionInstanceTag" : "LogicMeter1",
            "index" : 1,
            "bridgeIndex" : 1
        }
    }
}

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--StateControl1.

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. index - Index of the control point. stateInstanceTag - Instance tag of the state control subscriptionInstanceTag - (Optional) Instance tag of the meter control for subscribing to feedback. If null or empty, will attempt to subscribe to stateInstanceTag bridgeIndex - The index of the control on a Legacy object

Presets

If you intend to ONLY do direct preset calling by string, this object is NOT required to recall presets. This activity is provided by the base level device object for the Tesira DSP. It is also provided by the Standalone object Presets. This config object is required regardless of control object if preset control iby index is required.

This control implements Essentials interfaces IHasDspPreset and IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
100	1	W	Select Preset By Index
N/A	1	R	Preset is Available By Index

Analogs

None

Serials

Legacy Join	Join	Type (RW)	Description
100	1	R	Preset Name by Index
100	1	W	Recall Preset By Name

Config Example

All preset configs must be part of a dictionary called presets.

{
    "presets" : {
        "SomeUniqueKey": {
            "label" : "Default",
            "presetName" : "Default Levels",
            "presetId" : 1101,
            "presetIndex" : 1
        }
    }
}

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Presets.

Config Notes

label - Passed directly across the eisc as the Label value. presetName - the actual name of the preset as defined in biamp software presetID - the ID of the preset as defined in biamp software presetIndex - the index of the preset for the digital press recall

If a presetName is defined, you don't need a presetId and vice versa. One or the other will be fine. If you are utilizing the "select preset by name" methodology, no presets need be defined in config.

Dialer

VoIP Controls are tested

POTS Controls are added, but as of yet untested.

DTMF is automatically managed based on current hook state.

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + (1 + (50 * (n- 1))), where n is the index of the dialer as defined by bridgeIndex.

For example, Incoming Call for Line 1 would be at join 3101, while the incoming call for Line 2 would be at join 3151.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interfaces AudioCodecBase and IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
3100	1	R	Incoming Call
3106	2	W	Answer
3107	3	W	End Call
3110	4	W	Keypad 0
3111	5	W	Keypad 1
3112	6	W	Keypad 2
3113	7	W	Keypad 3
3114	8	W	Keypad 4
3115	9	W	Keypad 5
3116	10	W	Keypad 6
3117	11	W	Keypad 7
3118	12	W	Keypad 8
3119	13	W	Keypad 9
3120	14	W	Keypad *
3121	15	W	Keypad #
3122	16	W	Keypad Clear
3123	17	W	Keypad Backspace
3124	18	RW	Dial
3125	19	RW	Auto Answer On
3126	20	RW	Auto Answer Off
3127	21	RW	Auto Answer Toggle
3129	22	RW	On Hook
3130	23	RW	Off Hook
3132	24	RW	Do Not Disturb Toggle
3133	25	RW	Do Not Disturb On
3134	26	RW	Do Not Disturb Off

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
3100	1	R	CallState Value

Serials

Legacy Join	Standalone Join	Type (RW)	Description
3100	1	RW	Dial String
3101	2	RW	Dialer Label
3102	3	RW	Last Number Dialed
3104	4	R	Caller ID Number
3105	5	R	Caller ID Name

Config Example

All dialer configs must be part of a dictionary called dialerControlBlocks.

{
    "dialerControlBlocks" : {
        "Dialer1" : {
            "enabled" : true,
            "label" : "Dialer 01",
            "isVoip" : true,
            "dialerInstanceTag" : "Dialer1",
            "controlStatusInstanceTag" : "VoIPControlStatus1",
            "index" : 1,
            "callAppearance" : 1,
            "clearOnHangup" : true,
            "appendDtmf" : false,
            "bridgeIndex" : 1
        }
    }
}

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Dialer1.

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. index - Index of the line you wish to manage. dialerInstanceTag - Instance tag of the dialer control controlStatusInstanceTag - Instance tag of the controlStatus control isVoip - sets the device type to VoIP for internal configuration. callAppearance - the index of the call appearance you wish to contorl in a VoIP line. clearOnHangup - if true will clear the Dial String whenever the line goes on hook. appendDtmf - if true will append DTMF digit presses to Dial String bridgeIndex - The index of the control on a Legacy object

Meter

Enables metering on the sepecified meter.
Using this is a bad idea, please avoid unless specifically requested.

Within the Legacy object this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interface IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
3501	1	RW	Meter Toggle

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
3501	1	R	Meter Feedback

Serials

Legacy Join	Standalone Join	Type (RW)	Description
3501	1	R	Control Label (Pass From Config)

Config Example

All state configs must be part of a dictionary called meterControlBlocks.

"meterControlBlocks" : {
    "Meter1" : {
        "enabled" : true,
        "label" : "State01",
        "meterInstanceTag" : "Meter1",
        "index" : 1,
        "bridgeIndex" : 1
    }
}

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Meter1.

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. meterInstanceTag - Instance tag of the meter control index - Index of the control point. bridgeIndex - The index of the control on a Legacy object

Crosspoint State Control

Provides a control point for a single crosspoint on a MatrixMixer.

This Join map represents a control that is part of an array of controls. Each join number = Join Map Number + State Index as defined by the config.

This control implements Essentials interface IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
2001	1	RW	Crosspoint Toggle
2002	2	W	Crosspoint On
2003	3	W	Crosspoint Off

Analogs

None

Serials

Legacy Join	Standalone Join	Type (RW)	Description
2001	1	R	Control Label (Pass From Config)

Config Example

All state configs must be part of a dictionary called crosspointStateControlBlocks.

"crosspointStateControlBlocks" : {
    "Crosspoint1" : {
        "enabled" : true,
        "label" : "Crosspoint1-2",
        "matrixInstanceTag" : "Meter1",
        "index1" : 1,
        "index2" : 2,
        "bridgeIndex" : 1
    }
}

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Crosspoint1.

Config Notes

enabled - enables the control to be subscribed and controlled
label - Passed directly across the eisc as the Label value
index1 - Input of the crosspoint to be controlled
index2 - Output of the crosspoint to be controlled
stateInstanceTag - Instance tag of the meter block
bridgeIndex - The index of the control on a Legacy object

RoomCombiner

Controls Biamp Tesira RoomCombiner objects. Control of LevelOut, MuteOut, and group selection is supported.

MuteOut is not a subscribed control for this block. Polling is simulated on each trigger of the mute, but there is no unsolicited feedback for mute status.

In order to keep the types of joins similar to a standard fader object, the choice was made to not provide direct control for wall states in this component. If direct wall state control is required, utilize a State Control block.

Within the Legacy object, this Join map represents a control that is part of an array of controls. Each join number = Join Map Number + roomCombiner bridgeIndex as defined by the config.

Within the Standalone object, this join map represents a single control as defined by the key in the bridge.

This control implements Essentials interfaces IBasicVolumeWithFeedback and IKeyed

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
2206	6	R	Channel Visible
2203	5	RW	Mute Toggle
2204	3	RW	Mute On
2205	4	RW	Mute Off
2201	1	W	Volume Up
2202	2	W	Volume Down

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
2201	1	RW	Volume Level
2202	2	R	Icon (0 - Level, 1 - Mic)
2204	3	RW	Set/Get the Combine Group Number for Room Combination
2203	4	R	Permissions (Pass From Config)

Serials

Legacy Join	Standalone Join	Type (RW)	Description
2201	1	R	Control Label (Pass From Config)

Config Example

All RoomCombiner configs must be part of a dictionary called roomCombinerControlBlocks.

"roomCombinerControlBlocks": {
    "Room01": {
        "enabled": true,
        "label": "Room 1",
        "isMic": false,
        "roomIndex" : 1,
        "roomCombinerInstanceTag": "RoomCombiner1",
        "unmuteOnVolChange" : true,
        "incrementAmount" : "2.0",
        "permissions" : 0,
        "bridgeIndex" : 1
    }

Config Notes

enabled - enables the control to be subscribed and controlled. label - Passed directly across the eisc as the Label value. isMic - drives the icon feedback. roomIndex - Index of the room on the combiner block. roomCombinerInstanceTag - Instance tag of the room combiner control. unmuteOnVolChange - if true, will unmute a muted control when the level increases. incrementAmount - the value in decimals by which a mute increment or decrement command will manipulate the level. permissions - Passed directly across the eisc as the Permissions value. bridgeIndex - The index of the control on a Legacy object

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Room01.

Tesira Expanders

Provides status updates for tesira expander devices related to health and device properties

Tesira Expander block is not supported in the Legacy bridge API. In order to utilize this control, one must directly bridge the control using the key <dspKey>--Expanders

Within the Standalone object, this join map represents each element in a list of Expander Devices

Digitals

Legacy Join	Standalone Join	Type (RW)	Description
N/A	1	R	Device Online

Analogs

Legacy Join	Standalone Join	Type (RW)	Description
N/A	N/A	N/A	N/A

Serials

Legacy Join	Standalone Join	Type (RW)	Description
N/A	1	R	Expander Hostname
N/A	2	R	Expander Serial Number
N/A	3	R	Expander Firmware
N/A	4	R	Expaner MAC Address

Config Example

All Tesira Expander config objects must be part of a dictionary called tesiraExpanderBlocks.

"tesiraExpanderBlocks": {
    "Expander01": {
        "hostname" : "MIC-01"
        "index" : 1
    },
    "Expander02": {
        "hostname" : "AMP-01"
        "index" : 2
    }
}

Config Notes

hostname - The hostname of the expander to be tracked. This value must match the configured expander index - The index within the bridged control where this device ins mapped. The joinmap of a device is equal to the join multipled by the index

In the provided example config object, given a base object key of dsp-1, this control would have a standalone key of dsp-1--Expanders.

Full Example Essentials Device Config

This config will create an internal loopback EISC on IPID D1 for a ssh-controlled tesira.

{
    "system": {},
    "system_url": "http://portal-QA.devcloud.pepperdash.com/templates/0f50640b-bc89-42d5-998f-81d137d3fc98#/template_summary",
    "template": {
        "devices": [
            {
                "key": "processor",
                "uid": 0,
                "type": "rmc3",
                "name": "RMC3",
                "group": "processor",
                "supportedConfigModes": [
                    "compliance",
                    "essentials"
                ],
                "supportedSystemTypes": [
                    "hudType",
                    "presType",
                    "vtcType",
                    "custom"
                ],
                "supportsCompliance": true,
                "properties": {}
            },
            {
                "key": "TesiraDsp-1",
                "name": "TesiraDspTesting",
                "type": "tesiraDsp",
                "group": "dsp",
                "properties": {
                    "control": {
                        "endOfLineString": "\n",
                        "deviceReadyResponsePattern": "",
                        "method": "ssh",
                        "tcpSshProperties": {
                            "address": "10.11.50.191",
                            "port": 22,
                            "autoReconnect": true,
                            "AutoReconnectIntervalMs": 10000,
                            "username": "default",
                            "password": "default"
                        }
                    },
                    "faderControlBlocks": {
                        "Fader1": {
                            "enabled": true,
                            "isMic": false,
                            "hasLevel": true,
                            "hasMute": true,
                            "index1" : 1,
                            "index2" : 0,
                            "label": "Room",
                            "levelInstanceTag": "ROOMVOL",
                            "muteInstanceTag": "ROOMVOL",
                            "unmuteOnVolChange" : true,
                            "incrementAmount" : "2.0",
                            "permissions" : 0,
                            "bridgeIndex" : 1

                        },
                        "Fader2": {
                            "enabled": true,
                            "isMic": false,
                            "hasLevel": true,
                            "hasMute": true,
                            "index1" : 1,
                            "index2" : 0,
                            "label": "VTC",
                            "levelInstanceTag": "VTCRXVOL",
                            "muteInstanceTag": "VTCRXVOL",
                            "unmuteOnVolChange" : true,
                            "incrementAmount" : "2.0"
                            "permissions" : 1,
                            "bridgeIndex" : 2
                        },
                        "Fader3": {
                            "enabled": true,
                            "isMic": false,
                            "hasLevel": true,
                            "hasMute": true,
                            "index1" : 1,
                            "index2" : 0,
                            "label": "ATC",
                            "levelInstanceTag": "ATCRXVOL",
                            "muteInstanceTag": "ATCRXVOL",
                            "unmuteOnVolChange" : true,
                            "incrementAmount" : "2.0"
                            "permissions" : 2,
                            "bridgeIndex" : 3
                        },
                        "Fader4": {
                            "enabled": true,
                            "isMic": false,
                            "hasLevel": true,
                            "hasMute": true,
                            "index1" : 1,
                            "index2" : 0,
                            "label": "PGM",
                            "levelInstanceTag": "PGMVOL",
                            "muteInstanceTag": "PGMVOL",
                            "unmuteOnVolChange" : true,
                            "incrementAmount" : "2.0"
                            "permissions" : 0,
                            "bridgeIndex" : 4
                        }
                    },
                    "dialerControlBlocks" : {
                        "Dialer1" : {
                            "enabled" : true,
                            "label" : "Dialer 1",
                            "isVoip" : true,
                            "dialerInstanceTag" : "Dialer1",
                            "controlStatusInstanceTag" : "VoIPControlStatus1",
                            "index" : 1,
                            "callAppearance" : 1,
                            "clearOnHangup" : true,
                            "appendDtmf" : false
                            "bridgeIndex" : 1
                        }
                    },
                    "stateControlBlocks" : {
                        "State1" : {
                            "enabled" : true,
                            "label" : "State01",
                            "stateInstanceTag" : "LogicState1",
                            "index" : 1,
                            "bridgeIndex" : 1
                        },
                        "State2" : {
                            "enabled" : true,
                            "label" : "State02",
                            "stateInstanceTag" : "LogicState1",
                            "index" : 2,
                            "bridgeIndex" : 2
                        },
                        "State3" : {
                            "enabled" : true,
                            "label" : "State02",
                            "stateInstanceTag" : "LogicState1",
                            "index" : 3,
                            "bridgeIndex" : 3
                        },
                        "State4" : {
                            "enabled" : true,
                            "label" : "State02",
                            "stateInstanceTag" : "LogicState1",
                            "index" : 4
                            "bridgeIndex" : 4
                        }
                    },
                    "switcherControlBlocks" : {
                        "switcherControl1" : {
                            "enabled" : true,
                            "label" : "switcher01",
                            "switcherInstanceTag" : "SourceSelector1",
                            "index1" : 1,
                            "bridgeIndex" : 1,
                            "switcherInputs" : {
                                "1" : {"label": "Input1" },
                                "2" : {"label": "Input2" },
                            },
                            "switcherOutputs" : {
                                "1" : {"label": "Output1" },
                                "2" : {"label": "Output2" },
                            }
                        }
                    },
                    "crosspointStateControlBlocks" : {
                        "Crosspoint1" : {
                            "enabled" : true,
                            "label" : "Crosspoint1-2",
                            "matrixInstanceTag" : "Meter1",
                            "index1" : 1,
                            "index2" : 2,
                            "bridgeIndex" : 1
                        }
                    },
                    "meterControlBlocks" : {
                        "Meter1" : {
                            "enabled" : true,
                            "label" : "State01",
                            "meterInstanceTag" : "Meter1",
                            "index" : 1,
                            "bridgeIndex" : 1
                        }
                    },
                    "roomCombinerControlBlocks": {
                        "Room01": {
                            "enabled": true,
                            "label": "Room 1",
                            "isMic": false,
                            "roomIndex" : 1,
                            "roomCombinerInstanceTag": "RoomCombiner1",
                            "unmuteOnVolChange" : true,
                            "incrementAmount" : "2.0",
                            "permissions" : 0,
                            "bridgeIndex" : 1
                        }
                     },
                    "presets" : {
                        "1": {
                            "label" : "Default",
                            "preset" : "Default Levels"
                            "presetIndex" : 1  
                        },
                        "2" : {
                            "label" : "High",
                            "Preset" : "Noise Reduction High"
                            "presetIndex" : 2
                        }
                    },
                    "tesiraExpanderBlocks": {
                        "Expander01": {
                            "hostname" : "MIC-01"
                            "index" : 1
                        },
                        "Expander02": {
                            "hostname" : "AMP-01"
                            "index" : 2
                        }
                    }
                }
            },
            {
                "key": "eisc-Dsp",
                "uid": 4,
                "name": "Bridge Dsp",
                "group": "api",
                "type": "eiscApiAdvanced",
                "properties": {
                    "control": {
                        "tcpSshProperties": {
                            "address": "127.0.0.2",
                            "port": 0
                        },
                        "ipid": "D1",
                        "method": "ipidTcp"
                    },
                    "devices": [
                        {
                            "deviceKey": "TesiraDsp-1",
                            "joinStart": 1
                        }
                    ]
                }
            }
        ],
        "info": {
            "comment": "",
            "lastModifiedDate": "2017-03-06T23:14:40.290Z",
            "lastUid": 12,
            "processorType": "Rmc3",
            "requiredControlSofwareVersion": "",
            "systemType": "MPR"
        },
        "rooms": [],
        "tieLines": []
    }
}

RoadMap

A Method by which we can continue even with "bad" instance tags in the config. Currently, this causes everything to fail upon subscription.

Files

README.md

Latest commit

History

README.md

File metadata and controls

Tesira DSP Essentials Plugin (c) 2023

License

Overview

Compatibility

Cloning Instructions

Dependencies

Installing Dependencies

Feature Notes

Installation

Controls and Configs

DeviceInfo

Digitals

Analogs

Serials

Config Notes

Level / Mute

Digitals

Analogs

Serials

Config Example

Config Notes

Switcher

Digitals

Analogs

Serials

Config Example

Config Notes

Router

Digitals

Analogs

Serials

Config Example

Config Notes

SourceSelector

Digitals

Analogs

Serials

Config Example

Config Notes

State

Digitals

Analogs

Serials

Config Example

Config Notes

Presets

Digitals

Analogs

Serials

Config Example

Config Notes

Dialer

Digitals

Analogs

Serials

Config Example

Config Notes

Meter

Digitals

Analogs

Serials

Config Example

Config Notes

Crosspoint State Control

Digitals

Analogs

Serials

Config Example

Config Notes

RoomCombiner

Digitals

Analogs

Serials

Config Example