mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-07 00:09:51 +03:00
114 lines
3.0 KiB
C++
114 lines
3.0 KiB
C++
/*
|
|
* uuid-common - Microcontroller common utilities
|
|
* Copyright 2019 Simon Arlott
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
// compare_flash_string added by Proddy
|
|
|
|
#ifndef UUID_COMMON_H_
|
|
#define UUID_COMMON_H_
|
|
|
|
#include <Arduino.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
/**
|
|
* Common utilities.
|
|
*
|
|
* - <a href="https://github.com/nomis/mcu-uuid-common/">Git Repository</a>
|
|
* - <a href="https://mcu-uuid-common.readthedocs.io/">Documentation</a>
|
|
*/
|
|
namespace uuid {
|
|
|
|
/**
|
|
* String compare two flash strings
|
|
*
|
|
* The flash string must be stored with appropriate alignment for
|
|
* reading it on the platform.
|
|
*
|
|
* @param[in] a Pointer to string stored in flash.
|
|
* @param[in] b Pointer to string stored in flash.
|
|
* @param[in] n optional max length
|
|
* @return 0 for match, otherwise diff
|
|
* @since 1.0.0
|
|
*/
|
|
int compare_flash_string(const __FlashStringHelper * a, const __FlashStringHelper * b);
|
|
int compare_flash_string(const __FlashStringHelper * a, const __FlashStringHelper * b, size_t n);
|
|
|
|
/**
|
|
* Read a string from flash and convert it to a std::string.
|
|
*
|
|
* The flash string must be stored with appropriate alignment for
|
|
* reading it on the platform.
|
|
*
|
|
* @param[in] flash_str Pointer to string stored in flash.
|
|
* @return A string copy of the flash string.
|
|
* @since 1.0.0
|
|
*/
|
|
std::string read_flash_string(const __FlashStringHelper * flash_str);
|
|
|
|
/**
|
|
* Append to a std::string by printing a Printable object.
|
|
*
|
|
* @param[in] printable Printable object.
|
|
* @param[in,out] output String to append to.
|
|
* @return The number of bytes that were written.
|
|
* @since 1.1.0
|
|
*/
|
|
size_t print_to_string(const Printable & printable, std::string & output);
|
|
|
|
/**
|
|
* Create a std::string from a Printable object.
|
|
*
|
|
* @param[in] printable Printable object.
|
|
* @return A string containing the printed output.
|
|
* @since 1.1.0
|
|
*/
|
|
std::string printable_to_string(const Printable & printable);
|
|
|
|
/**
|
|
* Type definition for a std::vector of flash strings.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
using flash_string_vector = std::vector<const __FlashStringHelper *>;
|
|
|
|
/**
|
|
* Loop function that must be called regularly to detect a 32-bit
|
|
* uptime overflow.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
void loop();
|
|
|
|
/**
|
|
* Get the current uptime as a 64-bit milliseconds value.
|
|
*
|
|
* @return The current uptime in milliseconds.
|
|
* @since 1.0.0
|
|
*/
|
|
uint64_t get_uptime_ms();
|
|
|
|
uint32_t get_uptime(); // added by proddy
|
|
uint32_t get_uptime_sec(); // added by proddy
|
|
|
|
void set_uptime();
|
|
|
|
} // namespace uuid
|
|
|
|
#endif
|