AETA

HIFISCOOP 3 · SCOOP 3 · SCOOP 4+ · SCOOPY+ · Scoop5 S · +2 more

Communityv2.2.0-betaUpdated 2 months ago

Documentation Report an issue View on GitHub

Documentation

AETA Audio Codecs Module for Companion

This module allows control of AETA Audio Codecs through Companion.

Utilities folder contains reference files for developers as well as a dial pad companion page template for phones/codecs numbers input.

Configuration

IP Address - The IP address of your AETA codec
Port - The TCP port for AARC protocol (default: 6000)
Password - AARC password if configured on the codec (leave blank if none)
Enable Status Polling - Enable/disable automatic status updates
Polling Interval - How often to poll for status updates (in milliseconds)
Enable VU Meter - Enable/disable real-time VU meter monitoring
VU Meter Interval - How often to poll for VU meter updates (in milliseconds)

Available Actions

Call Control

Dial Number - Make a call to a specified number or SIP URI
Applicable units: all units
Hang Up - End the current call
Applicable units: all units

Audio Settings

Set Input Gain - Adjust input gain (-12 to +12 dB)
Applicable units: HS3, S3, S4, S5, S+, SxS
Set Output Gain - Adjust output gain (-11 to +22 dBu)
Applicable units: all units
Set Coding Algorithm - Change the audio coding algorithm
Applicable units: all units
Set Coding Bit Rate - Change the audio bit rate
Applicable units: all units
Set Audio Interface Format - Select analogue or AES/EBU
Applicable units: HS3, S3, S4, S5, Scoop5 S, Scoop5 S-IP
Set AES Sync Mode - Set AES synchronization (genlock/master)
Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
Set AES Nominal Sampling Rate - Set AES interface sampling rate
Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
Set Input Impedance - Set analogue input impedance
Applicable units: S4, S5, Scoop5 S
Set Output Load - Set analogue output load
Applicable units: HS3, S3
Set Channel Panning Mode - Set stereo panning
Applicable units: S+, Sy+ S
Set Output Signal Selection - Route output signal (send/receive/mix)
Applicable units: S+, Sy+ S
Set Input Attenuation Pad - Enable/disable input pad
Applicable units: S+, Sy+ S
Set Headphone Coordination Channel Routing - Configure headphone routing
Applicable units: S+, Sy+ S
Monitor Audio Levels - Start/stop periodic monitoring

Network Settings

Set Network Type - Change network interface type
Applicable units: all units
Set IP Quality - Adjust IP streaming quality settings
Applicable units: S4, S5, S+, SxS
Set Packet Replication - Configure packet redundancy
Applicable units: S+, S5, SxS
Set DHCP Mode - Switch between DHCP and static IP
Applicable units: S4, S5, S+, SxS
Set IP Address - Set static IP address
Applicable units: S4, S5, S+, SxS
Set DNS Address - Set DNS server
Applicable units: S4, S5, S+, SxS
Set Gateway - Set default gateway
Applicable units: S4, S5, S+, SxS
Set Subnet Mask - Set subnet mask
Applicable units: S4, S5, S+, SxS

System Settings

Set 5A System - Enable/disable 5A system
Applicable units: all units
Load Preset Configuration - Apply predefined settings:
Applicable units: all units (presets use multiple commands)
- High Quality (Opus Stereo)
- Low Latency (G722)
- Mobile Data (Low Bandwidth)
- ISDN Backup Mode
Refresh Data - Manual refresh of codec status
Reset Device - Reboot the device
Applicable units: all units
Send Custom AT# Command - Send a custom AT# command
Applicable units: all units

Advanced/Other

