Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guysoft/MagicMirrorOS

MagicMirrorOS out-of-the-box distro
https://github.com/guysoft/MagicMirrorOS

Last synced: 13 days ago
JSON representation

MagicMirrorOS out-of-the-box distro

Awesome Lists containing this project

README 

        
MagicMirrorOS

=============



An out of the box `Raspberry Pi `_ Raspbian distro that lets you run `MagicMirror `_ to make an interactive mirror.



Where to get it?

----------------



Download directly from `here `_



Variants for arm 32-bit (``armhf`` in image name) and arm 64-bit (``arm64`` in image name) are available.



How to use it?

--------------



#. Use the `Raspberry Pi Imager `_ to install the zipped image to an SD card

#. Use the customization settings of the Raspberry Pi Imager for WiFi, hostname and user settings

#. Boot the Pi from the SD card

#. With the first start the docker images are pulled which takes some time, you can follow this process by executing ``journalctl --user -f``

#. You can change the settings of the MagicMirror in the files located at ``/opt/mm/mounts/``



Docker

------



Under the hood MagicMirrorOS uses `this docker setup `_.



You find the docker setup at ``/opt/mm/`` on your raspberrypi.

For more information about this setup, how you can start/stop the docker container,

how to see the logs , ..., please refer to the documentation provided there.



Requirements

------------

* Raspberrypi all versions should work

* 2A power supply

* Pi 2, 3, 4 & 5. The Raspberry Pi 0/1 is currently not supported.



Features

--------



* Runs `MagicMirror `_ out-of-the-box



Developing

----------



Requirements

~~~~~~~~~~~~



#. Docker or Vagrant, docker recommended

#. Docker Compose Plugin - recommended if using docker build method, instructions assume you have it

#. Downloaded `Raspbian Lite `_ image.

#. Root privileges for chroot

#. Bash

#. sudo (the script itself calls it, running as root without sudo won't work)



Build MagicMirrorOS

~~~~~~~~~~~~~~~~~~~



MagicMirrorOS can be built using docker running either on an intel or RaspberryPi (supported ones listed).

Build requires about 4.5 GB of free space available.



MagicMirrorOS supports building variants, this setup contains 2 variants for the 2 architectures, ``armhf`` and ``arm64``.



You can build it assuming you already have docker and the docker compose plugin installed issuing the following commands::



    variant="armhf"

    git clone https://github.com/guysoft/MagicMirrorOS.git

    cd MagicMirrorOS/src/image

    wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_${variant}_latest'

    cd ..

    sudo docker compose up -d

    sudo docker exec -it magicmirroros-build build $variant



Building Using Vagrant

~~~~~~~~~~~~~~~~~~~~~~

There is a vagrant machine configuration to let build MagicMirrorOS in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.



To use it::



    sudo apt-get install vagrant nfs-kernel-server

    sudo vagrant plugin install vagrant-nfs_guest

    sudo modprobe nfs

    cd MagicMirrorOS/src/vagrant

    sudo vagrant up



After provisioning the machine, its also possible to run a nightly build which updates from devel using::



    cd MagicMirrorOS/src/vagrant

    run_vagrant_build.sh [Variant]



Usage

~~~~~



#. If needed, override existing config settings by creating a new file ``src/config.local``. You can override all settings found in ``src/config``. If you need to override the path to the Raspbian image to use for building MagicMirrorOS, override the path to be used in ``ZIP_IMG``. By default, the most recent file matching ``*-raspbian.zip`` found in ``src/image`` will be used.

#. Run ``src/build_dist`` as root.

#. The final image will be created in ``src/workspace``



Customization

~~~~~



#. If you need to rotate the output



   #. edit the file ``/opt/mm/run/.env`` and add e.g the following line ``XRANDR_PARAMS="--orientation inverted"`` to rotate the output by 180 degrees, or ``XRANDR_PARAMS="--orientation left"`` to rotate the output by 90 degrees, to see all possible options login to the container with ``docker exec -it xserver /bin/bash`` and then you can look at all the options available with ``xrandr --help``.

   #. Restart the docker container by executing ``docker compose up`` in directory ``/opt/mm/run``



#. If you need to change the delay for the xrandr options to be applied, e.g. if the display is rotated when MagicMirror is starting, it can result in a black screen. To avoid this, increase the delay.



   #. edit the file ``/opt/mm/run/.env`` and add e.g the following line ``XRANDR_DELAY=10s`` to apply the xrandr options after 10 seconds, the default value is 5s.

   #. Restart the docker container by executing ``docker compose up`` in directory ``/opt/mm/run``



#. The setup tries to set the timezone automatically, if you need to change your local timezone:



   #. Find your timezone in the "TZ database name" column on `Wikipedia `_

   #. ``nano /opt/mm/run/compose.yaml`` and add::



        environment:

          TZ: 



   #. Restart the docker container by executing ``docker compose up`` in directory ``/opt/mm/run``



Code contribution would be appreciated!