Update manual(s)

micro-nova · Sep 13, 2024 · d4940fd · d4940fd
1 parent 79120aa
commit d4940fd
Show file tree

Hide file tree

Showing 14 changed files with 111 additions and 132 deletions.
diff --git a/docs/manuals/common/TROUBLESHOOTING.md b/docs/manuals/common/TROUBLESHOOTING.md
@@ -21,6 +21,10 @@ From the app:
 1. Click the gear icon in the bottom right corner to go to the configuration page
 2. Select **Updates** and click the **Check for Updates** button
 
+Without the app:
+1. Collecting the IP from the front display of your AmpliPro unit
+2. Navigating to `http://{Device_IP}:5001/update`
+
 ### New Release
 To update your AmpliPi software to the latest version:
 
@@ -47,7 +51,7 @@ Automated backups are also taken nightly at 2AM and stored for 90 days, and also
 
 These backups are dated tarballs stored at `/home/pi/backups`. This tarball contains the entire `/home/pi/.config/amplipi` directory. To restore this backup:
 1. Stop the AmpliPi service (`systemctl stop --user amplipi` as the `pi` user).
-1. Unpack a backup tarball and overwrite the contents of `.config/amplipi` (something like `tar --force-local -xvzf backups/config_2024-08-22T12:42:31-04:00_pre-fw-upgrade.tgz -C /`).  Here we use `config_2024-08-22T12:42:31-04:00_pre-fw-upgrade.tgz` as an example backup file. 
+1. Unpack a backup tarball and overwrite the contents of `.config/amplipi` (something like `tar --force-local -xvzf backups/config_2024-08-22T12:42:31-04:00_pre-fw-upgrade.tgz -C /`).  Here we use `config_2024-08-22T12:42:31-04:00_pre-fw-upgrade.tgz` as an example backup file.
 1. Start AmpliPi again (`systemctl start --user amplipi`).`
 
 ## Reimaging AmpliPro

diff --git a/docs/manuals/docker-compose.yaml b/docs/manuals/docker-compose.yaml
@@ -3,23 +3,23 @@
 # The file "manual.pdf" will be generated
 version: '3'
 services:
-  main:
-    image: witiko/markdown
-    container_name: markdown-translator-main
-    command: latexmk -lualatex main-manual.tex
-    restart: no
-    working_dir: /docs/manuals
-    volumes:
-      - .:/docs/manuals
+  # main:
+  #   image: witiko/markdown
+  #   container_name: markdown-translator-main
+  #   command: latexmk -lualatex main-manual.tex
+  #   restart: no
+  #   working_dir: /docs/manuals
+  #   volumes:
+  #     - .:/docs/manuals
 
-  expander:
-    image: witiko/markdown
-    container_name: markdown-translator-expander
-    command: latexmk -lualatex expander-manual.tex
-    restart: no
-    working_dir: /docs/manuals
-    volumes:
-      - .:/docs/manuals
+  # expander:
+  #   image: witiko/markdown
+  #   container_name: markdown-translator-expander
+  #   command: latexmk -lualatex expander-manual.tex
+  #   restart: no
+  #   working_dir: /docs/manuals
+  #   volumes:
+  #     - .:/docs/manuals
 
   streamer:
     image: witiko/markdown

diff --git a/docs/manuals/expander-manual.tex b/docs/manuals/expander-manual.tex
@@ -29,11 +29,11 @@
 
 \maketitle
 \setkeys{Gin}{width=.99\linewidth}
-\includegraphics{ imgs/main_graphic_16x9.jpg}
+\includegraphics{ imgs/expander.png}
 \newline
 \newline
 \begin{center}
-  \LARGE{ \textbf{ Device Model: AP-S4Z6}}
+  \LARGE{ \textbf{ Device Model: AP1-Z6}}
 \end{center}
 \includegraphics{ imgs/MicroNova_Logo.jpg}
 

diff --git a/docs/manuals/expander/ZONE_EXPANDER.md b/docs/manuals/expander/ZONE_EXPANDER.md
@@ -16,7 +16,6 @@ Adds 6 output zones to an AmpliPro Controller (often referred to as "AmpliPro Ma
 
 ### Rear Panel
 
-
 ![Zone Expander - Rear Panel]( imgs/expansion_rear_panel.jpg)
 
 - **PREOUT**: Unamplified zone audio outputs, intended for use with powered speakers/subwoofers.

diff --git a/docs/manuals/imgs/AmpliPro_streamer_front_angled.png b/docs/manuals/imgs/AmpliPro_streamer_front_angled.png
diff --git a/docs/manuals/imgs/expander.png b/docs/manuals/imgs/expander.png
diff --git a/docs/manuals/main/MAIN_CONTROLLER_SPECS.md b/docs/manuals/main/MAIN_CONTROLLER_SPECS.md
@@ -2,40 +2,40 @@
 
 |Feature||
 |:------|:-----|
-|Streaming Sources | Airplay™, Pandora®, Spotify Connect™, DLNA®, Internet Radio, Bluetooth™* External Media Drives  |
+|Streaming Sources          | Airplay™, Pandora®, Spotify Connect™, DLNA®, |
+|                           | Internet Radio\*, Bluetooth™\*, External Media Drives\* |
 |||
-|Control Interfaces| Web App, Mobile App, REST API, Third-Party Software|
+|Control Interfaces         | Web App, Mobile App, REST API, Third-Party Software|
 |||
-|Dimensions        | 2U 19" rackmount unit, 12.5” L x 19” W x 3.5” H|
+|Dimensions                 | 2U 19" rackmount unit, 12.5” L x 19” W x 3.5” H|
 |||
-|Weight            | 15 lbs / 6.8 kg |
+|Weight                     | 15 lbs / 6.8 kg |
 |||
-|Connectivity      | 100Mbps Ethernet|
-|                  | 2x USB 2.0|
+|Connectivity               | 100Mbps Ethernet |
 |||
-|Power Input       | 100-120 VAC or 180-264 VAC, 50-60Hz, Maximum input 782W|
+|Power Input                | 100-120 VAC or 180-264 VAC, 50-60Hz, Maximum input 782W|
 |||
-|Power Consumption | 6.7W Idle |
-|                  | 391W Continuous |
-|                  | 782W Peak |
+|Power Consumption          | 6.7W Idle |
+|                           | 391W Continuous |
+|                           | 782W Peak |
 |||
-|Peak Current Consumption|6.8A @ 115VAC or 3.4A @230VAC|
+|Peak Current Consumption   |6.8A @ 115VAC or 3.4A @230VAC|
 |||
-|Speaker Power     | 55 WPC @ 4 Ω |
-|                  | 32 WPC @ 8 Ω |
+|Speaker Power              | 55 WPC @ 4 Ω |
+|                           | 32 WPC @ 8 Ω |
 |||
-|Speaker Impedance | 4 - 8 Ω |
+|Speaker Impedance          | 4 - 8 Ω |
 |||
-|Stereo Zones      | 6 |
+|Stereo Zones               | 6 |
 |||
-|Audio Input       | 4 RCA Line In |
-|                  | Max input level: 2.0 VRMS (6dBV) |
-|                  | Input Sensitivity: 0.35 VRMS |
+|Audio Input                | 4 x RCA Line In |
+|                           | Max input level: 2.0 VRMS (6dBV) |
+|                           | Input Sensitivity: 0.35 VRMS |
+|                           | 2 x External USB 2.0 |
+|                           | 1 x Internal USB 2.0 |
+|                           | 1 x 3.5mm Audio Jack |
 |||
-|Digital Audio Sources | 32-bit 384KHz (Source 1), 16-bit 48KHz (Sources 2, 3, 4)|
+|Digital Audio Sources      | 32-bit 384KHz (Source 1), 16-bit 48KHz (Sources 2, 3, 4)|
 |
 |
-|
-|
-|
-| *\* with third party USB Adapter |
+| *\* with third party USB hardware |
diff --git a/docs/manuals/streamer-manual.tex b/docs/manuals/streamer-manual.tex
@@ -29,11 +29,11 @@
 
 \maketitle
 \setkeys{Gin}{width=.99\linewidth}
-\includegraphics{ imgs/main_graphic_16x9.jpg}
+\includegraphics{ imgs/AmpliPro_streamer_front_angled.png}
 \newline
 \newline
 \begin{center}
-  \LARGE{ \textbf{ Device Model: AP-S4Z6}}
+  \LARGE{ \textbf{ Device Model: AP1-S4}}
 \end{center}
 \includegraphics{ imgs/MicroNova_Logo.jpg}
 
@@ -42,16 +42,14 @@
 \newpage
 \pagenumbering{arabic}
 
-\markdownInput{common/LINKS.md}
+\markdownInput{streamer/LINKS.md}
 \newpage
 \markdownInput{common/SAFETY.md}
 \newpage
 \markdownInput{common/FCC.md}
 \newpage
 \markdownInput{streamer/OVERVIEW.md}
 \newpage
-\markdownInput{streamer/STREAMER.md}
-\newpage
 \markdownInput{streamer/STREAMER_SPECS.md}
 \newpage
 \markdownInput{streamer/INSTALLATION.md}

diff --git a/docs/manuals/streamer/INSTALLATION.md b/docs/manuals/streamer/INSTALLATION.md
@@ -1,68 +1,50 @@
 # Installation
 ## Overview
-It's time to upgrade your AmpliPro unit. To avoid damaging the unit, please read through this guide before installing and powering your AmpliPro unit!
-\
-\
- **WARNING!! VERIFY THAT THE VOLTAGE OF YOUR WALL OUTLET MATCHES THE VOLTAGE LISTED NEAR THE POWER INLET BEFORE PLUGGING IN. IF THE VOLTAGE IS NOT MATCHED, PLEASE CONTACT US AT support@micro-nova.com**
+It's time to power on your AmpliPro Streamer and try it out. To avoid damaging the unit, please read through this guide before installing and powering your AmpliPro unit!
 
 ## Mounting and Placement
 
-Main Controllers and Zone Expanders both ship with built-in 19" rackmount ears, so that they can be easily installed into a server rack.
-Both the main and expansion units are approximately 15 pounds (6.8 kilograms)
+AmpliPro Streamer units ship with built-in 19" rackmount ears, so that they can be easily installed into a server rack. Also included are four silicone "feet" if you prefer to run the unit from a shelf.
+The weight of the unit is approximately 5 pounds (2.3 kilograms)
 
 Some things to keep in mind to avoid overheating the unit:
 - Don't block the vent holes on the side
 - Don't allow dust to build up inside the unit. See cleaning instructions on the safety page for more details.
 
 
 ## Speakers
-Each of AmpliPro's zones has two speaker outputs that drive a 4-8 Ohm speaker, using the provided Euroblock connectors. Here is what the basic wiring diagram for a zone looks like:
-
-![Speaker wiring](imgs/zone_speaker_wiring.png)
-
-AmpliPro's amplifiers are capable of driving 4-8 Ohm speaker loads. Here is what a typical stereo speaker connection, using CL2-rated 14-AWG speaker wire and the Euroblock connectors, looks like:
-
-![Euroblock connector connection](imgs/euroblock_example.jpg)
-
-To connect a stereo speaker pair using speaker wire:
-
-1. Strip 3-4 inches of the cable jacket, then strip 1/4 inch of insulation from the end of each wire.
-2. Twist the frayed end of each wire.
-3. Please note that the wiring diagram (the image with four green squares wired to two speakers) shows polarity, not necessarily the colors of the wires. Make sure you connect positive to positive and negative to negative while also keeping the left and right channels separated into their own speakers.
-4. Unscrew each set screw to open the contacts, then insert and tighten down each wire one by one. Note that set screws loosen, but should not come out.
-5. To avoid any shorts, make sure that there aren't any stray wire strands.
-6. The speaker set can now be connected to one of the 6 zones.
-
-### Connections
-- Improper connection of speakers can damage the unit
-- Never connect multiple speakers in parallel such that it brings the total impedance below 4 ohms (max 2x 8ohm speakers in parallel).
-- Amplified speaker outputs **CAN NOT** be bridged, attempting to do so will damage the amplifier and void the warranty
+Each of your Streamer's zones outputs as a line-level RCA output pair. These outputs can be used to connect powered subwoofers and other active/powered speakers. Unlike with a standard edition AmpliPro, there are no in-app volume controls; volume is intended to be controlled by whatever amplifier or powered speaker solution you choose.
 
 ### Running wire in walls and ceilings
 - Most electric codes require the use of CL2-rated speaker wires for in-wall installations. Please refer to local building codes for more details.
 - Avoid running speaker wires next to AC power wires as much as possible to reduce noise.
 - When necessary, cross AC wires at 90-degree angles to avoid introducing any noise into the speakers.
 
-### Connecting the Expansion Unit
-
-To connect the expansion unit to the main system, first ensure that all units are disconnected from power. Then, using the included Expansion Data Cable, chain the units together using the chain in/out ports on the back. You can connect one controller and up to 5 expansion units in this fashion.
-
 ### More Info
 
 More information on speaker selection and installation can be found in AmpliPro’s community forums that can be reached from the system settings, simply click on "About", then the "Community" link and see the "Installation and Getting Started" topic on our discourse group, also accessible at amplipi.discourse.group.
 
-## Preamp Outputs
-Each of AmpliPro's zone outputs has a corresponding line-level RCA output pair. These outputs can be used to connect powered subwoofers and other active/powered speakers.
 
-The volume output of a preout is controlled by the corresponding speaker output. This allows a connected subwoofer to be controlled proportionally to the speaker's output in the same zone.
+## Power
+
+Plug the AmpliPro Streamer into a wall outlet. The ON/STANDBY will start off blinking red and then transition to solid red once the unit is fully powered on. Continue below to enjoy your unit!
 
-## Audio Inputs
-Each of the stereo RCA inputs can be connected to a different audio source, such as the output of a TV or other compatible device. See device specifications page for further information.
+## Startup and Configuration
+Now that the AmpliPro Streamer is powered on, it's time to use the software. To access the app, there are two options:
 
-## Power
-**WARNING!! VERIFY THAT THE VOLTAGE OF YOUR WALL OUTLET MATCHES THE VOLTAGE LISTED NEAR THE POWER INLET.**
+### Mobile App
+
+1. We offer mobile apps available on Android and iOS, simply search for "Amplipi" on the Google Play Store or Apple's App Store or go to the Links page at the start of this manual for QR codes for each version
+2. Once you have the app downloaded, permit the app to access devices on your local network. The app will automatically search your network for active AmpliPro units.
+3. If you have multiple controllers (main units or streamers), it will ask which unit you wish to connect to. We suggest giving different hostnames to each unit if you have multiple controllers on the same network for this reason.
+
+### Webapp
+
+Simply enter "amplipi.local" into a web browser, on any device that both has a web browser and is connected to the same network. Android and Windows 7 users will need to type the IP address found on the unit's display into their web browser instead.
 
-AmpliPro ships preconfigured for the typical mains voltage in your region, either 120V mains power or 230V mains; to see what mode it was set to before shipment, check which hole near the power inlet has a plastic peg/screw. If your unit is preconfigured incorrectly for your region, please contact us at **support@micro-nova.com**
-\
-Once you've ensured that the unit has the correct input voltage configured, plug the expander data cable into the expansion slots of both AmpliPro controller and expansion unit ensure both are plugged into a wall outlet. The ON/STANDBY will start off blinking red and then transition to solid red once the unit is fully powered on. Continue below to enjoy your unit!
+### From the app:
 
+1. Click the plus (+) icon and select a stream
+  - The Groove Salad - InternetRadio stream comes preconfigured (needs an internet connection).
+2. Click on the record/disc icon at the bottom of the screen to enter the player view, which has more controls depending on the stream type.
+3. If you wish to change the default group and zone names or add different streaming sources, click on the gear icon on the bottom right to reach the settings page where you can configure inputs and zones.
diff --git a/docs/manuals/streamer/LINKS.md b/docs/manuals/streamer/LINKS.md
@@ -0,0 +1,2 @@
+# Links
+![QR Codes](streamer/qr-page-streamer.png)
diff --git a/docs/manuals/streamer/OVERVIEW.md b/docs/manuals/streamer/OVERVIEW.md
@@ -4,7 +4,26 @@ AmpliPro™ is a multi-room/-zone home audio controller and amplifier made for w
 \
 Your AmpliPro Streamer Unit includes the following components:
 
-- 1 x User Manual
+- 1 x Quick Start Guide
 - 1 x AmpliPro Streamer Unit
 - 1 x Power Cable
 - 1 x Ethernet Cable
+
+### Front Panel
+
+![Zone Expander - Front Panel]( imgs/front_panel_streamer.png)
+
+- **ON/STANDBY**: Shows the state of the audio controller:
+    * Blue: The unit is on
+    * Blinking Red: The unit is waiting to be configured
+
+### Rear Panel
+
+
+![Zone Expander - Rear Panel]( imgs/rear_panel_streamer.png)
+
+- **OUTPUT**: Unamplified zone audio outputs, intended for use with powered speakers/subwoofers.
+- **SERVICE**: Micro USB service port, used for troubleshooting and reimaging the device
+- **USB**: 2 x USB 2.0 ports, to be used with bluetooth or FM radio dongles, or for an external storage device that contains music files
+- **AUX IN**: Audio Input
+- **NETWORK**: RJ-45 port for wired ethernet networking
diff --git a/docs/manuals/streamer/STREAMER.md b/docs/manuals/streamer/STREAMER.md
diff --git a/docs/manuals/streamer/STREAMER_SPECS.md b/docs/manuals/streamer/STREAMER_SPECS.md
@@ -2,29 +2,27 @@
 
 |Feature||
 |:------|:-----|
-|Streaming Sources | Airplay™, Pandora®, Spotify Connect™, DLNA®, |
-|                  | Internet Radio, Bluetooth™*, External Media Drives |
+|Streaming Sources            | Airplay™, Pandora®, Spotify Connect™, DLNA®, Lyrion Media Server|
+|                             | Internet Radio\*, Bluetooth™\*, External Media Drives\* |
 |||
-|Control Interfaces| Web App, Mobile App, REST API, Third-Party Software|
+|Control Interfaces           | Web App, Mobile App, REST API, Third-Party Software |
 |||
-|Dimensions        | 1U 19" rackmount unit with 300mm depth, 6” L x 19” W x 1.75” H|
+|Dimensions                   | 1U 19" rackmount unit with 300mm depth, 6” L x 19” W x 1.75” H |
 |||
-|Weight            | 5 Pounds / 2.3 Kilograms |
+|Weight                       | 5 Pounds / 2.3 Kilograms |
 |||
-|Power Input       | 100-240VAC 50-60Hz max input 45W |
+|Power Input                  | IEC 60320 C14 Inlet 100-240VAC 50-60Hz max input 45W |
 |||
-|Power Consumption | 1W Idle |
-|                  | 391W Continuous |
-|                  | 782W Peak |
+|Power Consumption            | 1W Idle |
+|                             | 391W Continuous |
+|                             | 782W Peak |
 |||
-|Peak Current Consumption| 6.8A @ 115VAC or 3.4A @230VAC |
+|Peak Current Consumption     | 6.8A @ 115VAC or 3.4A @230VAC |
 |||
-|Speaker Power     | 55 WPC @ 4 Ω |
-|                  | 32 WPC @ 8 Ω |
-|||
-|Speaker Impedance | 4 - 8 Ω |
-|||
-|Stereo Zones      | 6 |
-|||
-|Audio Input       | 2 x USB 2.0 (supports FM radio adapter, bluetooth adapter, external storage inputs) |
-|                  | 1 x Optical TOSLINK |
+|Inputs                       | 2 x External USB 2.0 |
+|                             | 1 x Internal USB 2.0 |
+|                             | 1 x 3.5mm Audio Jack |
+|
+|
+| *\* with third party USB hardware |
+
diff --git a/docs/manuals/streamer/qr-page-streamer.png b/docs/manuals/streamer/qr-page-streamer.png