FlowESI GUI menu description

"File" menu

The File menu allows the user to execute the following action:

Print Design
Save Project
Save Current Design under different project name
Switch Workspace
Exit FlowESIGUI

Print

Allows the user to print current design. Clicking "Print" will bring up a print dialog.

Project Open

Allows the user to open a FlowESI GUI project that is within the current workspace.

Project Save

Saves current state of project.

Project Save As

Allows the user to save current design with different project name.

Switch Workspace

Allows the user to create or change current workspace.

"Edit" menu

The edit menu allows user to perform the following operations on the components that have been places in the design area.

Undo
Redo
Cut
Copy
Paste
Select All

"Options" menu

Under Options menu the user can:

Modify Design Area
Enable Auto connection mode

Display

Allows customizing of Design Area. The following customizations are available:

Grid Style
Background and Grid marks colors
Show/Hide connection fly lines

Auto-Connect Sensors

This options will auto connect all components available in the Design Area.

NOTE: FlowESI GUI only supports 3 LC sensor. Attempting to connect more than 3 LC sensors will pop up a error message.

"Help" menu

This menu allows the user to:

Access FlowESI GUI Help documentation
Obtain FlowESI GUI information

Topics

Displays FlowESI GUI help documentation.

About

Displays the following information:

FlowESI GUI version number
Operating System information
Java Version

Flow ESI GUI Design Area

The Flow ESI Design Area allows the user to place and connect an MSP component and up to three LC sensors. Currently the only valid connections are:

MSP Connection		LC Sensor Connection
ESICH0 - ESICH3	–>	ESICHx
ESICOM	–>	ESICOM

Modifying component connections

The connection between components can be modified by clicking on the connection and dragging the connection to the desired position.

NOTE: Rearranging components in the Design Area will modify the components connections.

Customizing the Design Area

The Design Area can be customized using the Display options under "Options" menu. The table below shows all customization available.

Customization Option	Description
Show connection fly lines	Allows you to hide/show component connections
Grid style	Allows to switch between None, Dots, and Lines
Colors	Allows to change grid and design area background color

MSP Properties

The following section describes all available configurations options under MSP Properties.

Naming the MSP component

FlowESI GUI allows you to customize the name of the each component. This name is only for identification purposes. The only requirement is that each component have a unique name.

Device Selection

This section allows you to make a device and package selection. For device package information please consult your device specific erratasheet.

ESI Config

ESI High Speed Clock

ESI High Speed Clock is sourced by ESIOSC by default.

Selecting "Auto-Calibrate ESIOSC to 4.8 MHz" will call a drvierLib ESI API which auto calibrates ESIOSC to the desired frequency.
Disabling "Auto-Calibrate ESIOSC to 4.8 MHz" will set the ESIOSC to its nominal frequency. Please refer the device specific datasheet for nominal frequency information.

ACLK configuration

ACLK must be sourced by a high precision crystal oscillator. By default it is expected that a 32768 Hz crystal is used by the application. If a different crystal frequency is used the user must provide this information.

Periodic DAC Auto calibration

Enabling DAC auto calibration allows the activates auto calibration using the analog front end (AFE2). Auto calibration can run at different intervals. The table below shows the different calibration interval options.

Auto calibration Options
Every Minute
Hourly
Every 12 hrs
Daily

Sampling Frequency

This section allows you to select the desired sampling frequency. The "angle between sensor" is automatically selected based on the number of LC sensors which are correctly connected to the MSP component. The predefined angle between sensors are related to LC Sensor configuration. The table below shows the angle between sensor for each LC Sensor configuration.

LC Sensor Configuration	Angle Between Sensors
1 LC Sensor Configuration	360 deg
2 LC Sensor Configuration	90 deg
3 LC Sensor Configuration	120 deg

Ideal sampling frequency vs Effective Sampling Frequency

Ideal sampling frequency is calculated using the following equation where $\alpha$ is the angle between sensors and $rotation_{max}$ is the maximum rotation frequency.

