Versioning Overview
This document provides an overview of the mikroSDK v2.0 Versioning feature, available to NECTO Studio users. The mikroSDK Versioning system enables developers to retrieve and handle version information within their embedded projects. This guide serves as a reference to help developers understand how to manage dependencies and ensure compatibility across various versions of the SDK, while allowing for conditional compilation based on the SDK version.
Benefits for NECTO Studio Users
- Version Control: Retrieve and handle the version of the
mikroSDK
being used, which is crucial for ensuring backward compatibility and utilizing new features. - Conditional Compilation: Build specific features or code paths based on the SDK version, allowing optimized use of resources across versions.
- Automated Configuration: When integrating the versioning feature in NECTO Studio, most of the configurations (like CMakeLists linking) are automated.
- Compatibility Management: Manage compatibility between different versions of
mikroSDK
efficiently, helping to streamline code maintenance in multi-version environments.
mikroSDK Versioning API Files
The following files and configurations are required to use the mikroSDK Versioning feature in your NECTO Studio projects:
mikroSDK_version.h
: Provides macros and functions that allow developers to retrieve and manage the version information of the mikroSDK library.
Key mikroSDK Versioning Features
1. Version Macros
- Version Retrieval: Access predefined macros like
mikroSDK_MAJOR_VERSION
,mikroSDK_MINOR_VERSION
, andmikroSDK_PATCH_VERSION
to programmatically retrieve the SDK's version.
2. Conditional Compilation
- Version-Dependent Code: Use the version macros to conditionally compile certain parts of the code, making it easier to adapt to new features or maintain backward compatibility.
3. Easy Linking in NECTO Studio
- Library Manager Support: The mikroSDK Versioning feature is fully integrated into NECTO Studio, allowing seamless configuration and usage through the
Library Manager
.
How to Use the mikroSDK Versioning in NECTO Studio
- Make sure to check out mikroSDK's Code Examples for practical implementations of versioning logic in embedded systems!