Getting Started Example

If you want to use the RXF and Animation libraries but have not created the Framework libraries already and Animation Libraries, please do so.

Rhapsody in C

Please verify the implementation of your compiler bridge, target bridge, and RTOS bridge, in particular the function WSTTarget_Init(). The function WSTRTOS_incrementRxfTicks() must be called peridically, so either during board initialization within startup code, or within WSTTarget_Init() you must use a Interrupt Service Routine like WSTTarget_timerInterrupt(). For Animation, you must verify the implementation of the I/O interface used for Animation.

Note

The target interface WSTTarget.c is delivered without an implementation for the system tick interrupt etc. However, you can override the default WSTTarget.c by adding a component file to your Rhapsody model. For details please read the RXFDeployerGuide.pdf and see example implementation as Rhapsody component file in OORTXAnimationDemo.rpy. You can also directly use OORTXAnimationDemo.rpy instead of Blinky.rpy in the following steps to test the target debugging sample model.

Open the Rhapsody project Blinky at the directory <your Rhapsody>\Share\WST_RXF_V5\<your product>\Samples\Model\Blinky. In order to use Animation, you must add the stereotype LiveAnimation to your Component.

TargetComponent is using the stereotype RXFComponent which is defined in the profile Mendelssohn. Each RXF by Willert Software Tools comes with its own profile with the stereotype RXFComponent. RXFComponent sets the proper environment, some properies for the RXF and defines some Tags. These Tags are used by the Deployer so it will use relative paths inside your VisualDSP++ project. The stereotype LiveAnimation adds the proper compiler constants and C code to the generated sources. The other profile referenced, WSTProfile, is used to set Rhapsody GUI details which makes it easier for you to view and maintain your models.

ExamplePkg has two objects:

LED which has an Init(), on() and off() operation
Controller which has a simple statechart which toggles the states on and off in LED every 300 msec.

Select or verify the proper environment via the Features and do this for both Configurations Debug and Release:

The Deployer which will deploy Rhapsody generated source files and some generated configuration files, needs information from your model on relative paths inside a VisualDSP++ project:

It uses Tags from the stereotype RXFComponent which have preconfigured default values. The following tags can be specifyed for your Component:

the Tag relativeGeneratedFilePath defines the path inside the VisualDSP++ project to deploy Rhapsody model generated files to
the Tag relativeRxfPath defines the path inside the VisualDSP++ project to deploy framework files to
the Tag toolchainProjectFile defines the name of the VisualDSP++ project file to update (the deployed files must be added to the project). Set it to GettingStarted.dpj
the Tag rootDescription will be is displayed in the WSTDeployer GUI. It is a short text to inform developers working on the model, to what kind of build environment the model should be deployed. It can also include a non machine dependent hint, where the VisualDSP++ project's root directory can be found.
the Tag rootTitle is also displayed in the WSTDeployer GUI. It is a short title for the VisualDSP++ project's machine specific root path.

The following tag values are assigned per default after loading the profile and assigning the RXFComponent stereotype to a component:

These values can be overridden on component level, e.g. to match the desired destination IDE project.

Note

Each Rhapsody model must have a reference to the Mendelssohn profile and use the stereotype RXFComponent.
This will allow you to use the Tags. You can set them via the Features dialog for your component. Mendelssohn.sbs is installed in <Rhapsody>\Share\WST_RXF_V5\<product>\Config\Profiles\Mendelssohn_Profile_rpy

Use Code | Generate Debug to generate C code from this model, and accept the question to have the directory created for the Debug Configuration:

Use Code | Build TargetComponent.dat to generate

the file RhapsodyRun.bat to launch the deployer later on.
the file RxfDimensions.h which is an include file which contains constants which are derived from properties set in the Rhapsody model like RIC_MAX_EVENTS, RIC_MAX_TIMEOUTS, RIC_SMALL_BUFFER_SIZE etc.
These all deal with dimensions for the RXF, and because these are inserted in an include file you do not need to set these constants in your EDE later.
the file RxfConstants.h which sets constants with respect to the version of the RXF and Rhapsody and sets _DEBUG, WST_HIGHWATERMARKS and NO_MALLOC used in a Debug configuration or Buildset.
the file WSTMemoryTypes.h which is used for Memory Section Management so you can locate code and data exact where you like it.

Now you can deploy the generated files. The model does not contain the location of your GettingStarted VisualDSP++ project on your PC; the Deployer will maintain that information instead. This enables one to have the same project used by different persons at different locations; the installation of the Analog Devices toolchain on various PCs may differ.

Deployer

The very first time that the Deployer must deploy a project, it will automatically launch in configuration mode and ask for path(s). Select Code | Run TargetComponent.dat to start the Deployer:

The Deployer will prompt for the path to your GettingStarted project, so you must specify Rhapsody\Share\WST_RXF_V5\<your product>\Samples\Code\GettingStarted:

The Deployer knows from your model (from the component's tags) that it must search for a GettingStarted.dpj project file in that directory, which it will update with the names of the files it deploys:

After you saved the path to GettingStarted, the files are deployed to the VisualDSP++ project:

VisualDSP++ IDE

In VisualDSP++ you can open the project GettingStarted, which now contains the deployed files:

Note

To use the GettingStarted sample project together with the OORTXAnimationDemo.rpy project, you need to also add adi_ssl_Init.c to your GettingStarted project.
Please don't select to use relative paths, otherwise you might need a WSTDeployerExcludedFiles.txt file in the project directory and a corrected path of the file inside the VDSP++ project.

Build or Rebuild GettingStarted:

On completion of the build process, you can use the simulator or the debugger. To verify the correct working of your model, you can set a breakpoint in LED.c in the functions LED_off() and LED_on(). To view LiveAnimation, you must launch the animation program on your PC.

When you create your own IDE project, you must add a post-build command: prepareAnimation.bat
This batchfile will generate the XML file needed by the PC animation program. The batchfile is generated in your application directory.

Note

You must add an entry in the Rhapsody Tools menu, which launces the Deployer in Configuration Mode. This allows you to change the path used by the Deployer for your VisulaDSP++ project in case you want to use a different VisualDSP++ project for your Rhapsody project, or in case you moved the VisualDSP++ project.

Note

This product is delivered with a WSTProduct.h which activates support for target debugging by defining WST_PMF_ANIMATION, WST_PMF_ANIMATIONOORTX ,WST_ADSP_BF53x_SERIAL_IO and WST_MONITORIO_BYTEBASED. If you want to compile a project without target debugging support, make sure to remove the defines from WSTProduct.h and rebuild CreateRXFLibrary and your application.