Differences

This shows you the differences between two versions of the page.

--- resources:tools-software:sharc-audio-module:advanced-audio-projects:prerequisites [24 Oct 2022 17:15] – Add name for CCES Link Rebecca Butler
+++ resources:tools-software:sharc-audio-module:advanced-audio-projects:prerequisites [22 Feb 2024 21:51] (current) – Minor updates. Rebecca Butler
@@ Line 1: / Line 1: @@
 ====== Sharc Audio Module - Prerequisites ======
-//The following items below list the hardware and software prerequisites needed to setup and run the Sharc Audio Module with the sam-audio-starter software package.//
+//The following items below list the hardware and software prerequisites needed to setup and run the Audio Starter Projects. Verify hardware and software compatibility requirements here: [[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-a|Hardware-Software Compatibility]]!//
 ===== Hardware Prerequisites =====
+//Choose the setup and needs based on desired example.//
+==== Basic Analog Audio Only ====
   * Windows PC or laptop computer
   * [[adi>ice1000|ICE-1000/ICE-2000 JTAG Emulator]]
-  * [[:resources:tools-software:sharc-audio-module:hardware:main-board|SHARC Audio Module]]
+  * [[:resources:tools-software:sharc-audio-module:hardware:main-board|ADZS-SC589-MINI]] //or// [[adi>en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/eval-adsp-sc584.html|ADZS-SC584-EZLITE]] //or// [[adi>en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/ev-sc594-som.html#eb-overview|EV-SC594-SOM]] plus [[adi>en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/ev-somcrr-ezkit.html|Carrier]]
   * [[https://www.amazon.com/Wireless-Speakers-Leadsound-Portable-computer/dp/B01HB18IZ4?source=ps-sl-shoppingads-lpcontext&ref_=fplfs&smid=AHMAYDZNJIWS6&th=1 | Portable speaker with 3.5mm Aux Jack]] or equivalent
   * [[https://www.amazon.com/Sabrent-Plated-Premium-Auxiliary-CB-AUX5/dp/B01277P0CG/ref=sr_1_3?crid=1UF9AE07JP2YC&keywords=3.5mm+stereo+cable+male+to+male+sabrent&qid=1666283694&qu=eyJxc2MiOiIwLjc4IiwicXNhIjoiMC4wMCIsInFzcCI6IjAuMDAifQ%3D%3D&sprefix=3.5mm+stereo+cable+male+to+male+sabrent%2Caps%2C113&sr=8-3|3.5MM Stereo Audio Cable]] or equivalent
+  * [[https://www.amazon.com/AmazonBasics-3-5mm-2-Male-Adapter-Stereo/dp/B01D5H8JW0?th=1|RCA to 3.5mm cable]]
+==== Ethernet Audio ====
+//Note that this requires the Networking versions of the Audio Starter software to run! By default, the software that will be downloaded/cloned as per the upcoming instructions will be NOT be the Networking software. If you want to run the Ethernet examples, be sure to grab the Networking branch for your specific project (not all projects support Networking). [[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-a#software_compatibility | See our software list here!]]//
+  * Windows PC or laptop computer
+  * [[adi>ice1000|ICE-1000/ICE-2000 JTAG Emulator]]
+  * [[:resources:tools-software:sharc-audio-module:hardware:main-board|ADZS-SC589-MINI]] //or// [[adi>en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/eval-adsp-sc584.html|ADZS-SC584-EZLITE]]
+  * [[https://www.amazon.com/Mediabridge-Ethernet-Cable-Feet-31-399-10X/dp/B003O973OA/ref=pd_bxgy_vft_none_img_sccl_2/137-4526917-0523426?pd_rd_w=3uGzb&content-id=amzn1.sym.26a5c67f-1a30-486b-bb90-b523ad38d5a0&pf_rd_p=26a5c67f-1a30-486b-bb90-b523ad38d5a0&pf_rd_r=XRSRR6S3PTDYRE3MM6V1&pd_rd_wg=aQXAF&pd_rd_r=cc85d224-3a33-499c-815d-389d76ded4d2&pd_rd_i=B003O973OA&psc=1|Ethernet Cable x 2]]
+  * [[https://www.amazon.com/TP-LINK-TL-SG105E-5-Port-Gigabit-Version/dp/B00N0OHEMA?pd_rd_w=fKCOS&content-id=amzn1.sym.724fac2e-0491-4f7a-a10d-2221f9a8bc9a&pf_rd_p=724fac2e-0491-4f7a-a10d-2221f9a8bc9a&pf_rd_r=FSPJ47F190XTS4JHG4FB&pd_rd_wg=am33y&pd_rd_r=7f216575-ecce-4c08-824b-d9c92ab1df2c&pd_rd_i=B00N0OHEMA&ref_=pd_bap_d_grid_rp_0_1_ec_t&th=1 | Ethernet Switch]]
 ----
@@ Line 20: / Line 33: @@
   - [[https://gitforwindows.org/|Git for Windows]]
   - [[adi>en/design-center/evaluation-hardware-and-software/software/adswt-cces.html | CrossCore Embedded Studio]]
-  - Software Package with SAM Audio Starter
+  - Software Package with bootloader/pre-built LDRs.
-  - Preferred Serial Terminal Program such as [[https://osdn.net/projects/ttssh2/releases/|TeraTerm]]
+  - Software Package with Audio Starter
-\\
+  - Your Preferred Serial Terminal Program such as [[https://osdn.net/projects/ttssh2/releases/|TeraTerm]]
+  - If running the Ethernet Audio example - your preferred VBAN audio player such as Voicemeeter Standard
 ==== Install GIT For Windows ====
-//Git is a version control system/tool used for source code management. For this tutorial, we will be using the   command-line interface (Git bash) for compiling the sam-audio-starter project since it contains some extra open   source tools needed for compilation.//
+//Git for Windows is a build environment that includes various tools for version control, compilation, etc. In this project we are using Git for Windows to access Git, which is a version control system/tool used for source code management. Additionally, Git for Windows comes with a set of unix-like tools such as Git bash which we will use to access makefile tools. For this tutorial, we will be using the command-line interface (Git bash) for compiling the Audio Starter projects since it contains some extra open source tools needed for compilation.//
 | 1. Download Git for Windows: https://gitforwindows.org/ | |
@@ Line 40: / Line 55: @@
 ----
-==== Clone Repository/Download Software ====
+==== Download Bootloader Software ====
-//The sam-audio-starter contains all of the source code and some additional setup scripts that allows you to compile, flash and run the application. A public version is located in Analog Device's public github: [[repo>sharc-reusable-components.git]]//
+//Some of the Audio Starter projects require a bootloader to be flashed first. This section only applies to software running on the ADZS-SC589-MINI! **Skip this step if it doesn't apply to you!** This allows the use of the SAM flasher tool to make application updates. Software can be found here:[[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-a|Hardware-Software Compatibility]].//
+| 1. The software package can be downloaded directly (Be sure to unzip after download). | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:downloadzip.png?600 |}}|
+| 2. Keep track of where this project is unzipped as it will be referenced later as <BOOTLOADER_PROJECT_ROOT> | |
+----
+==== Clone Repository/Download Application Software ====
+//The Audio Starter projects contain all of the source code and some additional setup scripts that allows you to compile, flash and run the application. Software can be found here:[[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-a|Hardware-Software Compatibility]].//
+//If you don't want to use the command-line to clone the software and prefer to download a zip instead, skip to step 5 in this table!//
 | 1. Open the Git Bash application | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:gitclone1.png |}} |
 | 2. Change your directory to your preferred cloning location |{{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:changedirectory.png |}} |
-| 3. Clone the repository by running the command\\ \\ //git clone// %%https://github.com/analogdevicesinc/sharc-reusable-components.git%%| {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:clone1.png |}}|
+| 3. Clone the repository by running the command\\ \\ //git clone <Repository>//\\ \\ Where <Repository> can be acquired from the Hardware-Software Compatibility matrix| {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:clone1.png |}}|
-| 4. Note that by default the cloning action will create the default folder named //sharc-reusable-components// and will clone the default branch //1.0.0-Github//. A specific branch can be specified by using the //--branch <branch_name>//, alternatively. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:clone2.png |}}|
+| 4. Note that by default the cloning action will create the default folder named the same as the repository and will clone the default branch //2.0.0-Github//. A specific branch can be specified by using the //--branch <branch_name>//, alternatively. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:clone2.png |}}|
 | 5. Alternatively, the software package can be downloaded directly instead of being cloned (Be sure to unzip after download). | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:alternateclone.png |}}|
+| 6. Keep track of where the application was cloned or downloaded as it will be referred to later as <project_root> | |
-==== Install Preferred Serial Terminal Program ====
+----
+==== Install Your Preferred Serial Terminal Program ====
 //A serial terminal program, such as [[https://osdn.net/projects/ttssh2/releases/|TeraTerm]] or [[https://www.putty.org/|Putty]] is required for serial communication with the SAM. Download and install your preferred tool. This tutorial will use TeraTerm. \\ \\ Note that some parts of the SAM program use [[wp>XMODEM]]. Be sure to select a terminal with XMODEM capability if you will be using this part of the SAM program.//
 ----
+==== Install Your Preferred VBAN Audio Program ====
+//A VBAN audio streaming device is required to pass audio over Ethernet/UDP to the hardware. Follow any instructions for your VBAN audio program for installation. Please refer to any licensing rules for use.//
+----
+<note important>Having trouble? Check out our list of [[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-b|common issues]]!</note>
+----
 {{navigation Advanced Audio Projects#.|Advanced Audio Projects#.|Advanced Audio Projects#.environment_setup|Environment Setup and Compilation}}

Wiki

Analog Devices Wiki

Differences

Analog Devices Wiki

Differences

Page Tools