Skip to content

rsnodgrass/avemu

Repository files navigation

avemu - Test Emulator for A/V Equipment RS232 Control

MIT license beta_badge Donate Buy Me A Coffee

Overview

Avemu exposes a TCP port that can emulate responses to commands sent using simple text based (typically RS232 compatible) protocols used by various A/V equipment so testing common cases can occur without requiring physical hardware. This came about developing client libraries for controlling McIntosh, Lyngdorf, Xantech, and Anthem processors where the protocols were basic text based interactions and similar. After building several custom libraries, a "common" YAML based protocol definition format was created so building additional librares was not necessary.

Additionally, the pyavcontrol YAML format defining commands, messages, and simple tests enables quickly spinning up libraries in other languages (Go, C, etc) that support a wide variety of devices.

Support

While this is community supported along with all the 'pyavcontrol', effort was involved in creating this tool and new way of defining A/V equipment control interfaces to make emulation and client libraries possible. Please consider contributing a small token of thanks:

Donate Buy Me A Coffee

If you have questions or need the help of others, please participate in the community discussion. (LINK TO BE ADDED)

Supported Devices

See SUPPORTED.md for the complete list of supported devices. If interested in submitting YAML file defining the model for new devices, contribute through pyavcontrol and avemu will automatically include the new device.

Manufacturer Models
McIntosh MX-160, MX-180
Lyngdorf TDAI-3400, CD-2
Xantech MRAUDIO8x8, MX88
Trinnov Altitude32
HDFury VRROOM
...and more

Example Execution

The following is an example run avemu with the Lyngdorf CD-2 lyngdorf_cd2 model from pyavcontrol:

% ./avemu.py --model lyngdorf_cd2
2023-12-27 22:17:46 laptop.local __main__[38770] INFO Using default port 84 for lyngdorf_cd2
2023-12-27 22:17:46 laptop.local __main__[38770] INFO Emulating model lyngdorf_cd2 on socket://0.0.0.0:84/  (also on 192.168.1.25)
Supported commands:
!DEVICE?                      !ON                           !OFF                          !PWR
!NEXT                         !PLAY                         !STOP                         !PREV
!EJECT                        !REWIND                       !WIND                         !STOPWIND
!STATE?                       !DIGIT(1)                     !DIGIT(2)                     !TRACK?
!NOFTRACKS?                   !TIME?                        !REMTIME?                     !PLAYMODE({mode})
!PLAYMODE(0)                  !PLAYMODE(1)                  !PLAYMODE(2)                  !PLAYMODE(3)
!DISPMODE({mode})             !DISPMODE(0)                  !DISPMODE(1)                  !DISPMODE(2)
!DISPMODE(3)                  !SAMPLERATE({sample_rate})    !GAIN({gain})                 !SRC?
2023-12-27 22:17:50 laptop.local __main__[38770] INFO 192.168.1.125:57620 connected.
2023-12-27 22:17:50 laptop.local __main__[38770] INFO 192.168.1.125:57620 connected.
2023-12-27 22:17:50 laptop.local __main__[38770] DEBUG Received: !DEVICE?
2023-12-27 22:17:50 laptop.local handlers.default[38770] INFO Received device.name cmd: !DEVICE?
2023-12-27 22:17:50 laptop.local handlers.default[38770] DEBUG Replying to device.name !DEVICE?: !DEVICE(CD2)
2023-12-27 22:17:50 laptop.local __main__[38770] DEBUG Received: !SRC?
2023-12-27 22:17:50 laptop.local handlers.default[38770] INFO Received source.get cmd: !SRC?
2023-12-27 22:17:50 laptop.local handlers.default[38770] DEBUG Replying to source.get !SRC?: !SRC(1,"CD")

Future Ideas

  • Add ability to define EmulatorHandler class for each device model that allows additional programmatic override of handle_command() which can maintain state between calls for someone who wants to implement functionality where later queries should pickup previously set state.

See Also

About

Test Emulator for A/V RS232 Devices

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published