GUI description
The CAPSENSE™ Tuner application contains Menus,
Main toolbar
, and
Tabs toolbars
,
Widget Explorer pane
and
Widget/Sensor Parameters pane
, all used to tune a CAPSENSE™ application.
Menus
File
Open
– Opens a
<file_name>.cycapsense
configuration file. This command is visible only when running the Tuner independently from the Eclipse IDE.
Apply to Device
– Commits changed values of a widget/sensor parameter to the device. This command becomes active if a value of any configuration parameter from the Tuner application changes (that is, if the parameter values in the Tuner and the device are different). This is an indication to apply the changed parameter values to the device. For Read Only mode of the communication interfaces, this command is grayed out.
Open is System Explorer
– This opens your computer’s file explorer tool to the folder that contains the
*.cycapsense
file.
Import...
– Imports a specified configuration file.
Export...
– Exports the current configuration file into a specified file.
Export Register Map to PDF
– Exports the current configuration register map in PDF format for the latest version of the middleware available on the date of the CAPSENSE™ Tuner release.
Recent files – Shows recent files that you can open directly.
Exit
– Asks to save changes if there are any and closes the Tuner. Changes are saved to the configuration file.
Edit
Undo
– Undoes the last action or sequence of actions.
Redo
– Redoes the last undone action or sequence of undone actions.
View
Widget Explorer
– Hides or shows the Widget Explorer pane where widgets and sensors tree display.
Notice List
– Hides or shows the Notice List pane. The pane is shown by default.
Widget/Sensor Parameters
– Hides or shows the Widget/Sensor Parameters pane.
Gesture Event History
– Logs the detected gestures information. Displays in the View when any gesture is available.
Gesture
Monitor
– Provides visual indication for a detected gesture. Displays in the View when any gesture is available.
OpenOCD Log
– Hides or shows the OpenOCD Log pane.
Toolbar
– Hides or shows the Toolbar. Enabled by default.
Reset View
– Resets the view to the default.
Communication
Connect
– Connects to the device via a communication channel selected in the Tuner Communication Setup dialog. If the channel was not previously selected, the Tuner Communication dialog is shown.
Disconnect
– Closes the communication channel with the connected device.
Start
– Starts reading data from the device.
Stop
– Stops reading data from the device.
Restart
– Restarts reading data from the device.
Tools
Tuner Communication Setup…
– Opens the configuration dialog to set up a communication channel with the device.
Options…
– Opens the configuration dialog to set up Tuner preferences:
Display
,
SNR
,
Logging
,
Advanced
.
Logging
– Starts/stops data logging into a specified file.
Help
Main toolbar
Contains frequently used buttons that duplicate the main menu items:
Opens the configuration dialog to set up a communication channel with the device. The same as the
Tools > Tuner Communication Setup
menu command.
Connects to the device via a communication channel selected in the Tuner Communication Setup dialog. The same as the
Communication > Connect
menu command.
Closes the communication channel with the connected device. The same as the
Communication > Disconnect
menu command
Starts reading data from the device. The same as the
Communication > Start
menu command.
Stops reading data from the device. The same as the
Communication > Stop
menu command.
Restarts reading data from the device The same as the
Communication > Restart
menu command.
Powers on the target device.
Powers off the target device.
Opens a configuration file. The same as the
File > Open
menu command.
Commits changed values of a widget/sensor parameter to the device. The same as the
File > Apply to Device
menu command.
Commits changed values of a widget / sensor parameter to the CAPSENSE™ project. The same as the
File > Apply to Project
menu command.
Imports a specified configuration file. The same as the
File > Import
menu command.
Exports the current configuration file into a specified file. The same as the
File >Export
menu command.
Starts or stops data logging into a specified file. The same as the
Tools > Logging
menu command.
Read mode
– Selects the Tuner communication mode with a device (I2C and UART with LP).
Synchronized
– Application firmware periodically calls a corresponding Tuner function:
Cy_CapSense_RunTuner()
. The Tuner synchronizes data reading and firmware execution to preserve data coherency. CAPSENSE™ middleware waits for the Tuner read/write operation to be completed prior to execution of sensor scan and processing tasks. The Tuner does not read/write data until CAPSENSE™ middleware completes scanning and data processing tasks for all widgets in the application. The SNR and noise measurements are most accurate, and most tuning parameters can be edited in real time updating in this mode.
Asynchronized
– The Tuner reads data asynchronously with sensor scanning and data processing. Due to this, data coherency may be corrupted. So, the Tuner may read only partially updated sensor data. For example, the device completed scanning of only the first sensor in a row. At this moment, the Tuner reads data of the latest scan from the first sensor and data of previous scans from the remaining sensor. This can occur to all sensors, when the Tuner reads data prior to the completion of data processing tasks, such as baseline update and filter execution. SNR and noise measurements are less accurate due to non-coherent data reading and only a limited set of tuning parameters can be edited in real time in this mode. Asynchronized mode may work unreliably with Low Power widgets configurations when the application is mostly in Deep Sleep. The Tuner may miss the time window when the device awakes and is able to communicate with the Tuner.
Undoes the last action or sequence of actions. The same as the
Edit > Undo
menu command.
Redoes the undone action or sequence of undone actions. The same as the
Edit > Redo
menu command.
Tabs toolbars
The toolbars of the CAPSENSE™ Tuner tabs have mostly the same options:
Option | Description | Widget View tab | Graph View tab | SNR Measurement tab | Liquid Level Measurement tab | Touchpad View tab | Gesture View tab |
---|---|---|---|---|---|---|---|
Zoom in | Zooms in the widgets. Press the [ Esc ] key to undo zoom. | √ | √ | √ | |||
Zoom out | Zooms out the widgets. Press the [ Esc ] key to undo zoom. | √ | √ | √ | |||
Graph | Shows or hides the Touch Signal Graph. | √ | |||||
Save image | Opens the dialog to save the tab view as an image. To save the whole main window as an image, press and hold the [ Ctrl ] key. The supported formats: .PNG, .JPG, BMP. | √ | √ | √ | √ | √ | √ |
Number of samples | Defines the total amount of data samples shown on a single graph. | √ | |||||
Legend | Shows or hides the sensor series descriptions (with names and colors) in graphs | √ | √ | √ | |||
Clear graph/Clear | Clears all graphs. | √ | √ | √ | √ | √ | |
Spike | Highlights spikes on the graph. | √ | |||||
Opaque | The level of opacity of the area below the line series. | √ | |||||
Graph View tab toolbar ( Chart settings ) | Opens the menu for editing the chart line series parameters | √ | |||||
Reset position | Resets the image position and zoom. The image is moved to the center of the panel. | √ | |||||
Open image | Opens a custom image. | √ | |||||
Saved logged data | Saves data to a .csv file, by default to the design.lls.csv file. | √ | |||||
Load logged data | Logs data to a .csv file, by default to the design.lls.csv file. | √ |
Widget Explorer pane
The
Widget Explorer
pane contains a tree of widgets and sensors used in the CAPSENSE™ application. You can expand/collapse the Widget nodes to show/hide widget’s sensor nodes. You can check/uncheck individual widgets and sensors in the Widget Explorer pane. The widget checked status affects its visibility in the
Widget View tab
and the position graph series in the
Graph View tab
while the sensor checked status controls the visibility of the sensor raw count/baseline/signal/status graph series in the
Widget View tab
and signals in the
Touch Signal Graph
on the
Widget View tab
.
Selecting a widget or sensor in the Widget Explorer pane updates the selection in the Widget/Sensor Parameters pane.
Note:
For CSX widgets, the sensor tree displays individual nodes (Rx0_Tx0, Rx0_Tx1 …) contrary to the CAPSENSE™ Configurator where the CSX electrodes are displayed (Rx0, Rx1 … Tx0, Tx1 ...).
Note:
For ISX widgets, the sensor tree displays individual nodes (Rx0_Lx0, Rx0_Lx1 …) contrary to the CAPSENSE™ Configurator where the ISX electrodes are displayed (Rx0, Rx1 … Lx0, Lx1 ...).
Note:
For MSC HW configurations with enabled Multi-frequency mode, the Median check box in the Widget Explorer for each sensor displays a set of F0 values received from a kit in the
Graph View tab
tab.
Widget/Sensor Parameters pane
The
Widget/Sensor Parameters
pane displays the parameters of a widget or sensor selected in the Widget Explorer tree. The grid is similar to the grid on the
Widget Details
tab in the CAPSENSE™ Configurator with some exceptions. Some parameters available for modification in the CAPSENSE™ Configurator cannot be modified in the Tuner and some other minor differences. Select a parameter to see its description on the panel below the parameters list.
The
Widget/Sensor Parameters
pane includes the following groups of parameters:
Widget parameters
Widget general parameters
Cannot be modified from the CAPSENSE™ Tuner because corresponding parameter values reside in the application flash widget structures that cannot be modified at run-time.
Widget hardware parameters
Cannot be modified for the widgets with SMARTSENSE.
All
Widget hardware parameters
require hardware re-initialization. In Manual tuning mode, the availability of changing the Widget hardware parameters and
Apply to Device
command depends on the mode and communication protocol.
Protocol | I2C | UART | RTT |
---|---|---|---|
Mode | Read/Write | ||
Apply to Device | √ | √ | √ |
Widget hardware parameters | √ | √ | √ |
Mode | Read only | ||
Apply to Device | √ | ||
Widget hardware parameters | √ | √ |
Capacitive DAC parameters
Cannot be modified for the widgets with SMARTSENSE or appropriate CDAC mode set to AUTO in the CAPSENSE™ Configurator.
Scaled capacitive DAC parameters
This group of parameters is available only for the 5th generation LP devices. These parameters are read-only and applicable only for the CSD sensing method. Calculated from an actual CDAC with the scaling value.
Widget threshold parameters
Cannot be modified for widgets with SMARTSENSE– Full. In Manual tuning mode (for all widgets), the availability of changing Widget threshold parameters and
Apply to Device
command depends on the mode and communication protocol.
Protocol | I2C | UART | RTT |
---|---|---|---|
Mode | Read/Write | ||
Apply to Device | √ | √ | √ |
Widget threshold parameters | √ | √ | √ |
Mode | Read only | ||
Apply to Device | √ | ||
Widget threshold parameters | √ Note: Except ON debounce parameter (requires hardware re-initialization). | √ | √ |
Position filter parameters
,
Adaptive IIR filter parameters
,
Ballistic multiplier parameters
, and
Centroid parameters
Cannot be modified at runtime from the Tuner because, unlike the other parameters, these parameter values reside in the application flash widget structures that cannot be modified at run-time.
Sensor Parameters
Sensing parameters
When IDAC/CDAC is enabled, the parameter is read-only and displays values as calibrated by the firmware.
When the auto-calibration is disabled, the IDAC/CDAC value entered in the CAPSENSE™ Configurator displays and the parameter becomes writable in Read/Write mode.
Capacitance (fF)
When BIST is enabled in the CAPSENSE™ Configurator, the sensor/electrode capacitance is read-only, and displays values calculated by the firmware. The application code must have BIST-related function calls. When BIST is disabled, the Capacitance (fF) group is hidden
Note:
The
Position filter parameters
,
Adaptive IIR filter parameters
, and
Gesture parameters
reflect data stored in a loaded configuration file. Actual values may vary on a target device connected to the CAPSENSE™ Tuner.
Note:
For Liquid Level widgets, there is
Level filter parameters
group instead of
Position filter parameters
group.
Notice List
The
Notice List
pane combines notices (errors, warnings, tasks, and notes) from many places in the configuration into a centralized list. You can double-click a notice location to show a parameter causing the error or warning.
For more information about the Notice List, refer to the
Device Configurator user guide
.
Tabs
The CAPSENSE™ Tuner consists of the following tabs:
Widget View tab
– Displays the widgets, their touch status, and the touch signal bar graph.
Graph View tab
– Displays the sensor data charts.
SNR Measurement tab
– Provides the SNR measurement functionality.
Liquid Level Measurement tab
– Provides the liquid level measuring functionality.
Touchpad View tab
– Displays the touchpad heatmap.
Gesture View tab
– Displays the Gesture operation.