firmware_update.h

Go to the documentation of this file.

/*
 * Copyright Paul Reimer, 2018
 *
 * This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 Unported License.
 * To view a copy of this license, visit
 * https://creativecommons.org/licenses/by-nc-sa/4.0/
 * or send a letter to
 * Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
 */

#pragma once

#include <experimental/string_view>
#include <array>

#include "firmware_update_generated.h"

#include "esp_partition.h"
#include "esp_ota_ops.h"

namespace FirmwareUpdate {

using MD5Sum = std::array<uint8_t, 16>;
using FirmwareVersion = uint64_t;

auto get_current_partition()
  -> const esp_partition_t*;

auto get_next_ota_partition()
  -> const esp_partition_t*;

auto get_factory_partition()
  -> const esp_partition_t*;

auto compare_partitions(const esp_partition_t* lhs, const esp_partition_t* rhs)
  -> bool;

auto factory_reset()
  -> void;

auto reboot()
  -> void;

auto get_current_firmware_version()
  -> FirmwareVersion;

auto checksum_partition_md5(
  const esp_partition_t* partition,
  const size_t partition_size
) -> MD5Sum;

auto checksum_file_md5(
  const std::experimental::string_view path
) -> MD5Sum;

auto get_md5sum_hex_str(const MD5Sum& md5sum)
  -> std::string;

} // namespace FirmwareUpdate