Functions — github.com/ItKindaWorks/ESPHelper

CodeHub MCPcopy Create free account

hub / github.com/ItKindaWorks/ESPHelper / functions

Functions93 in github.com/ItKindaWorks/ESPHelper

⨍ Functions 93 ◇ Types & classes 6

↓ 8 callersMethodgetSsid

src/sharedData.h:151

↓ 7 callersMethodgetMqttHost

src/sharedData.h:148

↓ 7 callersMethodgetMqttPort

src/sharedData.h:157

↓ 7 callersMethodgetMqttUser

src/sharedData.h:149

↓ 7 callersMethodgetMqttWillMessage

src/sharedData.h:156

↓ 7 callersMethodgetMqttWillRetain

src/sharedData.h:159

↓ 7 callersMethodgetMqttWillTopic

src/sharedData.h:155

↓ 6 callersMethodgetMqttPass

src/sharedData.h:150

↓ 6 callersMethodgetMqttWillQoS

src/sharedData.h:158

↓ 6 callersMethodsetMqttHost

src/sharedData.h:135

↓ 6 callersMethodsetMqttPort

src/sharedData.h:144

↓ 6 callersMethodsetMqttWillMessage

src/sharedData.h:143

↓ 6 callersMethodsetMqttWillTopic

src/sharedData.h:142

↓ 5 callersMethodclear

@brief Clear the configuration data * * This method resets all fields in the ESPHelperConf structure to their default values. * It is useful fo

src/sharedData.h:190

↓ 5 callersMethodgetPass

src/sharedData.h:152

↓ 5 callersMethodsetMqttPass

src/sharedData.h:137

↓ 5 callersMethodsetMqttUser

src/sharedData.h:136

↓ 5 callersMethodsetMqttWillQoS

src/sharedData.h:146

↓ 5 callersMethodsetMqttWillRetain

src/sharedData.h:145

↓ 5 callersMethodsetPass

src/sharedData.h:139

↓ 5 callersMethodsetSsid

src/sharedData.h:138

↓ 4 callersMethodbegin

src/ESPHelper.cpp:182

↓ 3 callersMethodcloneTo

* @brief Clone the current configuration to another NetInfo object * * @param target The target NetInfo object to clone to * @param storeLocal

src/sharedData.h:125

↓ 3 callersMethodsetCallback

legacy funtion - here for compatibility. Sets the callback function for MQTT (see function above) input: function ptr that matches the MQTT callback

src/ESPHelper.cpp:687

↓ 3 callersMethodsetHostname

src/sharedData.h:141

↓ 2 callersMethodgetHostname

returns the current ESPHelper hostname input: NA output: char ptr containing the ESP hostname */

src/ESPHelper.cpp:1291

↓ 2 callersMethodhandle

src/ESPHelperWebConfig.cpp:103

↓ 1 callersFunctionconvert_file

(source_path, dest_path)

web_to_header.py:11

↓ 1 callersMethodend

end the instance of ESPHelper (shutdown wifi, ota, mqtt) input: NA output: NA */

src/ESPHelper.cpp:308

↓ 1 callersMethodhandlePost

If a POST request is made to URI /config

src/ESPHelperWebConfig.cpp:147

↓ 1 callersMethodhandleReset

src/ESPHelperWebConfig.cpp:233

↓ 1 callersMethodloop

main loop - should be called as often as possible - handles wifi/mqtt connection and mqtt handler input: NA output: true on: network/server connecte

src/ESPHelper.cpp:428

↓ 1 callersFunctionmain

web_to_header.py:54

↓ 1 callersFunctionpost_process_file

web_to_header.py:38

↓ 1 callersMethodsetExternalMemory

@brief Use an external ESPHelperConf object for storage * * This method allows the NetInfo instance to use an existing ESPHelperConf object * i

src/sharedData.h:111

↓ 1 callersMethodsetOtaPassword

src/sharedData.h:140

