Changes

Jump to navigation Jump to search
Line 4: Line 4:  
This tutorial is mainly intended for those who are building a Zynthian Box using one of the ''official'' kits, that i offer here:
 
This tutorial is mainly intended for those who are building a Zynthian Box using one of the ''official'' kits, that i offer here:
   −
  [https://discourse.zynthian.org/t/zynthian-kits/150/17 Getting a Zynthian Kit]
+
  [http://shop.zynthian.org Zynthian Shop]
   −
Specifically, the instructions are for the assembly of kits v2 (version 2), those using the All-In-One circuit and the PiScreen 3.5' display. If you have a older kit v1, based in the 2in1 circuit and the PiTFT 2.8' display, you better should read [[Building a Zynthian Box using an official Kit | this tutorial]].
+
Specifically, the instructions are for the assembly of kits v2 (version 2), those using the All-In-One circuit and the PiScreen 3.5' display. If you have an older kit v1, based in the 2in1 circuit and the PiTFT 2.8' display, you better should read [[Building a Zynthian Box using an official Kit | this tutorial]].
    
[[File:IMG_1459.JPG|600px]]
 
[[File:IMG_1459.JPG|600px]]
   −
Anyway, it's quite detailed and can be used as a guide to build 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 that way ;-)
    
=Bill of Materials=
 
=Bill of Materials=
* Zynthian Basic Kit (custom PCBs, electronic parts, wiring and knobs) See: [https://discourse.zynthian.org/t/zynthian-kits/150/17 Getting a Zynthian Kit]
+
* Zynthian Basic Kit (custom PCBs, electronic parts, wiring and knobs) Visit the [http://shop.zynthian.org Zynthian Shop]
* Case kit, with nuts, bolts and case connectors. See: [https://discourse.zynthian.org/t/zynthian-kits/150/17 Getting a Zynthian Kit]
+
* Case kit, including nuts, bolts and connectors. Visit the [http://shop.zynthian.org Zynthian Shop]
 
* Raspberry Pi 3 (or Raspberry Pi 2)
 
* Raspberry Pi 3 (or Raspberry Pi 2)
 
* [https://www.hifiberry.com/products/dacplus HifiBerry DAC+ souncard]
 
* [https://www.hifiberry.com/products/dacplus HifiBerry DAC+ souncard]
* [http://ozzmaker.com/product/piscreen-3-5-tft-with-touch-for-the-raspberry-pi PiScreen 3.5" touch-display]
+
* [http://ozzmaker.com/product/piscreen-3-5-tft-with-touch-for-the-raspberry-pi OzzMaker PiScreen 3.5" touch-display]
 
* Power adapter for Raspberry Pi (5.1v 2.4A with microUSB connector)
 
* Power adapter for Raspberry Pi (5.1v 2.4A with microUSB connector)
 +
* 16GB SD Card (a good one, please!)
    
=Some definitions=
 
=Some definitions=
Line 42: Line 43:  
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://blog.zynthian.org/download/zynthian_gorgona_edge_rbpi3_pitft-2017-09-18.img.torrent Download Zynthian "Gorgona Edge" SD-image]'''
+
  '''[http://blog.zynthian.org/download/zynthian_gorgona_next_rbpi3_piscreen2-2017-11-14.img.torrent Download Zynthian "Gorgona Next" SD-image, configured for Kits v2]'''
   −
It's a 9GB image file (a good amount of soundfonts) compiled for RBPi3.
+
It's a 11GB image file (plenty of soundfonts) compiled for RBPi3 and pre-configured for working with Kits v2 out-the-box. Plug & Play!
    
If you prefer a smaller image (Gorgonilla) or need support for RBPi2, then you can download the older Gorgona image:  
 
If you prefer a smaller image (Gorgonilla) or need support for RBPi2, then you can download the older Gorgona image:  
Line 50: Line 51:  
  '''[https://discourse.zynthian.org/t/merry-zynthians-and-happy-new-sd-image/314 Download Zynthian "Gorgona" SD-image]'''
 
  '''[https://discourse.zynthian.org/t/merry-zynthians-and-happy-new-sd-image/314 Download Zynthian "Gorgona" SD-image]'''
   −
These SD images include all the Zynthian software, properly configured for the standard hardware -- ready to use. Plug and play! ;-)
+
These older SD images are pre-configured for the older Kits v1, so you should adjust the configuration using the [[Configuration_Users_Guide|webconf tool]].
   −
After downloading the SD-image, you have to write it to a SDcard. You need a minimum size of 16GB SDcard for the full ''Gorgona'' image or 8GB for the ''Gorgonilla'' lite image.  
+
After downloading the SD-image, you have to write it to a SDcard. You need a minimum size of 16GB SDcard for the full ''Gorgona'' image or 8GB for the ''Gorgonilla'' lite image.
   −
Use Etcher https://etcher.io/ (free software works on Mac, Windows or Linux) to flash the image onto the SDcard.
+
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 SDcard. Or do it manually! There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
   −
Or do it manually: There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].
+
Finally, if you like, you can build your own SD image following these instructions:
 
  −
If you prefer, you can build your own SD image following these instructions:
      
  [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
 
  [https://discourse.zynthian.org/t/new-sd-image-setup-script/283 Building the SD Image using the Setup Script]
Line 351: Line 350:     
[[File:IMG_1393.JPG|600px]]
 
[[File:IMG_1393.JPG|600px]]
 +
 +
[[File:IMG_1401.JPG|600px]]
    
===Stick the rubber feet===
 
===Stick the rubber feet===
Line 358: Line 359:  
=Connecting everything=
 
=Connecting everything=
   −
This is an easy connection guide, based in colored wires and images. If you want to know and understand the details (or if you have problems and need to ''debug''), you should take a look to the [[#Technical_Reference|Technical Reference]].
+
The new Zynthian Kit 2 is designed to use JST connectors, so connecting everything is really straight-forward:
 
  −
===Connect the Dupont Wires to the Main Ribbon Bus===
  −
 
  −
====Controller Module 4-pin Dupont Wires (x 4)====
  −
 
  −
The next scheme shows the numbering/naming used for encoders and switches:
  −
 
  −
[[File:zynthian_ui_legend.png]]
  −
 
  −
Take the 4 x "20cm 4-pin Dupont Connector Wires". These wires are used to connect the 4 controller modules to the RBPi GPIO:
  −
 
  −
[[File:Controller_dupont_wires.jpg|600px]]
  −
 
  −
You have to connect it to the middle male connector of the Ribbon Bus Cable following the next scheme:
  −
 
  −
[[File:wiring_scheme_controllers_single.png|600px]]
  −
 
  −
You can leave disconnected the two purple wires. It's more comfortable to connect it to the 2in1 module after pluging the Main Ribbon Bus to the RBPi.
  −
 
  −
'''Note:''' While connectig the wires, the red wire of the Main Ribbon Bus must be at left. The red wire is ALWAYS the #1!
  −
 
  −
====2in1 Module 6-pin Dupont Wire====
  −
 
  −
Next, you take the "10cm 6-pin Dupont Connector Wire". This is used to connect the 2in1 module to the RBPi GPIO:
  −
 
  −
[[File:2in1_dupont_wire.jpg|600px]]
  −
 
  −
You have to connect it to the middle male connector of the Ribbon Bus Cable following the next scheme:
  −
 
  −
[[File:Cable-schema-2in1.png|600px]]
  −
 
  −
'''Note:''' While connectig the wires, the red wire of the Main Ribbon Bus must be at left. The red wire is ALWAYS the #1!
     −
In that point you should have something like this:
+
* Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the All-In-One module
   −
[[File:Zynthian_mounting_ribbon_wiring.jpg|600px]]
+
[[File:IMG_4741.JPG|600px]]
   −
===Connect the Main Ribbon Bus to the RBPi===
+
[[File:IMG_1474.JPG|600px]]
   −
It's time to connect the Main Ribbon Bus to the RBPi GPIO. When looking to the case from the front side, the red wire must be in the right, like in the photo above.
+
* Connect the 4 double JST cables to the 4 controller connectors on the All-In-One module (CTRL1, CTRL2, CTRL3, CTRL4)
   −
It's also time to connect the two purple wires to the 2in1 module if you haven't done before. This two wires are for the upper switches: CH(1) and LS(3).
+
[[File:IMG_4744.JPG|600px]]
   −
===Connect the Controller Modules (x4)===
+
[[File:IMG_1479.JPG|600px]]
   −
This step is a bit tricky. If you followed the instructions above, you have soldered the pin-rows in the bottom side of the controller PCBs, so numbering is reversed when looking from the bottom. You can use a little trick: rotate the PCB 180º and the numbering is "left to right" again ;-)
+
* 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 ;-)
   −
Anyway, if you take a look to the next photo, you shouldn't have any problem. Brown/green wires are #1.
+
[[File:IMG_1465.JPG|600px]]
   −
[[File:Zynthian_mounting_controllers_wiring.jpg|600px]]
+
At this point, your Zynthian Box should look something like this:
   −
'''Note:''' Some encoders have a different pin ordering. If you bought the encoders by yourself, perhaps you have to change A and B pins (brown<=>red, green<=>blue).
+
[[File:IMG_1409.JPG|600px]]
   −
===Connect the 2in1 Module===
+
* Connect the 4 x Controller Modules following the right numbering: from top to bottom and from left to right.
   −
Connect the 6-pin dupont wire to the 2in1 module. Numbering is from left to right (top to bottom in the photo) and pin 1 is the brown wire:
+
[[File:zynthian_controllers.png|600px]]
   −
[[File:Zynthian_mounting_2in1_top.jpg|600px]]
+
[[File:IMG_1412.JPG|600px]]
   −
Also, if you haven't done this before, connect the DIN-5 connector (MIDI-IN) to the 2in1 module. It's the 2-pin connector labeled as MIDI-IN.
+
* 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:Zynthian_mounting_2in1_case.jpg|400px]]
+
[[File:IMG_1489.JPG|600px]]
[[File:Zynthian_mounting_connectors.jpg|400px]]
  −
 
  −
===Connect the Jack connectors===
  −
 
  −
If you haven't done this before, connect the Jack connectors to the auxiliar on-board audio-out connector in the HifiBerry soundcard. It's the 3-pin connector that you soldered before:
  −
 
  −
[[File:Zynthian_mounting_hifiberry_3pin_connector.jpg|600px]]
      
===Connect the Display===
 
===Connect the Display===
   −
And finally, connect the ribbon's 26-pin connector to the Display's male side connector.
+
And finally, connect the ribbon's 26-pin connector to the Display's male side connector. Put attention to the orientation. The red wire should be the pin 1 that as marked in the display's PCB surface.
   −
[[File:Zynthian_mounting_controllers_wiring.jpg|600px]]
+
[[File:IMG_1501.JPG|600px]]
    
=Testing your Zynthian Box=
 
=Testing your Zynthian Box=
Line 450: Line 412:  
  2. Plug the mini-usb power conector. A good 5V micro-usb charger is recommended (> 2 Amp).
 
  2. Plug the mini-usb power conector. A good 5V micro-usb charger is recommended (> 2 Amp).
   −
These are the stages that you should see while booting:
+
If you are using a SD image pre-configured for the Zynthian Kits v2, these are the stages that you should see while booting:
    
  1. Initially, the display must go white
 
  1. Initially, the display must go white
Line 459: Line 421:     
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]]
    
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)]].
 
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)]].
 +
 +
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:
 +
 +
