Home » Mobile App » Mobile App and Firmware Version Compatibility
- Overview
- Key Concepts and Terminology
- Scope
- Offline Configuration Management - General Capabilities
- Offline Configuration Management - Version Tagging
- Version Compatibility Scenario 1: Newer Mobile App vs. Older Offline Configuration
- Version Compatibility Scenario 2: VFD with Same Firmware Version (Online)
- Version Compatibility Scenario 3: VFD on Older Firmware (Online)
- Version Compatibility Scenario 4: VFD Upgraded (VFD Newer than Local Config, App Compatible)
- Version Compatibility Scenario 5: VFD Reverted to Older Version
- Version Compatibility Scenario 6: VFD Newer Than Mobile App ⚠️
- Feature Visibility
- Summary Matrix
- Best Practices
Overview
This guide explains how the Clean Power VFD Mobile App and VFD firmware interact across different versions, how configurations are managed, and what operations are permitted when version mismatches occur.
Key Concepts and Terminology
Before diving into version compatibility scenarios, it's important to understand the following terms and concepts that will be used throughout this guide:
- Firmware
The embedded software permanently installed on the VFD hardware. Firmware determines what features and parameters the VFD supports. Firmware can be upgraded to add new capabilities or reverted to previous versions if needed.
- Mobile App (Clean Power VFD Mobile App)
The smartphone application used to configure, monitor, and manage VFD settings. The app runs on your mobile device and communicates with VFDs when connected.
- Configuration
A complete set of parameters and settings that define how a VFD operates. This includes motor specifications, control modes, protection settings, and other operational parameters that you define for your specific application.
- Offline Mode
- Operating the mobile app without being connected to a physical VFD. In offline mode, you can:
- Create new configurations
- Edit existing saved configurations
- View and manage locally stored configuration files
- All work is done locally on your mobile device, and no data is exchanged with a physical VFD.
- Online Mode
- Operating the mobile app while paired/connected to a physical VFD. In online mode, you can:
- View the current configuration stored in the VFD
- Compare your local configuration with the VFD's configuration
- Transfer (write) your local configuration to the VFD
- Import (read) the VFD's configuration to your mobile device
- This mode requires an active connection between your mobile device and the VFD.
Scope
This compatibility information applies to:
- Local configurations saved in the Clean Power VFD Mobile App (offline drives)
- Online configurations when the app is paired with a physical Clean Power VFD
- Version scenarios where VFD firmware is older than, equal to, newer than, or reverted from the app version
Offline Configuration Management - General Capabilities
The Clean Power VFD Mobile App supports full offline operation. You can:
- Create new configurations offline
- Edit any locally saved configuration offline
- Save configurations locally without VFD connection
Offline Configuration Management - Version Tagging
Each offline configuration is associated with a specific firmware profile:
- Version Association: Configurations are stored with the target firmware version against which they were created
- Persistence: Configurations remain fully viewable, editable, and saveable even after app updates
- Version Stability: The app does not automatically change the target firmware version of existing offline configurations
Note: Effective behavior when connecting to a VFD depends on the version relationship described in the scenarios below.
Version Compatibility Scenario 1: Newer Mobile App vs. Older Offline Configuration
Situation: A configuration was created with an older app/firmware profile. The mobile app has been updated (supporting new features), but the configuration remains offline.
Capabilities:
- Open and view the existing offline configuration
- Edit parameters belonging to the original firmware version profile
- Save the configuration locally
Behavior of the new parameters :
- Parameters introduced in newer firmware/app versions are not automatically injected into older configurations
- The app will not show the new fields until the related VFD is upgraded and the mobile is connected.
This way, we provides a clean experience to older version and it is not "spamming" with unavailable features for the related older version
- Configuration migration occurs only when linked to a physical VFD (see subsequent scenarios)
Version Compatibility Scenario 2: VFD with Same Firmware Version (Online)
Situation: The app version is compatible, and the connected VFD runs the same firmware version as the local configuration.
Capabilities:
Viewing:
- View VFD configuration
- Compare local saved configuration vs. VFD configuration
- Mismatches are clearly indicated
Configuration Management:
- Keep local configuration as-is
- Import VFD configuration and overwrite local version
- Edit local configuration
- Transfer local configuration to connected VFD
Feedback: Users are informed whether configuration transfers succeed or fail.
Note: This behavior also applies when the local configuration was created on the same version as the VFD, even if both are older than the current app version.
Version Compatibility Scenario 3: VFD on Older Firmware (Online)
Situation: The local configuration or app supports newer parameters, but the connected VFD runs older firmware.
Capabilities:
Viewing:
- View VFD's configuration (older version)
- See mismatches between local and VFD configurations
Parameter Handling:
- Parameters not supported by older VFD firmware are excluded from transfer
- Configuration is automatically constrained to VFD-supported parameters
Configuration Management:
- Edit configuration within constraints of VFD's supported parameters
- Save adjusted configuration
- Transfer compatible configuration to VFD
Protection: The app prevents unsupported parameters from being written to the VFD, protecting system integrity.
Feedback: Users are informed whether transfers succeed or fail.
Version Compatibility Scenario 4: VFD Upgraded (VFD Newer than Local Config, App Compatible)
Situation: The local configuration was created for older firmware, but the connected VFD has been upgraded. The mobile app version is compatible with the newer VFD firmware.
Automatic Migration:
- The app automatically migrates the local configuration
- Existing parameters are mapped to their equivalents in the new version where applicable
Capabilities:
Viewing:
- View configuration mismatches between migrated local configuration and upgraded VFD
- New parameters introduced in upgraded firmware appear as mismatches or unconfigured items
Configuration Management:
- Edit migrated local configuration (including new parameters)
- Save updated configuration
- Transfer configuration to upgraded VFD
Feedback: Users are informed whether transfers succeed or fail.
Benefit: Older offline configurations remain usable. The app assists with migration rather than requiring recreation from scratch
Version Compatibility Scenario 5: VFD Reverted to Older Version
Situation: A VFD previously running newer firmware has been reverted to an older version.
Parameter Handling:
- Parameters exclusive to newer firmware are automatically ignored
- Only parameters valid for the reverted firmware version are considered
Capabilities:
Viewing:
- View VFD configuration on reverted version
- See mismatches between VFD configuration and the compatible subset of local configuration
Configuration Management:
- Edit configuration constrained to reverted VFD's supported parameters
- Save version-compatible configuration
- Transfer compatible configuration to VFD
Protection: The app enforces the reverted firmware's capability set, preventing unsupported settings from being written.
Feedback: Users are informed whether transfers succeed or fail.
Version Compatibility Scenario 6: VFD Newer Than Mobile App ⚠️
Situation: The mobile app version is older than the connected VFD firmware.
Warning:
- Users are informed that VFD firmware is more recent than the mobile app
- Users are notified that the latest mobile app version is required for safe configuration
- User acknowledgment is required
Restrictions:
- Transfer of older local configurations to the newer VFD is blocked
- No full configuration write is permitted until app is updated
Protection: This prevents incompatible settings from being pushed to a drive with capabilities the app does not understand.
Feature Visibility
To prevent confusion when searching for new functionality:
A feature is visible and configurable only when all of the following conditions are met:
- The mobile app version supports the feature
- The VFD firmware version supports the feature
- The scenario complies with compatibility rules (no "VFD newer than app" block)
Unavailable Features:
When conditions are not met, features are either:
- Hidden from the user interface, or
- Presented as unsupported/unavailable according to compatibility logic
Summary Matrix
| Scenario | View Config | Edit Config | Transfer to VFD | Notes |
|---|---|---|---|---|
| Offline (any version) | ✓ | ✓ | — | Full offline support |
| Same firmware version | ✓ | ✓ | ✓ | Full compatibility |
| VFD older than config | ✓ | ✓ (constrained) | ✓ (subset) | Unsupported parameters excluded |
| VFD upgraded | ✓ | ✓ | ✓ | Automatic migration assisted |
| VFD reverted | ✓ | ✓ (constrained) | ✓ (subset) | Newer parameters ignored |
| VFD newer than app | ✓ | ✗ | ✗ | Blocked until app updated |
Best Practices
- Keep App Updated: Always use the latest mobile app version to access new features and ensure compatibility
- Version Awareness: Check firmware and app versions before configuration transfers
- Configuration Backup: Maintain local copies of configurations before major firmware upgrades
- Review After Upgrade: When VFD firmware is upgraded, review new parameters and update configurations accordingly
- Test Transfers: Verify configuration transfer success through the app's feedback system