↓ 1 callersMethodsetToLocalCopy

@brief Set the NetInfo to a local copy of the provided ESPHelperConf * * This method creates a local copy of the provided ESPHelperConf object.

src/sharedData.h:208

↓ 1 callersMethodunsubscribe

manually unsubscribes from a topic (This is basically just a wrapper for the pubsubclient function) input: char ptr to topic to unsubscribe from ou

src/ESPHelper.cpp:579

MethodESPHelper

empty initializer wrapper used for creating instances of ESPHelper that will be filled in later from a loaded config file input: NA output: NA */

src/ESPHelper.cpp:66

MethodESPHelperWebConfig

src/ESPHelperWebConfig.cpp:24

* @brief Construct a new NetInfo object with local storage * */

src/sharedData.h:67

MethodOTA_begin

begin the OTA subsystem but with a check for connectivity and enabled use of OTA input: NA output: NA */

src/ESPHelper.cpp:1223

MethodOTA_disable

disable use of OTA updates input: NA output: NA */

src/ESPHelper.cpp:1237

MethodOTA_enable

enable use of OTA updates input: NA output: NA */

src/ESPHelper.cpp:1211

MethodOTA_setHostname

set the hostname of the ESP for OTA uploads input: char ptr containing the intended hostname output: NA */

src/ESPHelper.cpp:1262

MethodOTA_setHostnameWithVersion

set the hostname of the ESP for OTA uploads and append the ESPHelper version number input: char ptr containing the intended hostname output: NA */

src/ESPHelper.cpp:1275

MethodOTA_setPassword

set a password for OTA updates input: char ptr containing the OTA password to be used output: NA */

src/ESPHelper.cpp:1250

MethodaddSubscription

add a topic to the list of subscriptions and attempt to subscribe to the topic on the spot input: char ptr for a topic to subscibe to output: true

src/ESPHelper.cpp:495

src/ESPHelperWebConfig.cpp:53

MethodbroadcastMode

enables and sets up broadcast mode rather than station mode. This allows users to create a network from the ESP and upload using OTA even if there is

src/ESPHelper.cpp:367

MethoddisableBroadcast

disable broadcast mode and reset to station mode (causes a call to begin - may want to change this in the future...) input: NA output: NA */

src/ESPHelper.cpp:406

MethodfillConfig

src/ESPHelperWebConfig.cpp:99

MethodgetHostname

src/sharedData.h:154

return the local IP address of the ESP as a string input: NA output: String representing the current IP address of the ESP */

src/ESPHelper.cpp:1147

MethodgetIPAddress

return the local IP address of the ESP input: NA output: IPAddress instance representing the current IP address of the ESP */

src/ESPHelper.cpp:1165

MethodgetMQTTClient

returns internal pubsubclient ptr (use with caution) input: NA output: pubsubclient ptr */

src/ESPHelper.cpp:1303

MethodgetMQTTIP

return the current MQTT server IP input: NA output: char ptr to the current MQTT IP or Hostname */

src/ESPHelper.cpp:1041

MethodgetMQTTQOS

return the QOS level for mqtt input: NA output: int for current MQTT QOS */

src/ESPHelper.cpp:1122

MethodgetNetInfo

return the current NetInfo state input: NA output: NetInfo of the current network */

src/ESPHelper.cpp:975

MethodgetOtaPassword

src/sharedData.h:153

return the current network password input: NA output: char ptr to the current network pass */

src/ESPHelper.cpp:1014

return the current SSID input: NA output: char ptr referencing the current SSID */

src/ESPHelper.cpp:987

MethodgetStatus

