Difference between revisions of "Zynthian Software"

Latest revision as of 16:38, 11 February 2024

1 Official ZynthianOS SD-Images

You can download the last official ZynthianOS SD-image, based on Raspberry Pi OS, from here:

Last Stable ZynthianOS (MD5-sum)

2 Unzipping

The file you download is a zip file that must be unzipped to get a .img file that can be 'burnt' to the micro-SD card used by the zynthian device (Raspberry Pi). This process differs depending on the operating system you use: windows, mac or linux.

3 Preparing the SD-card

Latest SD-card image weight around 8 GB compressed and around 14 GB unzipped. It includes all the software you need for your zynthian, properly configured for working out-the-box with the latest official kits. Completely ready to use. Plug and play!

After downloading and unzipping the SD-image, you have to write it to a suitable SD-card. You need a good-quality SD-card with a minimum size of 16GB. You can use a bigger one if you like.

You can use Etcher, a free software that works on Mac, Windows and Linux, to write the image into the SD-card. There is a really good manual for this at this link.

If you are a terminal guy, dd or pv will do the task. Don't forget to unmount the SD partition before burning and sync before extracting the card. With root privileges, run something like this:

umount /dev/sdc1
pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
sync

or if you are a sudoer:

sudo umount /dev/sdc1
sudo pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
sudo sync

Note:

RBPi2 is not supported by recent zynthian SD-images. If you want to use a RBPi2, you may need to build your own SD-image.

4 First Boot

First boot could take some time. Don't be impatient and wait until you see the splash screen with the logo. If you have a recent kit (V3, V4 & V5) and the display remains black after 1 minute, please, re-check the instructions above and re-burn the SD-card again. If this still don't work, try with a different SD-card before reporting in the forum. For solving SD-card issues, it could be useful to check the RPi4 status LEDs.

Once you see the splash screen, it could take some minutes until the system is ready. You deserve a beer, or at less some some tea or coffee. When the first-boot process finishes, the zynthian will reboot and you will be in the main menu, ready to play.

5 Configuration instructions

Recent SD-images auto-detect latest official kits V3, V4 & V5. If you are using an older kit or a custom hardware, your first step after booting should be accessing the webconf and configuring your hardware.

For accessing the webconf tool, see here
Once logged-in, go to Hardware -> Kit and select your kit version or "Custom". Click on save button.
Then, if you have a custom hardware configuration, configure each device: Audio, Display, Wiring. Use "Dummies" if you don't use any encoder/switch. Don't forget to save your configuration after each step.
When everything is configured, you can reboot Zynthian using the System -> Reboot menu item

6 Build your own SD-image

If you like, you can build your own SD image following these instructions:

Building the SD Image using the Setup Script

Also, you would like to try the new docker-builder (thanks @guysoft!!):

Building Zynthian with Docker

@@ Line 1: / Line 1: @@
 == Official ZynthianOS SD-Images ==
