Ks0354 Keyestudio ESP8266 WI-FI Development Board: Difference between revisions

From Keyestudio Wiki
Jump to navigation Jump to search
No edit summary
Line 43: Line 43:


<br>
<br>
==Detailed Using Method as follows==
==Detailed Using Methods are as follows==


===Step1| Install the Arduino IDE===
===Step1| Install the Arduino IDE===
Line 369: Line 369:


<br>
<br>
== Package List ==
== Package List ==
* Keyestudio ESP8266 WI-FI Development Board * 1
* Keyestudio ESP8266 WI-FI Development Board * 1

Revision as of 13:29, 30 August 2018

Keyestudio ESP8266 WI-FI Development Board



Description

This keyestudio ESP8266 WI-FI development board is based on the ESP8266-12FWIFI module developed by Ai-Thinker.
The processor ESP8266 integrates the industry-leading Tensilica L106 ultra-low-power 32-bit micro MCU in a smaller package, with 16-bit Lite mode.
The main frequency supports 80MHz and 160 MHz.
It supports RTOS, integrated with Wi-Fi MAC/BB/RF/PA/LNA. Onboard comes with curved antenna.
This development board is a standalone network controller, which can add networking function to those existing devices.
It has 11 I/O ports (4 of which can be used as PWM output), and all I/O ports operate at 3.3V. It also comes with an AD input interface, supporting the voltage range of 0-3.3V.
The board can be powered via the USB port, or with an external power supply (DC 7-12V), or powered by the female headers Vin/GND (DC 7-12V).


Technical Details

  • Microcontroller: ESP8266-12F
  • Operating Voltage: 3V3
  • Input Voltage (recommended): DC 7-12V
  • Digital I/O Pins: 8 (GPIO2, GPIO4, GPIO5, GPIO12, GPIO13, GPIO14, GPIO15, GPIO16)
  • Analog Input Pins: 1 (A0)
  • IO output maximum current: 12 mA
  • Main frequency supports 80 MHz and 160 MHz
  • LED_BUILTIN: GPIO 14
  • Comes with an external power jack (DC 7-12V)
  • Dimensions: 54mm*56mm*15mm


KS0354 （单尺寸）.png

Back View:

KS0354 BACK.png


Element and Interfaces

Here is an explanation of what every element and interface of the board does:
Ks0354 引脚.jpg


Specialized Functions of Some Pins

  • Serial communication: ' GPIO3 (RX) and GPIO1 (TX).
  • PWM Interfaces (Pulse-Width Modulation): GPIO 4, GPIO 12, GPIO 14, GPIO 15.
  • SPI communication: GPIO6(CLK), GPIO7(MISO), GPIO8(MOSI), GPIO9 (HD), GPIO10(WP), GPIO1(CS1), GPIO0(CS2)
  • IIC communication: GPIO2(SDA); GPIO14(SCL)
  • IR Remote Control Interface: GPIO5(IR RX); GPIO14(IR TX)



Detailed Using Methods are as follows

Step1| Install the Arduino IDE

When programming the control board, first you should install the Arduinosoftware and driver.
You can download the different versions for different systems from the link below:
https://www.arduino.cc/en/Main/OldSoftwareReleases#1.5.x

NOTE: this control board is only compatible with Arduino 1.6.5 version or latest.
In the following, we will download the Arduino 1.6.5 version.

Ks0354-step1-1.png

In this Windows system page, there are two options. One is Windows version, the other is Windows Installer.
For Windows Installer, you can download the installation file, this way you need to install the arduino IDE.
Ks0354-step1-2.png

For simple Windows version, you can download the software directly, do not need to install, just directly use the software after unzip the file.
Ks0354-step1-3.png

Next, we click the Windows, pop up the interface as below.
Ks0354-step1-4.png

Click JUST DOWNLOAD.When the ZIP file is downloaded well to your computer, you can directly unzip the file. Open the Arduino-1.6.5-r5 folder, you should get it as follows.
Ks0354-step1-5.png

Ks0354-step1-6.png

Click the icon of ARDUINO software to open it. This is your Arduino.
Ks0354-step1-7.png


Step2| Installing the Driver

The USB to serial port chip of this control board is CH340G. So you need to install the driver for the chip. You can click the driver file here usb_ch341_3.1.2009.06 to download it.
In different systems, the driver installation is similar. Here we start to install the driver on the Win7 system.
Plug one end of your USB cable into the Keyestudio ESP8266 WI-FI board and the other into a USB socket on your computer.
When you connect the ESP8266 WI-FI board to your computer at the first time, right click your “Computer” —>for “Properties”—> click the “Device manager”, under Other devices, you should see the “USB2.0-Serial”.
Ks0354 driver 1.png

Then right-click on the device and select the top menu option (Update Driver Software...) shown as the figure below..
Ks0354 driver 2.png

Then it will be prompted to either “Search Automatically forupdated driversoftware” or “Browse my computer for driver software”. Shown as below. In this page, select “Browse my computer for driver software”.
Ks0354 driver 3.png

