TiMax

This is the TiMax plugin documentation.

This plugin provides support for the Outboard TiMax 2 processor.

The individual device parameters can be read and/or set by accessing there predefined keys.

Supported parameters

Filter Parameters Reset

More	Mapping parameter name Parameter	Mapping IO type IO type	Read / Write access mode R/W
	Groups
	group_level_ch{i}	float	rw
	Group level in dB. Value between -100.0 and +10.0
	group_solo_ch{i}	bool	rw
	group_mute_ch{i}	bool	rw
	group_state_ch{i}	int8	r
	0 when nothing is set 1 when muted 2 when soloed 4 when solo-muted
	Inputs
	input_level_ch{i}	float	w
	Input level in dB. Value between -100.0 and +10.0
	input_solo_ch{i}	bool	rw
	input_mute_ch{i}	bool	rw
	input_solo_muted_ch{i}	bool	r
	input_state_ch{i}	int8	r
	0 when nothing is set 1 when muted 2 when soloed 4 when solo-muted
	source_level_analog_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	source_level_network_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	source_level_playback_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	input_level_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	input_vu_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	Outputs
	output_level_ch{i}	float	rw
	Input level in dB. Value between -100.0 and +10.0
	output_solo_ch{i}	bool	rw
	output_mute_ch{i}	bool	rw
	output_solo_muted_ch{i}	bool	r
	output_state_ch{i}	int8	r
	0 when nothing is set 1 when muted 2 when soloed 4 when solo-muted
	output_vu_ch{i}	float	r
	Input level in dB. Value between -100.0 and +10.0
	Cue Actions
	mute_all_outputs	bool	w
	stop_cues	bool	w
	go_cue	int16	w
	Only supports integer cue numbers
	go_cue	string	w
	Supports the "100.1.2" syntax
	Playback Actions
	pause_playback	bool	w
	true to pause false to resume (which is equal to resume_playback with a value of true)
	pause_playback	string	w
	String must be in the form of: 'ch_lo-ch_hi' where ch_lo is the lower channel, and ch_hi is upper channel bound of channels to pause. Channels ranging from 1 trough 64.
	resume_playback	bool	w
	true to resume false to pause (which is equal to pause playback with a value of true)
	resume_playback	string	w
	String must be in the form of: 'ch_lo-ch_hi' where ch_lo is the lower channel, and ch_hi is upper channel bound of channels to pause. Channels ranging from 1 trough 64.
	Unit Info
	ip_address	string	r
	input_channels	int8	r
	e.g.: 16, 32 or 64
	output_channels	int8	r
	e.g.: 16, 32 or 64
	design_name	string	r
	Current hardware design name e.g.: HARMONIC Timax 2
	firmware_date_time	string	r
	e.g.: "YY/MM/DDhh:mm:ss"
	firmware_version	string	r
	e.g.: S515
	serial_number	string	r
	unit_name	string	r
	s_key	string	r
	project	string	r
	unit_temperature	float	r
	Running Info
	current_cue	string	r
	e.g.: 1, or 1.5 or 1.5.6
	current_cue_major	int16	r
	e.g.: 1 in the cue 1.5.6
	current_cue_minor	int8	r
	e.g.: 5 in the cue 1.5.6
	current_cue_sub	int8	r
	e.g.: 6 in the cue 1.5.6
	current_time	float	r
	cue_clock_time	float	r
	cue_clock_running	bool	r
	show_clock_time	float	r
	show_clock_running	bool	r
	active_playback_channels	int8	r
	JSON
	json_levels	string	r
	Includes all: group_level group_solo group_mute input_level input_solo input_mute input_solo_muted output_level output_solo output_mute output_solo_muted
	json_vu	string	r
	Includes all: input_vu output_vu
	json_cue	string	r
	Includes all: current_cue current_cue_major current_cue_minor current_cue_sub cue_clock_running active_playback_channels
	json_info	string	r
	Includes all: ip_address input_channels output_channels design_name firmware_date_time firmware_version serial_number unit_name s_key project unit_temperature
	json_all	string	r
	Includes all json objects, except clocks: json_levels json_vu json_cue json_info
	json_clocks	string	r
	Includes all: current_time cue_clock_time show_clock_time show_clock_running

Explanation

• Solo-muted means that a channel was muted because any other input / output channel is soloed - Json encodes the individual channel data elements as an array, limited in size to input_channels and output_channels. And because it’s an array, all values are included, not only the changed ones. - Because the levels and the solo & mutes comes into different status message from the TiMax, the json response will either include the levels, or the solo & mutes.

The parameters that have a {i} suffix indicate multiple different parameters. Under most circumstances, they indicate the channel number between 0 and 63 (channel numbers are 0 based), for groups they range between 0 and 31.

NOTE

Group parameters only have effect in the TiMax if the group has controls assigned to it.

The current Cue is running when cue_clock_running is true. But when audio playback is paused, the cue clock keeps running, and is from heron now misaligned with the actual playback head.

Supported data types

• bool
• int
• double
• string

Data type	QVariant bool	QVariant int	QVariant float	QVariant string
TiMax::bool	•
TiMax::int		•
TiMax::float			•
TiMax::string				•

Configuration options

The minimal device config when using the default options would be:

settings.yml

devices:
  - type: timax
    name: timax1
    options:
      ip: 10.0.0.9

A complete config would look like this:

settings.yml

devices:
  - type: TiMax
    name: timax1
    options:
      ip: 10.0.0.9
      scan_rate: 50

where

type

is always “TiMax” as this is the name of this plugin.

name

unique arbitrary name.

options/ip

the ip address of the TiMax device. (default: 127.0.0.1)

options/scan_rate

this is the polling scan rate in ms and should be an integer. (default: 100, minimum: 10)