diff --git a/README.md b/README.md index 73c1c5ff9..9fcdf080b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # AmpliPi Home Audio System +AmpliPi is an open-source software solution for multi-room home audio systems, specifically developed for AmpliPro products. The AmpliPro [product line](https://www.amplipro.com/) is designed by the creators of this project, [Micronova](https://www.micro-nova.com/). These systems have been rigorously tested and successfully implemented in various commercial and residential settings. When you purchase AmpliPro hardware from us, you’re not only supporting the project but also gaining access to a professionally designed audio system that delivers exceptional sound quality, backed by worldwide support from our engineering team. + + [![Build Status][workflow-badge]][workflow-link] [![Coverage][coverage-badge]][coverage-link] [![GPL License][license-badge]](COPYING) -![AmpliPi](docs/imgs/amplipi.jpg) +![AmpliPi](docs/imgs/AmpliProOverview2.png) -AmpliPi™ is a multi room/zone home audio controller and amplifier made for whole house audio systems with many zones. It can play up to 4 simultaneous audio sources, each of which can be selected from either its analog RCA input or any supported digital stream (Pandora, Spotify, AirPlay, etc). Each source can be routed to one or more zones, all of which are configurable in real-time using the self-hosted AmpliPi Web App or its underlying REST API. It is expandable up to 36 zones using AmpliPi Zone Expanders. +AmpliPro™ is a multi room/zone audio streamer, controller, and amplifier made for whole house audio systems with many zones. It can play up to 4 simultaneous audio sources, each of which can be selected from either its analog RCA input or any supported digital stream (Pandora, Spotify, AirPlay, etc). Each source can be routed to one or more zones, all of which are configurable in real-time using the AmpliPi App (Android / iOS / web) or its underlying API. It is expandable up to 36 zones using AmpliPro Zone Expanders. -The AmpliPi design is entirely open source, from the software, to the firmware, to the schematics. The REST API and Web App are written in Python and run on a Raspberry Pi 3+ Compute Module. The firmware, which provides the low level volume control and zone configuration, is written in C and configured by the Python API over I2C. All of the internal circuitry comes with full schematics (available in this repo). +The AmpliPro design is entirely open source, from the software, to the firmware, to the schematics. The API and Web App are written in Python and run on a Raspberry Pi 3+ Compute Module. The firmware, which provides the low level volume control and zone configuration, is written in C and configured by the Python API over I2C. All of the internal circuitry comes with full schematics (available in this repo). -The system is self-hosted on the Raspberry Pi and is privacy-centric. By design, AmpliPi doesn’t listen to you or spy on you — it just plays your audio! The way it should be. An internet connection is only needed for some external streaming sources, such as Pandora. The Python application running on the Pi hosts a mobile-friendly website and REST API used to control the system. The website is built on top of the REST API. +The system is self-hosted on the Raspberry Pi and is privacy-centric. By design, AmpliPi doesn’t listen to you or spy on you — it just plays your audio! The way it should be. An internet connection is only needed for some external streaming sources, such as Pandora. The Python application running on the Pi hosts a mobile-friendly website and API used to control the system. The website is built on top of the API. -![High-level Schematic](hw/diagrams/signal_diagram.drawio.svg) +![High-level Schematic](hw/diagrams/NEWsignal_diagram.drawio.svg) -Check us out on [Kickstarter](https://www.kickstarter.com/projects/micro-nova/amplipi-home-audio-system)! ## Features -AmpliPi can play many different types of digital streaming inputs. Most of the streaming services supported can be played as independent digital streams on all four sources at once; check out the **Multiple?** heading. Below is the current status of our digital stream integrations. +AmpliPro can play many different types of digital streaming inputs. Most of the streaming services supported can be played as independent digital streams on all four sources at once; check out the **Multiple?** heading. Below is the current status of our digital stream integrations. Most of these digital streaming services are provided by other open-source projects; check out the **Provided By** heading. @@ -77,18 +79,18 @@ Here's an example of changing group and zone volumes: Check out the full documentation for the web app at [docs/WEB_APP.md](docs/manual/WEB_APP.md). -## The REST API -AmpliPi has a REST API that can be used to control volumes, switch and control audio sources, configure different streaming sources, and much more. It allows full configuration and real-time control of the AmpliPi device. The API conforms to the OpenAPI standard. It is fully documented on our [AmpliPi OpenAPI site](https://micro-nova.github.io/AmpliPi). +## The API +AmpliPi has a flexible API that can be used to control volumes, switch and control audio sources, configure different streaming sources, and much more. It allows full configuration and real-time control of the AmpliPro device. The API conforms to the OpenAPI standard. It is fully documented on our [AmpliPi OpenAPI site](https://micro-nova.github.io/AmpliPi).