* '''Display:''' PiScreen 3.5 (v2)
 +
* '''Audio:''' HifiBerry DAC+
 +
* '''Wiring:''' MCP23017_ENCODERS
 +
* '''Style:''' FontSize = 14
    
===Test the Controllers===
 
===Test the Controllers===
   −
If you get the Zynthian UI, then you should start by testing that your controllers are working OK.  
+
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.
 +
 
 +
1. Push 'select' to create a new layer. You should get into the 'Engine Selection' screen.  
   −
1. Push the 'SELECT' controller. You should get into the 'Engine Selection' screen.  
+
[[File:IMG_1563.JPG|600px]]
   −
If it doesn't works, try pushing the 'LS' 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, or perhaps you have changed some wires while connecting the main ribbon bus. Double-check the wiring again.
+
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.
   −
  2. Rotate the 'SELECT' controller to select the engine you want to start.  
+
  2. Rotate the 'SELECT' controller to select the engine you want to start for the new layer.  
    
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.
 
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.
   −
  3. Push 'BACK'. You should get into the 'Admin' screen. Push 'BACK' again to return to the 'Engine Selection' screen.
+
  3. Select the ZynAddSubFX engine, select channel #1, bank and preset. You should get into the 'Instrument Control' screen.
   −
4. Select the ZynAddSubFX engine, select channel #1, bank and instrument. You should get into the 'Instrument Control' screen:
+
[[File:IMG_1568.JPG|600px]]
   −
'''CAPTURE NEEDED HERE'''
+
  4. 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 analizing 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 'LS' to get into the 'Load Snapshot' screen. Push 'LS' again to 'Save Snapshot'. Push 'BACK' to return to the 'Instrument Control' screen.
+
  5. Push 'BACK'. You should go back to the 'Preset Selection' screen.  
   −
  7. Push 'CH' to jump to the 'Channel List' screen.
+
  6. Push 'Layer' again to return to the 'Layer Selection' screen. Try to create another layer following the same procedure.
   −
If everything works but 'LS' and 'CH' switches, then probably you have some wiring problem in the 2in1 module. Check the wiring again ;-)
+
[[File:IMG_1584.JPG|600px]]
   −
Finally, if you can't fix the problems, you could try to login into the system and run some testing program from the command line:
+
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.
   −
# /zynthian/zyncoder/zyncoder_test
+
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 ...
 
  −
or reading directly the GPIO:
  −
 
  −
# gpio readall
  −
 
  −
etc.
      
===Test the Audio Output===
 
===Test the Audio Output===
    
  1. Connect the audio output (RCA or Jack connectors) to your amplifier or auto-amplified speakers.
 
  1. Connect the audio output (RCA or Jack connectors) to your amplifier or auto-amplified speakers.
  2. Boot your Zynthian. You should be in the initial 'Load Snapshot' screen.
+
  2. Boot your Zynthian. You should be in the initial 'Layer Selection' screen.
  3. Push BACK twice to 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 stuff ;-)
  5. Push 'BACK' to stop the playing
+
  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, 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)]].
Line 513: Line 478:     
  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.
+
  2. Boot your Zynthian, select FluidSynth engine, channel #1 and 'FluidR3 GM' bank. Select some instrument.
 +
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.
  4. Select 'MIDI Test' option and push 'SELECT'. You should hear the test midi-track: a 'Take Five' version ;-)
+
  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
   Line 525: Line 491:  
  2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and instrument
 
  2. Boot your Zynthian, select ZynAddSubFX, channel #1, bank and 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 ;-)
+
  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 ;-)
    
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)]].
Line 538: Line 504:  
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)]].
   −
=Close the Case=
+
=Final steps=
 +
 
 +
When everything is working OK, it's time to close the case, but first ...
 +
 
 +
===Insert the knobs===
 +
 
 +
You should insert the knobs into the encoders before closing the case. This will avoid forcing the encoders too much as otherwise, you could break them.
 +
Follow these simple steps and you wouldn't have any problem:
 +
 
 +
* moisten with water or saliva the encoder stem
 +
* press the encoder with the finger from the rear while pushing the knob from the front until is completely inserted
   −
When everything is working OK, it's time to close the case.
+
===Close the case===
   −
This can be a little bit tricky. Take your time to see how to bend and drive the cables to get a good fitting.
+
Once the knobs are in its place, take your time to see how to bend and drive the cables to get a good fitting when closing the case.
   −
[[File:Zynthian_mounting_case_open.jpg|600px]]
+
[[File:IMG_1626.JPG|600px]]
   −
[[File:Zynthian_finished_01.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.
Line 559: Line 535:  
  - '''restart GUI''' (or '''reboot''') from the admin menu
 
  - '''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.
    
=Locating and Solving problems=
 
=Locating and Solving problems=
Line 596: Line 572:  
This is the electrical scheme of the All-In-One circuit:
 
This is the electrical scheme of the All-In-One circuit:
   −
[[File:Zynthian_scheme_GPIO.png|800px]]
+
[[File:Zynthian_allinone.sch.svg|800px]]
    
===RBPi GPIO===
 
===RBPi GPIO===
    
[[File:Raspberry-Pi-j8header-2b.png|400px]]
 
[[File:Raspberry-Pi-j8header-2b.png|400px]]

Navigation menu