settings.hpp

Go to the documentation of this file.

// Copyright (C) 2025 Vincent Hamp
//
// 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 <https://www.gnu.org/licenses/>.

 
#pragma once
 
#include <string>
#include <z21/z21.hpp>
#include "base.hpp"
 
namespace mem::nvs {

class Settings : public Base {
public:
  Settings() : Base{"settings", NVS_READWRITE} {}
 
  std::string getAccessPointSSID() const;
  esp_err_t setAccessPointSSID(std::string_view str);
 
  std::string getAccessPointPassword() const;
  esp_err_t setAccessPointPassword(std::string_view str);
 
  std::string getAccessPointIP() const;
  esp_err_t setAccessPointIP(std::string_view str);
 
  std::string getAccessPointNetmask() const;
  esp_err_t setAccessPointNetmask(std::string_view str);
 
  std::string getAccessPointGateway() const;
  esp_err_t setAccessPointGateway(std::string_view str);
 
  std::string getStationSSID() const;
  esp_err_t setStationSSID(std::string_view str);
 
  std::string getStationPassword() const;
  esp_err_t setStationPassword(std::string_view str);
 
  std::string getStationAlternativeSSID() const;
  esp_err_t setStationAlternativeSSID(std::string_view str);
 
  std::string getStationAlternativePassword() const;
  esp_err_t setStationAlternativePassword(std::string_view str);
 
  std::string getStationIP() const;
  esp_err_t setStationIP(std::string_view str);
 
  std::string getStationNetmask() const;
  esp_err_t setStationNetmask(std::string_view str);
 
  std::string getStationGateway() const;
  esp_err_t setStationGateway(std::string_view str);
 
  [[deprecated(
    "This method will be removed in favor of `getmDNS`.")]] std::string
  getStationmDNS() const;
  std::string getmDNS() const;
  esp_err_t setmDNS(std::string_view str);
 
  bool getDNSRedirection() const;
  esp_err_t setDNSRedirection(bool value);
 
  uint8_t getHttpReceiveTimeout() const;
  esp_err_t setHttpReceiveTimeout(uint8_t value);
 
  uint8_t getHttpTransmitTimeout() const;
  esp_err_t setHttpTransmitTimeout(uint8_t value);
 
  bool getHttpExitMessage() const;
  esp_err_t setHttpExitMessage(bool value);
 
  drv::out::track::CurrentLimit getCurrentLimit() const;
  esp_err_t setCurrentLimit(drv::out::track::CurrentLimit value);
 
  drv::out::track::CurrentLimit getCurrentLimitService() const;
  esp_err_t setCurrentLimitService(drv::out::track::CurrentLimit value);
 
  uint8_t getLedDutyCycleBug() const;
  esp_err_t setLedDutyCycleBug(uint8_t value);
 
  uint8_t getLedDutyCycleWiFi() const;
  esp_err_t setLedDutyCycleWiFi(uint8_t value);
 
  uint8_t getCurrentShortCircuitTime() const;
  esp_err_t setCurrentShortCircuitTime(uint8_t value);
 
  uint8_t getDccPreamble() const;
  esp_err_t setDccPreamble(uint8_t value);
 
  uint8_t getDccBit1Duration() const;
  esp_err_t setDccBit1Duration(uint8_t value);
 
  uint8_t getDccBit0Duration() const;
  esp_err_t setDccBit0Duration(uint8_t value);
 
  uint8_t getDccBiDiBitDuration() const;
  esp_err_t setDccBiDiBitDuration(uint8_t value);
 
  uint8_t getDccProgrammingType() const;
  esp_err_t setDccProgrammingType(uint8_t value);
 
  uint8_t getDccStartupResetPacketCount() const;
  esp_err_t setDccStartupResetPacketCount(uint8_t value);
 
  uint8_t getDccContinueResetPacketCount() const;
  esp_err_t setDccContinueResetPacketCount(uint8_t value);
 
  uint8_t getDccProgramPacketCount() const;
  esp_err_t setDccProgramPacketCount(uint8_t value);
 
  bool getDccBitVerifyTo1() const;
  esp_err_t setDccBitVerifyTo1(bool value);
 
  uint8_t getDccProgrammingAckCurrent() const;
  esp_err_t setDccProgrammingAckCurrent(uint8_t value);
 
  uint8_t getDccLocoFlags() const;
  esp_err_t setDccLocoFlags(uint8_t value);
 
  uint8_t getDccAccessoryFlags() const;
  esp_err_t setDccAccessoryFlags(uint8_t value);
 
  uint8_t getDccAccessorySwitchTime() const;
  esp_err_t setDccAccessorySwitchTime(uint8_t value);
 
  uint8_t getDccAccessoryPacketCount() const;
  esp_err_t setDccAccessorPacketCount(uint8_t value);
 
  uint8_t getExtensionFlags() const;
  esp_err_t setExtensionFlags(uint8_t value);
};
 
} // namespace mem::nvs