Difference between revisions of "Zynthian Software"

Revision as of 12:38, 18 March 2023

1 Official ZynthianOS SD-Images

This is the last official Zynthian SD-Image, based on Raspberry Pi OS:

Last Stable ZynthianOS (MD5-sum)

2 Unzipping

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.

A raspberry Pi desktop instance will unzip and burn the Imager application to write the SSD...

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.

3 Instructions

Note:

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.

For accessing to the webconf tool, see here
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

4 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!

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.

Use 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 this link.

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.

5 Build your own 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: @@
-==New Aruk SD-Images (Stretch-based)==
+== Official ZynthianOS SD-Images ==
-We are working on the next official Zynthian SD-Image, Aruk, based in Raspbian Stretch and built using a the CustomPiOS system (thanks @guysoft!!). Currently we are quite close to the final release and have a second Release Candidate (RC-2):
+This is the last official Zynthian SD-Image, based on Raspberry Pi OS:
-  [https://os.zynthian.org/2019-05-23-zynthianos-stretch-lite-1.0.0-RC2.zip ZynthianOS "Aruk" RC-2] ([https://os.zynthian.org/2019-05-23-zynthianos-stretch-lite-1.0.0-RC2.zip.md5 MD5-sum])
+  '''[https://os.zynthian.org/zynthianos-last-stable.zip Last Stable ZynthianOS]''' ([https://os.zynthian.org/zynthianos-last-stable.zip.md5 MD5-sum])
-and if you really like to be in the cutting edge, try the nightly builds:
+== Unzipping ==
+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.
- [https://os.zynthian.org ZynthianOS nightly builds]
+[[File:Imager.png|thumb]]
+A raspberry Pi desktop instance will unzip and burn 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>
-but, if you do so, please, check in the Jenkins panel that the build is green.
+== Instructions ==
-'''Note:''' There are no torrents for Aruk SD-images yet. When the final release is out, we will prepare the torrent files for faster and more reliable downloading.
+{{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.
-== "Gorgona Omega" SD-Images==
- '''DEPRECATION WARNING!!''' Gorgona Omega is at the very end of its life cycle and it's not longer maintained nor fixed. If you use it, probably you will have problems for updating. I strongly suggest using the new '''Aruk SD-image''' (see below).
-The easiest way of getting the software is to download the torrent file for the latest ''official'' SD card image 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]'''
+* For accessing to the webconf tool, [[Accessing_Zynthian_from_your_computer#Accessing_the_Web_Configuration_Tool|see here]]
- SHA1: 601ab5e58d3f08b7cda6f5821d396f6622e93106
+* 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
+}}
- '''[http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2018-04-03.zip.torrent Download Zynthian "Gorgona Omega" SD-image, configured for Kits v1]'''
+<!--
- SHA1: 53ce2ba3c055698d27108750c2b80313f904c921
+== Nightly Build SD-Images ==
-It's a 8GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3. (Please, keep feeding the torrent after downloading!)
+If you like to be in the cutting edge, test the latest features and find the bugs, try the nightly builds:
-These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
+ '''[https://os.zynthian.org ZynthianOS Nightly Builds]'''
-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.
+Our nightly build system is based on the fantastic work of @guysoft, the [https://github.com/guysoft/CustomPiOS CustomPiOS] system:
-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].
+ ''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.''
-'''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.
+'''@guysoft has largely contributed to the project by configuring and setting up the ZynthianOS build server. Really big thanks!!'''
+-->
-==Build your own image==
+== Preparing the SD-card ==
-If you like, you can build your own SD image following these instructions:
+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!
- [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
+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.
-Also, you would like to try the new experimental docker-builder (thanks @guysoft!!):
+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].
- [https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]
+{{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.}}
-==Problems with Torrent?==
+== Build your own image ==
-In case you have troubles using Torrent, you can download the Gorgona Omega image from these links:
+If you like, you can build your own SD image following these instructions:
-* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv2-2018-04-03.zip Gorgona Omega, Kit v2]
+ [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
-* [http://zynthian.org/download/zynthian_gorgona_omega_rbpi3_kitv1-2018-04-03.zip Gorgona Omega, Legacy Kit V1]
+Also, you would like to try the new docker-builder (thanks @guysoft!!):
-Please, try first with torrent and don't use these "direct download" links unless you really need it:
+ [https://discourse.zynthian.org/t/building-zynthian-image-now-works-with-docker/2499 Building Zynthian with Docker]
-* 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.
-* Torrent should download faster than direct download links because you are downloading from several sources at once.