Changes

Jump to navigation Jump to search

Building a Zynthian Box using an official Kit v2 (view source)

Revision as of 15:09, 17 November 2019

2,909 bytes added ,  15:09, 17 November 2019
→‎Connecting everything
Line 9: Line 9:     
[[File:IMG_2287.JPG|600px]]
 
[[File:IMG_2287.JPG|600px]]
−
[[File:IMG_1459.JPG|600px]]
     −
Anyway, the instructions are quite detailed and can be used as inspiration for building a custom Zynthian Box from scratch. Of course, you will have to be creative if you want to do it in that way ;-)
+
Anyway, the instructions are quite detailed and can be used as inspiration for building a custom Zynthian Box from scratch. Of course, you will have to be creative if you want to do it in such a way ;-)
 +
 
 +
[[File:IMG_2280.JPG|600px]]
    
=Bill of Materials=
 
=Bill of Materials=
Line 32: Line 33:  
The Zynthian Software stack consist of:
 
The Zynthian Software stack consist of:
   −
  + '''GNU Linux Operating System:''' Raspbian Jessie (Minibian is used in the last SD images)
+
  + '''GNU Linux Operating System:''' Raspbian Jessie (Minibian is used in the most recent SD images)
 
  + '''Jack Audio Daemon'''
 
  + '''Jack Audio Daemon'''
 
  + '''MOD-HOST + MOD-UI''' software, from [http://moddevices.com ModDevices] ([https://github.com/moddevices github repositories])
 
  + '''MOD-HOST + MOD-UI''' software, from [http://moddevices.com ModDevices] ([https://github.com/moddevices github repositories])
Line 44: Line 45:  
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:
   −
  '''[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/2019-06-26-zynthianos-stretch-lite-1.0.0-RC3.zip Download Zynthian "Aruk RC-3" SD-image]'''
    
It's a 8GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3. (Please, keep feeding the torrent after downloading!)
 
It's a 8GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3. (Please, keep feeding the torrent after downloading!)
Line 64: Line 65:  
This is a sketch with the main blocks of the ''official'' Zynthian Box:
 
This is a sketch with the main blocks of the ''official'' Zynthian Box:
   −
[[File:Zynthian_hardware_scheme.png|600px]]
+
[[File:Zynthian_hardware_scheme.png|800px]]
    
In the project's repositories you will find all the electric schemes, PCB specifications, Herber files, etc. to build your own Zynthian Box from scratch:
 
In the project's repositories you will find all the electric schemes, PCB specifications, Herber files, etc. to build your own Zynthian Box from scratch:
Line 267: Line 268:  
===Building the MIDI-IN/OUT/THRU connectors===
 
===Building the MIDI-IN/OUT/THRU connectors===
   −
Before mounting the MIDI-IN/OUT/THRU connectors into the case we will solder the needed wires. Doing it in that way is rather more comfortable than trying to solder inside the case with all the wiring mess.
+
Before mounting the MIDI-IN/OUT/THRU connectors into the case we will solder the needed wires that allow connecting it to the All-In-One circuit using a JST connector. Doing it in that way is rather more comfortable than trying to solder inside the case with all the wiring mess.
   −
If you want, you can protect the contacts using heat-shrink sleeve (the red sleeve pieces in the photo). In that case, remember to insert the sleeve pieces before soldering ;-)
+
[[File:IMG_4777.JPG|600px]]
   −
[[File:IMG_4777.JPG|600px]]
+
'''JST Connector wires'''[[File:Midiconnfront.jpg|340px|right]]
 +
 
 +
* JST White (1) => LED's Anode (LED's red wire/long lead)
 +
* JST Yellow (2) => LED's Cathode (LED's black wire/short lead)
 +
* JST Black (3) => pin 5 of MIDI connector
 +
* JST Red (4) => pin 4 of MIDI connector
 +
 
 +
If you want (i strongly recommend you do it!), you can protect the contacts using heat-shrink sleeve (the red sleeve pieces in the photo). In that case, remember to insert the sleeve pieces before soldering ;-)
    
[[File:IMG_1276.JPG|600px]]
 
[[File:IMG_1276.JPG|600px]]
Line 342: Line 350:  
When it's done, you have to solder the 2 LED wires (red/black) with the 2 spare wires on the MIDI JST harness (white/yellow). Polarity is important, so don't cross the wires:
 
When it's done, you have to solder the 2 LED wires (red/black) with the 2 spare wires on the MIDI JST harness (white/yellow). Polarity is important, so don't cross the wires:
   −
  * LED's red wire => JST's white wire
+
  * JST White wire (1) => LED's Anode (LED's red wire/long lead)
−
  * LED's black wire => JST's yellow wire
+
  * JST Yellow wire (2) => LED's Cathode (LED's black wire/short lead)
    