Set Dial Method - Select tone or pulse dialing
Applicable units: S+, S4, S5, SxS
Set Dial Tone - Wait for dial tone or not
Applicable units: S+, S4, S5, SxS
Set ISDN Call Filter - Set ISDN call filtering mode
Applicable units: all units
Set Proprietary ISDN Filter - Enable/disable proprietary ISDN filter
Applicable units: HS3, S3
Set High Layer Capability (HLC) - Enable/disable HLC encoding
Applicable units: HS3, S3
Set Auto Redial - Enable/disable auto redial for codec
Applicable units: S4, S5, S+, SxS
Set Redial Retries - Set number of redial attempts
Applicable units: S4, S5, S+, SxS
Set Redial Wait Time - Set wait time between redials
Applicable units: S4, S5, S+, SxS
Set Loop Control - Configure loop control for outgoing links
Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
Set Backup Network - Select backup network type
Applicable units: S4, S5, SxS
Set Passive Backup Mode - Enable/disable passive backup
Applicable units: S4, S5, SxS
Set Original/Copy Field (MPEG only) - Set MPEG original/copy field
Applicable units: HS3, S3
Set Copyright Field (MPEG only) - Set MPEG copyright field
Applicable units: HS3, S3
Set Error Correction/Protected Mode - Configure error correction
Applicable units: all units
Set Clock Mode (POTS) - Set POTS clock mode
Applicable units: S+, S5, SxS
Set Line Level (POTS) - Set POTS output line level
Applicable units: S+, S5, SxS
Set Speed (POTS) - Set POTS speed mode
Applicable units: S+, S4, S5, SxS
Set Data Channel - Enable/disable serial data channel
Applicable units: all units
Set Data Channel Baud Rate - Set baud rate for data channel
Applicable units: all units
Set Relay Transmission - Enable/disable relay transmission
Applicable units: all units
Set GPI State - Set General Purpose Input (GPI) state
Applicable units: S+, S4, S5, SxS
Set GPO State - Set General Purpose Output (GPO) state
Applicable units: S+, S4, S5, SxS
Set Auxiliary 3 kHz Audio Channel - Enable/disable auxiliary channel
Applicable units: HS3, S3, S4, S5
Display Text Message - Send a text message to the device
Applicable units: S+, S4, S5, SxS

Available Feedbacks

Status Indicators

Codec Connected - Changes color when codec has an established connection
Ringing - Changes color when there's an incoming call
Calling - Changes color during outgoing call attempt
Call Established - Changes color when call is connected
Call Released - Changes color when call is ended

Technical Monitoring

Codec Alarms - Changes color when the codec has active alarms
Audio Levels - Visual feedback for Tx/Rx audio levels

Variables

Connection Status

Connection Status
Codec Model
Last Error Message

Call Status

Ringing Status
Calling Status
Established Status
Released Status
Dial Number
Local Number

Audio Settings

Coding Algorithm
Coding Bit Rate
Audio Status
Audio Level
Input/Output Gain
Tx Left Level
Tx Right Level
Rx Left Level
Rx Right Level

Network Settings

Network Type
IP Quality
Packet Replication
Network Quality
Jitter Buffer Status

System Status

Active Alarms
5A System Status
Configuration Number
Test Loop Status

Network Configuration

IP Address
IP Mask
Gateway
DNS
DHCP Mode

Supported Models

HIFISCOOP 3
SCOOP 3
SCOOP 4+
SCOOPY+
SCOOP5 S
SCOOP5 S-IP
SCOOPY+ S

Error Handling

The module includes comprehensive error handling:

Connection failures
Authentication errors
Invalid commands
Network issues
Audio problems
Hardware alarms

Version History

Version 2.2.0-beta

Upgraded to Bitfocus Companion API 2.1 (Companion 5.0+)
Added layered button presets with real-time audio level gauges for stereo and mono Tx/Rx monitoring
Implemented preset alternatives providing both rich layered gauges and simple fallback styles
Fixed button presets images

Version 2.1.0-beta

Added model filtering to actions and variables

Version 2.0.0-beta

Major update to support Companion API 2.0

Version 1.1.2-beta

Fixed states are now stored as booleans
Fixed number/SIP field not being parsed properly

Version 1.1.1-beta

Implemented real-time VU Metering (Tx/Rx Levels)
Improved status reporting and error handling

Version 1.0.3-beta

fixed call states feedbacks