2,705
edits
Changes
Jump to navigation
Jump to search
Line 2:
Line 2: − + + + + + + + + + + + + + + Line 31:
Line 44: + + + + + + − This SD-image include all the zynthian software properly configured and ready to use. Plug and play! ;-)+ + + + + − After downloading the SD-image, you have to write it to a SD-card. Depending on your OS you have to choose how to create the SD-card. You need a minimum size of 16GB for the full ''Gorgona'' image and 8GB for the ''Gorgonilla'' lite image. There is a really good manual for this at [https://www.raspberrypi.org/documentation/installation/installing-images/ this link].+ Line 74:
Line 97: − + + + + Line 107:
Line 133: + + Line 116:
Line 144: − + + Line 126:
Line 155: − + Line 146:
Line 175: + Line 156:
Line 186: − + − + + Line 173:
Line 204: − + − + − + − + − + − + 1 x MCP23008 => 18 pins IC+ − + + + Line 259:
Line 292: − + Line 319:
Line 352: − + Line 330:
Line 363: + + + + + + Line 375:
Line 414: − + Line 400:
Line 439: − + Line 422:
Line 461: − + Line 534:
Line 573: − + − + + + + + + + + Line 559:
Line 605: − + − + Line 656:
Line 702: + + + + + + +
Building a Zynthian Box using an official Kit (view source)
Revision as of 09:57, 20 November 2017
, 09:57, 20 November 2017→Zynthian Software
=Introduction=
=Introduction=
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]
[https://discourse.zynthian.org/t/zynthian-kits/150/17 Getting a Zynthian Kit]
Specifically, the instructions are for the assembly of kits v1 (version 1), those using the 2in1 circuit and the PiTFT 2.8' display. If you have a newer kit v2, based in the All-In-One circuit and the PiScreen 3.5' display, you better should read [[Building a Zynthian Box using an official Kit v2 | this updated tutorial]].
[[File:Zynthian_finished_02.jpg|600px]]
[[File:Zynthian_finished_02.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, 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 ;-)
=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]
* Case kit, with nuts, bolts and case connectors. See: [https://discourse.zynthian.org/t/zynthian-kits/150/17 Getting a Zynthian Kit]
* Raspberry Pi 3 (or Raspberry Pi 2)
* [https://www.hifiberry.com/products/dacplus HifiBerry DAC+]
* PiTFT 2.8' TouchScreen
** [https://www.adafruit.com/product/2298 Resistive touchscreen] (less expensive)
** [https://www.adafruit.com/product/2423 Capacitive touchscreen] (better touch response)
* Power adapter for Raspberry Pi (5.1v 2.4A with microUSB connector)
=Some definitions=
=Some definitions=
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_next_rbpi3_pitft28-2017-11-14.img.torrent Download Zynthian "Gorgona Next" SD-image, configured for Kits v1]'''
It's a 11GB image file (plenty 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]'''
'''[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! ;-)
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.
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:
If you prefer, you can build your own SD image following these instructions:
+ '''1 x Adafruit PiTFT 2.8' ScreenTouch (or clonic)'''
+ '''1 x Adafruit PiTFT 2.8' ScreenTouch (or clonic)'''
Of course, other arrangements and combinations are possible and some community members are working on them:
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].
You can take a look to some of the alternate builds made by some community members:
- [https://discourse.zynthian.org/t/a-build-with-variations/324 A build with variations, by vagnscott]
- [https://discourse.zynthian.org/t/a-build-with-variations/324 A build with variations, by vagnscott]
- [https://discourse.zynthian.org/t/another-wiring/333 Another Wiring, by Imager]
- [https://discourse.zynthian.org/t/another-wiring/333 Another Wiring, by Imager]
- [https://discourse.zynthian.org/t/success-cases/41 Success Cases]
===Zynthian Case===
===Zynthian Case===
+ Basic understanding of reading basic electronic circuit diagrams
+ Basic understanding of reading basic electronic circuit diagrams
+ Enjoyment of work with electronic hardware and parts
+ Enjoyment of work with electronic hardware and parts
If you have not soldered before, you should read a [http://www.ladyada.net/learn/soldering/thm.html good soldering tutorial], or perhaps you would prefer the [http://mightyohm.com/files/soldercomic/FullSolderComic_EN.pdf Soldering is Easy] comic book by [http://mightyohm.com/ MightOhm].
====Tools====
====Tools====
+ Wire-cutter
+ Wire-cutter
+ Small Plier
+ Small Plier
+ Screw drivers
+ Screw-drivers Philips
+ Wrench, for potentiometer nuts (recommended)
+ PCB holder for soldering (very recommended!)
+ PCB holder for soldering (very recommended!)
+ Small iron brush (very recommended!)
+ Small iron brush (very recommended!)
===Some general recommendations===
===Some general recommendations===
'''1.''' Be careful with your fingers. Your body can hold a good amount of static electric charge. Under some circumstances that charge can be drained through some of the components that you are handling and this could break the component. Try to hold the PCBs by the borders and discharge your body frequently touching some "ground" with your fingers.
'''1.''' Be careful to protect the components from [http://en.wikipedia.org/wiki/Electrostatic-sensitive_device electrostatic discharge]. This is most critical for the ICs and the diodes. Be careful with your fingers. Your body can hold a good amount of static electric charge. Under some circumstances that charge can be drained through some of the components that you are handling and this could break the component. Try to hold the PCBs by the borders and discharge your body frequently touching some "ground" with your fingers.
'''2.''' Before soldering, please, check that you are soldering in the right side of PCB, also that components orientation is correct (ICs, diode)
'''2.''' Before soldering, please, check that you are soldering in the right side of PCB, also that components orientation is correct (ICs, diode)
+ 4 x rotary encoders with switch (PEC11R-4215K-S0024)
+ 4 x rotary encoders with switch (PEC11R-4215K-S0024)
+ 4 x ceramic capacitor 100nF (C1)
+ 4 x ceramic capacitor 100nF (C1)
+ 8 x ceramic capacitor 10nF (c2, c3)
+ 4 x 4-pin-row male connector (angle)
+ 4 x 4-pin-row male connector (angle)
0. Be sure that you have read and understdood [[#Some_general_recommendations|these recommendations]].
0. Be sure that you have read and understdood [[#Some_general_recommendations|these recommendations]].
1. Bend the encoder's securing tabs to 75º, so you can insert it in the upside of the PCB (the labeled side!). Please, be very careful when bending the tabs as the encoder case is quite fragil and could be deformed. I recommend to use a small plier and not reaching to 90º.
1. Bend the encoder's securing tabs to 75º, so you can insert it in the upside of the PCB (the labeled side!). Please, be very careful when bending the tabs as the encoder case is quite fragil and could be deformed. I recommend to use a small plier and not reaching to 90º.
2. Place the capacitor in the C1 position (the most right!)
2. Place the 100nF capacitor in C1 position (the most right!). This is for debouncing the push switch.
3. Solder the encoder and capacitor carefully.
3. Place the 2 x 10nF capacitors in C2 & C3 positions. These are for debouncing the rotary encoder contacts.
3. Solder the encoder and capacitors carefully.
4. Place the pin-row connector in the downside of the PCB, with the angle pins facing inwards (look the photo!)
4. Place the pin-row connector in the downside of the PCB, with the angle pins facing inwards (look the photo!)
5. Solder the pin-row carefully.
5. Solder the pin-row carefully.
+ 1 x 2in1 PCB
+ 1 x 2in1 PCB
+ 1 x opto-coupler 6N138 => 8 pins IC
+ 1 x GPIO-expander MCP23008 => 18-pin IC
+ 1 x dioode 1N4148 (D1)
+ 1 x opto-coupler 6N138 => 8-pin IC
+ 1 x resistor 1K (R1) => red-black-brown
+ 1 x diode 1N4148 (D1)
+ 1 x resistor 10K (R2) => orange-black-brown
+ 1 x resistor 1K (R1) => brown-black-red (*)
+ 1 x resistor 220 (R3) => red-red-black
+ 1 x resistor 10K (R2) => brown-black-orange (*)
+ 1 x resistor 220 (R3) => red-red-brown (*)
+ 2 x ceramic capacitor 100nF (C1, C2)
+ 2 x ceramic capacitor 100nF (C1, C2)
+ 1 x 8-row-pin male connector (angle)
+ 1 x 8-row-pin male-angle connector
+ 1 x 6-row-pin male connector
+ 1 x 6-row-pin male connector
+ 1 x 2-row-pin male connector
+ 1 x 2-row-pin male connector
(*) Read from left to right with the tolerance ring (gold or silver) on the right.
[[File:2in1_kit.jpg|600px]]
[[File:2in1_kit.jpg|600px]]
[[File:Jack_connectors_unassambled.jpg|600px]]
[[File:Jack_connectors_unassambled.jpg|600px]]
[[File:Jack_connectors_assambled.jpg|600px]]
[[File:Jack_connectors_assembled_new.jpg|600px]]
=Case Mounting=
=Case Mounting=
[[File:bolts_screentouch.jpg|200px]]
[[File:bolts_screentouch.jpg|200px]]
[[File:zynthian_mounting_screentouch.jpg|600px]]
[[File:zynthian_mounting_display.jpg|600px]]
===Secure the Controllers===
===Secure the Controllers===
=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]].
===Connect the Dupont Wires to the Main Ribbon Bus===
===Connect the Dupont Wires to the Main Ribbon Bus===
====Controller Module 4-pin Dupont Wires (x 4)====
====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:
Take the 4 x "20cm 4-pin Dupont Connector Wires". These wires are used to connect the 4 controller modules to the RBPi GPIO:
Anyway, if you take a look to the next photo, you shouldn't have any problem. Brown/green wires are #1.
Anyway, if you take a look to the next photo, you shouldn't have any problem. Brown/green wires are #1.
[[File:Zynthian_mounting_controllers.jpg|600px]]
[[File:Zynthian_mounting_controllers_wiring.jpg|600px]]
'''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).
'''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).
And finally, connect the ribbon's 26-pin connector to the ScreenTouch.
And finally, connect the ribbon's 26-pin connector to the ScreenTouch.
[[File:Zynthian_mounting_controllers.jpg|600px]]
[[File:Zynthian_mounting_controllers_wiring.jpg|600px]]
=Testing your Zynthian Box=
=Testing your Zynthian Box=
2. After 5-10 seconds, it will show the Zynthian splash screen
2. After 5-10 seconds, it will show the Zynthian splash screen
3. After 1-2 seconds, it will go black
3. After 1-2 seconds, it will go black
4. If you are using a fresh zynthian image, the stages 2 and 3 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
5. After 5-10 seconds, the zynthian UI will be shown
5. After 5-10 seconds, the zynthian UI will be shown
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 a USB keyboard, you can 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 doesn't go white in boot stage 1===
I recommend you disconnect the controller and 2in1 modules and try to boot again.
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.
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===
===The display doesn't show the Zynthian splash screen in 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.
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.
===The display is completely white===
The latest SD Gorgona Edge image is pre-configured for the new v2 Kit. As you are using a Kit v1, you should access the Webconf tool (see [[Configuration_Users_Guide]]) using your browser and change these options:
Display: PiTFT 2.8’ Resistive
Wiring Layout: PROTOTYPE-4
Style -> Font Size: 10
'''More coming soon ...'''
'''More coming soon ...'''
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].
===Electric Scheme===
===Electrical Schematic===
This is the electric scheme of a Zynthian Box, excluding soundcard and display:
This is the electrical schematic of a Zynthian Box, excluding the soundcard and display:
[[File:Zynthian_scheme_GPIO.png|800px]]
[[File:Zynthian_scheme_GPIO.png|800px]]
|-
|-
|}
|}
EDIT from music.friend: I think that actually the 2nd from left pin
of the MIDI IN socket carries the pin number 5. Pint 2 of the MIDI IN
socket is used for MIDI OUT and MIDI THHRU for shielding (Connection to GND),
while the MIDI IN socket has no direct connection to the receiver, otherwise
the Optocoupler does not really make sense.
NOTE: This is my first WIKI edit - please forgive me if i have misssed to
follow existing style or other rules.