Since | Origin / Contributor | Maintainer | Source |
---|---|---|---|
2015-09-02 | Robert Foss | Robert Foss | enduser_setup.c |
This module provides a simple way of configuring ESP8266 chips without using a serial interface or pre-programming WiFi credentials onto the chip.
After running enduser_setup.start()
a portal like the above can be accessed through a wireless network called SetupGadget_XXXXXX. The portal is used to submit the credentials for the WiFi of the enduser.
After an IP address has been successfully obtained this module will stop as if enduser_setup.stop()
had been called.
Controls whether manual AP configuration is used.
By default the enduser_setup
module automatically configures an open access point when starting, and stops it when the device has been successfully joined to a WiFi network. If manual mode has been enabled, neither of this is done. The device must be manually configured for wifi.SOFTAP
mode prior to calling enduser_setup.start()
. Additionally, the portal is not stopped after the device has successfully joined to a WiFi network.
Most importantly, the onConfigured()
callback is not supported in manual mode. This limitation may disappear in the future.
enduser_setup.manual([on_off])
on_off
a boolean value indicating whether to use manual mode; if not given, the function only returns the current setting.The current setting, true if manual mode is enabled, false if it is not.
Starts the captive portal.
enduser_setup.start([onConfigured()], [onError(err_num, string)], [onDebug(string)])
onConfigured()
callback will be fired when an IP-address has been obtained, just before the enduser_setup module will terminate itselfonError()
callback will be fired if an error is encountered. err_num
is a number describing the error, and string
contains a description of the error.onDebug()
callback is disabled by default. It is intended to be used to find internal issues in the module. string
contains a description of what is going on.nil
enduser_setup.start(
function()
print("Connected to wifi as:" .. wifi.sta.getip())
end,
function(err, str)
print("enduser_setup: Err #" .. err .. ": " .. str)
end
);
Stops the captive portal.
enduser_setup.stop()
none
nil