get the current connection status of ESPHelper input: NA output: int for current ESPHelper connection status(refer to connStatus enum is sharedData.

src/ESPHelper.cpp:1182

MethodhandleGet

main config page that allows user to enter in configuration info

src/ESPHelperWebConfig.cpp:118

MethodhandleNotFound

src/ESPHelperWebConfig.cpp:242

initialize the NetInfo data and reset wifi. set hopping and OTA to off input: char ptr for network SSID char ptr for network Password char ptr fo

src/ESPHelper.cpp:128

MethodlistSubscriptions

DEBUG ONLY - print the subscribed topics list to the serial line input: NA output: NA */

src/ESPHelper.cpp:1195

generate unique MQTT name from MAC addr input: uint8* (array) representing the ESP mac address output: string version of that mac address # */

src/ESPHelper.cpp:958

FunctionprintNetInfo

src/ESPHelper.cpp:29

publish to a specified topic input: char ptr to topic to publish to char ptr to the payload to be published output: NA */

src/ESPHelper.cpp:592

MethodpublishJson

src/ESPHelper.cpp:612

Methodreconnect

attempts to connect to wifi & mqtt server if not connected input: NA output: NA */

src/ESPHelper.cpp:725

MethodremoveSubscription

attempts to remove a topic from the topic list input: char ptr to a topic to subscribe to output: true on: subscription removed from list (does not

src/ESPHelper.cpp:543

Methodresubscribe

loops through list of subscriptions and attempts to subscribe to all topics input: NA output: NA */

src/ESPHelper.cpp:522

@brief Safely copy a string to a destination buffer * * This method copies a string from source to destination, ensuring that the destination *

src/sharedData.h:176

MethodsetConnectionStatus

internal function used to set _connectionStatus based on the WiFi & MQTT status input: NA output: NA */

src/ESPHelper.cpp:877

MethodsetFlashReset

src/ESPHelperWebConfig.cpp:226

MethodsetMQTTBuffer

sets a new buffer size for mqtt messages in/out input: int bytes of how large the buffer should be output: true: success false: failure */

src/ESPHelper.cpp:1316

MethodsetMQTTCallback

set the callback function for MQTT input: function ptr that matches the MQTT callback function signature in pubsubclient output: NA */

src/ESPHelper.cpp:668

MethodsetMQTTIP

set a new MQTT server IP or Hostname - does not automatically disconnect from current network/server if already connected input: char ptr to a new M

src/ESPHelper.cpp:1054

MethodsetMQTTQOS

set the QOS level for mqtt input: int for MQTT QOS level output: NA */

src/ESPHelper.cpp:1135

set a new network password - does not automatically disconnect from current network if already connected input: char ptr to the new network pass to

src/ESPHelper.cpp:1028

set a new SSID - does not automatically disconnect from current network if already connected input: char ptr to the SSID to connect to output: NA */

src/ESPHelper.cpp:1001

MethodsetWifiCallback

sets a custom function to run when connection to wifi is established input: void function ptr with no params output: NA */

src/ESPHelper.cpp:700

MethodsetWifiLostCallback

sets a custom function to run when connection to wifi is lost input: void function ptr with no params output: NA */

src/ESPHelper.cpp:713

set a new MQTT Will - does not automatically disconnect from current network/server if already connected input: char ptr to MQTT will topic char pt

src/ESPHelper.cpp:1087

Methodsubscribe

subscribe to a speicifc topic (does not add to topic list) input: char ptr to a topic to subscribe to int for QOS of the subscription output: true

src/ESPHelper.cpp:472

MethodupdateNetwork

input: output: */

src/ESPHelper.cpp:922

MethoduseConfig

src/ESPHelperWebConfig.cpp:95

MethoduseSecureClient

enables the use of a secure (SSL) connection to an MQTT broker. (Make sure your mqtt port is set to one expecting a secure connection) input: char pt

src/ESPHelper.cpp:335

MethodvalidateConfig

checks which parts of a NetInfo have been filled out and updates internal flags noting which are set input: NA output: NA */

src/ESPHelper.cpp:146

Method~ESPHelperWebConfig

src/ESPHelperWebConfig.cpp:44

* @brief Destroy the Net Info object * */

src/sharedData.h:91