/SCWifiConnector

A library to configure the ESP8266 wifi network using an Android application in the same way Google do with Chromecast.

Primary LanguageJavaApache License 2.0Apache-2.0

SCWifiConnector

A library to configure the ESP8266 wifi network using an Android application in the same way Google do with Chromecast.

This works with the ESP8266 Arduino platform

https://github.com/esp8266/Arduino

What this library do ?

  • the library attempt to connect to the given target network.
  • if it timeout, the library start a network (called connector network) and wait until it receive new credential via udp packet.
  • the library support 3 type of message in upd packet : "ssid:(ssid of target network)", "pass:(passphrase of target network)" and "request:(custom value)".
  • this library doesn't save the credential; it's up to you to save it in the connection callback. See exemple.
  • this library doesn't restart connector network when the target network is lost. (future improvement)

Install

For ESP8266

You can install through the Arduino Library Manager or copie/paste files under arduino/src/ folders.

For Android

You can compile and install the demo application or download it on Google play:

Get it on Google Play

Parameter

For ESP8266

setConnectorSSID(ssid, passPhrase)

This is the network create by library to wait credential of target network. The default value is : SSID = "esp8226_wificonnector_network" PassPhrase = "wificonnector_1234"

setHidden(isHidden)

Whatever the conenctor network is hidden. Default value True.

setConnectorIpAndPort(ipBroadCast, port)

The ip and port the library will waiting for UDP packet. Default is 192.168.1.1 port 4120.

setTargetSSID(SSID, passPhrase)

The credential to connect to the target network. See NetworkConfig struct in the example projet.

setTimeOut(timeout)

The time that the library attenmpt to connect to the target network. After this delay, the ConnectionFailureCallback will be call.

setConnectionCallback()

Called when a connection to the target network is make. You should save the credential. See example projet.

setConnectionFailureCallback()

Called when no connection is make with the target network.

setDeviceIdenfiticationRequestCallback()

Call when the Android application send identification request. The ESP8266 should be blink a led to physically identify itself.

Glossary

Connector network

The wifi network create by the library in order to configure target network (receive target network credential)

Target network

The network on which the user want his ESP8266 connect.