2,705
edits
Changes
Jump to navigation
Jump to search
Line 78:
Line 78: − + − + + − + '''Wiring Kit with JST connectors''' − + Line 89:
Line 89: − + '''1 x ZynScreen 3.5' Touch-Display''' − + + Line 105:
Line 105: − + + + Line 111:
Line 113: − Put the rings on the outer side of the case to avoid damaging the case surface when you tighten the nuts.+ − + − + Line 125:
Line 127: − + − + − + Line 144:
Line 146: − − + − + − + Line 157:
Line 158: − Line 169:
Line 169: − + Line 190:
Line 190: − + Line 209:
Line 209: − + − + Line 235:
Line 235: + Line 243:
Line 244: + Line 251:
Line 253: + + − Line 264:
Line 267: + + − + − + − + − If you are using a SD image pre-configured for the Zynthian Kits v3, these are the stages that you should see while booting:+ − + − 2. After 5-10 seconds, it will show the Zynthian splash screen+ − 3. After 1-2 seconds, it will go black + − 4. If you are using a fresh zynthian image and it's the first boot, the stages 2 and 3 will be repeated + − 5. After 5-10 seconds, the zynthian UI will be shown − + + + + + + + + + + + + + + + + + − 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 v3, 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===+ − + − + − + − 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 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.+ − 3. Select the ZynAddSubFX engine, select channel #1, bank and preset. You should get into the 'Instrument Control' screen.+ − [[File:IMG_1568.JPG|600px]]+ − 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 analizing the observed behaviour.+ − 5. 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_1584.JPG|600px]]+ − 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.+ − + + + + + + + + + Line 338:
Line 363: − + Line 358:
Line 383: − + − + Line 370:
Line 395: − + + + − + + Line 382:
Line 410: − + − + − + − - '''restart GUI''' (or '''reboot''') from the admin menu + + Line 393:
Line 422: − + + + − ===The display don't go white in the boot stage 1===+ − I recommend you disconnect the controller and 2in1 modules and try to boot again.+ − 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===+ − 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.+ − '''More coming soon ...'''+ Line 419:
Line 449: − − ===Electrical Schematic=== − − This is the electrical scheme of the All-In-One circuit: − − [[File:Zynthian_allinone.sch.svg|800px]] − − ===RBPi GPIO=== − − [[File:Raspberry-Pi-j8header-2b.png|400px]]
Building a Zynthian Box using an official Kit v3 (view source)
Revision as of 20:37, 17 July 2019
, 20:37, 17 July 2019no edit summary
A Zynthian Kit is a set of specific and generic electronic parts. This tutorial refers to the ''official'' Zynthian Bundle All Kit v3, that is composed of these specific parts:
A Zynthian Kit is a set of specific and generic electronic parts. This tutorial refers to the ''official'' Zynthian Bundle All Kit v3, that is composed of these specific parts:
+ '''4 x Controller Modules'''
+ '''4 x Controller Modules + Wiring'''
+ '''1 x Zynaptik Module'''
+ '''1 x Zynaptik Module:''' MIDI Ports + extended I/O
+ '''1 x ZynScreen 3.5':''' Touch-Display + Controllers circuit
+ '''1 x Main ribbon bus cable'''
+ '''1 x Main ribbon bus cable'''
[[File:IMG_2430.JPG|600px]]
[[File:IMG_2461.JPG|600px]]
these generic parts:
these generic parts:
+ '''1 x Raspberry Pi 3'''
+ '''1 x Raspberry Pi 3'''
+ '''1 x Hifiberry DAC+ADC'''
+ '''1 x Hifiberry DAC+ADC'''
[[File:IMG_2377.JPG|600px]]
[[File:IMG_2377.JPG|600px]]
and aluminium case:
and the aluminium case:
+ '''1 x Zynthian Aluminium Case'''
+ '''1 x Zynthian Aluminium Case'''
+ '''1 x Connectors'''
+ '''1 x Connectors'''
===Prerequisites===
===Prerequisites===
Assembling your own Zynthian Box is not very difficult, but you will need your attention, a screwdriver and an adjustable wrench. Read the instructions and observe the detailed photos carefully. If you get in trouble you can ask the community:
Assembling your Zynthian Kit V3 is not difficult at all: you need your attention, a screwdriver and an adjustable wrench. The kit v3 is a pre-built kit and you don't need to solder anything, just screwdrive the bolts and plug the wires.
Read the instructions and observe the detailed photos carefully. If you get in trouble you can ask the community:
https://discourse.zynthian.org
https://discourse.zynthian.org
===Secure the Jack connectors===
===Secure the Jack connectors===
Insert every connector from the inner-side of the case and the ring washers and nuts from the outer-side. The ring-washers will avoid damaging the case surface when you tighten the nuts. A wrench or pair of pliers can be useful for tightening the nuts.
[[File:IMG_2397.JPG|600px]]
[[File:IMG_2397.JPG|600px]]
[[File:IMG_2398.JPG|600px]]
[[File:IMG_2398.JPG|600px]]
===Secure the MIDI-IN/OUT/THRU connectors===
===Secure the MIDI connectors===
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 every connector with the JST-wire from the outer-side of the case and the nut from the inner-side. A wrench or pair of pliers can be useful for tightening the nuts.
[[File:IMG_2401.JPG|600px]]
[[File:IMG_2401.JPG|600px]]
===Mount the MIDI activity LEDS===
===Mount the MIDI activity LEDS===
Insert the 3 LEDS in the case holes, leaving the short lead at left. And don't push the LED's head! Instead push the black plastic holder around the LED. Sometimes is hard to push ...
Insert the 3 LEDS in the case holes, leaving the short lead at left. Don't push the LED's head! Instead push the black plastic holder around the LED. Sometimes is hard to push ...
[[File:IMG2403.JPG|600px]]
[[File:IMG2403.JPG|600px]]
When it's done, you have to plug the LED wires into the 2 spare "DUPONT" wires from the MIDI harness (green & yellow ones). Polarity is important, so don't cross the wires:
When it's done, you have to plug the LED wires into the 2 spare "DUPONT" connectors from the MIDI harness (green & yellow wires). Polarity is important, so don't cross the wires:
* JST Green wire (1) => LED's Anode (LED's long lead)
* JST Green wire (1) => LED's Anode (LED's long lead)
* JST Yellow wire (2) => LED's Cathode (LED's short lead)
* JST Yellow wire (2) => LED's Cathode (LED's short lead)
As the LED's leads are too long, you should cut them a little bit (7-8 mm is a good length), but remember where the "short" lead is located!!
As the LED's leads are too long, you would like to cut them a little bit (7-8 mm is a good length), but remember where the "short" lead is located!!
[[File:IMG2406.JPG|600px]]
[[File:IMG2406.JPG|600px]]
[[File:IMG_1293.JPG|600px]]
[[File:IMG_1293.JPG|600px]]
For easier assembling, you should follow the next steps:
For easier assembling, you should follow the next steps:
1. fix the 2x4 separators to the RBPi. The bigger one must be on top and the smaller one on bottom.
1. Fix the 2x4 separators to the RBPi. The bigger one must be on top and the smaller one on bottom.
2. insert the Hifiberry soundcard in the RBPi.
2. Insert the Hifiberry soundcard in the RBPi.
3. screw the 4 bolts on top of the HifiBerry.
3. Screwdrive the 4 bolts on top of the HifiBerry.
[[File:IMG_1353.JPG|600px]]
[[File:IMG_1353.JPG|600px]]
[[File:IMG_2395.JPG|600px]]
[[File:IMG_2395.JPG|600px]]
===Secure the Main Computing Block===
===Secure the Main Computing Block===
===Secure the Zynaptik module===
===Secure the Zynaptik module===
Secure the Zynaptik module to the case using 4 x separators and 8 x M2.5 bolts.
Secure the Zynaptik module to the case using 4 x separators and 8 x M2.5 bolts. I recommend to start fixing the separators to the case.
[[File:IMG_1294.JPG|400px]]
[[File:IMG_1294.JPG|400px]]
===Secure the Controllers===
===Secure the Controllers===
Plug a wire in every controller.
Plug a wire on every controller.
[[File:Rotary&wire.JPG|600px]]
[[File:Rotary&wire.JPG|600px]]
===Stick the rubber feet===
===Stick the rubber feet===
[[File:Zynthian_mounting_case_bottom.jpg|600px]]
[[File:IMG 2536.JPG|600px]]
=Connecting everything=
=Connecting everything=
The Zynthian Kit 3 is designed to use JST connectors, so connecting everything is really straight-forward:
The Zynthian Kit 3 is designed to use JST connectors that can't be plugged reversed, so connecting everything is really straight-forward:
* Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the Zynaptik module. The red wire is pin 1, so if you are looking at the case from the front side, it should be at right.
* Connect the Main Ribbon Bus cable to the RBPi's 40-pin header and also to the Zynaptik module. The red wire is pin 1, so if you are looking at the case from the front side, it should be at right.
[[File:dacplus-adc-top audio-out.jpg|600px]]
[[File:dacplus-adc-top audio-out.jpg|600px]]
[[File:IMG_2414.JPG|600px]]
[[File:IMG_2414.JPG|600px]]
The black wire on the "R" pin, white on the "L" one and red on "GND" (middle).
The black wire on the "R" pin, white on the "L" one and red on "GND" (middle).
[[File:dacplus-adc-top audio-in.jpg|600px]]
[[File:dacplus-adc-top audio-in.jpg|600px]]
[[File:IMG_2416.JPG|600px]]
[[File:IMG_2416.JPG|600px]]
The black wire should be connected to pin 3, red wire to pin 2 and white wire to pin 1. Looking at the first photo, numbering is left to right.
The black wire should be connected to pin 3, red wire to pin 2 and white wire to pin 1. Looking at the first photo, numbering is left to right.
[[File:Screen&Ribbon.JPG|600px]]
[[File:Screen&Ribbon.JPG|600px]]
At this point, your Zynthian Box should look something like this:
At this point, your Zynthian Box should look something like this:
[[File:Precierre.JPG|600px]]
[[File:Precierre.JPG|600px]]
=Testing your Zynthian Box=
=Testing your Zynthian Box=
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:
1. Initially, the display must go white
1. After 5-10 seconds, it will show the Zynthian splash screen
2. After 3-4 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. 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 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:
* 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 V3".
* Save the changes and reboot your Zynthian.
===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 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.
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.
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.
1. Push 'select' to create a new layer. You should get into the 'Engine Selection' screen.
4. Select the ZynAddSubFX engine, select channel #1, bank 'Collection' and preset 'Metal Drips'.
[[File:IMG_1563.JPG|600px]]
[[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.
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]]
8. Push BACK again. You should go back to the 'Bank Selection' screen.
[[File:IMG_2498.JPG|600px]]
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]]
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 ...
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===
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.
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 ;-)
===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.
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.
[[File:Precierre.JPG|600px]]
[[File:Precierre.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]]
[[File:ZynthianFront.jpg|600px]]
=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 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''')
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=
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===
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.
===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 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 can't solve the problem===
===You can't solve the problem===
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].