After soldering all the 3 LEDs, you may want to protect the connection with heat shrink sleeve, adhesive tape or hot melt glue.
 
After soldering all the 3 LEDs, you may want to protect the connection with heat shrink sleeve, adhesive tape or hot melt glue.
Line 384: Line 392:  
The new Zynthian Kit 2 is designed to use JST connectors, so connecting everything is really straight-forward:
 
The new Zynthian Kit 2 is designed to use JST connectors, so connecting everything is really straight-forward:
   −
* Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the All-In-One module
+
===Connect the Ribbon Bus cable===
 +
 
 +
Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the All-In-One module
    
[[File:IMG_4741.JPG|600px]]
 
[[File:IMG_4741.JPG|600px]]
Line 390: Line 400:  
[[File:IMG_1474.JPG|600px]]
 
[[File:IMG_1474.JPG|600px]]
   −
* Connect the 4 double JST cables to the 4 controller connectors on the All-In-One module (CTRL1, CTRL2, CTRL3, CTRL4)
+
===Connect the controllers (1)===
 +
 
 +
Connect the 4 double JST cables to the 4 controller connectors on the All-In-One module (CTRL1, CTRL2, CTRL3, CTRL4)
    
[[File:IMG_4744.JPG|600px]]
 
[[File:IMG_4744.JPG|600px]]
Line 396: Line 408:  
[[File:IMG_1479.JPG|600px]]
 
[[File:IMG_1479.JPG|600px]]
   −
* Connect the 2 JST cables from the MIDI connectors to the MIDI-IN and the MIDI-OUT/THRU connectors on the All-In-One module. Note that currently only 2 connectors are available in the official aluminum case, so you have to choose what do you prefer: MIDI-OUT or MIDI-THRU ;-)
+
===Connect the MIDI connectors & activity LEDs===
 +
 
 +
Connect the 2 JST cables from the MIDI connectors to the MIDI-IN and the MIDI-OUT/THRU connectors on the All-In-One module. Note that currently only 2 connectors are available in the official aluminum case, so you have to choose what do you prefer: MIDI-OUT or MIDI-THRU ;-)
    
[[File:IMG_1465.JPG|600px]]
 
[[File:IMG_1465.JPG|600px]]
Line 404: Line 418:  
[[File:IMG_1409.JPG|600px]]
 
[[File:IMG_1409.JPG|600px]]
   −
* Connect the 4 x Controller Modules following the right numbering: from top to bottom and from left to right.
+
===Connect the controllers (2)===
 +
 
 +
Connect the 4 x Controller Modules following the right numbering: from top to bottom and from left to right.
    
[[File:zynthian_controllers.png|600px]]
 
[[File:zynthian_controllers.png|600px]]
Line 410: Line 426:  
[[File:IMG_1412.JPG|600px]]
 
[[File:IMG_1412.JPG|600px]]
   −
* Connect the Jack connector to the auxiliar audio-out connector on the HifiBerry soundcard. It's the 3-pin JST connector that you soldered before:
+
===Connect the Audio Jack connectors===
 +
 
 +
Connect the Jack connector to the auxiliar audio-out connector on the HifiBerry soundcard. It's the 3-pin JST connector that you soldered before:
    
[[File:IMG_1489.JPG|600px]]
 
