Skip to content

Style, rewording #2642

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 19, 2022
Merged

Style, rewording #2642

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d580db9
Style, rewording
LizUpton Oct 14, 2022
4eb5fcf
Update faq.adoc
LizUpton Oct 18, 2022
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
51 changes: 24 additions & 27 deletions documentation/asciidoc/accessories/iqaudio/faq.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
=== Saving alsamixer settings
=== Saving AlsaMixer settings

Storing the alsamixer setting can be achieved by performing the following at the command line:
To store the AlsaMixer settings, add the following at the command line:

----
$ sudo alsactl store
----

It is possible to save the current state to a file, then reload that state at startup (very useful for the
Codec boards and use cases)
You can save the current state to a file, then reload that state at startup.

To save:

Expand All @@ -24,24 +23,22 @@ $ sudo alsactl restore -f /home/pi/usecase.state
=== Using external USB devices

If you want to enable 1.2 amp USB support (to allow USB hard disks to power up when
accessory boards are in use) then you may also want to add the following line to your `/boot/config.txt`
accessory boards are in use), you may also want to add the following line to your `/boot/config.txt`
file:

----
max_usb_current=1
----

Please ensure your Raspberry Pi power supply is able to deliver a minimum of 2.5 amps if you are powering via mini USB and
enable `max_usb_current`.

=== MPD based audio with volume control
=== MPD-based audio with volume control

To allow MPD (Music Player Daemon) based audio software to control the audio board’s built in volume the file
`/etc/mpd.conf` may need to be changed to support the correct ALSA mixer name.
To allow Music Player Daemon (MPD)-based audio software to control the audio board’s built in volume, the file
`/etc/mpd.conf` may need to be changed to support the correct AlsaMixer name.

This can be achieved by ensuring the 'Audio Output' section of `/etc/mpd.conf` has the 'mixer_control'
line. Below is an example for the Texas Instruments based boards (DAC
PRO/DAC{plus}/DigiAMP{plus})
This can be achieved by ensuring the 'Audio output' section of `/etc/mpd.conf` has the 'mixer_control'
line. Below is an example for the Texas Instruments-based boards (DAC
PRO/DAC{plus}/DigiAMP{plus}):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels a bit uncomfortable with no spaces between the slashes here? (or maybe that's just me)
Also, "Texas Instruments-based boards" feels like a level of technical detail that the users shouldn't need to know?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the TI bit had me vacillating when I did the first pass. I'll kill it. Slashes/spaces is a style guide thing; no spaces for consistency.

Not fixing the TI reference for now; another one for a sit-down conversation.


----
audio_output {
Expand All @@ -53,17 +50,17 @@ audio_output {

=== Hardware information

* PCB screws are all m2.5
* PCB standoffs (for CASE) are 5mm male / female
* PCB standoffs (for Raspberry Pi to audio products) are 9mm female / female
* PCB standoffs (for XLR to DAC PRO) are 8mm female / male
* PCB standoffs (for the official Raspberry Pi 7-inch display) are 5mm male / female
* The rotary encoders we have used and tested are the ALPHA 3 pin Rotary Encoder
RE160F-40E3-20A-24P, the ALPS EC12E2430804 (RS: 729-5848), the Bourns ECW0JB24-AC0006L (RS: 263-2839)
* The Barrel connector used for powering the DigiAMP+ is 2.5mmID, 5.5mmOD, 11mm
* The DigiAMP{plus} is designed to operate with a 12v 3amp to 24v supply such as the XPPower
VEC65US19 or similar
* The DigiAMP{plus} uses CamdenBoss two part connectors. Those fitted to the PCB are:
CTBP9350/2AO
* The speaker terminal used on the Codec Zero will accept wires of between 14 ~ 26 AWG
(wire of max 1.6mm in diameter)
* PCB screws are all M2.5.
* PCB standoffs (for case) are 5mm male/female.
* PCB standoffs (for Raspberry Pi to audio boards) are 9mm female/female.
* PCB standoffs (for XLR to DAC PRO) are 8mm female/male.
* PCB standoffs (for the official Raspberry Pi 7-inch display) are 5mm male/female.
* The rotary encoders we have used and tested are the Alpha three-pin rotary encoder
RE160F-40E3-20A-24P, the ALPS EC12E2430804 (RS: 729-5848), and the Bourns ECW0JB24-AC0006L (RS: 263-2839).
* The barrel connector used for powering the DigiAMP{plus} is 2.5mmID, 5.5mmOD, 11mm.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Space between 'mm' and 'ID' and 'OD'?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aallan More discussion about the barrel connector here ☝️

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah, ID and OD. Interesting.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cf. https://www.raspberrypi.com/documentation/accessories/build-hat.html#powering-the-build-hat

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should describe it (in both places) like this then, "via a DC 5521 centre positive barrel connector (5.5mm × 2.1mm × 11mm)" assuming it is a centre positive barrel?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...except the connector here has a 2.5mm inside diameter, which is different to the Build HAT's 2.1mm inside diameter 😜

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and this is why we all hate barrel jacks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one also requires a conversation in person. Let's talk tomorrow.

* The DigiAMP{plus} is designed to operate with a 12V to 24V, 3A supply such as the XPPower
VEC65US19 or similar.
* The DigiAMP{plus} uses CamdenBoss two-part connectors. Those fitted to the PCB are
CTBP9350/2AO.
* The speaker terminal used on the Codec Zero will accept wires of between 14~26 AWG
(wire of max 1.6mm in diameter).