Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More Manuals #923

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
79120aa
Rename 'manual' folder to 'manuals', rearrange file structure within …
SteveMicroNova Aug 30, 2024
d4940fd
Update manual(s)
SteveMicroNova Sep 13, 2024
eacea18
Move specific images into their proper specific directories, reroute …
SteveMicroNova Sep 16, 2024
4fd7f68
Update manual troubleshooting guide
SteveMicroNova Sep 16, 2024
2f6566f
Updating wording, images in manuals
SteveMicroNova Sep 19, 2024
a33d8be
Remove references of groups from the streamer manual
SteveMicroNova Sep 19, 2024
224fc0e
Add "tarball" definition to the glossaries
SteveMicroNova Sep 19, 2024
7d0f31e
Update images, fonts, spelling
SteveMicroNova Sep 25, 2024
d7934e7
Change colors, upgrade specs table
SteveMicroNova Sep 25, 2024
1d3289e
Update wording
SteveMicroNova Sep 25, 2024
3e141e8
Update tables to be in latex, add SPECS_TITLE.md as a means of keepin…
SteveMicroNova Sep 25, 2024
51ad415
Remove all references to "streamer unit" from the entire repo, now si…
SteveMicroNova Sep 26, 2024
9d3029b
Change punctuation
SteveMicroNova Sep 26, 2024
bc69340
Update images
SteveMicroNova Sep 26, 2024
e52ae4f
Add newly measured specs
SteveMicroNova Sep 27, 2024
bfd478e
Add error codes section to both TROUBLESHOOTING.md files
SteveMicroNova Oct 14, 2024
cb89643
Remove multiple instances of Airplay across supported stream lists
SteveMicroNova Oct 17, 2024
cbb8c77
Update Webapp PC picture to remove corruption
SteveMicroNova Oct 21, 2024
9445d15
Update info, fix broken font issue
SteveMicroNova Dec 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Rename 'manual' folder to 'manuals', rearrange file structure within …
…manuals folder to support four separate manuals with some common files
  • Loading branch information
SteveMicroNova committed Aug 30, 2024
commit 79120aafcb705c779e9fb44fe928ce401818b9ac
30 changes: 0 additions & 30 deletions docs/manual/MANUAL.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/manual/docker-compose.yaml

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
40 changes: 40 additions & 0 deletions docs/manuals/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# This file allows the manual to be generated with a single click in vscode
# With the docker extension installed right click on this file and select "Compose Up"
# 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

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
container_name: markdown-translator-streamer
command: latexmk -lualatex streamer-manual.tex
restart: no
working_dir: /docs/manuals
volumes:
- .:/docs/manuals

