2,705
edits
Changes
Jump to navigation
Jump to search
Line 39:
Line 39: − + Line 45:
Line 45: − + − + − + − + − + Line 76:
Line 76: − + Line 110:
Line 110: − + Line 127:
Line 127: − + Line 136:
Line 136: − + Line 184:
Line 184: − + Line 318:
Line 318: − + Line 324:
Line 324: − + − + − + Line 342:
Line 342: − + − + − + − + Line 358:
Line 358: − + − + Line 378:
Line 378: − + − + Line 389:
Line 389: − + − + − + − + − + − + Line 408:
Line 408: − + − + Line 419:
Line 419: − + Line 425:
Line 425: − + − + Line 435:
Line 435: − + Line 442:
Line 442: − + Line 448:
Line 448: − + Line 456:
Line 456: − + − + − + − + Line 476:
Line 476: − + − +
Building a Zynthian Box using an official Kit v3 (view source)
Revision as of 17:07, 9 September 2020
, 17:07, 9 September 2020→Zynthian Software
+ '''Zynthian Webconf Tool''' ([https://github.com/zynthian/zynthian-webconf github repository])
+ '''Zynthian Webconf Tool''' ([https://github.com/zynthian/zynthian-webconf github repository])
All the software used by Zynthian is Free Software, and it's covered by the GPL license or similar. If you don't know what Free Software is, take a look at this link:
All the software used by Zynthian is Free Software (free as in ''freedom'', not as in ''free beer''), and it's covered by the GPL license or similar. If you don't know what Free Software is, take a look at this link:
[https://www.gnu.org/philosophy/free-sw.en.html What is Free Software?]
[https://www.gnu.org/philosophy/free-sw.en.html What is Free Software?]
The easiest way of getting the software is downloading the last ''official'' SD image from here:
The easiest way of getting the software is downloading the last ''official'' SD image from here:
'''[https://os.zynthian.org/2019-06-26-zynthianos-stretch-lite-1.0.0-RC3.zip Download Zynthian "Aruk RC-3" SD-image]'''
'''[https://os.zynthian.org/zynthianos-last-stable.zip Download Last Stable ZynthianOS SD-image]'''
It's a 16GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3.
It's a 8 GB compressed image file (plenty of soundfonts) 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!
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 your SD card. You need a SD card with a minimum size of 16GB.
After downloading the SD-image, you have to write it to your micro-SD card. You need a '''micro-SD card with a minimum size of 16 GB'''.
If you don't know how to do it, you can use [https://etcher.io/ Etcher] (free software, works on Mac, Windows or Linux) to flash the image onto the SD card. Or do it manually! There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
If you don't know how to do it, you can use [https://etcher.io/ Etcher] (free software, works on Mac, Windows or Linux) to flash the image onto the micro-SD card. Or do it manually! There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
you can also build your own SD image following these instructions:
you can also build your own SD image following these instructions:
===Zynthian Bundle All Kit v3===
===Zynthian Bundle All Kit v3===
A Zynthian Kit is a set of electronic parts. The ''official'' Zynthian Bundle All Kit v3 consists of specific parts:
A Zynthian Kit is a set of electronic and mechanic parts. The ''official'' Zynthian Bundle All Kit v3 consists of these specific parts:
+ '''4 x Controller Modules + Wiring'''
+ '''4 x Controller Modules + Wiring'''
===Prerequisites===
===Prerequisites===
Assembling your Zynthian Kit V3 is not difficult at all: you need is your attention, a screwdriver, and an adjustable wrench. You don't need to solder anything, just put it together and connect the wires.
Assembling your Zynthian Kit V3 is not difficult at all: you need your attention, a screwdriver, and an adjustable wrench. You don't need to solder anything, just put it together and connect the wires.
Read the instructions and observe the detailed photos carefully. If you get in trouble you can ask the community:
Read the instructions and observe the detailed photos carefully. If you get in trouble you can ask the community:
===Secure the MIDI connectors===
===Secure the MIDI connectors===
Insert each MIDI from the outside and secure them with the bolt from the inside.
Insert each MIDI connector, from the outside and secure them with the bolt from the inside.
[[File:IMG_2401.JPG|600px]]
[[File:IMG_2401.JPG|600px]]
Insert the 3 LEDS in the case from the inside, leaving the short lead at left. Make sure you push the LEDs by the plastic around the LED, not the LED itself.
Insert the 3 LEDS in the case from the outside, leaving the short lead at left. Make sure you push the LEDs by the plastic around the LED, not the LED itself.
[[File:IMG2403.JPG|600px]]
[[File:IMG2403.JPG|600px]]
[[File:IMG_2410.JPG|600px]]
[[File:IMG_2410.JPG|600px]]
The zynaptik board has some extra circuitry which doesn't have anything soldered on it. These are used for modifying the board, and it is fully functional as it is.
The zynaptik board has some extra circuitry which doesn't have anything soldered on it. These are used for adding extra functionality to the board.
===Mount the Display===
===Mount the Display===
4. After 5-10 seconds, the zynthian UI will be shown
4. After 5-10 seconds, the zynthian UI will be shown
If you get the Zynthian UI, then you have assembled the Zynthian box correctly.
If you get the Zynthian UI, then you have assembled the Zynthian box correctly. Congratulations!
[[file:IMG_2490.JPG|600px]]
[[file:IMG_2490.JPG|600px]]
If you don't get an error screen or a blank screen, you probably you made a mistake during the assembly. You have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
If you don't get an error screen or a blank screen, you probably you made a mistake during the assembly. You have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
If you are using the Aruk RC-3 SD image (you should!), you will note that the controllers are not working at all. This SD image is pre-configured for working with the kit v2, so you need to configure the software for working with the kit v3. The simplest way of doing it is using the webconf tool:
If you are using the Aruk RC-3 SD image (which you should), you will notice that the controllers are not working at all. This SD image is pre-configured for working with the kit v2, so you need to configure the software for working with the kit v3. The simplest way of doing it is using the webconf tool:
* Connect your zynthian to your local network using an ethernet cable (RJ-45).
* Connect your zynthian to your local network using an ethernet cable (RJ-45).
* From your web browser, access the zynthian's webconf tool by typing "zynthian.local" in the address bar. If this doesn't work for you, you should try with the IP. You can get the IP of your zynthian by navigating to the Admin Menu and clicking "Network Info". You should do that by using the "touch" interface: Click the top bar with a stick (or your nail, if it's not too wide) until you are in the Admin Menu. Once you are there, go down and click "Network Info".
* From your web browser, access the zynthian's webconf tool by typing "zynthian.local" in the address bar. If this doesn't work for you, you should try with the IP. You can get the IP of your zynthian by navigating to the Admin Menu and clicking "Network Info". You should do that by using the touch interface: Click the top bar with a stick (or your nail, if it's not too wide) until you are in the Admin Menu. Once you are there, go down and click "Network Info".
* Type the password (''raspberry'') for login into the webconf tool.
* Type the password (''raspberry'') and log into the webconf tool.
* Once you are logged in, you have to access Hardware->Kit and select "Kit V3".
* Once you are logged in, you have to access Hardware->Kit and select "Kit V3".
* Save the changes and reboot your Zynthian.
* Save the changes and reboot your Zynthian.
[[File:IMG_2496.JPG|600px]]
[[File:IMG_2496.JPG|600px]]
If it doesn't works, try rotating/pushing the 'learn/snapshot' controller. Perhaps you have cross-wired the 3 & 4 controllers and in that case, you have to fix the wiring. If it doesn't work, try pushing the other two controllers and rotating the controllers. If something happens, most probably you have reversed the wiring order when connecting the controllers. Double-check the wiring again.
If it doesn't work, try rotating/pushing the 'learn/snapshot' controller. Perhaps you have cross-wired the 3 & 4 controllers and in that case, you have to fix the wiring. If it doesn't work, try pushing the other two controllers and rotating the controllers. If something happens, most probably you have reversed the wiring when connecting the controllers. Double-check the wiring again.
3. Rotate the SELECT controller to choose the engine you want to instance for the new layer.
3. Rotate the SELECT controller to choose the engine you want to instance for the new layer.
The selector must go down when rotating clockwise and go up when rotating counter-clockwise. If the rotation sense is reversed, you should check the wiring. Perhaps some harness is faulty. The wires color sequence should be: red, black, yellow, green.
The selector must go down when rotating clockwise and go up when rotating counter-clockwise. If the rotation sense is reversed, you should check the wiring. Perhaps one of the connections are faulty. The wires' color sequence should be red, black, yellow, green.
4. Select the ZynAddSubFX engine, select channel #1, bank 'Collection' and preset 'Metal Drips'.
4. Select the ZynAddSubFX engine, select channel #1, select bank 'Collection' and preset 'Metal Drips'.
[[File:IMG_2497.JPG|600px]]
[[File:IMG_2497.JPG|600px]]
You should get into the 'Instrument Control' screen.
You should get to the 'Instrument Control' screen.
[[File:IMG_2500.JPG|600px]]
[[File:IMG_2500.JPG|600px]]
5. Rotate every control to test that it works and that the rotation sense is correct.
5. Rotate every control to test that it works and that the rotation sense is correct.
If some controller doesn't work correctly, check the wiring again. You could try to figure what is happening by analyzing the observed behaviour.
If one of the controllers doesn't work correctly, check the wiring again.
6. Push SELECT to move to the next controller screen. Bold push to select a controller screen from the list.
6. Push SELECT to move to the next controller screen. Bold push (a push lasting about 1 second) to select a controller screen from the list.
7. Push BACK. You should go back to the 'Preset Selection' screen.
7. Push BACK. You should go back to the 'Preset Selection' screen.
[[File:IMG_2506.JPG|600px]]
[[File:IMG_2506.JPG|600px]]
If everything is working OK, then you should read the [[Zynthian_Users_Guide|User's Guide]] and start enjoying your Zynthian Box, but before that ... why not enjoying a little bit? Connect your MIDI keyboard, your speakers and check this out:
If everything is working OK, then you should read the [[Zynthian_Users_Guide|User's Guide]] and start enjoying your Zynthian Box, but before that ... why not enjoy it a little bit? Connect your MIDI keyboard, your speakers and check this out:
Bank 'net-wisdom', Preset 'Vangelis Saw - C'
Bank 'net-wisdom', Preset 'Vangelis Saw - C'
Keep pushing a single note (or a chord) and move the cutoff and resonance controllers. Enjoy! ;-)
Keep pushing a single note (or a chord) and move the cutoff and resonance controllers. Play around a bit and have some fun
===Test the Audio Output===
===Test the Audio Output===
2. Boot your Zynthian. You should be in the initial 'Layer Selection' screen.
2. Boot your Zynthian. You should be in the initial 'Layer Selection' screen.
3. Push BACK and you will get into the 'Admin' screen.
3. Push BACK and you will get into the 'Admin' screen.
4. Select 'Audio Test' option and push 'SELECT'. You should hear the test audio-track: a nice afrocuban stuff ;-)
4. Select 'Audio Test' option and push 'SELECT'. You should hear the test audio-track: a nice afrocuban track
5. Push 'BACK' to stop the playing, and 'BACK' again to return to the "Layer Selection' screen.
5. Push 'BACK' to stop the playing, and 'BACK' again to return to the "Layer Selection' screen.
If you hear nothing, please, check the amplifier, speakers, cabling, gain, volume, etc. If nothing works, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
If you hear nothing, check the amplifier, speakers, cabling, gain, volume, etc. If nothing works, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
===Test the MIDI subsystem===
===Test the MIDI subsystem===
1. Connect the audio output (RCA or Jack connector) to your amplifier or auto-amplified speakers.
1. Connect the audio output (RCA or Jack connector) to your amplifier or auto-amplified speakers.
2. Boot your Zynthian, select FluidSynth engine, channel #1 and 'TimGM6mb' bank. Select some instrument, like "Piano 1".
2. Boot your Zynthian, select FluidSynth engine, channel #1 and 'TimGM6mb' bank. Select an instrument, like "Piano 1".
3. You could add more layers for completing the band ;-)
3. You could add more layers to complete the band
3. Push BACK, holding the switch pushed more than 2 seconds. You should get into the 'Admin' screen.
3. Push BACK, holding the switch down for more than 2 seconds. You should get to the 'Admin' screen.
4. Select 'MIDI Test' option and push 'SELECT'. You should hear the test midi-track ('Take Five') interpreted by your Zynthian's band ;-)
4. Select 'MIDI Test' option and push 'SELECT'. You should hear the test midi-track ('Take Five') interpreted by your Zynthian's band
5. Push 'BACK' to stop the playing
5. Push 'BACK' to stop the playing
1. Connect the audio output (RCA or Jack connector) to your amplifier or auto-amplified speakers.
1. Connect the audio output (RCA or Jack connector) to your amplifier or auto-amplified speakers.
2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and instrument
2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and an instrument
3. Connect a MIDI-USB keyboard to any USB port. The keyboard should be configured to use channel #1.
3. Connect a MIDI-USB keyboard to any USB port. The keyboard should be configured to use channel #1.
3. After 2-3 seconds , play something with your keyboard. A simple ''Chopin's Nocturni'' would be enough. You should hear your music. If you don't like it, probably you should take some piano lessons, same as me ;-)
3. After 2-3 seconds , play something with your keyboard. A simple ''Chopin's Nocturni'' should be enough. You should hear your music. If you don't like it, you should probably take some piano lessons, like me.
If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and instrument.
2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and instrument.
3. Connect your keyboard's MIDI-OUT to the Zynthian's MIDI-IN using a MIDI cable.
3. Connect your keyboard's MIDI-OUT to the Zynthian's MIDI-IN using a MIDI cable.
3. After 2-3 seconds, play something with your keyboard. OK! A single melody can do the task. You should hear your song ;-)
3. After 2-3 seconds, play something with your keyboard. A single melody can do the trick.
If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
=Final steps=
=Final steps=
Once everything is in its place and you have tested that it works, it's time to close the case ...
Once everything is in its place and you have tested that it works, it's time to close the case
===Close the case===
===Close the case===
Take your time to see how to bend and drive the cables to get a good fitting when closing the case. The ribbon bus cable is pre-bended for easing this process.
Take your time to bend and push the cables to get a good fit when closing the case. The ribbon bus cable is pre-bent to make this process easier.
Finally, screw-drive the 8 sheet-threader bolts for securing the case, 4 each side.
Finally, fasten the 8 sheet-threaded bolts to secure the case, 4 on each side.
=Update your Zynthian Box=
=Update your Zynthian Box=
If you are using the official Zynthian SD Image, the first thing you should do after booting up your Zynthian Box and having the controllers working OK is update the software:
If you are using the official Zynthian SD Image, the first thing you should do after booting up your Zynthian Box and making the controllers are working, is update the software:
- connect your Zynthian Box to your router using an ethernet cable
- connect your Zynthian Box to your router using an ethernet cable
- from the admin menu, click '''restart UI''' (or '''reboot''')
- from the admin menu, click '''restart UI''' (or '''reboot''')
The update process can take some time. Be patient. If you get some ERROR message while updating, please, [https://discourse.zynthian.org/t/problems-updating-the-software-from-the-admin-menu/386 ask in the forum]. You can send a photo or description of the error message.
The update process can take some time. Be patient. If you get an error message while updating, please, [https://discourse.zynthian.org/t/problems-updating-the-software-from-the-admin-menu/386 ask in the forum]. You can send a photo or description of the error message.
You can also update the software using the webconf tool, or from the command line.
You can also update the software using the webconf tool, or from the command line.
In this section i will try to give you some tips for locating and solving the problems you may have.
In this section i will try to give you some tips for locating and solving the problems you may have.
For finding and solving problems, i really recommend to connect a HDMI display to the RBPi. It will give you accurate information during the booting sequence. Also, if you connect an USB keyboard, you could login into the system and get extra information, inspect the logs, etc.
For finding and solving problems, I really recommend connecting a HDMI display to the Raspberry Pi. This will show you all information during the boot process. If you connect a USB keyboard to the Pi, you can login into the system and get extra information, inspect the logs, etc.
===The display don't show the zynthian splash screen on boot===
===The display don't show the zynthian splash screen on boot===
In that case, probably the system is not booting correctly. You could try to connect a HDMI display and see if the system is booting. If you can't see the booting sequence, then you should re-burn your SD-card with the Zynthian image. Also, check that your image file is correct by using the SHA1 signature.
In that case, probably the system is not booting correctly. You could try to connect a HDMI display and see if the system is booting. If you can't see the boot sequence, then you should re-flash your SD-card with the Zynthian image. Also check that your image file is correct by using the SHA1 signature.
===You get the zynthian error screen with the IP===
===You get the zynthian error screen with the IP===
Your hardware seems to be incorrectly configured. You should access the webconf tool and configure your hardware.
Your hardware seems to be configured incorrectly. You should access the webconf tool and configure your hardware.
===Your controllers doesn't work===
===Your controllers doesn't work===
You make a mistake while connecting the controllers or your hardware (wiring layout) is incorrectly configured. You should access the webconf tool and configure your hardware.
You made a mistake while connecting the controllers, or your hardware (wiring layout) is incorrectly configured. You should access the webconf tool and configure your hardware.
===You can't solve the problem===
===You can't solve the problem===
https://discourse.zynthian.org
https://discourse.zynthian.org
Also, if you found a solution for a problem not described here, please send feedback to the community, or better, edit this wiki! ;-)
Also, if you found a solution for a problem not described here, please send feedback to the community so others can see how you solved the problem
=Technical Reference=
=Technical Reference=
Finally, i have included here some detailed schemes. People hacking the standard Zynthian design would find it very useful. Also, if you have some problem and need to "debug", you would find it useful too.
Finally, I have included some detailed schematics. People hacking the standard Zynthian design would find it very useful. If you have a problem and need to "debug", you could find it useful too.
[[File:Zynthian_controller_single2_smd.svg|600px]]
[[File:Zynthian_controller_single2_smd.svg|600px]]