Age | Commit message (Collapse) | Author |
|
|
|
This allows to stream to multiple devices at the same time. Nevertheless
it still works for a point to point stream.
|
|
The soundbox software should be portable to other Raspberry Pis without
the HiFiBerry DAC too.
|
|
|
|
The music streaming documentation used to enforce re-encoding via ffmpeg
to save bandwidth. This led to pretty poor audio quality. This is not
the purpose of soundbox. It is assumed that the user wants the highest
possible audio quality as default.
|
|
Configuring the Alpine Linux operating system correctly for soundbox is
not trivial. Since it is very important it has to be documented in
detail.
|
|
The tar-based installation is more difficult to explain but has the
advantage that the partition size is maximized from the beginning. This
is way easier than resizing the partition after the installation.
|
|
This is currently the recommended OS installation for soundbox.
|
|
The positions of the connectors had to be adapted to the new PCB case
dimensions.
Furthermore the micro USB port which is built in to supply the device
with power is now the only visible micro USB port from the outside. The
other one is unused and could lead to confusion. User might plug in the
power cable into the wrong port.
Hiding this misleading USB port is an elegant way to avoid this problem.
Developers can still open the device to make use of that port if
required.
|
|
The front panel has to be very close and thin so that USB and HDMI
cables can still be connected when only the ports are cut out of the
panel.
|
|
Since a proper norm-based distance bolt was not found printing spacers
is the easiest way to make the case producable independent of part
availability.
|
|
This makes sure that the bolts inside the connectors align with them.
Thus the bolts do not stick inside the case which might lead to PCB
collisions.
|
|
The height should take into account that the shell is two instead of one
times the thickness high. This is relevant for the vertical spacing.
|
|
There used to be no extra space between paragraphs which in combination
with no indentation was not useful.
|
|
This flag makes sure the file is streamed in native frame rate and not
e.g. way faster. This is the expected behaviour.
|
|
This port should be used in the future as soundbox standard port.
|
|
This allows more testing than only streaming sine waves.
|
|
This documents a basic FFmpeg streaming example so that soundbox devices
can be tested.
|
|
This section is important to communicate how to interpret version
numbers in the context of this device repository.
|
|
This is required to build the table of contents and similar parts of the
document correctly.
|
|
Inside the artifacts folder aswell as inside the source folder adding a
'soundbox-' prefix to files is uncommon. In both cases only the root level
folder should contain the name 'soundbox' to remove redundancies.
|
|
This target will skip generating the artifacts directory. This avoids a
bloated build directory while the default target 'all' still generates
the artifacts.
|
|
All build files relevant for users (artifacts) should be provided in
build/artifacts. This folder has subdirectories for every revision and a
corresponding Zstandard-compressed Tar archive.
This archive contains the full result of the build of the current source
directory and can easily be shared.
|
|
The CAD model of the full assembly might be useful to be included in
other projects or CAD files.
|
|
Most users will not own the default printer and thus cannot work with
the built gcode files with the default slicer configuration.
It might be easier for those users to manually slice the STL instead of
modifying the soundbox source code.
|
|
|
|
|
|
Providing a structural overview inside the README should help developers
new to the repository to get familiar with it.
|
|
This document will be quite long. Thus the report document class is more
suitable.
|
|
This draft should give an overview of the planned sections which is
useful to decide what should belong into the first sections and what
should be written in later ones.
|
|
The build system should convert the documentation source files
automatically to a single PDF file to make documentation generation
trivial.
|
|
This target removes the build directory and is thus repository-global.
|
|
This LaTeX document should contain the full device documentation for
soundbox. It will not cover aspects about the source or how to build.
This should be covered inside the README of this repository. Everything
else will be part of the resulting documentation PDF file.
|
|
This license should cover the documentation of soundbox because software
licenses like the AGPL or hardware licenses like OHL are not well
suited.
|
|
The front panel needs holes for the HDMI, micro USB and cinch connectors
of the Raspberry Pi Zero W.
|
|
|
|
After switching the panel to PCB-based dimensions the shell follows with
this commit.
|
|
The whole case should move from case- to PCB-based parameters.
|
|
The long term goal is to switch from case-oriented parameters to
PCB-oriented parameters to simplify re-using the pcb_case library.
|
|
This makes the file structure simpler and makes it easy to produce the
whole case in one run.
|
|
This value used to consider only the required space for the Raspberry Pi
Zero W board, not for the required HifiBerry board.
|
|
|
|
This will help to identify calculation issues by human visual
inspection. The PCB is not yet aligned.
|
|
Without the bolt_ds_tol the drilling is too tight to be used for
tolerance testing without drilling manually.
|
|
Based on tolerance test printing.
|
|
Result from test print.
|
|
This is the result from a tolerance test printing.
|
|
Reducing from +/- 3 to +/- 2 reduces printing time for the tolerance
test.
|
|
|
|
The printer resolution is set to 0.15 mm so this is a useful step size.
|