Feature/wider dispersion (#26)

* starting to restructure the doc

* testing dispersion mitigation

* adding a tuning with wider dispersion

* small tweaks

LICENSE

@@ -33,7 +33,7 @@ exhaustive, and do not form part of our licenses.
      material not subject to the license. This includes other CC-
      licensed material, or material used under an exception or
      limitation to copyright. More considerations for licensors:
-    wiki.creativecommons.org/Considerations_for_licensors
+      wiki.creativecommons.org/Considerations_for_licensors
 
      Considerations for the public: By using one of our public
      licenses, a licensor grants the public permission to use the
@@ -50,7 +50,7 @@ exhaustive, and do not form part of our licenses.
      Although not required by our licenses, you are encouraged to
      respect those requests where reasonable. More considerations
      for the public:
-    wiki.creativecommons.org/Considerations_for_licensees
+      wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================
 

docs/source/conf.py

@@ -35,8 +35,14 @@
     'sphinx-favicon',
     'sphinxcontrib.youtube',
     'sphinx_panels',
+    'myst_parser',
+    'sphinxemoji.sphinxemoji',
+    'sphinx_last_updated_by_git',
 ]
 
+sphinxemoji_style = 'twemoji'
+source_suffix = ['.rst', '.md']
+
 # Display todos by setting to True
 todo_include_todos = True
 

docs/source/contributing.rst

@@ -0,0 +1,12 @@
+.. _contribution guideline:
+
+Contribution Guideline
+######################
+
+The following document describes how to contribute to the STRØM 1.0 project.
+
+The CC BY-NC-SA 4.0 license
+***************************
+
+.. include:: ../../CONTRIBUTING.md
+   :parser: myst_parser.sphinx_

docs/source/end-of-life.rst

@@ -0,0 +1,2 @@
+End of life
+###########

docs/source/index.rst

@@ -1,16 +1,36 @@
+.. |date| date::
+
 #########################################
 An Open Source Wireless Streaming Speaker
 #########################################
 
+The *Strøm* open source speaker project have been started with the main goal of creating a fully functional "streaming speaker", but as an open sourced product. One that you can choose to buy fully built and tested, or choose to built it yourself.
 
+.. toctree::
+  :caption: Documentation Sections
+  :maxdepth: 1
 
-The *Strøm* open source speaker project have been started with the main goal of creating a fully functional "streaming speaker", but as an open sourced product. One that you can choose to buy fully built and tested, or choose to built it yourself.
+  requirements
+  user-documentation/index
+  repair
+  end-of-life
+  contributing
+  license
+  todo
+
+Read on below to get a high level `Introduction to the project`_ as a whole.
 
 .. figure:: _static/images/stroem-speaker.png
    :alt: Speaker
 
    Strøm speaker in conifer linoleum and blue fabric on the soft top.
 
+
+
+
+Introduction to the project
+###########################
+
 The primary features of the *Strøm* speaker are:
 
 * Minimalistic design language
@@ -20,12 +40,31 @@ The primary features of the *Strøm* speaker are:
 
 Making it a modern, minimalistic and fully capable speaker.
 
+Motivation for starting the STRØM 1.0 project
+*********************************************
 
-.. toctree::
-   :maxdepth: 2
 
-   guides/index
-   software/index
-   speaker/index
-   requirements
-   todo
+Project goals
+*************
+
+
+Project history
+***************
+
+Initially started as an OPEN!NEXT demonstrator project in December 2021. The project was started by Tue Dissing.
+
+Contributing to the project
+***************************
+
+Interested in contributing to the project? Then please take a quick look at the contribution guideline beforehand.
+You find the contribution :ref:`here <contribution guideline>` and in the GitHub repo as well: `LydByDissing/stroem/CONTRIBUTING.md <https://github.com/LydByDissing/stroem/blob/main/CONTRIBUTING.md>`_.
+
+Last updated
+************
+The mainline documentation have last been updated at |date|.
+
+License
+#######
+
+This project is licenced under the Creative Commons ShareAlike 4.0 with a non-commercial clause: `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`_.
+You can read the licens in here or in the GitHub repo: `LydByDissing/stroem/LICENSE <https://github.com/LydByDissing/stroem/blob/main/LICENSE>`_.

docs/source/license.rst

@@ -0,0 +1,12 @@
+Project Licensing
+#################
+
+The STRØM 1.0 project consists of several open source projects. One for the software platform, one of the hardware (PCB) and this project.
+
+The license listed below only covers what is committed to this GitHub repository: `LydByDissing/stroem <https://github.com/LydByDissing/stroem>`_. The other projects are licenced seperately.
+
+The CC BY-NC-SA 4.0 license
+***************************
+
+.. include:: ../../LICENSE
+   :parser: myst_parser.sphinx_

docs/source/repair.rst

@@ -0,0 +1,2 @@
+Repair
+######

docs/source/requirements.txt

@@ -1,6 +1,6 @@
 sphinx-rtd-theme>=1.0.0
 rst2html>=2020.7.4
-docutils>=0.16
+docutils<0.18>=0.17
 rst2pdf>=0.98
 sphinx_charts>=0.0.4
 plotly>=5.4.0
@@ -12,3 +12,9 @@ sphinx-favicon>=0.2
 sphinxcontrib-youtube>=1.0.1
 sphinx-panels>=0.6.0
 sphinx-toolbox>=2.15.3
+MarkupSafe>=2.1.1
+jinja2>=3.1.2
+myst-parser>=0.17.2
+sphinxemoji>=0.2.0
+sphinx-last-updated-by-git>=0.3.2
+schemdraw>=0.14

docs/source/user-documentation/index.rst

@@ -0,0 +1,11 @@
+
+
+User Documentation
+##################
+
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   *

docs/source/user-documentation/maintanence.rst

@@ -0,0 +1,2 @@
+Maintenance
+***********

docs/source/user-documentation/user-manual.rst

@@ -0,0 +1,2 @@
+User Manual
+***********

voicing/voicing-80hz-target.yaml

@@ -1,6 +1,7 @@
 ---
 devices:
-  samplerate: 44100
+  #samplerate: 44100
+  samplerate: 48000
   chunksize: 8192
   capture:
     type: CoreAudio
@@ -42,7 +43,7 @@ filters:
     type: BiquadCombo
     parameters:
       type: LinkwitzRileyHighpass
-      freq: 45
+      freq: 50
       order: 8
   HS_1_negative:
     type: Biquad
@@ -84,7 +85,7 @@ filters:
     parameters:
       type: Peaking
       freq: 78
-      gain: 9
+      gain: 4
       q: 2.4
   peak_3:
     type: Biquad
@@ -114,14 +115,21 @@ filters:
       freq: 1000
       gain: 1.3
       q: 0.8
+  peak_6:
+    type: Biquad
+    parameters:
+      type: Peaking
+      freq: 3300
+      gain: 3
+      q: 3
   gain_to_normal_level:
     type: Gain
     parameters:
       gain: -6
 
 pipeline:
-  - type: Mixer
-    name: mono
+#  - type: Mixer
+#    name: mono
   - type: Filter
     channel: 0
     names:
@@ -136,6 +144,7 @@ pipeline:
       - peak_4
       - peak_16k
       - peak_5
+      - peak_6
       - gain_to_normal_level
   - type: Filter
     channel: 1
@@ -151,4 +160,5 @@ pipeline:
       - peak_4
       - peak_16k
       - peak_5
+      - peak_6
       - gain_to_normal_level