$sampleRate_{min} = 2*\frac{360}{\alpha}*rotation_{max}$
Effective Sampling frequency is the based on the available Time State Machine (TSM) Start Trigger ACLK Divider. The effective sampling frequency is the closest TSM Start Trigger ACLK Divider which will meet the ideal sampling frequency.

Sensor Configuration

The "Number of sensors connected" is automatically selected based on the number of LC sensors which are correctly connected to the MSP component.

TSM and PSM

Time State Machine (TSM) and Processing State Machine (PSM) are automatically generated based on your sensor configuration. The TSM and PSM tables cannot be modified. However, the tables have the following properties:

TSM table
- Table are configured to allow auto calibration of TSM delay.
PSM table
- Tables are configured to:
  - Detect clockwise rotations
  - Set bit Q7 for state transition errors
  - For 2 and 3 LC sensor configuration:
    - Set bit Q1 for clockwise rotation and Q2 for counter clockwise rotations
  - For 1 LC sensor configuration:
    - Set bit Q1 for every rotation detection.

View TSM Table

Clicking "View TSM Table" will display the TSM table used for the current LC sensor configuration.

View PSM Table

Clicking "View PSM Table" will display the PSM table used for the current LC sensor configuration.

Output Selection

This section allows you select the type of board you will use to load the code. Currently two boards are supported:

EVM430-FR6989
Custom Board. For more information on how to create a custom board file please refer to Creating a custom board file section.

Hardware Selection

Allows you to select between available board selections.

Output Options

Based on the selected board, different options are enabled. The next table provides a description for each output options.

Output Option	Description	Requirement
Toggle LED every time a rotation is detected	Toggles every time bit Q6 is set	Board must have "Rotation LED" enabled
Turn ON LED during recalibration	LED is turned ON while auto calibration routine is running	-Board must have "Calibration LED" enabled -DAC auto calibration must be enabled in "ESI Config" Tab
Display rotations on LCD	Updates LCD counter every time a complete clockwise rotation is detected	-Board must have same 24 segment LCD as EVM430-FR6989 -Enable LCD option in the board configuration file
Enable Target Communication via HID/UART communication bridge	Enabling this option allows you to perform the following actions: Start auto calibration routines, send ESI counters information, send debug information	-Board must have a HID/UART communication bridge same as EVM430-FR6989 -Enabled target communication in the board configuration file

ESI ISR Configuration

ESI Interrupt Service Routines Configuration

This section allows you to enable various ESI interrupt sources. The following table list all available interrupts and describes its source.

ESI Interrupt Service Routine Options	Interrupt Description	Default action
Handle "clockwise" rotation counter increments	Interrupt occurs every time ESICNT0 increments	If LCD is selected in "Output Selection" tab Displays ESICNT1 in LCD Otherwise: None
Handle "counter clockwise" rotation counter increments	Interrupt occurs every time ESICNT2 decrements	If LCD is selected in "Output Selection" tab Displays ESICNT1 in LCD Otherwise: None
Handle "bidirectional" rotation counter updates	Interrupt occurs every time ESICNT1 updates	If Rotational LED selected in "Output Selection" tab Toggles Rotational LED Otherwise : None
Handle rotation "errors"	Interrupt occurs every time Q7 bit is set	None
Handle "rotation detection"	Interrupt occurs every time Q6 bit is set	If LCD is selected in "Output Selection" tab Displays number of disc rotation in LCD If Rotational LED selected in "Output Selection" tab Toggles Rotational LED Otherwise: None

Code Generation

This section allows you to generate:

Full Projects:
- Code Composer Studio (CCSv6 or later)
- IAR Embedded Workbench (6.10.2 or later)
ESI configuration files only -Allows you to update ALL ESIconfig files in a CCS project. The following files will be updated:
- ESIConfig/esiCalibration.c
- ESIConfig/esiCalibration.h
- ESIConfig/esiConfig.c
- ESIConfig/esiConfig.h