[[File:IMG_1489.JPG|600px]]
 +
 +
{{NoteBox|At this point, if you have a v2+ kit (HifiBerry DAc+ADC soundcard with audio input), you should take a look to the [http://wiki.zynthian.org/index.php/Building_a_Zynthian_Box_using_an_official_Kit_v3#Connect_the_Audio_Jack_connectors v3 kit instructions].}}
    
===Connect the Display===
 
===Connect the Display===
Line 427: Line 447:     
It's easy to make a mistake while assembling the parts or connecting the wires. Some errors can be dangerous for the electronic components (short-circuits, some specific bad-wiring combinations) so it's better to be sure that everything is correctly assembled and connected.
 
It's easy to make a mistake while assembling the parts or connecting the wires. Some errors can be dangerous for the electronic components (short-circuits, some specific bad-wiring combinations) so it's better to be sure that everything is correctly assembled and connected.
 +
 +
Put special attention to ribbon bus connection and verify that red wire is on pin 1 for every connector. Also put attention to audio jack connectors and check that they are correctly connected to the Hifiberry soundcard.
    
===First Boot===
 
===First Boot===
   −
When you are pretty sure that everything is in its place, it's time to boot by first time, so:
+
When you are sure that everything is in its place, it's time to boot the machine, so:
   −
  1. Insert the SD-card with the zynthian image ready to run. If you don't have one yet, [[#Zynthian_Software|read this]].
+
  1. Insert the SD-card with the zynthian image ready to run. If you don't have one yet, [[#Zynthian_Software|read this]]. You can insert the SD-card through the "window" on the bottom-side of the case. Also, if the case is still open, you can do it from the top.
−
  2. Plug the mini-usb power conector. A good 5V micro-usb charger is recommended (> 2 Amp).
+
  2. Plug the mini-usb power connector. A good 5V micro-usb charger is recommended (> 2 Amp).
   −
If you are using a SD image pre-configured for the Zynthian Kits v2, these are the stages that you should see while booting:
+
These are the stages that you should see while booting:
   −
  1. Initially, the display must go white
+
  1. After 5-10 seconds, it will show the Zynthian splash screen
−
2. After 5-10 seconds, it will show the Zynthian splash screen
+
  2. After 3-4 seconds, it will go black
−
  3. After 1-2 seconds, it will go black
+
  3. If you are using a fresh zynthian image and it's the first boot, the stages 1 and 2 will be repeated
−
  4. If you are using a fresh zynthian image and it's the first boot, the stages 2 and 3 will be repeated
+
  4. After 5-10 seconds, the zynthian UI will be shown
−
  5. After 5-10 seconds, the zynthian UI will be shown
      
If you get the Zynthian UI, congratulations!!! You are really close to get it!!
 
If you get the Zynthian UI, congratulations!!! You are really close to get it!!
   −
[[file:IMG_1562.JPG|600px]]
+
[[file:IMG_2490.JPG|600px]]
 +
 
 +
If you don't get an error screen or a blank screen, bad luck! Probably you made some mistake during the mounting process. 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 are lucky because this SD image is pre-configured for working with the kit v2. If not, perhaps you need to configure the software for working with the kit v2. The simplest way of doing it is using the webconf tool:
   −
If not, bad luck! Probably you made some mistake during the mounting process. You have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].
+
* 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".
 +
* Type the password (''raspberry'') for login into the webconf tool.
 +
* Once you are logged in, you have to access Hardware->Kit and select "Kit V2".
 +
* Save the changes and reboot your Zynthian.
   −
If you are using an older SD image that is not pre-configure for the Kit v2, then you should configure your Zynthian Box's hardware using the [[Configuration_Users_Guide|webconf tool]]. These are the adjustments you have to do:
+
If you are using a really old SD image (you shouldn't!) that is not pre-configure for the Kit v2, then you have to specify every part of your hardware configuration. These are the adjustments you have to set:
    
* '''Display:''' PiScreen 3.5 (v2)
 
* '''Display:''' PiScreen 3.5 (v2)
−
* '''Audio:''' HifiBerry DAC+
+
* '''Audio:''' HifiBerry DAC+ / HifiBerry DAC+ADC
−
* '''Wiring:''' MCP23017_ENCODERS
+
* '''Wiring:''' MCP23017_EXTRA
 
* '''Style:''' FontSize = 14
 
* '''Style:''' FontSize = 14
   −
===Test the Controllers===
+
===Test the Controllers & UI===
 +
 
 +
If you get into the Zynthian UI, then you should be in the 'Layer list' screen. Let's start testing that your controllers are working OK.
 +
 
 +
1. Rotate the SELECT controller up & down for selecting the different options in the Layers menu.
 +
 
 +
2. Push SELECT to create a New 'Synth Layer'. You should get into the 'Engine Selection' screen.
 +
 
 +
[[File:IMG_2496.JPG|600px]]
   −
If you get into the Zynthian UI, then you should be in the 'Layer Selection' screen. Let's start testing that your controllers are working OK.  
+
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.
   −
  1. Push 'select' to create a new layer. You should get into the 'Engine Selection' screen.  
+
  3. Rotate the SELECT controller to choose the engine you want to instance for the new layer.  
   −
[[File:IMG_1563.JPG|600px]]
+
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.
   −
If it doesn't works, try pushing the '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.
+
4. Select the ZynAddSubFX engine, select channel #1, bank 'Collection' and preset 'Metal Drips'.  
   −
2. Rotate the 'SELECT' controller to select the engine you want to start for the new layer.  
+
[[File:IMG_2497.JPG|600px]]
   −
The selector must go down when rotating clockwise and go up when rotating counterclockwise. If the rotation sense is reversed, you should check the wiring.
+
You should get into the 'Instrument Control' screen.
   −
3. Select the ZynAddSubFX engine, select channel #1, bank and preset. You should get into the 'Instrument Control' screen.
+
[[File:IMG_2500.JPG|600px]]
   −
[[File:IMG_1568.JPG|600px]]
+
5. Rotate every control to test that it works and that the rotation sense is correct.  
   −
4. 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 some controller doesn't work correctly, check the wiring again. You could try to figure what is happening by analizing the observed behaviour.
+
6. Push SELECT to move to the next controller screen. Bold push to select a controller screen from the list.
   −
  5. Push 'BACK'. You should go back to the 'Preset Selection' screen.  
+
  7. Push BACK. You should go back to the 'Preset Selection' screen.  
   −
6. Push 'Layer' again to return to the 'Layer Selection' screen. Try to create another layer following the same procedure.
+
[[File:IMG_2499.JPG|600px]]
   −
[[File:IMG_1584.JPG|600px]]
+
8. Push BACK again. You should go back to the 'Bank Selection' screen.  
   −
7. From the "Instrument Control" screen, push 'Snapshot' to get into the 'Load Snapshot' screen. Push 'Snapshot' again to 'Save Snapshot'. Push 'BACK' to return to the 'Instrument Control' screen.
+
[[File:IMG_2498.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 ...
+
9. Push LAYER again to return to the 'Layer Selection' screen. Try to create another layer following the same procedure.
 +
 
 +
[[File:IMG_2509.JPG|600px]]
 +
 
 +
10. Push 'SNAPSHOT' to get into the 'Snapshot' screen. Select 'New Snapshot' and your first snapshot will be stored.
 +
 
 +
[[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:
 +
 
 +
Bank 'net-wisdom', Preset 'Vangelis Saw - C'
 +
 
 +
Keep pushing a single note (or a chord) and move the cutoff and resonance controllers. Enjoy! ;-)
    
===Test the Audio Output===
 
===Test the Audio Output===
Line 501: Line 550:     
  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 'FluidR3 GM' bank. Select some instrument.
+
  2. Boot your Zynthian, select FluidSynth engine, channel #1 and 'TimGM6mb' bank. Select some instrument, like "Piano 1".
 
  3. You could add more layers for completing the band ;-)
 
  3. You could add more layers for completing 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 pushed more than 2 seconds. You should get into the 'Admin' screen.
Line 521: Line 570:     
  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 instrument.
−
  3. Connect your keyboard's MIDI-OUT to the Zynthian's MIDI-IN using a MIDI cable. The keyboard should be configured to use channel #1.
+
  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. OK! A single melody can do the task. You should hear your song ;-)
   Line 534: Line 583:     
Take your time to see how to bend and drive the cables to get a good fitting when closing the case.
 
Take your time to see how to bend and drive the cables to get a good fitting when closing the case.
 +
    
[[File:IMG_1626.JPG|600px]]
 
[[File:IMG_1626.JPG|600px]]
   −
[[File:IMG_1617.JPG|600px]]
      
Finally, screw-drive the 8 sheet-threader bolts for securing the case, 4 each side.
 
Finally, screw-drive the 8 sheet-threader bolts for securing the case, 4 each side.
 +
 +
 +
[[File:IMG_2287.JPG|600px]]
 +
    
=Update your Zynthian Box=
 
=Update your Zynthian Box=
Line 545: Line 598:  
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 having the controllers working OK is update the software:
   −
  - connect the Zynthian Box to your router using a RJ45 cable
+
  - connect your Zynthian Box to your router using an ethernet cable
−
  - '''update zynthian software''' from the admin menu
+
  - from the admin menu, click '''update software'''
−
  - '''update zynthian library''' from the admin menu
+
  - from the admin menu, click '''restart UI''' (or '''reboot''')
−
- '''restart GUI''' (or '''reboot''') from the admin menu
      
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 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.
 +
 +
You can also update the software using the webconf tool, or from the command line.
    
=Locating and Solving problems=
 
=Locating and Solving problems=
Line 556: Line 610:  
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 a USB keyboard, you can login into the system and get extra information, inspect the logs, etc.
+
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.
 +
 
 +
===The display don't show the zynthian splash screen on boot===
   −
===The display don't go white in the boot stage 1===
+
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.
   −
I recommend you disconnect the controller and 2in1 modules and try to boot again.
+
===You get the zynthian error screen with the IP===
−
If the problem persist it's very probable you haven't solder correctly the side 26-pin connector. You should double check the connector and be sure that it's correctly soldered.
     −
===The display don't show the zynthian splash screen in the boot stage 2===
+
Your hardware seems to be incorrectly configured. You should access the webconf tool and configure your hardware.
   −
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.
+
===Your controllers doesn't work===
   −
'''More coming soon ...'''
+
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 can't solve the problem===
 
===You can't solve the problem===
Line 573: Line 628:  
If you can't find a solution for your problem, ask the community:
 
If you can't find a solution for your problem, ask the community:
   −
  https://discourse.zynthian.com
+
  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, or better, edit this wiki! ;-)
Line 583: Line 638:  
You can find all this info and much more in the project's [https://github.com/zynthian/zynthian-hw Hardware Repository].
 
You can find all this info and much more in the project's [https://github.com/zynthian/zynthian-hw Hardware Repository].
   −
===Electrical Schematic===
+
=== All-In-One Schematic===
    
This is the electrical scheme of the All-In-One circuit:
 
This is the electrical scheme of the All-In-One circuit:
Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/2695...10592"

Navigation menu