AlteriomPainlessMesh v2.1.1
Easy ESP32/ESP8266 mesh networking with Alteriom IoT extensions
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
painlessmesh::plugin::ota::State Class Reference

#include <ota.hpp>

Inheritance diagram for painlessmesh::plugin::ota::State:
Inheritance graph
[legend]
Collaboration diagram for painlessmesh::plugin::ota::State:
Collaboration graph
[legend]

Public Member Functions

 State ()
 
 State (JsonObject jsonObj)
 
 State (const Announce &ann)
 
JsonObject addTo (JsonObject &&jsonObj) const
 
size_t jsonObjectSize () const
 
- Public Member Functions inherited from painlessmesh::protocol::PackageInterface
virtual ~PackageInterface ()=default
 

Public Attributes

TSTRING md5
 
TSTRING hardware = "ESP8266"
 
TSTRING role
 
size_t noPart = 0
 
size_t partNo = 0
 
bool broadcasted = false
 
bool compressed = false
 
TSTRING ota_fn = "/ota_fw.json"
 
std::shared_ptr< Task > task
 

Detailed Description

Data related to the current state of the node update

This class is used by the OTA algorithm to keep track of both the current version of the software and the ongoing update.

The firmware md5 uniquely identifies each firmware version

Constructor & Destructor Documentation

◆ State() [1/3]

painlessmesh::plugin::ota::State::State ( )
inline

◆ State() [2/3]

painlessmesh::plugin::ota::State::State ( JsonObject  jsonObj)
inline

◆ State() [3/3]

painlessmesh::plugin::ota::State::State ( const Announce &  ann)
inline

Member Function Documentation

◆ addTo()

JsonObject painlessmesh::plugin::ota::State::addTo ( JsonObject &&  jsonObj) const
inlinevirtual

◆ jsonObjectSize()

size_t painlessmesh::plugin::ota::State::jsonObjectSize ( ) const
inlinevirtual

Member Data Documentation

◆ broadcasted

bool painlessmesh::plugin::ota::State::broadcasted = false

◆ compressed

bool painlessmesh::plugin::ota::State::compressed = false

◆ hardware

TSTRING painlessmesh::plugin::ota::State::hardware = "ESP8266"

◆ md5

TSTRING painlessmesh::plugin::ota::State::md5

◆ noPart

size_t painlessmesh::plugin::ota::State::noPart = 0

◆ ota_fn

TSTRING painlessmesh::plugin::ota::State::ota_fn = "/ota_fw.json"

◆ partNo

size_t painlessmesh::plugin::ota::State::partNo = 0

◆ role

TSTRING painlessmesh::plugin::ota::State::role

◆ task

std::shared_ptr<Task> painlessmesh::plugin::ota::State::task

The documentation for this class was generated from the following file: