Skip to content

bitfocus/companion-module-aetaaudio-codecs

Repository files navigation

AETA Audio Codecs Companion Module

This module allows you to control AETA Audio Codecs Bitfocus Companion.

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

Features

  • Full call control (dial, hang up, redial, etc.)
  • Audio configuration (input/output gain, coding algorithm, bit rate, interface format, etc.)
  • Network configuration (type, IP quality, packet replication, DHCP/static, IP, DNS, gateway, mask)
  • System and advanced settings (5A system, presets, reset, custom AT# commands, ISDN/POTS, backup, loop, relay, GPI/GPO, etc.)
  • Feedbacks for connection, call, and alarm status
  • Variable support for dynamic actions
  • Comprehensive error handling

Configuration

  • IP Address: IP of your AETA codec
  • Port: TCP port for AARC protocol (default: 6000)
  • Password: AARC password if set (leave blank if none)
  • Enable Status Polling: Enable/disable automatic status updates
  • Polling Interval: How often to poll for status updates (ms)
  • Enable VU Meter: (Feature currently disabled)
  • VU Meter Interval: (Feature currently disabled)

Actions

Call Control

  • Dial Number (manual entry or variable)
    Applicable units: all units
  • Hang Up
    Applicable units: all units

Audio Settings

  • Set Input Gain
    Applicable units: HS3, S3, S4, S5, S+, SxS
  • Set Output Gain
    Applicable units: all units
  • Set Coding Algorithm
    Applicable units: all units
  • Set Coding Bit Rate
    Applicable units: all units
  • Set Audio Interface Format
    Applicable units: HS3, S3, S4, S5, Scoop5 S, Scoop5 S-IP
  • Set AES Sync Mode
    Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
  • Set AES Nominal Sampling Rate
    Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
  • Set Input Impedance
    Applicable units: S4, S5, Scoop5 S
  • Set Output Load
    Applicable units: HS3, S3
  • Set Channel Panning Mode
    Applicable units: S+, Sy+ S
  • Set Output Signal Selection
    Applicable units: S+, Sy+ S
  • Set Input Attenuation Pad
    Applicable units: S+, Sy+ S
  • Set Headphone Coordination Channel Routing
    Applicable units: S+, Sy+ S
  • Monitor Audio Levels (feature currently disabled)

Network Settings

  • Set Network Type
    Applicable units: all units
  • Set IP Quality
    Applicable units: S4, S5, S+, SxS
  • Set Packet Replication
    Applicable units: S+, S5, SxS
  • Set DHCP Mode
    Applicable units: S4, S5, S+, SxS
  • Set IP Address
    Applicable units: S4, S5, S+, SxS
  • Set DNS Address
    Applicable units: S4, S5, S+, SxS
  • Set Gateway
    Applicable units: S4, S5, S+, SxS
  • Set Subnet Mask
    Applicable units: S4, S5, S+, SxS

System Settings

  • Set 5A System
    Applicable units: all units
  • Load Preset Configuration (High Quality, Low Latency, Mobile Data, ISDN Backup)
    Applicable units: all units (presets use multiple commands)
  • Refresh Data
  • Reset Device
    Applicable units: all units
  • Send Custom AT# Command
    Applicable units: all units

Advanced/Other

  • Set Dial Method
    Applicable units: S+, S4, S5, SxS
  • Set Dial Tone
    Applicable units: S+, S4, S5, SxS
  • Set ISDN Call Filter
    Applicable units: all units
  • Set Proprietary ISDN Filter
    Applicable units: HS3, S3
  • Set High Layer Capability (HLC)
    Applicable units: HS3, S3
  • Set Auto Redial
    Applicable units: S4, S5, S+, SxS
  • Set Redial Retries
    Applicable units: S4, S5, S+, SxS
  • Set Redial Wait Time
    Applicable units: S4, S5, S+, SxS
  • Set Loop Control
    Applicable units: S4, S5, Scoop5 S, Scoop5 S-IP
  • Set Backup Network
    Applicable units: S4, S5, SxS
  • Set Passive Backup Mode
    Applicable units: S4, S5, SxS
  • Set Original/Copy Field (MPEG only)
    Applicable units: HS3, S3
  • Set Copyright Field (MPEG only)
    Applicable units: HS3, S3
  • Set Error Correction/Protected Mode
    Applicable units: all units
  • Set Clock Mode (POTS)
    Applicable units: S+, S5, SxS
  • Set Line Level (POTS)
    Applicable units: S+, S5, SxS
  • Set Speed (POTS)
    Applicable units: S+, S4, S5, SxS
  • Set Data Channel
    Applicable units: all units
  • Set Data Channel Baud Rate
    Applicable units: all units
  • Set Relay Transmission
    Applicable units: all units
  • Set GPI State
    Applicable units: S+, S4, S5, SxS
  • Set GPO State
    Applicable units: S+, S4, S5, SxS
  • Set Auxiliary 3 kHz Audio Channel
    Applicable units: HS3, S3, S4, S5
  • Display Text Message
    Applicable units: S+, S4, S5, SxS

Feedbacks

  • Codec Connected
  • Ringing
  • Calling
  • Call Established
  • Call Released
  • Codec Alarms

Variables

  • Connection Status, Codec Model, Last Error Message
  • Ringing/Calling/Established/Released Status
  • Dial Number, Local Number
  • Coding Algorithm, Bit Rate, Audio Status, Audio Level, Input/Output Gain
  • Network Type, IP Quality, Packet Replication, Network Quality, Jitter Buffer Status
  • Active Alarms, 5A System Status, Configuration Number, Test Loop Status
  • 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

Handles:

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

Version History

1.0.3-beta

  • fixed call states feedbacks

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •