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:Zynthian_finished_02.jpg|600px]]
+
[[File:IMG_2287.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 such a way ;-)
 +
 
 +
[[File:IMG_2280.JPG|600px]]
    
=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 30: 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 42: 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://blog.zynthian.org/download/zynthian_gorgona_edge_rbpi3_pitft-2017-09-18.img.torrent Download Zynthian "Gorgona Edge" SD-image]'''
+
  '''[https://os.zynthian.org/zynthianos-last-stable.zip Download Last Stable ZynthianOS SD-image]'''
 
  −
It's a 9GB image file (a good amount of soundfonts) compiled for RBPi3.
  −
 
  −
If you prefer a smaller image (Gorgonilla) or need support for RBPi2, then you can download the older Gorgona 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! ;-)
+
It's a 8 GB compressed image file (plenty of soundfonts) compiled for Raspberry Pi 3.
   −
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.  
+
These SD card images include all the Zynthian software, properly configured for working with the official kits. Completely ready to use. Plug and play!
   −
Use Etcher https://etcher.io/ (free software works on Mac, Windows or Linux) to flash the image onto the SDcard.
+
After downloading the SD-image, you have to write it to a micro-SD card. You need '''a micro-SD card with a minimum size of 16 GB''', although you can use a bigger one if you want.
   −
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].
   −
If you prefer, you can build your own SD image following these instructions:
+
Finally, if you like, 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 68: 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 86: Line 83:  
  + '''Wiring Kit with JST connectors'''
 
  + '''Wiring Kit with JST connectors'''
   −
[[File:Zynthian_kit_assembled.jpg|600px]]
+
[[File:IMG_1286.JPG|600px]]
    
and these generic parts:
 
and these generic parts:
Line 93: Line 90:  
  + '''1 x Hifiberry DAC+''' (also pro & lite)
 
  + '''1 x Hifiberry DAC+''' (also pro & lite)
 
  + '''1 x PiScreen 3.5' Touch-Display'''
 
  + '''1 x PiScreen 3.5' Touch-Display'''
 +
 +
[[File:IMG_1299.JPG|600px]]
 +
    
Of course, other arrangements and combinations are possible. You can easily configure your hardware using the [http://wiki.zynthian.org/index.php/Configuration_Users_Guide Webconf Tool], or if it doesn't work, tweaking from the [http://wiki.zynthian.org/index.php/Command_Line_User_Guide command line].
 
Of course, other arrangements and combinations are possible. You can easily configure your hardware using the [http://wiki.zynthian.org/index.php/Configuration_Users_Guide Webconf Tool], or if it doesn't work, tweaking from the [http://wiki.zynthian.org/index.php/Command_Line_User_Guide command line].
Line 190: Line 190:  
  4. Place the JST connector in the downside of the PCB, with the angle pins facing inwards (look the photo!)
 
  4. Place the JST connector in the downside of the PCB, with the angle pins facing inwards (look the photo!)
 
  5. Solder the JST connector carefully.
 
  5. Solder the JST connector carefully.
  7. Use the plier to close the tabs again, trying to "catch" the PCB.
+
  7. Use the plier to close the encoder's tabs again, trying to "catch" the PCB.
    
[[File:IMG_4781.JPG|600px]]
 
[[File:IMG_4781.JPG|600px]]
Line 231: Line 231:  
(*) You could use some tape for fixing the components while soldering, specially for ICs and connectors.
 
(*) You could use some tape for fixing the components while soldering, specially for ICs and connectors.
   −
[[File:2in1_ensambled.jpg|600px]]
+
[[File:IMG_1251.JPG|800px]]
 +
 
 +
[[File:IMG_1252.JPG|800px]]
 +
 
 +
[[File:IMG_1277.JPG|800px]]
    
===Tweaking the HifiBerry DAC+ soundcard===
 
===Tweaking the HifiBerry DAC+ soundcard===
Line 244: Line 248:  
'''WARNING!''' Soldering the big 40-pin connector can be difficult if you don't have enough practice. Please, before starting be sure that you have read and understood [[#Some_general_recommendations|these recommendations]].
 
'''WARNING!''' Soldering the big 40-pin connector can be difficult if you don't have enough practice. Please, before starting be sure that you have read and understood [[#Some_general_recommendations|these recommendations]].
   −
[[File:Hifiberry_dacplus_extra_connectors_unassembled.jpg|600px]]
+
[[File:IMG_1369.JPG|600px]]
   −
[[File:Hifiberry_dacplus_extra_connectors_mounted.jpg|600px]]
+
[[File:IMG_1370.JPG|600px]]
    
===Tweaking the OzzMaker PiScreen 3.5' touch-display===
 
===Tweaking the OzzMaker PiScreen 3.5' touch-display===
Line 264: 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.
 +
 
 +
[[File:IMG_4777.JPG|600px]]
 +
 
 +
'''JST Connector wires'''[[File:Midiconnfront.jpg|340px|right]]
   −
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 ;-)
+
* 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
   −
[[File:Midi_connector_unasambled.jpg|600px]]
+
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:Midi_connector_assembled.jpg|600px]]
      
Depending of your case version, you will need to build 2 or 3 MIDI connectors.
 
Depending of your case version, you will need to build 2 or 3 MIDI connectors.
Line 278: Line 290:  
In the same way, before mounting the Jack connectors into the case we will solder the needed wires. You can use heat-shrink sleeve too.
 
In the same way, before mounting the Jack connectors into the case we will solder the needed wires. You can use heat-shrink sleeve too.
   −
[[File:Jack_connectors_unassambled.jpg|600px]]
+
[[File:IMG_4774.JPG|600px]]
   −
[[File:Jack_connectors_assembled_new.jpg|600px]]
+
[[File:IMG_1272.JPG|600px]]
    
=Case Mounting=
 
=Case Mounting=
Line 288: Line 300:  
The main computing block is composed by the RBPi and the HifiBerry soundcard, and shouold be assembled using the next set of separator & bolts:
 
The main computing block is composed by the RBPi and the HifiBerry soundcard, and shouold be assembled using the next set of separator & bolts:
   −
[[File:Bolts_main_computing_block.jpg|200px]]
+
[[File:IMG_1293.JPG|400px]]
    
For easier assembling, you should follow the next steps:
 
For easier assembling, you should follow the next steps:
Line 296: Line 308:  
  3. screw the 4 bolts on top of the HifiBerry.
 
  3. screw the 4 bolts on top of the HifiBerry.
   −
[[File:Main_computing_block_rbpi.jpg|600px]]
+
[[File:IMG_1353.JPG|600px]]
   −
[[File:Main_computing_block_02.jpg|600px]]
+
[[File:IMG_1348.JPG|600px]]
   −
[[File:Main_computing_block.jpg|600px]]
+
[[File:IMG_1351.JPG|600px]]
    
===Secure the Main Computing Block===
 
===Secure the Main Computing Block===
Line 306: Line 318:  
After assembling the main computing block, you should secure it to the case. Use 4 black M2.5 bolts (see photo above).
 
After assembling the main computing block, you should secure it to the case. Use 4 black M2.5 bolts (see photo above).
   −
[[File:zynthian_mounting_computing_block_01.jpg|600px]]
+
[[File:IMG_1314.JPG|600px]]
    
===Secure the All-In-One module===
 
===Secure the All-In-One module===
Line 312: Line 324:  
Secure the All-In-One module to the case using 4 x separators and 8 x M2.5 bolts.
 
Secure the All-In-One module to the case using 4 x separators and 8 x M2.5 bolts.
   −
[[File:bolts_2in1.jpg|150px]]
+
[[File:IMG_1294.JPG|400px]]
   −
[[File:zynthian_mounting_2in1_01.jpg|600px]]
+
[[File:IMG_1356.JPG|600px]]
    
===Secure the Jack connectors===
 
===Secure the Jack connectors===
Line 320: Line 332:  
Put the rings on the outer side of the case to avoid damaging the case surface when you tighten the nuts.
 
Put the rings on the outer side of the case to avoid damaging the case surface when you tighten the nuts.
   −
[[File:zynthian_mounting_jack_connectors_detail.jpg|600px]]
+
[[File:IMG_1371.JPG|600px]]
 
  −
[[File:zynthian_mounting_jack_connectors_top.jpg|600px]]
      
===Secure the MIDI-IN/OUT/THRU connectors===
 
===Secure the MIDI-IN/OUT/THRU connectors===
Line 328: Line 338:  
Just insert the connector with the JST-wire from the out-side of the case and the nut from the innerside. A pair of pliers can be useful for tighten.
 
Just insert the connector with the JST-wire from the out-side of the case and the nut from the innerside. A pair of pliers can be useful for tighten.
   −
[[File:zynthian_mounting_midi_connector_detail.jpg|600px]]
+
[[File:IMG_1383.JPG|600px]]
   −
[[File:zynthian_mounting_midi_connector_top.jpg|600px]]
     −
===Secure the Display===
+
===Mount the MIDI activity LEDS===
   −
This step is a little bit tricky because the bolts & nuts are tiny, and it have some slack. Don't press too much the nuts. The PCB have to bend a little bit, but not too much. You should be capable of moving the display pushing the borders with your fingers. Later, when the screen is on, you will fine adjust the position for having the margins equalized.
+
Insert the 3 LEDS in the case holes. You may want to push the LEDs with something more rigid than your finger. The screwdriver's handle could be fine.
   −
'''Note:''' Before fixing the screen, don't forget to remove the protective plastic sheet!
+
[[File:IMG_2223.JPG|600px]]
 +
[[File:IMG_2224.JPG|600px]]
   −
[[File:bolts_screentouch.jpg|200px]]
+
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:
   −
[[File:zynthian_mounting_display.jpg|600px]]
+
* JST White wire (1) => LED's Anode (LED's red wire/long lead)
 +
* JST Yellow wire (2) => LED's Cathode (LED's black wire/short lead)
   −
===Secure the Controllers===
+
After soldering all the 3 LEDs, you may want to protect the connection with heat shrink sleeve, adhesive tape or hot melt glue.
   −
[[File:zynthian_mounting_controllers.jpg|600px]]
+
[[File:IMG_2226.JPG|600px]]
   −
===Stick the rubber feet===
+
===Secure the Display===
   −
[[File:Zynthian_mounting_case_bottom.jpg|600px]]
+
For fixing the display to the case cover, you have to use this set:
   −
=Connecting everything=
+
[[File:IMG_1295.JPG|400px]]
   −
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]].
+
It's composed of 4 bolts, 4 nuts and 4 nylon separators. Before fixing the screen, don't forget to remove the protective plastic sheet.
   −
===Connect the Dupont Wires to the Main Ribbon Bus===
+
[[File:IMG_1387.JPG|600px]]
   −
====Controller Module 4-pin Dupont Wires (x 4)====
+
===Secure the Controllers===
   −
The next scheme shows the numbering/naming used for encoders and switches:
+
Fix the 4 controller modules to the case cover using the 4 bolts and washers attached to every rotary encoder.
   −
[[File:zynthian_ui_legend.png]]
+
'''IMPORTANT:''' For avoiding problems while closing the case, i recommend to mount the controller modules with the connectors facing one another. See the photo below.
   −
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:IMG_1393.JPG|600px]]
   −
[[File:Controller_dupont_wires.jpg|600px]]
+
[[File:IMG_1401.JPG|600px]]
   −
You have to connect it to the middle male connector of the Ribbon Bus Cable following the next scheme:
+
===Insert the knobs===
   −
[[File:wiring_scheme_controllers_single.png|600px]]
+
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:
   −
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.
+
* moisten with water or saliva the encoder stem and the knob hole
 +
* press the encoder PCB with the finger from the rear side while pushing the knob from the front side until is completely inserted
   −
'''Note:''' While connectig the wires, the red wire of the Main Ribbon Bus must be at left. The red wire is ALWAYS the #1!
+
===Stick the rubber feet===
   −
====2in1 Module 6-pin Dupont Wire====
+
[[File:Zynthian_mounting_case_bottom.jpg|600px]]
   −
Next, you take the "10cm 6-pin Dupont Connector Wire". This is used to connect the 2in1 module to the RBPi GPIO:
+
=Connecting everything=
   −
[[File:2in1_dupont_wire.jpg|600px]]
+
The new Zynthian Kit 2 is designed to use JST connectors, so connecting everything is really straight-forward:
   −
You have to connect it to the middle male connector of the Ribbon Bus Cable following the next scheme:
+
===Connect the Ribbon Bus cable===
   −
[[File:Cable-schema-2in1.png|600px]]
+
Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the All-In-One module
   −
'''Note:''' While connectig the wires, the red wire of the Main Ribbon Bus must be at left. The red wire is ALWAYS the #1!
+
[[File:IMG_4741.JPG|600px]]
   −
In that point you should have something like this:
+
[[File:IMG_1474.JPG|600px]]
   −
[[File:Zynthian_mounting_ribbon_wiring.jpg|600px]]
+
===Connect the controllers (1)===
   −
===Connect the Main Ribbon Bus to the RBPi===
+
Connect the 4 double JST cables to the 4 controller connectors on the All-In-One module (CTRL1, CTRL2, CTRL3, CTRL4)
   −
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.
+
[[File:IMG_4744.JPG|600px]]
   −
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_1479.JPG|600px]]
   −
===Connect the Controller Modules (x4)===
+
===Connect the MIDI connectors & activity LEDs===
   −
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 controllers (2)===
   −
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:
+
Connect the 4 x Controller Modules following the right numbering: from top to bottom and from left to right.
   −
