soundbox, branch restructuringDevice to connect classic audio systems to the networkhttps://cgit.xengineering.eu/soundbox/atom?h=restructuring2024-12-26T11:07:01ZWIP: Introduce second license CC-BY-SA2024-12-26T11:07:01Zxengineeringme@xengineering.eu2024-12-23T21:11:51Zurn:sha1:3093a0ade2fb1ad612975185f92d497e24cced16
TODO: add LICENSE.txt to explain which license applies to what
TODO: Adapt license notices in PDF output.
TODO: Add explanation in build tree.
WIP: Move `mech` directory to `case`2024-12-26T11:06:36Zxengineeringme@xengineering.eu2024-12-24T11:39:34Zurn:sha1:db966c966929dd3abc29ebab7ce47d638ba4a94f
TODO: There are outdated references (see grep -R mech .)
The directory name should reflect what is inside, not the field of
engineering it belongs to.
doc: Update changelog for release 0.2.12024-10-12T12:14:02Zxengineeringme@xengineering.eu2024-10-12T12:14:02Zurn:sha1:03d41e8069623b5d627dfb298c471a16c380c91ddoc: Fix and rework source links in changelog2024-10-12T11:22:39Zxengineeringme@xengineering.eu2024-10-12T11:22:39Zurn:sha1:c0d25407c8e1b4fba828ac4eec5e2b79372692de
The release 0.2.0 had a bad link. Furthermore the prefix `Source code: `
was added to the source URLs.
doc: Replace subsections by paragraphs in changelog2024-10-12T11:18:06Zxengineeringme@xengineering.eu2024-10-12T11:18:06Zurn:sha1:9be5f9f58c5e7df0c8e264cdd4eee7e1f27b4034
The categories like `added` or `changed` should not show up in the table
of contents and should be less dominant. A `\paragraph` is more suitable
for this.
doc: Fix quote characters2024-10-12T11:04:28Zxengineeringme@xengineering.eu2024-10-12T11:02:58Zurn:sha1:263787bae1d698ebc7aa9cc6581b69d258dcca7d
LaTeX used to convert `'` quotes to a `’` even in verbatim environments.
This is unsuitable to copy commands from the documentation to the Linux
command line interface.
Since this use case is very important to use the documentation this has
to be fixed. Using the `upquote` package is sufficient to prevent the
conversion.
doc: Revert change to Alpine 3.19.02024-09-29T09:33:31Zxengineeringme@xengineering.eu2024-09-29T09:33:31Zurn:sha1:17b8d231406c2365d06cdd8b048b3495705be0df
There were ALSA and SDL2 related audio issues with the latest version.
Rolling back since soundbox should anyway move to a
microcontroller-based solution.
doc: Update changelog for 0.2.02024-09-29T09:17:53Zxengineeringme@xengineering.eu2024-09-29T08:56:44Zurn:sha1:97148c8d1b91289b1c41d736077fca8ac1a840d3doc: Fix soundbox script for IPv62024-09-29T09:16:30Zxengineeringme@xengineering.eu2024-09-29T08:53:57Zurn:sha1:c4611a3fbefdbc974b384ca71133e2e6fbc98240
It used to listen on IPv4 requests only.
doc: Add unofficial support for HiFiBerry Amp22024-09-28T20:53:37Zxengineeringme@xengineering.eu2024-09-28T20:53:37Zurn:sha1:77158b80a0e3d24ec7c70a1ad36b1f680c942940
This board is suitable to connect passive speakers to an unofficial
soundbox build.
doc: Update changelog for IPv6-related changes2024-09-28T20:17:04Zxengineeringme@xengineering.eu2024-09-28T20:17:04Zurn:sha1:afa22db1f3a1b50b6ae9577df8da7af830047601doc: Adapt streaming guide to IPv62024-09-28T20:09:46Zxengineeringme@xengineering.eu2024-09-28T20:09:46Zurn:sha1:55db6f8b7338a2c47447aceec93908160dd60128
It is a bit more complex to stream via IPv6 link-local addresses. This
commit adapts the user guide to it.
doc: Explain how to get the IPv6 address of a device2024-09-28T19:57:44Zxengineeringme@xengineering.eu2024-09-28T19:57:44Zurn:sha1:95a419ec6fd69ede07cb4f01682adc36c1fd3dbadoc: Add device label2024-09-28T19:49:08Zxengineeringme@xengineering.eu2024-09-28T19:45:07Zurn:sha1:5c5d5c3f938bc19e75d81a4b1279d9a356bde36e
It is required for the user to know the MAC address since it is used to
calculate the IPv6 address required for streaming audio to the device
without additional network configuration.
Thus a label containing the MAC address has to be added to the device.
doc: Add instructions to note down MAC address2024-09-28T19:49:08Zxengineeringme@xengineering.eu2024-09-28T19:12:34Zurn:sha1:844588c7b98db65fc4c8050bae3184a747822092
The MAC address is required to compute the IPv6 link-local address of
the device used for streaming audio.
doc: Enable IPv62024-09-28T19:49:08Zxengineeringme@xengineering.eu2024-09-28T18:51:04Zurn:sha1:7745d56644621cb0365d51ee5a284a36f5089dd6
soundbox should use IPv6 for streaming. IPv6 link-local addresses are
well-suited for soundbox devices since they are generated by the
hardware MAC address in this case.
This has the advantage that they do not need external infrastructure
like a DHCP server to be set up and that they are valid and unique for
the whole life cycle of the device. This makes network management
significantly easier.
doc: Remove lldpd server2024-09-28T19:49:02Zxengineeringme@xengineering.eu2024-09-27T13:59:53Zurn:sha1:6cfb69f8a265ffadead2275c13c74178b17b5184
The goal is to switch to IPv6 link-local addresses only. They have the
advantage that they can be static by a hardware MAC address, are suited
for local network streaming and discovery can be done by using the
`ping` utility. Additionally the address can be calculated based on MAC
addresses which can be printed on the case and typed into the client by
the user. Thus this makes network discovery only a convenience feature
instead of a required one.
Removing the LLDP-based discovery is the first step into this direction.
doc: Update to Alpine Linux version 3.20.32024-09-28T19:48:48Zxengineeringme@xengineering.eu2024-09-28T17:56:30Zurn:sha1:0abe275743dd9cf73e339a7e41636a6da0f7914f
No special reason for the update. Only keeping up with the state of the
OS and security patches.
doc: Fix / improve changelog entry2024-09-27T14:22:26Zxengineeringme@xengineering.eu2024-09-27T14:09:33Zurn:sha1:cc175e90beac3175d95dffdbe20e614435354bf0doc: Fix typo2024-09-27T14:22:22Zxengineeringme@xengineering.eu2024-09-27T13:13:28Zurn:sha1:4bbbb35f7f50fac36063ef2a41acdf8adcee4c2fdoc: Rename last section to "License"2024-09-26T19:53:21Zxengineeringme@xengineering.eu2024-09-26T19:53:21Zurn:sha1:334d6b69204d0acca740da7ff14a28b937c2328d
It used to be named by the chosen license. To make the structure of the
document more generic it should only be named "License".
doc: Rename section "Production" to "Production Guide"2024-09-26T19:51:23Zxengineeringme@xengineering.eu2024-09-26T19:51:23Zurn:sha1:e899802f7d2edfa5cd8559aabc62198ace292cdedoc: Add changelog to appendix2024-09-26T19:45:14Zxengineeringme@xengineering.eu2024-09-26T19:38:43Zurn:sha1:6fe267f08b0f1cd277f2578951bae6a088c77a8dFix wrong version string2024-02-02T20:34:32Zxengineeringme@xengineering.eu2024-02-02T20:34:32Zurn:sha1:aa9f5f134e995693633b5dba569d631fc4389624
The `--long` option for `git describe` adds the number of commits since
the last release and the Git hash always (even on a release). This is
not intended. Removing this option works before and after the first
release as expected.
doc: Replace author name by email address2024-02-02T20:21:51Zxengineeringme@xengineering.eu2024-02-02T20:21:51Zurn:sha1:65bd53fb8c324c2237ccd9ce06bb9f3d47222f1f
Since the name is contained inside the mail address it is not required
to add both.
Adding the email address is important for all kinds of feedback. This
might include general reactions to the project, feature requests, legal
questions or patches for improvements.
doc: Mention license in introduction text2024-02-02T20:21:00Zxengineeringme@xengineering.eu2024-02-02T20:21:00Zurn:sha1:94d7ae0f681a2ab325f865d48a3a5131fdec4ebe
This is very important information for every reader so it should be part
of the first section.
doc: Add license text as appendix2024-02-02T20:06:23Zxengineeringme@xengineering.eu2024-01-21T08:28:01Zurn:sha1:8a6065d53dcbc1f0cedd6925681b43c9c5e0b890
The text of each used license is added to the documentation PDF since
this might be passed to third parties without the source or build tree.
Adding the licenses to the PDF makes sure they are always accessible.
Switch completely to CERN-OHL-S2024-02-02T19:57:44Zxengineeringme@xengineering.eu2024-02-02T17:44:46Zurn:sha1:52e93507245fb2c2421f0d324d6af1724ea847a9
The CERN Open Hardware License is not restricted to mechanical or
electrical design files but instead has a very wide scope (see section
1.3 of the OHL).
Thus it can be applied to all contents of this repository. Having only
one license makes the license structure for this project way easier.
Since the OHL is written with hardware in mind it likely fits better to
this open hardware project.
doc: Make version and date files phony targets2024-01-31T20:34:17Zxengineeringme@xengineering.eu2024-01-31T20:34:17Zurn:sha1:0c1cabb24ed00c6a69a69cc4bc4505c384be6b35
This makes sure that the version / date file is always re-generated.
Otherwise it is hard to make sure that e.g. the version is always
aligned with the real state.
doc: Restrict lldpd to Unix OS not Linux2024-01-30T20:14:44Zxengineeringme@xengineering.eu2024-01-30T20:14:44Zurn:sha1:9af2e3c3357ff738700e89dd816fd4162fd3bfcf
The lldpd homepage [1] mentions Unix operating systems as host systems,
not only Linux. Furthermore there is a possibly working homebrew package
for MacOS.
[1]: https://lldpd.github.io
[2]: https://formulae.brew.sh/formula/lldpd#default