redhawksdr.org Home

REDHAWK Manual - 3.0.1

Introduction

Introduction

Process Management and Interaction

Basic Sandbox Example

Basic IDE Example

Further Reading

Install

Install from RPMs

Install from Source

External Dependencies

Yum Repository

C++

Java and JacORB

Python

IDE (DEPRECATED)

Troubleshooting

Components

Components

REDHAWK Core Assets

Creating a Component Project

Creating Octave Components

Running a Component

Sandbox

A Hello World Component

Component Structure

Component Structure

Generated Component Files

Generated Component Methods

Base Component Members

Component Implementations

Java Version

Managing Properties

Events

Shared Libraries

Shared Libraries

Creating a REDHAWK Shared Library Project

Using a REDHAWK Shared Library Project

Packaging Shared Libraries

Manually Including External Libraries

Connections

Connections

The Connection Process

Why Ports?

Port Access

Dynamic Connections

Standardized Data Interfaces

Bulkio

BulkIO

Stream API

Signal Related Information (SRI)

Attachable Streams

pushPacket Data Flow

Bit Data

Multi-out Ports

Working with Complex Data

Time Stamps

Port Statistics

Examples

Burstio

BurstIO

Data Transfers

Burst Signal Related Information (SRI)

Multi-out Ports

Working with Complex Data

Time Stamps

Port Statistics

Messaging

Messaging

Message Producer

Message Consumer

Viewing Messages

Connecting Producers and Consumers

Connection Callbacks

Custom IDL Interfaces

Creating Connections between Components in FPGA

Waveforms

Waveforms

Waveform Editor

Create and Deploy a Sample Waveform

Waveform Deployment and Computing Resources

Services

Services

Devices

Devices

FrontEnd Interfaces

Interacting with Hardware

Device Interaction with Hardware

Creating a FrontEnd Interfaces Device

Interacting with an FEI Device with the Python Package

Using an FEI Device in the IDE

Associating a Waveform with an FEI Device

Using Devices to Run Components

Using Devices to Interface with FPGAs

Functions and Data Structures Provided by the FrontEnd Interfaces Library and Code Generators

Miscellaneous FrontEnd Tuner Library Implementation Details

Persona Device Pattern

Nodes

Nodes

Running a Node

Creating a New Node

Distributed Computing and RF Devices

Customizing Resources per GPP

Shared Address

Shared Address

Component Model Overview

Examples

Shared Memory

Shared Memory

Shared Memory IPC

Metrics

Tuning

Sandbox

Sandbox

Python

Python Sandbox

Working with Components, Devices, and Services

Helpers

Devices

Example Sandbox Interaction

Built-in Sources and Sinks

Working with SDDS Data

Plotting Data

Miscellaneous

IDE DEPRECATED

IDE Sandbox (DEPRECATED)

Runtime Environment

Runtime Environment

Launching a Domain

Domain Manager

File System

Applications

The Application Factory

The Device Manager

The Allocation Manager

The Connection Manager

Events

Runtime Environment Inspection

Logging

Logging

Logging Structure

Configuring Logger Settings

Adjusting Logging at Runtime

Logging Within A Resource

Viewing Logging Events

Logging Configuration Plugin

Containers

Containers

Use in Python Sandbox

Use in a Domain

Plugin Class

Docker REDHAWK Components

IDE DEPRECATED

IDE(DEPRECATED)

Launching the REDHAWK IDE for the First Time

PyDev Overview

The Workbench

Editors and Views

Editors and Views

SoftPkg Editor

Waveform Editor

Node Editor

NeXtMidas Plot Editor

REDHAWK Explorer View

REDHAWK Plot View

Plot Settings Dialog

Event Viewer View

Data List and Statistics Views

Port Monitor View

SRI View

Console View

Properties View

Creating REDHAWK Projects

Adding/Changing/Removing REDHAWK Project Namespaces

Debugging REDHAWK Components and Devices with Eclipse

Deploying Projects to the SDRROOT

Snapshot Tool

Connect Wizard

Using the Octave Wizard

Plot Port Wizard

SDRROOT in the IDE

Exploring Domain

Running Domain in the IDE

Connecting to a Domain

Viewing the Contents of the Domain in the REDHAWK Explorer View

Working with Waveforms on a Running Domain

Plotting BulkIO Ports

Increasing the Bandwidth of BulkIO Connections

Getting Details About Error Conditions

Appendices

Optimization

Share Projects With Others

Troubleshoot Connections

Troubleshoot omniNames and omniEvents

Glossary

Acronyms

Launching the REDHAWK IDE for the First Time

Launching the REDHAWK IDE for the First Time

This section describes the basic process for starting the REDHAWK IDE for the first time.

NOTE
Before starting the REDHAWK IDE for the first time, the REDHAWK Core Framework (CF) and the IDE must be Installed.

Start the REDHAWK IDE by entering the following command:

rhide

At startup, the IDE may prompt for a workspace location. The workspace stores many of the IDE's settings and also acts as a logical collection of projects under development. The IDE creates new projects in the workspace by default.

WARNING
If you upgraded from 1.8.x, 1.9.x, or 1.10.x, it is recommended that you use a different workspace location rather than reusing a previous version's workspace. If you set the workspace to the same workspace that you used in 1.8.x, 1.9.x, or 1.10.x, you must delete the domain from REDHAWK Explorer before launching the domain from Target SDR.