[[File:Zynthian_mounting_2in1_top.jpg|600px]]
+
[[File:zynthian_controllers.png|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.
+
[[File:IMG_1412.JPG|600px]]
   −
[[File:Zynthian_mounting_2in1_case.jpg|400px]]
+
===Connect the Audio Jack connectors===
[[File:Zynthian_mounting_connectors.jpg|400px]]
     −
===Connect the 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:
   −
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:IMG_1489.JPG|600px]]
   −
[[File:Zynthian_mounting_hifiberry_3pin_connector.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===
   −
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 436: 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).
    
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!!
   −
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)]].
+
[[file:IMG_2490.JPG|600px]]
   −
===Test the Controllers===
+
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 get the Zynthian UI, then you should start by testing that your controllers are working OK.  
+
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:
   −
1. Push the 'SELECT' controller. You should get into the 'Engine Selection' screen.  
+
* 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 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 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:
   −
2. Rotate the 'SELECT' controller to select the engine you want to start.
+
* '''Display:''' PiScreen 3.5 (v2)
 +
* '''Audio:''' HifiBerry DAC+ / HifiBerry DAC+ADC
 +
* '''Wiring:''' MCP23017_EXTRA
 +
* '''Style:''' FontSize = 14
   −
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.
+
===Test the Controllers & UI===
   −
3. Push 'BACK'. You should get into the 'Admin' screen. Push 'BACK' again to return to the 'Engine Selection' screen.
+
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.  
   −
  4. Select the ZynAddSubFX engine, select channel #1, bank and instrument. You should get into the 'Instrument Control' screen:
+
  1. Rotate the SELECT controller up & down for selecting the different options in the Layers menu.  
   −
'''CAPTURE NEEDED HERE'''
+
2. Push SELECT to create a New 'Synth Layer'. You should get into the 'Engine Selection' screen.
 +
 
 +
[[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.
 +
 
 +
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.
 +
 
 +
4. Select the ZynAddSubFX engine, select channel #1, bank 'Collection' and preset 'Metal Drips'.
 +
 
 +
[[File:IMG_2497.JPG|600px]]
 +
 
 +
You should get into the 'Instrument Control' screen.
 +
 
 +
[[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 analizing the observed behaviour.
+
If some controller doesn't work correctly, check the wiring again. You could try to figure what is happening by analyzing the observed behaviour.
 +
 
 +
6. Push SELECT to move to the next controller screen. Bold push to select a controller screen from the list.
 +
 
 +
7. Push BACK. You should go back to the 'Preset Selection' screen.
 +
 
 +
[[File:IMG_2499.JPG|600px]]
   −
  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.
+
  8. Push BACK again. You should go back to the 'Bank Selection' screen.  
   −
7. Push 'CH' to jump to the 'Channel List' screen.
+
[[File:IMG_2498.JPG|600px]]
   −
If everything works but 'LS' and 'CH' switches, then probably you have some wiring problem in the 2in1 module. Check the wiring again ;-)
+
9. Push LAYER again to return to the 'Layer Selection' screen. Try to create another layer following the same procedure.
   −
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:
+
[[File:IMG_2509.JPG|600px]]
   −
  # /zynthian/zyncoder/zyncoder_test
+
  10. Push 'SNAPSHOT' to get into the 'Snapshot' screen. Select 'New Snapshot' and your first snapshot will be stored.
   −
or reading directly the GPIO:
+
[[File:IMG_2506.JPG|600px]]
   −
# gpio readall
+
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:
   −
etc.
+
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===
    
  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 507: 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.
+
  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. 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 519: Line 563:  
  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 526: 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 ;-)
    
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=
 +
 
 +
Once everything is in its place and you have tested that it works, it's time to close the case ...
 +
 
 +
===Close the case===
   −
When everything is working OK, it's time to close the case.  
+
Take your time to see how to bend and drive the cables to get a good fitting when closing 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.
     −
[[File:Zynthian_mounting_case_open.jpg|600px]]
+
[[File:IMG_1626.JPG|600px]]
   −
[[File:Zynthian_finished_01.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 548: 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 559: 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 go white in the boot stage 1===
+
===The display don't show the zynthian splash screen on boot===
   −
I recommend you disconnect the controller and 2in1 modules and try to boot again.
+
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.
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===
+
===You get the zynthian error screen with the IP===
   −
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 hardware seems to be incorrectly configured. You should access the webconf tool and configure your hardware.
 +
 
 +
===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 576: 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 586: 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:
   −
[[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