IMPORTANT: If updating a project via ESI Configuration files only resulted in compilation errors. It is recommended to use the Full Project.

Output Directory

Output Directory always point to directory which contains the current FlowESI GUI project.

IMPORTANT: To update the output location you must create a new FlowESI GUI project (File –> Save As)

Generation Type

Full CCS Project

Generates a full CCS project using projecspec file. For more information on how to import, compile and load CCS project please refer to Loading and Running Generated Projects

Full IAR Project

Generates a full IAR project files (.eww, .ewp, and .ewd). For more information on how to import, compile and load IAR projects please refer to Loading and Running Generated Projects

ESI Configuration Files Only (CCS)

Using this code generation option will ask you to provide the path to the CCS project location. Once you provide the path to the CCS project location only ESI configuration will be updated.

Obtaining path to CCS Project

In CCS right-click on CCS project to be updated and select "Properties"
Click on "Resource"
CCS project location will be displayed under "Location:"

ESI Configuration Files Only (IAR)

Updated ESI Configuration files in IAR project.

Target Comm

This section allows you to control the following actions on your board via FlowESI GUI:

Start TSM and DAC auto calibration
Send counters information
Send debug information

HID/UART Bridge

Connect/Disconnect

Connects/Disconnects to HID/UART Bridge. Connecting to the HID/UART bridge will enable all "Control Panel" options.

Control Panel

The control panel allows you to control all target communication actions. This panel is only enabled after a valid HID/UART bridge communication is established. Th available actions are:

Start Calibration
Send counters info
Send Debug info

Sensor Calibration

This section allows you to track the initial calibration process. For more information regarding the calibration process please refer to Loading and Running Generated Projects section.

Time State Machine calibration

This panel provides information regarding TSM delay settings for each ESI channel. The each delay measurement is displayed in micro seconds $(\mu Sec)$ . For more information regarding the calibration process please refer to Loading and Running Generated Projects section.

Digital to Analog Converter (DAC) calibration

This panel provides information regarding initial DAC calibration. After DAC calibration process is completed this section will display the DAC values found for each ESI channel. The DAC values are in Volts (V).

ESI Counter and Rotation Information

This section is enabled by clicking on "Send counters info". This section provides transmission status, rotation direction (clockwise or counterclockwise), and ESI counters information (ESICNT0, ESICNT1, ESICNT2). In addition, the Status Log allows you to monitor HID/UART bridge status, active transmissions (e.g. transmitting counters info or debug info) and recalibration using AFE2 status.

Status

This panel will display a "Transmitting... " message while an "Send counters info" is enabled.

Rotation Direction

This panel will display a "Clockwise" or "Counter Clockwise" message while an

"Send counters info". The direction is determined based on the ESICNT information received from the target board.

ESI Counters

This panel display the current ESICNT, ESICNT1 and ESICNT2 information in the target board. The format to display the counters values is uint16_t data type.

Status Log

This panel provides the following information:

HID/UART Bridge – Connection status (connected/disconnected) – HID VID and PID information
Current transmission enabled. – Sending counter info or sending debug info.
Recalibration Status – Generates a start/end of calibration messages – Displays DAC content after recalibration

Debug Info

This panel provides basic debug information.

NOTE: In order to properly visualize debug information it is recommend that a low sampling rate is used while using this feature.

Last PSM address

This information is obtained from bit 6-0 in ESIDEBUG1 register.

Current PSM Bits

This information is obatined form bits 7-0 in ESIDEBUG2 register.

LC Sensor Properties

This panel allows you to visualize the theoretical LC Sensor Oscillation. The equation used to generate the oscillation graph is shown below.

$v(t) = 1.5*cos(\omega t)*e^{-\delta t}+1.5$

NOTE: The only purpose of the LC sensor properties is to allow users the analyze the effect of inductance, $R_{max}$ , and capacitance changes. Inductance, $R_{max}$ , and capacitance values are not use during code generation.