pyAmpliPi is a Python library that allows you to
AmpliPi programmatically via the restful api provided by the device.
get_status() function returns a Status object which contains the current running configuration for the
controller including the firmware and configuration files used. This can be used to verify connectivity to a
keep-alive/healthchecks regularly, however should be limited to once every 60 seconds.
As mentioned above, the
Status object contains the overall state of all subobjects and should not be used for
calls that require updates more often. In these cases, the specific endpoints should be used:
Set Methods are provided to update inputs, sources, zones, and groups.
announce provides access to PA capabilities by providing a URL as the
Visit the AmpliPi website for additional information.
pyamplipi requires Python 3.5 or newer.
pip install pyamplipi
pyamplipi depends on a number of Python packages. If you use pip to install pyamplipi,
the dependencies will be installed automatically for you. If not, you can inspect
the requirements in the
MIT license: http://www.opensource.org/licenses/mit-license.php