Zynthian Software

From ZynthianWiki
Jump to navigation Jump to search

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)


The latest staging image is available here:

Last Staging ZynthianOS (MD5-sum)


WARNING!!

If you have a new V5 kit, you SHOULD download 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.


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, free software that works on Mac, Windows and Linux, to write the image into the SD-card. You can do it from the terminal too, using dd or pv cli tools. There is a really good manual for this at this link.

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


5 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