After that, select the option to browseand navigate to the “drivers” folder of usb-ch341 installation.
Ks0354 driver 4.png

Once the software has been installed, you will get a confirmation message. Installation completed, click “Close”.
Ks0354 driver 5.png

Up to now, the driver is installed well. Then you can right click “Computer” —>“Properties”—>“Device manager”, you should see the device as the figure shown below.
Ks0354 driver 6.png


Step3| Installing the ESP8266 with Arduino

Double-click the icon of Arduino software downloaded well, you will get the interface shown below.
Ks0313图片1.png
(Note: if the Arduino software loads in the wrong language, you can change it in the preferences dialog. See the environment page for details.)
Ks0354-step1-7.png

The functions of each button on the Toolbar are listed below:
IDE.png

IDE 1.png Verify/Compile Check the code for errors
IDE 2.png Upload Upload the current Sketch to the Arduino
IDE 3.png New Create a new blank Sketch
IDE 4.png Open Show a list of Sketches
IDE 5.png Save Save the current Sketch
IDE 6.png Serial Monitor Display the serial data being sent from the Arduino

First, plug one end of your USB cable into the Keyestudio ESP8266 WI-FI board and the other into a USB socket on your computer.
Ks0354-step3.png

Then open the Arduino IDE, click the “File” to select the “Preferences”.
Ks0354-step3-1.png

The pop-up interface is shown below. See the “Additional Boards Manager URLs”, copy and paste the link: http://arduino.esp8266.com/stable/package_esp8266com_index.json and then click OK.
Ks0354-step3-2.png

After that, click “Tools”, for “Board”, enter theBoards Manager, it will automatically download the relevant file. Shown below.
Ks0354-step3-3.png

Ks0354-step3-4.png

Done downloading the relevant file, it will pop up the window below. Then enter the 8266 on the blank bar and click Install.
Ks0354-step3-5.png

Ks0354-step3-6.png

Installation completed, click Close, then click “Tools”, for “Board”, you should see the Generic ESP8266 Module. Shown below.
Ks0354-step3-7.png


Step4| Add the Libraries

Before upload the code to test your board, you should first add all the libraries into the libraries folder of Arduino-1.6.5-r5. You can click the link to download all the libraries needed.
https://drive.google.com/open?id=11mTs_DbCIx-PQHPjfZOAekBZ7IL8al3D
Ks0354-step4.png


Step5| Select the Board and Serial Port

Open the Arduino IDE, you’ll need to click the “Tools”, then select the Board and the Serial Port.
Ks0354-step3-7.png

You can check the Serial Port on your computer’s Device Manager.
Ks0354 driver 6.png

Ks0354 port.png

Below is the complete settings you should refer to:
Ks0354 Tools.png


Step6| Upload the Code

Add well all the libraries mentioned above, and select well the Board and Port, you should upload the code to test your board.
Below is an example code, you can copy and paste it on Arduino IDE. Or dowload the code here
NOTE: in the code, you should modify the WIFI name and password here:
const char* WIFI_SSID = "HUAWEI-3L9ML8";
const char* WIFI_PWD = "75785302";

#include <ESP8266WiFi.h>
#include <WiFiUdp.h>
#include <Ticker.h>
#include <JsonListener.h>
#include "SSD1306Wire.h"
#include "OLEDDisplayUi.h"
#include "Wire.h"
#include "WorldClockClient.h"
#include "icons.h"
#include "fonts.h"
#define SDA_PIN 5//oled_SDA
#define SCL_PIN 4//oled_SCL


/***************************
 * Begin Settings
 **************************/
// WIFI
const char* WIFI_SSID = "HUAWEI-3L9ML8";
const char* WIFI_PWD = "75785302";

// Setup
const int UPDATE_INTERVAL_SECS = 10 * 60; // Update every 10 minutes

// Display Settings
const int I2C_DISPLAY_ADDRESS = 0x3c;

// TimeClient settings


// Initialize the oled display for address 0x3c
// sda-pin=14 and sdc-pin=12

SSD1306Wire  display(I2C_DISPLAY_ADDRESS, SDA_PIN, SCL_PIN);
OLEDDisplayUi ui     ( &display );

/***************************
 * End Settings
 **************************/
String timeZoneIds [] = {"America/New_York", "Europe/London", "Europe/Paris", "Australia/Sydney"};
WorldClockClient worldClockClient("de", "CH", "E, dd. MMMMM yyyy", 4, timeZoneIds);


// flag changed in the ticker function every 10 minutes
bool readyForUpdate = false;

String lastUpdate = "--";

Ticker ticker;


void updateData(OLEDDisplay *display) {
  drawProgress(display, 50, "Updating Time...");
  worldClockClient.updateTime();
  drawProgress(display, 100, "Done...");
  readyForUpdate = false;
  delay(1000);
}

void drawProgress(OLEDDisplay *display, int percentage, String label) {
  display->clear();
  display->setTextAlignment(TEXT_ALIGN_CENTER);
  display->setFont(ArialMT_Plain_10);
  display->drawString(64, 10, label);
  display->drawProgressBar(10, 28, 108, 12, percentage);
  display->display();
}