REST API overview + src="docs/imgs/OverviewRestAPI2.png">

-With the REST API, you can easily add automation to your home audio system. Use the API to trigger your AmpliPi system to play music based on smart home events. For example, only play music in zones of your house where motion has been detected, or start playing Pandora when the front door is unlocked. +With its API, you can easily add automation to your home audio system. Use the API to trigger your AmpliPro system to play music based on smart home events. For example, only play music in zones of your house where motion has been detected, or start playing Pandora when the front door is unlocked. -Not quite sure how to accomplish this? No problem - The AmpliPi controller hosts its API documentation as well. Using a web browser pointed at your local AmpliPi box, you can view the API documentation, as well as test sending and receiving API commands to and from the AmpliPi. +Not quite sure how to accomplish this? No problem - The AmpliPro controller hosts its API documentation as well. Using a web browser pointed at your local AmpliPro box, you can view the API documentation, as well as test sending and receiving API commands to and from the AmpliPro. [workflow-badge]: https://github.com/micro-nova/AmpliPi/actions/workflows/python-app.yml/badge.svg [workflow-link]: https://github.com/micro-nova/AmpliPi/actions?query=workflow%3Apython-app.yml @@ -100,7 +102,7 @@ Not quite sure how to accomplish this? No problem - The AmpliPi controller hosts Releases are available on [GitHub](https://github.com/micro-nova/AmpliPi/releases), see [CHANGELOG.md](CHANGELOG.md) for the changes in each release. -To update you AmpliPi to the latest version: +To update you AmpliPro to the latest version: 1. Go to the web app at [amplipi.local](http://amplipi.local). 1. Click the gear icon (⚙) in the upper right corner to go to the configuration page 1. Select **Updates** and click the **Check for Updates** button @@ -114,5 +116,5 @@ If you don't see an update button, you have an older version of AmpliPi. It will 1. The update will mistakenly fail with the message "`Error checking version: NetworkError when attempting to fetch resource`". Just go back to the app at [amplipi.local](http://amplipi.local) to enjoy the new feaures. For custom changes or offline updating, a .tar.gz file can also be uploaded -to the AmpliPi. This can be generated from a git checkout with +to the AmpliPro. This can be generated from a git checkout with `poetry version prerelease && poetry build`. The release will be generated to the dist folder. diff --git a/docs/imgs/AmpliProOverview2.png b/docs/imgs/AmpliProOverview2.png new file mode 100644 index 000000000..256f68995 Binary files /dev/null and b/docs/imgs/AmpliProOverview2.png differ diff --git a/docs/imgs/OverviewRestAPI2.png b/docs/imgs/OverviewRestAPI2.png new file mode 100644 index 000000000..92ddc1293 Binary files /dev/null and b/docs/imgs/OverviewRestAPI2.png differ diff --git a/hw/diagrams/NEWsignal_diagram.drawio.svg b/hw/diagrams/NEWsignal_diagram.drawio.svg new file mode 100644 index 000000000..36cf4bf0c --- /dev/null +++ b/hw/diagrams/NEWsignal_diagram.drawio.svg @@ -0,0 +1,4 @@ + + + +
2
3
4
                CM6206
                DAC / ADC
1
              PCM5102A
             DAC
Raspberry Pi
CM3+ module




Source 1
1
Source 2
2
Source 3
3
Source 4
4
Zone 1
Zone 2
Zone 6
...
To Expansion Out
Source Selectors
Amplifiers
Line Level &
Speaker Outputs
Analog Sources
(RCA Jacks)
Digital
Sources
Aux Input
(3.5mm)
Analog / Digital
Source Selectors
 \ No newline at end of file