The EleksMaker EleksTube bamboo LED clock was originally a kickstart project that was produced to highlight EleksMaker's laser cutting technology, but is now being sold on Banggood.
I have noticed that this clock has a poor time keeping ability and will gain minutes every day. EleksMaker has updated the clock controller and has greatly improved the internal clock time keeping. However, you still need to use the PC software to set the clock time, control the colour of the clock display and adjust the time for DST offsets periodically. Fortunately EleksMaker has published an API to interface with the serial port available on the clock controller. The API details are located on EleksMakers forum here: http://forum.eleksmaker.com/topic/1941/elekstube-api-control-protocol
As a result, I developed this Arduino program to provide NTP or GPS updates to the EleksTube using an inexpensive ESP8266 development board.
The program has the following features:
- Utilizes WiFiManager to setup a Access Point the first time the program in run.
- Displays the Access Point IP address on the clock display and waits for the user to connect to the AP and add a SSID to the configuration.
- Allows user to add timezonedb token, OTA password, Blynk auth token, Blynk host and Blynk port to wifi configuraton and subsequently saved in SPIF filesystem to be used in the program.
- Automatically determines your time zone based on your internet IP address.
- Uses the time zone information to determine your offset from UTC.
- Uses the time zone information to determine DST details - DST start, DST end and current DST status - either on or off. Uitilzes this information to automatically switch DST offset from UTC when DST changes occur.
- Utilizes OTA (Over The Air) update capabilities of the ESP 8266 module to allow sketch updates after the module is installed in the belly of the clock.
- Uses Blynk https://www.blynk.cc mobile application software to control the clock. The Blynk application allows for selection of clock source (NTP,GPS or internal RTC), update internal RTC with NTP/GPS data, display current date information once a minute for five seconds at a configurable start second. Change from 24hr to 12hr time display, change the calculated timezone to a user selectable timezone. Configure a time range when the clock display should be off - ie. when sleeping if clock is in a bedroom. Each digit can have an individual colour set and stored and restored during a reboot. The date display can have a different colour than the time display. Display built in EleksTube display features - Waterfall, Rainbow and Random. Ability to brighten and dim the display without changing the selected colour.
Parts List:
Arduino Controller:
ESP8266 12-F - https://www.banggood.com/Geekcreit-Doit-NodeMcu-Lua-ESP8266-ESP-12F-WIFI-Development-Board-p-985891.html?rmmds=myorder&cur_warehouse=CN
or
Wemo D1 mini - https://www.banggood.com/Wemos-D1-Mini-V3_0_0-WIFI-Internet-Of-Things-Development-Board-Based-ESP8266-4MB-p-1264245.html?rmmds=myorder&cur_warehouse=CN - preferred since it does not experience a power on reset issue.
4 pin 2.54 mm pin header to solder to the EleksTube clock serial interface - https://www.banggood.com/10Pcs-Lantian-2_54mm-Gold-plated-3U-Reverse-Curved-Single-Row-Pin-Header-Connector-p-1365750.html?rmmds=search&ID=557432&cur_warehouse=CN
3 wire jumper cable with Dupont connectors to connect EleksTube serial and power to the Arduino board - https://www.banggood.com/120pcs-10cm-Female-To-Female-Jumper-Cable-Dupont-Wire-For-Arduino-p-994310.html?rmmds=detail-left-hotproducts__8&HotRecToken=CgEwEAIaAklWIgJQRCgB&cur_warehouse=CN
BN-220 GPS module - https://www.banggood.com/Dual-BN-220-GPS-GLONASS-Antenna-Module-TTL-Level-RC-Drone-Airplane-p-1208588.html?rmmds=myorder&cur_warehouse=CN. Includes connection cable and mounting pad.
Both Arduino controllers come with pin headers.
To get started:
Install a local Blynk server:
I would recommend that a local Blynk App server be configured to support the EleksTube. The following link describes the installation procedure:
https://github.com/blynkkk/blynk-server#getting-started
The Blynk server can be installed easily on a Raspberry PI, Windows PC, Docker or Linux PC. Once the Blynk server is installed, you will need to login and create a new user with sufficient credit to support the EleksTube Blynk App - approximately $3200 in credit. Details on logging and and setting up a user are detailed in the installation instructions
Install the Blynk Android/IOS App:
Install the Android or IOS app on your smart phone and scan the following image in the app to install the EleksTube Blynk App.
To start using it:
- Download Blynk App: http://j.mp/blynk_Android or http://j.mp/blynk_iOS
- Login to the Blynk App with the username and password created during the installation of your local Blynk Server. Specify the local Blynk Server and port.
- Touch the QR-code icon and point the camera to the code below
Copy the blynk auth token from the Blynk app located in the "Nut" menu of the EleksTube app - under Devices, My Devices. The Auth Token is pushed to the Blynk server, but will be required for the EleksTube connection to the Blynk Server.
You will need Auth Token when configuring the Wifi setting of the EleksTube. Press the "Email" key to email the auth token to yourself.
Compile and install the program:
Download and install the Arduino IDE - https://www.arduino.cc/en/Main/Software
The software was created using IDE version 1.8.6.
Download the Arduino sketch for the EleksTube - EleksTube_Wifi.ino
Load the EleksTube_Wifi.ino in the Arduino IDE.
Download and install the ESP8266 board manager into the Arduino IDE - https://github.com/esp8266/Arduino
Download and install the libraries detailed in the Arduino sketch into the Arduino IDE.
Connect your ESP8266 board to your PC and select the boards serial port in the Arduino IDE.
Select your ESP8266 Board type in the "Tools" menu of the Arduino IDE.
Verify the sketch in the Arduino IDE to esure you are not missing any libraries.
Upload the compiled sketch to your ES8266 board.
Configure the Wifi prior to connecting to the EleksTube clock if desired. The ESP8266 board will become a Wifi Access Point (AP) the first time connected with no valid wifi configuration. The default IP address of the AP is 192.168.4.1. Use a Wifi connected PC or smartphone to connect to the open AP.
If you are connecting the ESP8266 12-F board to the EleksTube, be aware that there is an issue the power on reset if the power is connected to the Vin pin on the board. I experienced CPU lock up if power was connected to the Vin on the board. However if you connect the power to the USB port, there is no issue with power on reset. As a result you may have to make a cable with a male micro usb connector to power the ESP8266 12-F baord from the EleksTube clock. See the pictures below.
ESP8266 12-F pinouts:
3v3 pin to the red wire on GPS module
GND pin to the black wire on GPS module
RX pin to the white wire on GPS module. You must remove this wire if you are uploading new code via the EPS8266 USB interface as this port is shared with the USB port.
D4 pin to the RX pin on the EleksTube clock serial interface
Micro USB port - plus(+) and minus (-) from the EleskTube clock serial interface - Micro USB wiring - https://never-stop-building-blog-production.s3.amazonaws.com/pictures/wiring-micro-usb-pinout/micro-usb-power-connector-wiring.png
ESP8266 WEMOS D1 mini V3.0.0 pinouts:
+5V pin to EleksTube + pin on serial interface
GND pin (solder an extra pin to this connection since there will be two connections to the GND pin) to negative (-) pin on EleksTube clock serial interface and black wire on the GPS module
D4 pin to the RX pin on the EleksTube clock serial interface
RX pin to the white wire on the GPS module. You must remove this wire if you are uploading new code via the EPS8266 USB interface as this port is shared with the USB port.
3V3 pin to the red wire on the GPS module.
The first time the program is installed on a new ESP8266 board, the SPIF filesystem is initialized. The SPIF filesystem is used to store configuration parameters during the WiFi setup.
Once you have completed the Wifi setup and entered your timezonedb, blynk token, blynk host (local or remote) and blynk port (8080 for local), the clock will begin displaying the corrected time.
OTA (Over The Air) Updates:
The EleksTube_Wifi sketch includes the ability to update the software installed on the Arduino board over WiFi after the first time the software is installed and configured. To update the software via Wifi simply select the "EleksTube" IP address as the port in the Arduino IDE instead of a serial port. When you upload your sketch to the board, you will be prompted for a password. The password will be the password that was entered during the WiFi configuration.
Reset Wifi Configuration
There is a special key sequence in the Blynk App to manually reset the Wifi configuration.
The sequence invloves:
- Press the "Update RTC" button
- Exactly 3 seconds later press the "Update RTC" button again
If you miss the 3 second window the sequnce resets and you must attempt again. If successfull, the Wifi connectivity parameters are reset (not the other save parameters - OTA password, timezoneDB key, Blynk Auth token, Blynk host and Blynk port), the Arduino is reset and the EleksTube clock will display the Access Point IP address.
Screenshots of the application and configuration.
Images of connectivity to the EleksTube controller, ESP8266 or Wemos D1 Arduino boards and BN-220 GPS.
Wemos D1 mini Connectivity
