/anthem-receiver

Protocol support for Anthem receivers (AVM-60, etc.)

Primary LanguagePythonOtherNOASSERTION

anthem-receiver: Client library for control of Anthem A/V Receivers over TCP/IP

License: MIT Latest release

A tool and API for controlling Anthem A/V receivers via their proprietary TCP/IP protocol.

Table of contents

Introduction

Python package anthem-receiver provides a command-line tool as well as a runtime API for controlling many Anthem receiver models that include an Ethernet port for TCP/IP control.

Some key features of anthem-receiver:

  • JSON results
  • Query receiver model
  • Query power status
  • Power on
  • Power standby
  • Wait for warmup/cooldown

Installation

Prerequisites

Python: Python 3.8+ is required. See your OS documentation for instructions.

From PyPi

The current released version of anthem-receiver can be installed with

pip3 install anthem-receiver

From GitHub

Poetry is required; it can be installed with:

curl -sSL https://install.python-poetry.org | python3 -

Clone the repository and install anthem-receiver into a private virtualenv with:

cd <parent-folder>
git clone https://github.com/sammck/anthem-receiver.git
cd anthem-receiver
poetry install

You can then launch a bash shell with the virtualenv activated using:

poetry shell

Usage

Command Line

There is a single command tool anthem-receiver that is installed with the package.

API

TBD

Known issues and limitations

  • Import/export are not yet supported.

Getting help

Please report any problems/issues here.

Contributing

Pull requests welcome.

License

anthem-receiver is distributed under the terms of the MIT License. The license applies to this file and other files in the GitHub repository hosting this file.

References

Authors and history

The author of anthem-receiver is Sam McKelvie.