Skip to content

Commit

Permalink
Added version define
Browse files Browse the repository at this point in the history
  • Loading branch information
lewisxhe committed Dec 12, 2024
1 parent 0c829b2 commit 09cc44d
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/SensorLib.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
#include <string.h>
#endif

#include "SensorLib_Version.h"

#ifdef ARDUINO_ARCH_MBED
// Not supported at the moment
#error The Arduino RP2040 MBED board package is not supported when PIO is used. Use the community package by Earle Philhower.
Expand Down
56 changes: 56 additions & 0 deletions src/SensorLib_Version.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/**
*
* @license MIT License
*
* Copyright (c) 2024 lewis he
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @file SensorLib_Version.h
* @author Lewis He ([email protected])
* @date 2024-12-12
*
*/

#pragma once

/** Major version number (X.x.x) */
#define SENSORLIB_VERSION_MAJOR 0
/** Minor version number (x.X.x) */
#define SENSORLIB_VERSION_MINOR 2
/** Patch version number (x.x.X) */
#define SENSORLIB_VERSION_PATCH 4

/**
* Macro to convert SENSORLIB version number into an integer
*
* To be used in comparisons, such as SENSORLIB_VERSION >= SENSORLIB_VERSION_VAL(2, 0, 0)
*/
#define SENSORLIB_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch))

/**
* Current SENSORLIB version, as an integer
*
* To be used in comparisons, such as SENSORLIB_VERSION >= SENSORLIB_VERSION_VAL(2, 0, 0)
*/
#define SENSORLIB_VERSION SENSORLIB_VERSION_VAL(SENSORLIB_VERSION_MAJOR, \
SENSORLIB_VERSION_MINOR, \
SENSORLIB_VERSION_PATCH)

#define SENSORLIB_VERSION_STR "v0.2.4"

0 comments on commit 09cc44d

Please sign in to comment.