void drawClock(OLEDDisplay *display, int x, int y, int timeZoneIndex, String city, const char* icon) {
  display->setTextAlignment(TEXT_ALIGN_LEFT);
  display->setFont(ArialMT_Plain_10);
  display->drawString(x + 60, y + 5, city);
  display->setFont(Crushed_Plain_36);
  display->drawXbm(x, y, 60, 60, icon);
  display->drawString(x + 60, y + 15, worldClockClient.getHours(timeZoneIndex) + ":" + worldClockClient.getMinutes(timeZoneIndex));

}

void drawFrame1(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y) {
  drawClock(display, x, y, 0, "New York",  new_york_bits);
}

void drawFrame2(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y) {
  drawClock(display, x, y, 1, "London",  london_bits);
}

void drawFrame3(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y) {
  drawClock(display, x, y, 2, "Paris",  paris_bits);
}

void drawFrame4(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y) {
  drawClock(display, x, y, 3, "Sydney",  sydney_bits);
}


void setReadyForWeatherUpdate() {
  Serial.println("Setting readyForUpdate to true");
  readyForUpdate = true;
}

// this array keeps function pointers to all frames
// frames are the single views that slide from right to left
FrameCallback frames[] = { drawFrame1, drawFrame2, drawFrame3, drawFrame4};
int numberOfFrames = 4;

void setup() {
  Serial.begin(115200);
  Serial.println();
  Serial.println();

  // initialize dispaly
  display.init();
  display.clear();
  display.display();

  //display.flipScreenVertically();
  display.setFont(ArialMT_Plain_10);
  display.setTextAlignment(TEXT_ALIGN_CENTER);
  display.setContrast(255);

  WiFi.begin(WIFI_SSID, WIFI_PWD);

  int counter = 0;
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
    display.clear();
    display.drawString(64, 10, "Connecting to WiFi");
    display.drawXbm(46, 30, 8, 8, counter % 3 == 0 ? activeSymbol : inactiveSymbol);
    display.drawXbm(60, 30, 8, 8, counter % 3 == 1 ? activeSymbol : inactiveSymbol);
    display.drawXbm(74, 30, 8, 8, counter % 3 == 2 ? activeSymbol : inactiveSymbol);
    display.display();

    counter++;
  }

  ui.setTargetFPS(30);

  // You can change this to
  // TOP, LEFT, BOTTOM, RIGHT
  ui.setIndicatorPosition(BOTTOM);

  // Defines where the first frame is located in the bar.
  ui.setIndicatorDirection(LEFT_RIGHT);

  // You can change the transition that is used
  // SLIDE_LEFT, SLIDE_RIGHT, SLIDE_TOP, SLIDE_DOWN
  ui.setFrameAnimation(SLIDE_LEFT);

  // Add frames
  ui.setFrames(frames, numberOfFrames);

  // Inital UI takes care of initalising the display too.
  ui.init();

  Serial.println("");

  updateData(&display);

  ticker.attach(UPDATE_INTERVAL_SECS, setReadyForWeatherUpdate);

}

void loop() {

  if (readyForUpdate && ui.getUiState()->frameState == FIXED) {
    updateData(&display);
  }

  int remainingTimeBudget = ui.update();

  if (remainingTimeBudget > 0) {
    // You can do some work here
    // Don't do stuff if you are below your
    // time budget.
    delay(remainingTimeBudget);
  }
}


After copy and paste the code on IDE, click the compile button, if compiling successfully, the message "Done compiling." will appear in the status bar. Shown below.
Ks0354 upload-3.png

Then click the “Upload” button, if the upload is successful, the message "Done uploading." will appear in the status bar.
Ks0354 upload-4.png


Step7| What Should You See

Done uploading, connect the keyestudio OLED display module to the WIFI board (separately GPIO5, GPIO4, GND, 3.3V), then supply the control board with DC 7-12V power via a black external DC jack. Finally, the board will be connected to the WIFI you have set in the code, so you should see the worldwide time display.
Ks0354-step7.png


Package List

  • Keyestudio ESP8266 WI-FI Development Board * 1
  • USB cable * 1


More Resources

You can download the PDF file from the link:
https://drive.google.com/open?id=1jEDfJttzF6Rto5Qg96Q2kK_dEKz09n3e

Driver File Download:
https://drive.google.com/open?id=1ssALY3RCks_VnWJJ-TuBczs28s2gimEI

Download the Libraries:
https://drive.google.com/open?id=11mTs_DbCIx-PQHPjfZOAekBZ7IL8al3D

Download the Source Code:
https://drive.google.com/open?id=1bYBkZpkznGzVIrcFOBszWwVbIONHVwJw

ARDUINO Software:
https://www.arduino.cc/en/Main/OldSoftwareReleases#1.5.x



Buy From

Retrieved from "http://wiki.keyestudio.com/index.php?title=Ks0354_Keyestudio_ESP8266_WI-FI_Development_Board&oldid=11385"