Changes

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

Revision as of 13:17, 13 January 2020

236 bytes removed , 13:17, 13 January 2020

→‎Test the Controllers & UI

Line 16: Line 16:

* Zynthian Basic Kit v3 (4 x controller v3 + zynaptic circuit + ribbon bus cable)

* ZynScreen v1.4 (3.5" touch-display + controller driver)

−

* [https://www.raspberrypi.org/products/ Raspberry Pi 3 or 3+ ~~Model B~~]

+

* [https://www.raspberrypi.org/products/ Raspberry 3 Model B or B+]

* [https://www.hifiberry.com/products/dacplus HifiBerry DAC+ADC souncard]

* Case kit v3, including nuts, bolts and connectors

Line 39: Line 39:

+ '''Zynthian Webconf Tool''' ([https://github.com/zynthian/zynthian-webconf github repository])

−

All the software used by Zynthian is Free Software, and it's covered by the GPL license or similar. If you don't know what Free Software is, take a look at this link:

+

All the software used by Zynthian is Free Software (free as in ''freedom'', not as in ''free beer''), and it's covered by the GPL license or similar. If you don't know what Free Software is, take a look at this link:

[https://www.gnu.org/philosophy/free-sw.en.html What is Free Software?]

Line 76: Line 76:

===Zynthian Bundle All Kit v3===

−

A Zynthian Kit is a set of electronic parts. The ''official'' Zynthian Bundle All Kit v3 consists of specific parts:

+

A Zynthian Kit is a set of electronic and mechanic parts. The ''official'' Zynthian Bundle All Kit v3 consists of these specific parts:

+ '''4 x Controller Modules + Wiring'''

Line 110: Line 110:

===Prerequisites===

−

Assembling your Zynthian Kit V3 is not difficult at all: you need is your attention, a screwdriver, and an adjustable wrench. You don't need to solder anything, just put it together and connect the wires.

+

Assembling your Zynthian Kit V3 is not difficult at all: you need your attention, a screwdriver, and an adjustable wrench. You don't need to solder anything, just put it together and connect the wires.

Read the instructions and observe the detailed photos carefully. If you get in trouble you can ask the community:

Line 127: Line 127:

===Secure the MIDI connectors===

−

Insert each MIDI from the outside and secure them with the bolt from the inside.

+

Insert each MIDI connector, from the outside and secure them with the bolt from the inside.

[[File:IMG_2401.JPG|600px]]

Line 184: Line 184:

[[File:IMG_2410.JPG|600px]]

−

The zynaptik board has some extra circuitry which doesn't have anything soldered on it. These are used for ~~modifying~~ the board~~, and it is fully functional as it is~~.

+

The zynaptik board has some extra circuitry which doesn't have anything soldered on it. These are used for adding extra functionality to the board.

===Mount the Display===

Line 216: Line 216:

=Connecting everything=

−

The Zynthian Kit 3 is designed to use JST connectors ~~that~~ can't be plugged ~~reversed~~, so connecting everything is ~~really~~ straight-forward:

+

The Zynthian Kit 3 is designed to use JST connectors which can't be plugged in wrong, so connecting everything is straight-forward:

===Connect the Ribbon Bus cable===

−

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 Raspberry Pi's 40-pin header and to the Zynaptik module. The red wire is pin 1, so if you are looking at the case from the front, it should be on the right.

[[File:Ribbon.jpeg|600px]]

Line 237: Line 237:

[[File:MIDIConnector.JPG|600px]]

−

{{NoteBox|If you don’t connect the status LEDs, the MIDI-OUT and MIDI-THRU won’t work unless you short ~~jumpers~~ JP1 & JP2 in the zynaptik board.}}

+

{{NoteBox|If you don’t connect the status LEDs, the MIDI-OUT and MIDI-THRU won’t work unless you short the JP1 & JP2 jumpers on the zynaptik board.}}

===Connect the Audio Output Jack connectors===

−

Connect the audio output jack connectors to the audio-output header on the Hifiberry soundcard:

+

Connect the audio output jack connectors to the audio-output header to the Hifiberry soundcard:

[[File:dacplus-adc-top audio-out.jpg|600px]]

Line 256: Line 256:

====HifiBerry DAC+ADC Standard====

−

Connect the ~~audio~~ input jack connector to the audio-input header on the ~~soundcard~~ using the 3-pin Dupont connector:

+

Connect the input jack connector to the audio-input header on the sound card using the 3-pin Dupont connector:

[[File:dacplus-adc-top audio-in.jpg|600px]]

Line 266: Line 266:

−

{{WarningBox|Due to hardware problems, Hifiberry has recently changed (September 2019) [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc the specification of the DAC+ADC]. It seems that the Balanced Audio input doesn't work ~~like~~ expected ~~and~~ it works like a simple not-~~Balanced~~ input. You can read more about this subject on [https://discourse.zynthian.org/t/new-official-kit-v2-audio-input-is-here/3013/25 this forum thread].

+

{{WarningBox|Due to hardware problems, Hifiberry has recently changed (September 2019) [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc the specification of the DAC+ADC]. It seems that the Balanced Audio input doesn't work as expected. Instead it works like a simple not-balanced input. You can read more about this subject on [https://discourse.zynthian.org/t/new-official-kit-v2-audio-input-is-here/3013/25 this forum thread].

<br>

−

~~So, for taking profit~~ of the stereo connector ~~that~~ should be a mono balanced input but it'~~s not balanced at all~~, you ~~better~~ get a stereo ~~unbalanced~~ input by connecting both audio channels to the connector. The problem is that the 3-~~wires~~ Dupont connector included in official kit ~~doesn't allow to do it easily~~. You have to cut the second wire (red or white) and solder a single Dupont connector, connecting it to the pin 5 on the Hifiberry. Please, check the [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc/ Hifiberry DAC+ADC specification]}}

+

In order to take advantage of the stereo connector, which should be a mono balanced input but isn't, you can get an unbalanced stereo input by connecting both audio channels to the connector. The problem is that the 3-wire Dupont connector included in official kit. You have to cut the second wire (red or white) and solder a single Dupont connector, connecting it to the pin 5 on the Hifiberry. Please check the [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc/ Hifiberry DAC+ADC specification]}}

====HifiBerry DAC+ADC PRO====

−

Connect the ~~audio~~ input jack connector to the audio-input header on the ~~soundcard~~ using the three 1-pin Dupont connectors as indicated in the image:

+

Connect the input jack connector to the audio-input header on the sound card using the three 1-pin Dupont connectors as indicated in the image:

[[File:dacplusadcpro-top-audio-in.jpg|600px]]

−

~~In such a~~ way, you have the balanced input connected to the Right channel. If you want to use the Left channel~~, please~~, take a look to the [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc-pro Hifiberry DAC+ADC PRO specification].

+

This way you will have the balanced input connected on the Right channel. If you want to use the Left channel, take a look at the [https://www.hifiberry.com/docs/data-sheets/datasheet-dac-adc-pro Hifiberry DAC+ADC PRO specification].

===Connect the Display===

−

~~And finally,~~ connect the ribbon's 26-pin connector to the display's connector. '''~~Put~~ attention to the orientation'''. The red wire should be the pin 1 ~~that~~ as marked in the display's PCB surface.

+

connect the ribbon's 26-pin connector to the display's connector. '''Pay attention to the orientation'''. The red wire should be the pin 1, which as marked on the display's PCB surface.

[[File:Screen&Ribbon.JPG|600px]]

−

At this point, your Zynthian Box should look ~~something~~ like this:

+

At this point, your Zynthian Box should look like this:

[[File:Precierre.JPG|600px]]

−

=== Building and Testing the Official Kit V3, by Sébastien Marty ===

Line 299: Line 298:

And that's all. Your Zynthian Box is almost ready to boot. I recommend that you double-check everything before trying to boot.

−

===Double-check ~~part's assembling~~ and wiring===

+

===Double-check the parts and wiring===

−

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 (such as short circuits) 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~~.

+

Pay attention to ribbon bus connection and verify that red wire is on pin 1 for every connector. Pay attention to the audio jack connectors and make sure they are connected correctly to the Hifiberry sound card.

===First Boot===

−

When you are sure that everything is in its place, it's time to boot the machine~~, so~~:

+

When you are sure that everything is in its place, it's time to boot the machine:

−

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~~.

+

1. Insert the SD-card with the zynthian image. 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.

2. Plug the mini-usb power connector. A good 5V micro-usb charger is recommended (> 2 Amp).

Line 319: Line 318:

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, then you have assembled the Zynthian box correctly. Congratulations!

[[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 don't get an error screen or a blank screen, you probably you made a mistake during the assembly. 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:

+

If you are using the Aruk RC-3 SD image (which you should), you will notice 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".

+

* 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.

+

* Type the password (''raspberry'') and log 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.

Line 343: Line 342:

[[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.

+

If it doesn't work, 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 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.

+

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 one of the connections are 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'.

+

4. Select the ZynAddSubFX engine, select channel #1, select bank 'Collection' and preset 'Metal Drips'.

[[File:IMG_2497.JPG|600px]]

−

You should get ~~into~~ the 'Instrument Control' screen.

+

You should get to the 'Instrument Control' screen.

[[File:IMG_2500.JPG|600px]]

Line 359: Line 358:

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~~.

+

If one of the controllers doesn't work correctly, check the wiring again.

−

6. Push SELECT to move to the next controller screen. Bold push to select a controller screen from the list.

+

6. Push SELECT to move to the next controller screen. Bold push (a push lasting about 1 second) to select a controller screen from the list.

7. Push BACK. You should go back to the 'Preset Selection' screen.

Line 379: Line 378:

[[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:

+

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 enjoy it 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! ;-)~~

+

Keep pushing a single note (or a chord) and move the cutoff and resonance controllers. Play around a bit and have some fun

===Test the Audio Output===

Line 390: Line 389:

2. Boot your Zynthian. You should be in the initial 'Layer Selection' 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 track

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, check the amplifier, speakers, cabling, gain, volume, etc. If nothing works, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].

===Test the MIDI subsystem===

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 'TimGM6mb' bank. Select ~~some~~ instrument, like "Piano 1".

+

2. Boot your Zynthian, select FluidSynth engine, channel #1 and 'TimGM6mb' bank. Select an instrument, like "Piano 1".

−

3. You could add more layers ~~for completing~~ the band ~~;-)~~

+

3. You could add more layers to complete 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 down for more than 2 seconds. You should get to the 'Admin' screen.

−

4. Select 'MIDI Test' option and push 'SELECT'. You should hear the test midi-track ('Take Five') interpreted by your Zynthian's band ~~;-)~~

+

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

Line 409: Line 408:

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 an instrument

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. If you don't like it, ~~probably~~ you should take some piano lessons, ~~same as~~ me ~~;-)~~

+

3. After 2-3 seconds , play something with your keyboard. A simple ''Chopin's Nocturni'' should be enough. You should hear your music. If you don't like it, you should probably take some piano lessons, like me.

If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].

Line 420: Line 419:

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.

−

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. A single melody can do the trick.

If this doesn't work, you have to [[#Locating_and_Solving_problems|locate and solve the problem(s)]].

Line 426: Line 425:

=Final steps=

−

Once everything is in its place and you have tested that it works, it's time to close the case ~~...~~

+

Once everything is in its place and you have tested that it works, it's time to 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. The ribbon bus cable is pre-~~bended for easing~~ this process.

+

Take your time to bend and push the cables to get a good fit when closing the case. The ribbon bus cable is pre-bent to make this process easier.

Line 436: Line 435: −

Finally, ~~screw-drive~~ the 8 sheet-~~threader~~ bolts ~~for securing~~ the case, 4 each side.

+

Finally, fasten the 8 sheet-threaded bolts to secure the case, 4 on each side.

Line 443: Line 442:

=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 making the controllers are working, is update the software:

- connect your Zynthian Box to your router using an ethernet cable

Line 449: Line 448:

- 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 an 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.

Line 457: Line 456:

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 an USB keyboard, you ~~could~~ login into the system and get extra information, inspect the logs, etc.

+

For finding and solving problems, I really recommend connecting a HDMI display to the Raspberry Pi. This will show you all information during the boot process. If you connect a USB keyboard to the Pi, you can 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.

+

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 boot sequence, then you should re-flash 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 hardware seems to be configured incorrectly. 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 made 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===

Line 477: Line 476:

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 so others can see how you solved the problem

=Technical Reference=

−

Finally, i have included ~~here~~ some detailed ~~schemes~~. People hacking the standard Zynthian design would find it very useful. ~~Also, if~~ you have ~~some~~ problem and need to "debug", you ~~would~~ find it useful too.

+

Finally, I have included some detailed schematics. People hacking the standard Zynthian design would find it very useful. If you have a problem and need to "debug", you could find it useful too.

[[File:Zynthian_controller_single2_smd.svg|600px]]

Jofemodo

Bureaucrats, Interface administrators, Suppressors, Administrators

2,705

edits

Changes

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

Revision as of 13:17, 13 January 2020

Navigation menu

Search