Difference between revisions of "Zynthian Software"

From ZynthianWiki
Jump to navigation Jump to search
Line 8: Line 8:
 
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 normally use: windows, mac or linux.
 
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 normally use: windows, mac or linux.
 
<br>
 
<br>
 
== Instructions ==
 
 
The latest SD-image auto-detects latest official kits V3, V4 & V5. If you are using a different/custom hardware, your first step after booting should be accessing the webconf and configuring your hardware.
 
 
* 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
 
  
 
<!--
 
<!--
Line 41: Line 32:
  
 
{{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.}}
 
{{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.}}
 +
 +
== Configuration instructions ==
 +
 +
Latest SD-image auto-detects latest official kits V3, V4 & V5. If you are using a different/custom hardware, your first step after booting should be accessing the webconf and configuring your hardware.
 +
 +
* 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
  
 
== Build your own image ==  
 
== Build your own image ==  

Revision as of 18:33, 22 June 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

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

Use Etcher (free software works on Mac, Windows or Linux) to write the image into the SD-card, 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.

4 Configuration instructions

Latest SD-image auto-detects latest official kits V3, V4 & V5. If you are using a different/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 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