# wallpanel:
# image: witiko/markdown
# container_name: markdown-translator-wallpanel
# command: latexmk -lualatex wallpanel-manual.tex
# restart: no
# working_dir: /docs/manuals
# volumes:
# - .:/docs/manuals
63 changes: 63 additions & 0 deletions docs/manuals/expander-manual.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
\documentclass{article}
\usepackage{geometry}
\geometry{
a4paper,
total={170mm,257mm},
left=20mm,
top=20mm,
}
\usepackage{tgheros}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
%\usepackage[english]{isodate}
%\usepackage[parfill]{parskip}
\usepackage[hybrid]{markdown}
\markdownSetup{
pipeTables,
tableCaptions,
rendererPrototypes = {
image = {\begin{center}\setkeys{Gin}{width=.99\linewidth}\includegraphics{#2}\end{center}}, % center images inline expanding to page width
codeSpan = {\texttt{#1}}, % Render inline code via `\texttt`.'
}
}
\title{
\textbf{AmpliPro Expansion Unit - User Manual}
}
\date{ \textbf{ Version: 0.3.5}}
\setlength\parindent{0pt}
\begin{document}

\maketitle
\setkeys{Gin}{width=.99\linewidth}
\includegraphics{ imgs/main_graphic_16x9.jpg}
\newline
\newline
\begin{center}
\LARGE{ \textbf{ Device Model: AP-S4Z6}}
\end{center}
\includegraphics{ imgs/MicroNova_Logo.jpg}

\newpage
\tableofcontents
\newpage
\pagenumbering{arabic}

\markdownInput{common/LINKS.md}
\newpage
\markdownInput{common/SAFETY.md}
\newpage
\markdownInput{common/FCC.md}
\newpage
\markdownInput{expander/OVERVIEW.md}
\newpage
\markdownInput{expander/ZONE_EXPANDER.md}
\newpage
\markdownInput{expander/ZONE_EXPANDER_SPECS.md}
\newpage
\markdownInput{expander/INSTALLATION.md}
\newpage
\markdownInput{common/TROUBLESHOOTING.md}
\newpage
\markdownInput{common/WARRANTY.md}

\end{document}
68 changes: 68 additions & 0 deletions docs/manuals/expander/INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 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**

## 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)

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

### 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.

## 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.

## Power
**WARNING!! VERIFY THAT THE VOLTAGE OF YOUR WALL OUTLET MATCHES THE VOLTAGE LISTED NEAR THE POWER INLET.**

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!

13 changes: 13 additions & 0 deletions docs/manuals/expander/OVERVIEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Overview
AmpliPro™ is a multi-room/-zone home audio controller and amplifier made for whole-home audio systems with many zones. It can play up to 4 simultaneous audio streams (Airplay™, Pandora®, Spotify Connect™, etc.) or sources (RCA inputs), each routed to one or many zones, all of which are configurable in real-time using the mobile apps (see QR codes on the first page of this manual), self-hosted AmpliPi Web App, or the underlying REST API. It is expandable up to 36 zones using AmpliPro Expanders.
\
This manual belongs to one such expansion unit, with it you're able to wire up 6 more zones for use with your main AmpliPro Control Unit.
\
\
Your AmpliPro Expansion Unit includes the following components:

- 1 x User Manual
- 1 x AmpliPro Expansion Unit
- 1 x Expansion Data Cable
- 1 x Power Cable
- 6 x 4-pin Euroblock connectors (for speaker connections)
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/manuals/imgs/front_panel_streamer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/manuals/imgs/rear_panel_streamer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
63 changes: 63 additions & 0 deletions docs/manuals/main-manual.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
\documentclass{article}
\usepackage{geometry}
\geometry{
a4paper,
total={170mm,257mm},
left=20mm,
top=20mm,
}
\usepackage{tgheros}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
%\usepackage[english]{isodate}
%\usepackage[parfill]{parskip}
\usepackage[hybrid]{markdown}
\markdownSetup{
pipeTables,
tableCaptions,
rendererPrototypes = {
image = {\begin{center}\setkeys{Gin}{width=.99\linewidth}\includegraphics{#2}\end{center}}, % center images inline expanding to page width
codeSpan = {\texttt{#1}}, % Render inline code via `\texttt`.'
}
}
\title{
\textbf{AmpliPro Home Audio Controller - User Manual}
}
\date{ \textbf{ Version: 0.3.5}}
\setlength\parindent{0pt}
\begin{document}

\maketitle
\setkeys{Gin}{width=.99\linewidth}
\includegraphics{ imgs/main_graphic_16x9.jpg}
\newline
\newline
\begin{center}
\LARGE{ \textbf{ Device Model: AP-S4Z6}}
\end{center}
\includegraphics{ imgs/MicroNova_Logo.jpg}

\newpage
\tableofcontents
\newpage
\pagenumbering{arabic}

\markdownInput{common/LINKS.md}
\newpage
\markdownInput{common/SAFETY.md}
\newpage
\markdownInput{common/FCC.md}
\newpage
\markdownInput{main/OVERVIEW.md}
\newpage
\markdownInput{main/MAIN_CONTROLLER.md}
\newpage
\markdownInput{main/MAIN_CONTROLLER_SPECS.md}
\newpage
\markdownInput{main/INSTALLATION.md}
\newpage
\markdownInput{common/TROUBLESHOOTING.md}
\newpage
\markdownInput{common/WARRANTY.md}

\end{document}
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

|Feature||
|:------|:-----|
|Streaming Sources | Airplay™, Pandora®, Spotify Connect™, DLNA®, Internet Radio, Bluetooth™* |
|Streaming Sources | Airplay™, Pandora®, Spotify Connect™, DLNA®, Internet Radio, Bluetooth™* External Media Drives |
|||
|Control Interfaces| Web App, Mobile App, REST API, Third-Party Software|
|||
File renamed without changes.
22 changes: 12 additions & 10 deletions docs/manual/manual.tex → docs/manuals/streamer-manual.tex
Original file line number Diff line number Diff line change
@@ -20,7 +20,9 @@
codeSpan = {\texttt{#1}}, % Render inline code via `\texttt`.'
}
}
\title{ \textbf{AmpliPro Home Audio Controller - User Manual}}
\title{
\textbf{AmpliPro Streamer Unit - User Manual}
}
\date{ \textbf{ Version: 0.3.5}}
\setlength\parindent{0pt}
\begin{document}
@@ -40,22 +42,22 @@
\newpage
\pagenumbering{arabic}

\markdownInput{LINKS.md}
\markdownInput{common/LINKS.md}
\newpage
\markdownInput{SAFETY.md}
\markdownInput{common/SAFETY.md}
\newpage
\markdownInput{FCC.md}
\markdownInput{common/FCC.md}
\newpage
\markdownInput{OVERVIEW.md}
\markdownInput{streamer/OVERVIEW.md}
\newpage
\markdownInput{MAIN_CONTROLLER.md}
\markdownInput{streamer/STREAMER.md}
\newpage
\markdownInput{MAIN_CONTROLLER_SPECS.md}
\markdownInput{streamer/STREAMER_SPECS.md}
\newpage
\markdownInput{INSTALLATION.md}
\markdownInput{streamer/INSTALLATION.md}
\newpage
\markdownInput{TROUBLESHOOTING.md}
\markdownInput{common/TROUBLESHOOTING.md}
\newpage
\markdownInput{WARRANTY.md}
\markdownInput{common/WARRANTY.md}

\end{document}
Loading