-This is the last official Zynthian SD-Image, based on Raspberry Pi OS:
+You can download the last official ZynthianOS SD-image, based on Raspberry Pi OS, from here:
   '''[https://os.zynthian.org/zynthianos-last-stable.zip Last Stable ZynthianOS]''' ([https://os.zynthian.org/zynthianos-last-stable.zip.md5 MD5-sum])
+<!--
+<br>
-== Unzipping ==
+The latest staging image is available here:
-You will need to unzip this file to provide an .img file that can be 'burnt' to an SSD disk that is bootable in the zynthian machine.
-This process differs depending on the Operating system you use for Internet access.
-[[File:Imager.png|thumb]]
+ '''[https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip Last Staging ZynthianOS]''' ([https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip.md5 MD5-sum])
-A raspberry Pi desktop instance will unzip from the file manager and provides the Imager application to write the SSD...
-[[File:Usbssdwriter.jpg|thumb]]
-You will require a SSD Writer, but this task can be completed with only the raspberry Pi you are using for the zynthian with a little ssd disk swapping.
 <br>
-== Instructions ==
+{{WarningBox|If you have a new V5 kit, you SHOULD download [https://os.zynthian.org/2023-07-12-zynthianos-staging-2307.zip the staging image]. The last stable SD-image has some issues configuring the V5 hardware. We are working to release a new stable image as soon as possible.}}
+-->
-{{NoteBox|This SD-image is pre-configured for '''official kits v4 & v3'''. If you are using a different hardware, your first step should be accessing the webconf and configuring your hardware.
+<br>
+== Unzipping ==
-* For accessing to the webconf tool, [[Accessing_Zynthian_from_your_computer#Accessing_the_Web_Configuration_Tool|see here]]
+The file you download is a zip file that must be unzipped to get a ''.img'' file that can be 'burnt' to the micro-SD card used by the zynthian device (Raspberry Pi). This process differs depending on the operating system you use: windows, mac or linux.
-* Once logged in go to Hardware -> Kit and select "Custom" then click on save button
-* Then, stil in the Hardware menu, configure each device: Audio, Display, Wiring (use "Dummies" if you do not use any encoder/switch). Don't forget to save your configuration after each step.
-* When everything is configured, you can reboot Zynthian using the System -> Reboot menu item
-}}
 <!--
@@ Line 44: / Line 36: @@
 == Preparing the SD-card ==
-Current images are 8 GB compressed image file compiled for Raspberry Pi 3. These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
+Latest SD-card image weight around 8 GB compressed and around 14 GB unzipped. It includes all the software you need for your zynthian, properly configured for working out-the-box with the latest official kits. Completely ready to use. Plug and play!
+After downloading and unzipping the SD-image, you have to write it to a suitable SD-card. You need a good-quality SD-card with a '''minimum size of 16GB'''. You can use a bigger one if you like.
+You can use [https://etcher.io/ Etcher], a free software that works on Mac, Windows and Linux, to write the image into the SD-card. There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
+If you are a terminal guy, ''dd'' or ''pv'' will do the task. Don't forget to ''unmount'' the SD partition before burning and ''sync'' before extracting the card. With root privileges, run something like this:
+ umount /dev/sdc1
+ pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
+ sync
+or if you are a ''sudoer'':
+ sudo umount /dev/sdc1
+ sudo pv 2023-08-25-zynthianos-stable-2308.img > /dev/sdc
+ sudo sync
+{{NoteBox|RBPi2 is not supported by recent zynthian SD-images. If you want to use a RBPi2, you may need to build your own SD-image.}}
+<br>
+== First Boot ==
+First boot could take some time. Don't be impatient and wait until you see the splash screen with the logo. If you have a recent kit (V3, V4 & V5) and the display remains black after 1 minute, please, re-check the instructions above and re-burn the SD-card again. If this still don't work, try with a different SD-card before reporting in the [https://discourse.zynthian.org forum]. For solving SD-card issues, it could be useful to [https://raspberrytips.com/green-and-red-light-on-raspberry-pi check the RPi4 status LEDs].
+Once you see the splash screen, it could take some minutes until the system is ready. You deserve a beer, or at less some some tea or coffee. When the first-boot process finishes, the zynthian will reboot and you will be in the main menu, ready to play.
+<br>
-After downloading the SD-image, you have to write it to a SD-card. You need a SD card with a '''minimum size of 16GB''', although you can use a bigger one if you want.
+== Configuration instructions ==
-Use [https://etcher.io/ Etcher] (free software works on Mac, Windows or Linux) to write the image onto the SDcard. Or do it manually! There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
+Recent SD-images auto-detect latest official kits V3, V4 & V5. If you are using an older kit or a custom hardware, your first step after booting should be accessing the webconf and configuring your hardware.
-{{NoteBox|RBPi2 is not currently supported by the latest official zynthian SD images, so if you want to use a RBPi2, you may need to build your own SD image.}}
+* For accessing the webconf tool, [[Accessing_Zynthian_from_your_computer#Accessing_the_Web_Configuration_Tool|see here]]
+* Once logged-in, go to Hardware -> Kit and select your kit version or "Custom". Click on save button.
+* Then, if you have a custom hardware configuration, configure each device: Audio, Display, Wiring. Use "Dummies" if you don't use any encoder/switch. Don't forget to save your configuration after each step.
+* When everything is configured, you can reboot Zynthian using the System -> Reboot menu item
+<br>
-== Build your own image ==
+== Build your own SD-image ==
 If you like, you can build your own SD image following these instructions: