Difference between revisions of "Zynthian Software"

 
(94 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Official "Gorgona Omega" SD-Images==
+
== Official ZynthianOS SD-Images ==
  
The easiest way of getting the software is to download the torrent file for the latest ''official'' SD card image from here:
+
You can download the last official ZynthianOS SD-image, based on Raspberry Pi OS, from here:
  
  '''[http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv2-2018-04-03.zip.torrent Download Zynthian "Gorgona Omega" SD-image, configured for Kits v2]'''
+
  '''[https://os.zynthian.org/zynthianos-last-stable.zip Last Stable ZynthianOS]''' ([https://os.zynthian.org/zynthianos-last-stable.zip.md5 MD5-sum])
SHA1: 601ab5e58d3f08b7cda6f5821d396f6622e93106
+
<!--
 +
<br>
  
'''[http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2018-04-03.zip.torrent Download Zynthian "Gorgona Omega" SD-image, configured for Kits v1]'''
+
The latest staging image is available here:
SHA1: 53ce2ba3c055698d27108750c2b80313f904c921
 
  
It's a 8GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3. (Please, keep feeding the torrent after downloading!)
+
'''[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])
 +
<br>
  
These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
+
{{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.}}
 +
-->
 +
<br>
  
After downloading the SD-image, you have to write it to a SDcard. You need a SD card with a minimum size of 16GB, although you can use a bigger one if you want.
+
== Unzipping ==
  
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].
+
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.
  
'''NOTE:''' 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.
+
<!--
 +
== Nightly Build SD-Images ==
  
==Experimental ZynthianOS Aruk SD-Images (Stretch-based)==
+
If you like to be in the cutting edge, test the latest features and find the bugs, try the nightly builds:
  
We are working on the next Zynthian SD-Image, Aruk, based in Raspbian Stretch and built using a the CustomPiOS system. Currently we are quite close to the final release and have a Release Candidate (RC1):
+
'''[https://os.zynthian.org ZynthianOS Nightly Builds]'''
  
[https://os.zynthian.org/2019-04-10-zynthianos-stretch-lite-1.0.0-RC1.zip ZynthianOS "Aruk" RC-1] ([https://os.zynthian.org/2019-04-10-zynthianos-stretch-lite-1.0.0-RC1.zip.md5 MD5-sum])
+
Our nightly build system is based on the fantastic work of @guysoft, the [https://github.com/guysoft/CustomPiOS CustomPiOS] system:
  
and if you like to be in the cutting edge, try the nightly builds:
+
''CustomPiOS is a Raspberry Pi and other ARM devices distribution builder. CustomPiOS opens an already existing image, modifies it and repackages the image ready to ship.''
  
[https://os.zynthian.org ZynthianOS nightly builds]
+
'''@guysoft has largely contributed to the project by configuring and setting up the ZynthianOS build server. Really big thanks!!'''
 +
-->
  
Thanks @guysoft!!
+
== Preparing the SD-card ==
  
== Build your own image ==
+
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!
  
If you like, you can build your own SD image following these instructions:
+
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.
  
[https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
+
<br>
  
Also, you would like to try the new experimental docker-builder:
+
== Configuration instructions ==
  
[https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]
+
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.
  
Thanks @guysoft!!
+
* 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
  
==Problems with Torrent?==
+
<br>
  
In case you have troubles using Torrent, you can download the Gorgona Omega image from these links:
+
== Build your own SD-image ==
  
* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv2-2018-04-03.zip Gorgona Omega, Kit v2]
+
If you like, you can build your own SD image following these instructions:
  
* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2018-04-03.zip Gorgona Omega, Legacy Kit V1]
+
[https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
  
Please, try first with torrent and don't use these "direct download" links unless you really need it:
+
Also, you would like to try the new docker-builder (thanks @guysoft!!):
  
* Zynthian server have limits and if everybody is trying to download the SD images directly from there, it will get overloaded and forum, wiki and other Zynthian services will be slower.
+
[https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]
* Torrent should download faster than direct download links because you are downloading from several sources at once.
 

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