Skip to content

Commit

Permalink
a few more typos and wordings (MiczFlor#1952)
Browse files Browse the repository at this point in the history
* typos

* GPIOs listed as unsupported

is this still true? i used gpio on future3 and it seems fine. if its obsolete then merge.

* typos and wording

* typos, wording

* info about tail -f on installlog

* added info about monitoring install log

* tail -f INSTALL-log,with proper formating

* wording

* wording
  • Loading branch information
kugelzucker authored and c0un7-z3r0 committed Apr 30, 2023
1 parent 6fdbf43 commit 9a0fcd3
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 22 deletions.
16 changes: 8 additions & 8 deletions docs/sphinx/featurelist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Feature Status
**This is where we are in a nutshell:** Playing music from local folders via RFID trigger.
We also built a new WebUI to control the Jukebox from a browser.

The are a few things that are specifically not integrated yet: GPIOs, playing streams, podcasts or Spotify.
The are a few things that are specifically not integrated yet: playing streams, podcasts or Spotify.

In the following is the currently implemented feature list in more detail. It also shows some of the holes.
In the following is the currently implemented feature list in more detail. It also shows some of the shortcomings.
However the list is *not complete in terms of planned features*,
but probably **reflects more of where work is currently being put into**.

Expand Down Expand Up @@ -103,10 +103,10 @@ ZMQ Publisher

* |[X]| Last Value Cache
* |[X]| Subscriber detection and initial status update
* |[X]| Port configuration option (WS und/oder TCP)
* |[X]| Port configuration option (WS and/or TCP)
* |[ ]| Callback registration option for plugin on topic send

* How to interact with threading?
* How to interact with threads?

Playback
^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -206,11 +206,11 @@ Timer
* Needs to be cancelable

* |[X]| Publish mechanism of timer status
* |[X]| Change multitimer function call interface such that Endless timer etc do not pass the `iteration` kwarg
* |[X]| Change multitimer function call interface such that endless timer etc wont pass the `iteration` kwarg
* |[ ]| Make timer settings persistent
* |[ ]| Idle timer

* This needs clearer specification: Idle is when no music is playing and no user interaction si taking place
* This needs clearer specification: Idle is when no music is playing and no user interaction is taking place
* i.e. needs information from RPC AND from player status. Let's do this when we see a little clearer about Spotify


Expand Down Expand Up @@ -254,7 +254,7 @@ Others
Start-up stuff
^^^^^^^^^^^^^^^^^

* |[X]| check music folder rights
* |[X]| check music folder permissions
* |[X]| mpc update / (mpc rescan)
* |[X]| sudo iwconfig wlan0 power off (need to be done after every restart)
* |[X]| Optional power down HDMI circuits: /usr/bin/tvservice -o
Expand All @@ -277,7 +277,7 @@ WebUI

* |[X]| Playback Control
* |[X]| Cover Art
* |[X]| Register cards / Delete Card
* |[X]| Register cards / Delete cards
* |[X]| Shutdown button
* |[ ]| Settings configuration page
* |[ ]| System information page
Expand Down
22 changes: 16 additions & 6 deletions docs/sphinx/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@ Install Raspberry Pi OS Lite
-------------------------------------------

.. important:: Currently, the installation does only work on Raspberry Pi's with ARMv7 and ARMv8 architecture, so 2, 3 and 4!
1 and Zero's are currently unstable and will require a bit more work!
Pi 1 and Zero's are currently unstable and will require a bit more work!

Before you can install the Phoniebox software, you need to prepare your Raspberry Pi.

1. Connect a Micro SD card to your computer (preferable an SC card with high read throughput)
1. Connect a Micro SD card to your computer (preferable an SD card with high read throughput)
2. `Download <https://www.raspberrypi.org/software/>`_
the `Raspberry Pi Imager <https://www.raspberrypi.org/blog/raspberry-pi-imager-imaging-utility/>`_ and open it
3. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system (only the 32 bit version is supported)
3. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system (only the 32 bit version is supported) (you can use the settings menu of the Raspberry Pi Imager to configure SSH and WiFi in a more userfriendly way, or do it manually as described in the next step)
4. Select your Micro SD card (your card will be formatted)
5. Click *Write*
5. Click *Write*
6. Wait for the imaging process to be finished (it'll take a few minutes)


Initial Boot
Pre-boot preparation
-------------------------------------------

You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to proceed with the next steps.

1. Open a terminal of your choice.
2. Insert your card again if it has been ejected automatically.
3. Navigate to your SC card e.g., ``cd /Volumes/boot`` for Mac or ``D:`` for Windows.
3. Navigate to your SD card e.g., ``cd /Volumes/boot`` for Mac or ``D:`` for Windows.
4. Enable SSH by adding a simple file.

.. code-block:: bash
Expand Down Expand Up @@ -81,8 +81,18 @@ specify the variables like this:
cd; GIT_USER='MiczFlor' GIT_BRANCH='future3/develop' bash <(wget -qO- https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/future3/develop/installation/install-jukebox.sh)
This will switch directly to the specified feature branch during installation.

.. attention:: For all branches *except* the current Release, you will need to build the Web App locally on the Pi.
This is not part of the installation process due to memory limitation issues.
See :ref:`developer/development_environment:Steps to install`.



If you suspect an error you can monitor the installation-process with

.. code-block:: bash
cd; tail -f INSTALL-<fullname>.log
2 changes: 1 addition & 1 deletion docs/sphinx/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ browser for now.

Configuration
--------------
In ``jukebox.yaml`` (and all other config files): do not use paths with ``~/some/dir``.
In ``jukebox.yaml`` (and all other config files): do not use relative paths with ``~/some/dir``.
Always use entire explicit path, e.g. ``/home/pi/some/dir``.

**Sole** exception is in playermpd.mpd_conf.
2 changes: 1 addition & 1 deletion docs/sphinx/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There are a number of significant changes to the overall system setup, which req
Updating your Jukebox Version 3
-------------------------------------

Things on Version 3 are moving fast and you may want to get stay on the edge. Since we are in Alpha Release stage,
Things on Version 3 are moving fast and you may want to keep up with recent changes. Since we are in Alpha Release stage,
a fair number of fixes are expected to be committed in the near future.

You will need to do three things to update your version from develop (or the next release candidate version)
Expand Down
12 changes: 6 additions & 6 deletions docs/sphinx/primer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ project check out the `documentation of Version 2 <https://github.com/MiczFlor/R
Why?
-----

* Better extensibility, clear architecture allowing easier integration of new feature
* Higher performance especially on lower end hardware (it's a stetch at the moment)
* Better extensibility, clear architecture allowing for easier integration of new features
* Higher performance especially on lower end hardware (it's a stretch at the moment)
* Better maintainability
* Better observability for debugging

Expand All @@ -23,17 +23,17 @@ How?
* Jukebox core is a holistic Python3-only application
* Avoid shell script invocation during runtime wherever possible
* Establish a socket based API (using ZeroMQ) toward the WebUI or other clients
* Implemented a Remote-Procedure-Call (RPC) server through which all user function call pass
* Implemented a Remote-Procedure-Call (RPC) server through which all user function calls pass
* Implemented a plugin concept to dynamically load Python modules configurable through the configuration file
* In conjunction with the RPC, this is a neat way of allowing additional feature without having to touch the core all the time
* In conjunction with the RPC, this is a neat way of allowing additional features without having to touch the core all the time

Where are we? Help wanted!
--------------------------

The initial proof-of-concept phase has been left behind and there is quite some functionality available already.
This is still heavily in progress but the WebUI and RFID-triggered playback of local files work.
This is still an ongoing process but the WebUI and RFID-triggered playback of local files work.

Features/files from version 2.X will only be copied/merged when they can be integrated and tested.
Features/files from version 2.X will only be copied/merged once they can be integrated and tested.
If you don't find your v2.X contributions, it doesn't mean they are obsolete. Things will be integrated step by step.
And, of course, you are welcome to adapt your previous contributions to this new exiting structure.

0 comments on commit 9a0fcd3

Please sign in to comment.