Compare commits
19 Commits
0543b9c0c7
...
1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 1629f24fcc | |||
| adb3677d71 | |||
| d6f06525c9 | |||
| 4d810783fc | |||
| feb26d7269 | |||
| 3dfd6c82fe | |||
| 244455909d | |||
| f53f557a6a | |||
| e1df24633a | |||
| 4543cf1e09 | |||
| 0cf2e5ca90 | |||
| ff90c610ae | |||
| 2e50dd0e3f | |||
| b584cc03bd | |||
| eb4341e05b | |||
| 73b390d8cd | |||
| 5a51707452 | |||
| f4b49dd8c4 | |||
| a4be8f1d9e |
13
.gitignore
vendored
13
.gitignore
vendored
@@ -65,4 +65,15 @@ log.txt
|
||||
modules.order
|
||||
Module.symvers
|
||||
Mkfile.old
|
||||
dkms.conf
|
||||
dkms.conf
|
||||
|
||||
# Python
|
||||
venv
|
||||
.venv
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
|
||||
# Local backup
|
||||
*.*_
|
||||
*.*bak*
|
||||
|
||||
99
README.md
99
README.md
@@ -1,96 +1,49 @@
|
||||
# Important Note:
|
||||
This project has been unofficially forked from https://github.com/techniccontroller/wordclock_esp8266 which was initially created by techniccontroller. Copyright and licensing is respected.
|
||||
This project has been unofficially forked from https://github.com/techniccontroller/wordclock_esp8266 which was initially created by techniccontroller. Copyright and licensing is respected. Very many thanks for the initial code!
|
||||
|
||||
|
||||
# Wordclock 2.0
|
||||
|
||||
Wordclock 2.0 with ESP8266 and NTP time
|
||||
|
||||
More details on my website: https://techniccontroller.com/word-clock-with-wifi-and-neopixel/
|
||||
|
||||
More details on techniccontroller's website: https://techniccontroller.com/word-clock-with-wifi-and-neopixel/
|
||||
|
||||
**Languages**
|
||||
|
||||
The Wordclock is available in **German**, **English** and **Italian** language. By default the language is German.
|
||||
To use the English or Italian language please replace the file *wordclockfunctions.ino* with *wordclockfunctions.ino_english* or *wordclockfunctions.ino_italian*.
|
||||
The code compiles only with one file named *wordclockfunctions.ino*. So please rename the file you want to use to *wordclockfunctions.ino* and replace the existing file.
|
||||
The Wordclock is available in **German** language.
|
||||
|
||||
|
||||
## Features
|
||||
- 6 modes (Clock, Digital Clock, SPIRAL animation, TETRIS, SNAKE, PONG)
|
||||
- time update via NTP server
|
||||
- automatic summer/wintertime change
|
||||
- easy WIFI setup with WifiManager
|
||||
- configurable color
|
||||
- configurable night mode (start and end time)
|
||||
- configurable brightness
|
||||
- automatic mode change
|
||||
- webserver interface for configuration and control
|
||||
- physical button to change mode or enable night mode without webserver
|
||||
- automatic current limiting of LEDs
|
||||
- Time update via NTP server
|
||||
- Games: Pong, Snake, Tetris, ...
|
||||
- Automatic summer/wintertime change
|
||||
- Easy wifi setup with WifiManager
|
||||
- Configurable color
|
||||
- Configurable night mode (start and end time)
|
||||
- Configurable brightness
|
||||
- Automatic mode change
|
||||
- Webserver interface for configuration and control (web address: wordclock.local)
|
||||
- Automatic current limiting of LEDs
|
||||
|
||||
## Pictures of clock
|
||||

|
||||
|
||||
## Screenshots of webserver UI
|
||||

|
||||
|
||||
## Quickstart
|
||||
|
||||
1. Clone the project into the sketch folder of the Arduino IDE,
|
||||
2. Rename the file "example_secrets.h" to "secrets.h". You don't need to change anything in the file if you want uses the normal WiFi setup with WiFiManager (see section "Remark about the WiFi setup").
|
||||
3. Install the additional libraries and flash it to the ESP8266 as usual (See section [*Upload program to ESP8266*](https://github.com/techniccontroller/wordclock_esp8266/blob/main/README.md#upload-program-to-esp8266-with-arduino-ide) below).
|
||||
4. The implemented WiFiManager helps you to set up a WiFi connection with your home WiFi -> on the first startup it will create a WiFi access point named "WordclockAP". Connect your phone to this access point and follow the steps which will be shown to you.
|
||||
5. After a successful WiFi setup, open the browser and enter the IP address of your ESP8266 to access the interface of the webserver.
|
||||
6. Here you can then upload all files located in the folder "data". Please make sure all icons stay in the folder "icons" also on the webserver.
|
||||
|
||||
|
||||
<img src="https://techniccontroller.com/wp-content/uploads/filemanager1-1.png" height="300px" /> <img src="https://techniccontroller.com/wp-content/uploads/filemanager2-1.png" height="300px" /> <img src="https://techniccontroller.com/wp-content/uploads/filemanager3-1.png" height="300px" />
|
||||
|
||||
## Install needed Libraries
|
||||
|
||||
Please download all these libraries as ZIP from GitHub, and extract them in the *libraries* folder of your Sketchbook location (see **File -> Preferences**):
|
||||
|
||||
- https://github.com/adafruit/Adafruit-GFX-Library
|
||||
- https://github.com/adafruit/Adafruit_NeoMatrix
|
||||
- https://github.com/adafruit/Adafruit_NeoPixel
|
||||
- https://github.com/tzapu/WiFiManager
|
||||
- https://github.com/adafruit/Adafruit_BusIO
|
||||
1. Clone the project into the a directory.
|
||||
2. Open directory in VSCode with PlatformIO extension installed.
|
||||
3. Current dependencies (2024-07-21):
|
||||
- Platform espressif8266 @ 2.6.3 (required: espressif8266 @ 2.6.3)
|
||||
- Libraries
|
||||
- ├── FastLED @ 3.7.0 (required: fastled/FastLED @ 3.7.0)
|
||||
- ├── FastLED NeoMatrix @ 1.2.0 (required: marcmerlin/FastLED NeoMatrix @ ^1.2)
|
||||
- │⠀⠀⠀└── Framebuffer GFX @ 1.1.0 (required: Framebuffer GFX)
|
||||
- │⠀⠀⠀│⠀⠀⠀├── Adafruit GFX Library @ 1.11.9 (required: Adafruit GFX Library)
|
||||
- │⠀⠀⠀│⠀⠀⠀│⠀⠀⠀└── Adafruit BusIO @ 1.16.1 (required: Adafruit BusIO)
|
||||
- ├── WiFiManager @ 0.16.0 (required: tzapu/WiFiManager @ ^0.16.0)
|
||||
- └── base64 @ 1.4.0 (required: densaugeo/base64 @ ^1.4.0)
|
||||
|
||||
|
||||
## Remark about the WiFi setup
|
||||
|
||||
Regarding the Wifi setting, I have actually implemented two variants:
|
||||
1. By default the WifiManager is activated. That is, the word clock makes the first time its own WiFi (should be called "WordclockAP"). There you simply connect to the cell phone and you can perform configuration of the WiFi settings conveniently as with a SmartHome devices (Very elegant 😊)
|
||||
2. Another (traditional) variant is to define the wifi credentials in the code (in secrets.h).
|
||||
- For this you have to comment out lines 230 to 251 in the code of the file *wordclock_esp8266.ino* (/\* before and \*/ after)
|
||||
- and comment out lines 257 to 305 (/\* and \*/ remove)
|
||||
|
||||
|
||||
## Remark about Logging
|
||||
|
||||
The wordclock send continuously log messages to the serial port and via multicast UDP. If you want to see these messages, you have to
|
||||
|
||||
- open the serial monitor in the Arduino IDE (Tools -> Serial Monitor). The serial monitor must be set to 115200 baud.
|
||||
|
||||
OR
|
||||
|
||||
- run the following steps for the multicast UDP logging:
|
||||
|
||||
1. starting situation: wordclock is connected to WLAN, a computer with installed Python (https://www.python.org/downloads/) is in the same local area network (WLAN or LAN doesn't matter).
|
||||
3. open the file **multicastUDP_receiver.py** in a text editor and in line 81 enter the IP address of the computer (not the wordclock!).
|
||||
```python
|
||||
# ip address of network interface
|
||||
MCAST_IF_IP = '192.168.0.7'
|
||||
```
|
||||
4. execute the script with following command:
|
||||
|
||||
```bash
|
||||
python multicastUDP_receiver_analyzer.py
|
||||
```
|
||||
|
||||
5. now you should see the log messages of the word clock (every 5 seconds a heartbeat message and the currently displayed time).
|
||||
If this is not the case, there could be a problem with the network settings of the computer, then recording is unfortunately not possible.
|
||||
|
||||
6. If special events (failed NTP update, reboot) occur, a section of the log is saved in a file called *log.txt*.
|
||||
In principle, the events are not critical and will occur from time to time, but should not be too frequent.
|
||||
By default the WifiManager is activated. That is, the word clock makes the first time its own WiFi (should be called "WordclockAP"). There you simply connect to the cell phone and you can perform configuration of the WiFi settings conveniently as with SmartHome devices.
|
||||
|
||||
26
include/diagnosis.h
Normal file
26
include/diagnosis.h
Normal file
@@ -0,0 +1,26 @@
|
||||
#ifndef DIAGNOSIS_H
|
||||
#define DIAGNOSIS_H
|
||||
|
||||
#include <Arduino.h>
|
||||
#include "led_matrix.h"
|
||||
#include "udp_logger.h"
|
||||
|
||||
class Diagnosis
|
||||
{
|
||||
public:
|
||||
Diagnosis(); // constructor
|
||||
Diagnosis(UDPLogger *logger, LEDMatrix *matrix); // constructor
|
||||
|
||||
String handle_command(const String &command);
|
||||
String print_device_info();
|
||||
String print_sketch_info();
|
||||
String print_last_reset_details();
|
||||
String print_matrix_fps();
|
||||
|
||||
private:
|
||||
UDPLogger *_logger;
|
||||
LEDMatrix * _matrix;
|
||||
void print(const String &s);
|
||||
};
|
||||
|
||||
#endif // DIAGNOSIS_H
|
||||
@@ -1,24 +1,28 @@
|
||||
#ifndef LEDMATRIX_H
|
||||
#define LEDMATRIX_H
|
||||
|
||||
#ifndef FASTLED_INTERNAL
|
||||
#define FASTLED_INTERNAL
|
||||
#endif
|
||||
|
||||
#include <Arduino.h>
|
||||
#include <Adafruit_GFX.h>
|
||||
#include <Adafruit_NeoMatrix.h>
|
||||
#include <FastLED_NeoMatrix.h>
|
||||
#include "wordclock_constants.h"
|
||||
#include "udp_logger.h"
|
||||
|
||||
#define DEFAULT_CURRENT_LIMIT 9999
|
||||
|
||||
extern const uint32_t colors_24bit[NUM_COLORS];
|
||||
|
||||
class LEDMatrix
|
||||
{
|
||||
public:
|
||||
LEDMatrix(Adafruit_NeoMatrix * matrix, uint8_t brightness, UDPLogger * logger);
|
||||
LEDMatrix(FastLED_NeoMatrix *matrix, uint8_t brightness, UDPLogger *logger);
|
||||
static uint16_t color_24_to_16bit(uint32_t color24bit);
|
||||
static uint32_t color_24bit(uint8_t r, uint8_t g, uint8_t b);
|
||||
static uint32_t interpolate_color_24bit(uint32_t color1, uint32_t color2, float factor);
|
||||
static uint32_t wheel(uint8_t WheelPos);
|
||||
uint16_t get_fps(void);
|
||||
void draw_on_matrix_instant();
|
||||
void draw_on_matrix_smooth(float factor);
|
||||
void flush(void);
|
||||
@@ -31,17 +35,17 @@ public:
|
||||
void setup_matrix();
|
||||
|
||||
private:
|
||||
Adafruit_NeoMatrix * _neomatrix;
|
||||
UDPLogger * _logger;
|
||||
FastLED_NeoMatrix *_neomatrix;
|
||||
UDPLogger *_logger;
|
||||
|
||||
uint8_t _brightness;
|
||||
uint16_t _current_limit;
|
||||
|
||||
// target representation of matrix as 2D array
|
||||
uint32_t _target_grid[MATRIX_HEIGHT][MATRIX_WIDTH] = {0};
|
||||
uint32_t _target_grid[MATRIX_HEIGHT][MATRIX_WIDTH];
|
||||
|
||||
// current representation of matrix as 2D array
|
||||
uint32_t _current_grid[MATRIX_HEIGHT][MATRIX_WIDTH] = {0};
|
||||
uint32_t _current_grid[MATRIX_HEIGHT][MATRIX_WIDTH];
|
||||
|
||||
// target representation of minutes indicator LEDs
|
||||
uint32_t _target_minute_indicators[4] = {0, 0, 0, 0};
|
||||
@@ -53,4 +57,4 @@ private:
|
||||
uint16_t _calc_estimated_led_current(uint32_t color);
|
||||
};
|
||||
|
||||
#endif /* LEDMATRIX_H */
|
||||
#endif /* LEDMATRIX_H */
|
||||
@@ -79,8 +79,8 @@ private:
|
||||
UDPLogger *_logger;
|
||||
uint8_t _gameState = 0;
|
||||
uint8_t _numBots = 0;
|
||||
uint8_t _playerMovement[PLAYER_AMOUNT] = {0};
|
||||
Coords _paddles[PLAYER_AMOUNT][PADDLE_WIDTH] = {0};
|
||||
uint8_t _playerMovement[PLAYER_AMOUNT];
|
||||
Coords _paddles[PLAYER_AMOUNT][PADDLE_WIDTH];
|
||||
Coords _ball = {0, 0};
|
||||
Coords _ball_old = {0, 0};
|
||||
int _ballMovement[2] = {0, 0};
|
||||
|
||||
@@ -76,7 +76,7 @@ private:
|
||||
uint8_t _userDirection = 0;
|
||||
uint8_t _gameState = 0;
|
||||
Coords _head = {0, 0};
|
||||
Coords _tail[MAX_TAIL_LENGTH] = {0};
|
||||
Coords _tail[MAX_TAIL_LENGTH];
|
||||
Coords _food = {0, 0};
|
||||
unsigned long _lastDrawUpdate = 0;
|
||||
unsigned long _lastButtonClick = 0;
|
||||
|
||||
80
include/time_manager.h
Normal file
80
include/time_manager.h
Normal file
@@ -0,0 +1,80 @@
|
||||
#ifndef TIME_MANAGER_H
|
||||
#define TIME_MANAGER_H
|
||||
|
||||
#include <Arduino.h>
|
||||
#include <time.h>
|
||||
#include "udp_logger.h"
|
||||
|
||||
typedef enum
|
||||
{
|
||||
TIME_UPDATE_FAILED = 0,
|
||||
TIME_UPDATE_OK = 1,
|
||||
TIME_UPDATE_PENDING = 2,
|
||||
} TimeUpdateState;
|
||||
|
||||
typedef enum
|
||||
{
|
||||
TM_INIT = 0,
|
||||
TM_INITIAL_SYNC = 1,
|
||||
TM_NORMAL = 2,
|
||||
TM_SYNC_OVERDUE = 3,
|
||||
TM_SYNC_TIMEOUT = 4,
|
||||
TM_SETUP_FAILED = 5,
|
||||
} TimeManagerState;
|
||||
|
||||
class TimeManager
|
||||
{
|
||||
#define NTP_MAX_UPDATE_TIME_US (5 * 1000 * 1000) // 5000ms max update time
|
||||
|
||||
public:
|
||||
// constructors
|
||||
TimeManager();
|
||||
TimeManager(const char *tz,
|
||||
const char *ntp_server,
|
||||
bool (*is_wifi_connected)(void),
|
||||
uint32 ntp_max_offline_time_s,
|
||||
UDPLogger *logger);
|
||||
|
||||
// init
|
||||
void init();
|
||||
|
||||
// callback
|
||||
void time_set_cb(void); // callback which is called when NTP time was set
|
||||
|
||||
// ntp methods
|
||||
bool ntp_sync_successful(void) const; // was there a NTP sync once?
|
||||
bool ntp_sync_overdue(void); // function to check if NTP sync is overdue
|
||||
bool ntp_sync_timeout(void); // function to check if maximum time since last NTP sync has been reached
|
||||
TimeUpdateState get_time(); // main time update method, called in loop
|
||||
|
||||
// getter for time values
|
||||
bool isdst(void) const; // true if summertime (daylight saving time)
|
||||
int day(void) const;
|
||||
int hour(void) const;
|
||||
int minute(void) const;
|
||||
int month(void) const;
|
||||
int year(void) const;
|
||||
struct tm time_info(void) const;
|
||||
|
||||
// getter
|
||||
TimeManagerState tm_state(void) const; // get current state
|
||||
|
||||
// logging
|
||||
void log_time() const; // log _time_info
|
||||
void log_time(struct tm time_info) const; // log argument time_info
|
||||
|
||||
private:
|
||||
void _set_up_ntp(void); // set up NTP server
|
||||
bool (*_is_wifi_connected)(void); // function to check if wifi is connected
|
||||
|
||||
const char *_ntp_server = "pool.ntp.org"; // ntp server address
|
||||
const char *_tz; // timezone
|
||||
struct tm _time_info = {0, 0, 0, 0, 0, 0, 0, 0, 0}; // structure tm holds time information
|
||||
time_t _now = 0; // local time value
|
||||
time_t _ntp_sync_timestamp_s = 0; // timestamp of last successful ntp sync
|
||||
TimeManagerState _tm_state = TM_INIT; // Main state
|
||||
UDPLogger *_logger; // logger instance
|
||||
uint32 _ntp_max_offline_time_s; // maximum time in seconds which is considered ok since last NTP update
|
||||
};
|
||||
|
||||
#endif /* TIME_MANAGER_H */
|
||||
@@ -16,7 +16,7 @@
|
||||
#define HTTP_PORT (80) // Standard HTTP port
|
||||
|
||||
// ESP8266 Pins
|
||||
#define NEOPIXEL_PIN (14) // pin to which the NeoPixels are attached
|
||||
#define FASTLED_PIN (14) // pin to which the LEDs are attached
|
||||
#define BUTTON_PIN (5) // pin to which the button is attached
|
||||
|
||||
// Time limits
|
||||
@@ -33,17 +33,18 @@
|
||||
#define NIGHTMODE_END_MIN (0)
|
||||
|
||||
// Timings in us
|
||||
#define PERIOD_ANIMATION_US (200 * 1000) // 200ms
|
||||
#define PERIOD_CLOCK_UPDATE_US (1 * 1000 * 1000) // 1s
|
||||
#define PERIOD_HEARTBEAT_US (1 * 1000 * 1000) // 1s
|
||||
#define PERIOD_MATRIX_UPDATE_US (100 * 1000) // 100ms
|
||||
#define PERIOD_NIGHTMODE_CHECK_US (20 * 1000 * 1000) // 20s
|
||||
#define PERIOD_NTP_UPDATE_US (30 * 1000 * 1000) // 30s
|
||||
#define PERIOD_PONG_US (10 * 1000) // 10ms
|
||||
#define PERIOD_SNAKE_US (50 * 1000) // 50ms
|
||||
#define PERIOD_STATE_CHANGE_US (10 * 1000 * 1000) // 10s
|
||||
#define PERIOD_TETRIS_US (50 * 1000) // 50ms
|
||||
#define TIMEOUT_LEDDIRECT_US (5 * 1000 * 1000) // 5s
|
||||
#define PERIOD_ANIMATION_US (200 * 1000) // 200ms
|
||||
#define PERIOD_CLOCK_UPDATE_US (1 * 1000 * 1000) // Must be 1s! Do not change!
|
||||
#define PERIOD_HEARTBEAT_US (1 * 1000 * 1000) // 1s
|
||||
#define PERIOD_MATRIX_UPDATE_US (33 * 1000) // 33ms
|
||||
#define PERIOD_NIGHTMODE_CHECK_US (30 * 1000 * 1000) // 30s
|
||||
#define PERIOD_TIME_UPDATE_US (1 * 1000 * 1000) // 1000ms
|
||||
#define PERIOD_PONG_US (10 * 1000) // 10ms
|
||||
#define PERIOD_SNAKE_US (50 * 1000) // 50ms
|
||||
#define PERIOD_STATE_CHANGE_US (10 * 1000 * 1000) // 10s
|
||||
#define PERIOD_TETRIS_US (50 * 1000) // 50ms
|
||||
#define TIMEOUT_LEDDIRECT_US (5 * 1000 * 1000) // 5s
|
||||
#define PERIOD_BRIGHTNESS_UPDATE_US (5 * 60 * 1000 * 1000) // 300s
|
||||
|
||||
#define SHORT_PRESS_US (100 * 1000) // 100ms
|
||||
#define LONG_PRESS_US (2 * 1000 * 1000) // 2s
|
||||
@@ -62,17 +63,17 @@
|
||||
|
||||
// Number of colors in colors array
|
||||
#define NUM_COLORS (7)
|
||||
#define COLOR_ORDER GRB // WS2812B color order
|
||||
|
||||
// LED matrix size
|
||||
#define MATRIX_WIDTH (11)
|
||||
#define MATRIX_HEIGHT (11)
|
||||
#define NUM_MATRIX (MATRIX_WIDTH * (MATRIX_HEIGHT + 1))
|
||||
|
||||
// NTP macros
|
||||
#define BUILD_YEAR (__DATE__ + 7) /* Will expand to current year at compile time as string. */
|
||||
#define NTP_MININUM_RX_YEAR (atoi(BUILD_YEAR) - 1) /* Will expand to current year at compile time minus one. */
|
||||
#define NTP_MININUM_YEAR (1900) // NTP minimum year is 1900
|
||||
#define NTP_MAX_UPDATE_TIME_US (500000) // 500ms max update time
|
||||
#define NTP_NEXT_UPDATE_DELAY_US (10000000) // 10s delay time between updates
|
||||
#define NTP_WATCHDOG_COUNTER_INIT (30) // Watchdog value, count of retries before restart
|
||||
#define BUILD_YEAR (__DATE__ + 7) // Will expand to current year at compile time as string.
|
||||
#define NTP_MINIMUM_RX_YEAR (atoi(BUILD_YEAR) - 1) // Will expand to current year minus one at compile time.
|
||||
#define NTP_START_YEAR (1900) // NTP minimum year is 1900
|
||||
#define NTP_MAX_OFFLINE_TIME_S (7 * 24 * 3600) // Watchdog value, maximum offline time before a restart is triggered
|
||||
|
||||
#endif /* WORDCLOCK_CONSTANTS_H */
|
||||
|
||||
@@ -61,12 +61,11 @@ typedef enum
|
||||
// ----------------------------------------------------------------------------------
|
||||
// FUNCTIONS DECLARATIONS
|
||||
// ----------------------------------------------------------------------------------
|
||||
bool get_ntp_time(uint32 timeout);
|
||||
bool check_wifi_status(void);
|
||||
String leading_zero2digit(int value);
|
||||
uint8_t calculate_dynamic_brightness(uint8_t min_brightness, uint8_t max_brightness, int hours, int minutes, bool summertime);
|
||||
uint8_t update_brightness(void);
|
||||
void check_night_mode(void);
|
||||
void check_wifi_status(void);
|
||||
void cold_start_setup(void);
|
||||
void draw_main_color(void);
|
||||
void handle_button(void);
|
||||
@@ -76,8 +75,6 @@ void handle_data_request(void);
|
||||
void handle_led_direct(void);
|
||||
void limit_value_ranges(void);
|
||||
void log_data(void);
|
||||
void log_time(tm local_time);
|
||||
void ntp_time_update(uint32 max_update_time);
|
||||
void on_state_entry(uint8_t state);
|
||||
void read_settings_from_EEPROM(void);
|
||||
void reset_wifi_credentials(void);
|
||||
@@ -85,7 +82,7 @@ void send_heartbeat(void);
|
||||
void set_dynamic_brightness(bool state);
|
||||
void set_main_color(uint8_t red, uint8_t green, uint8_t blue);
|
||||
void set_night_mode(bool on);
|
||||
void state_change(uint8_t newState);
|
||||
void state_change(ClockState_en new_state);
|
||||
void update_matrix(void);
|
||||
void write_settings_to_EEPROM(void);
|
||||
|
||||
|
||||
@@ -12,15 +12,16 @@
|
||||
default_envs = nodemcuv2
|
||||
|
||||
[env]
|
||||
platform = espressif8266
|
||||
platform = espressif8266@2.6.3
|
||||
board = nodemcuv2
|
||||
framework = arduino
|
||||
lib_deps =
|
||||
adafruit/Adafruit BusIO@^1.15.0
|
||||
adafruit/Adafruit NeoMatrix@^1.3.0
|
||||
adafruit/Adafruit NeoPixel@^1.11.0
|
||||
densaugeo/base64@^1.4.0
|
||||
tzapu/WiFiManager@^0.16.0
|
||||
densaugeo/base64@^1.4.0
|
||||
fastled/FastLED@3.7.6
|
||||
marcmerlin/FastLED NeoMatrix@^1.2
|
||||
tzapu/WiFiManager@^2.0.17
|
||||
build_flags =
|
||||
-DFASTLED_ESP8266_RAW_PIN_ORDER
|
||||
|
||||
[env:nodemcuv2]
|
||||
monitor_speed = 115200
|
||||
|
||||
13
scripts/http_diagnosis.py
Normal file
13
scripts/http_diagnosis.py
Normal file
@@ -0,0 +1,13 @@
|
||||
import requests
|
||||
|
||||
r = requests.get("http://wordclock.local/cmd?diag=reset_info")
|
||||
print(r.status_code)
|
||||
print(r.text)
|
||||
|
||||
r = requests.get("http://wordclock.local/cmd?diag=sketch_info")
|
||||
print(r.status_code)
|
||||
print(r.text)
|
||||
|
||||
r = requests.get("http://wordclock.local/cmd?diag=device_info")
|
||||
print(r.status_code)
|
||||
print(r.text)
|
||||
@@ -4,13 +4,15 @@ import queue
|
||||
import socket
|
||||
import struct
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
LOG_PATH = Path("C:/temp/wordclock_log.txt")
|
||||
|
||||
def setup_logging():
|
||||
FORMAT = "%(asctime)s %(message)s"
|
||||
logging.basicConfig(format=FORMAT, level=logging.INFO)
|
||||
logger = logging.getLogger()
|
||||
handler = logging.StreamHandler(sys.stdout)
|
||||
handler = logging.FileHandler(LOG_PATH)
|
||||
handler.setLevel(logging.INFO)
|
||||
logger.addHandler(handler)
|
||||
return logger
|
||||
@@ -42,33 +44,9 @@ mreq = struct.pack("4s4s", group, socket.inet_aton(get_ip_address()))
|
||||
sock.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, mreq)
|
||||
|
||||
logger.info("Ready")
|
||||
saveCounter = 0
|
||||
|
||||
buffer = queue.Queue(20)
|
||||
|
||||
# Receive/respond loop
|
||||
while True:
|
||||
data, address = sock.recvfrom(1024)
|
||||
data_str = data.decode("utf-8").strip()
|
||||
logger.info(data_str)
|
||||
data_str = datetime.now().strftime("%b-%d-%Y_%H%M%S") + ": " + data_str
|
||||
buffer.put(data_str)
|
||||
if buffer.full():
|
||||
buffer.get()
|
||||
|
||||
if "NTP-Update not successful" in data_str or "Start program" in data_str:
|
||||
f = open("log.txt", "a")
|
||||
while not buffer.empty():
|
||||
f.write(buffer.get())
|
||||
f.write("\n")
|
||||
f.close()
|
||||
saveCounter = 20
|
||||
|
||||
if saveCounter > 0:
|
||||
f = open("log.txt", "a")
|
||||
f.write(data_str)
|
||||
f.write("\n")
|
||||
if saveCounter == 1:
|
||||
f.write("\n")
|
||||
f.close()
|
||||
saveCounter -= 1
|
||||
|
||||
BIN
scripts/requirements.txt
Normal file
BIN
scripts/requirements.txt
Normal file
Binary file not shown.
93
src/connectivity/diagnosis.cpp
Normal file
93
src/connectivity/diagnosis.cpp
Normal file
@@ -0,0 +1,93 @@
|
||||
#include "diagnosis.h"
|
||||
|
||||
Diagnosis::Diagnosis()
|
||||
{
|
||||
_logger = nullptr;
|
||||
}
|
||||
|
||||
Diagnosis::Diagnosis(UDPLogger *logger, LEDMatrix *matrix) // constructor
|
||||
{
|
||||
_logger = logger;
|
||||
_matrix = matrix;
|
||||
}
|
||||
|
||||
String Diagnosis::handle_command(const String &command)
|
||||
{
|
||||
if (command == "device_info")
|
||||
{
|
||||
return print_device_info();
|
||||
}
|
||||
else if (command == "sketch_info")
|
||||
{
|
||||
return print_sketch_info();
|
||||
}
|
||||
else if (command == "reset_info")
|
||||
{
|
||||
return print_last_reset_details();
|
||||
}
|
||||
else if (command == "matrix_fps")
|
||||
{
|
||||
return print_matrix_fps();
|
||||
}
|
||||
else
|
||||
{
|
||||
// Handle unknown command
|
||||
String unknown_command = "Diagnosis: Unknown command!\n";
|
||||
print(unknown_command);
|
||||
return unknown_command;
|
||||
}
|
||||
}
|
||||
|
||||
String Diagnosis::print_device_info()
|
||||
{
|
||||
// Retrieve and print device information
|
||||
String device_info = "Device Information:\n";
|
||||
device_info += "Chip ID: " + String(ESP.getChipId()) + "\n";
|
||||
device_info += "Flash Chip ID: " + String(ESP.getFlashChipId()) + "\n";
|
||||
device_info += "Flash Chip Size: " + String(ESP.getFlashChipSize()) + " bytes\n";
|
||||
device_info += "Free Heap Size: " + String(ESP.getFreeHeap()) + " bytes\n";
|
||||
device_info += "Free Sketch Space: " + String(ESP.getFreeSketchSpace()) + " bytes\n";
|
||||
device_info += "SDK Version: " + String(ESP.getSdkVersion()) + "\n";
|
||||
print(device_info);
|
||||
return device_info;
|
||||
}
|
||||
|
||||
String Diagnosis::print_sketch_info()
|
||||
{
|
||||
// Retrieve and print sketch information
|
||||
String sketch_info = "Sketch Information:\n";
|
||||
sketch_info += "Sketch Size: " + String(ESP.getSketchSize()) + " bytes\n";
|
||||
sketch_info += "Sketch MD5: " + String(ESP.getSketchMD5()) + "\n";
|
||||
print(sketch_info);
|
||||
return sketch_info;
|
||||
}
|
||||
|
||||
String Diagnosis::print_last_reset_details()
|
||||
{
|
||||
// Retrieve and print last reset details
|
||||
String reset_info = "Last Reset Details:\n";
|
||||
reset_info += "Reset Reason: " + String(ESP.getResetReason()) + "\n";
|
||||
reset_info += "Reset Info: " + String(ESP.getResetInfo()) + "\n";
|
||||
print(reset_info);
|
||||
return reset_info;
|
||||
}
|
||||
|
||||
String Diagnosis::print_matrix_fps()
|
||||
{
|
||||
// Retrieve and print matrix FPS
|
||||
String matrix_fps = "Matrix FPS: " + String(_matrix->get_fps()) + "\n";
|
||||
print(matrix_fps);
|
||||
return matrix_fps;
|
||||
}
|
||||
|
||||
void Diagnosis::print(const String &s)
|
||||
{
|
||||
if (_logger != nullptr)
|
||||
{
|
||||
_logger->log_string(s);
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial.println(s);
|
||||
}
|
||||
}
|
||||
214
src/connectivity/time_manager.cpp
Normal file
214
src/connectivity/time_manager.cpp
Normal file
@@ -0,0 +1,214 @@
|
||||
#include "time_manager.h"
|
||||
#include "wordclock_constants.h"
|
||||
#include <coredecls.h> // required for settimeofday_cb()
|
||||
#include <sntp.h>
|
||||
#include <time.h>
|
||||
|
||||
extern UDPLogger logger; // logging instance
|
||||
|
||||
// ----------------------------------------------------------------------------------
|
||||
// Class
|
||||
// ----------------------------------------------------------------------------------
|
||||
TimeManager::TimeManager(){};
|
||||
TimeManager::TimeManager(const char *tz,
|
||||
const char *ntp_server,
|
||||
bool (*is_wifi_connected)(void),
|
||||
uint32 ntp_max_offline_time_s,
|
||||
UDPLogger *logger)
|
||||
{
|
||||
_tz = tz;
|
||||
_ntp_server = ntp_server;
|
||||
_is_wifi_connected = is_wifi_connected;
|
||||
_ntp_max_offline_time_s = ntp_max_offline_time_s;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
void TimeManager::init()
|
||||
{
|
||||
// Set up NTP server once
|
||||
_set_up_ntp();
|
||||
|
||||
if (_tm_state == TM_INITIAL_SYNC)
|
||||
{
|
||||
// force sntp reinit now
|
||||
sntp_stop();
|
||||
sntp_init();
|
||||
}
|
||||
settimeofday_cb([&]() { time_set_cb(); });
|
||||
}
|
||||
|
||||
bool TimeManager::ntp_sync_successful(void) const
|
||||
{
|
||||
return (_now > 1716913300); // UTC timestamp in the past (28.05.2024)
|
||||
}
|
||||
|
||||
bool TimeManager::ntp_sync_overdue(void)
|
||||
{
|
||||
if (!ntp_sync_successful())
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
bool retval = false;
|
||||
// after the ntp sync update delay has been reached six times, the sync is considered overdue
|
||||
if (_now >= (_ntp_sync_timestamp_s + (time_t)(6 * (sntp_update_delay_MS_rfc_not_less_than_15000() / 1000))))
|
||||
{
|
||||
_tm_state = TM_SYNC_OVERDUE;
|
||||
retval = true;
|
||||
}
|
||||
return retval;
|
||||
}
|
||||
|
||||
bool TimeManager::ntp_sync_timeout(void)
|
||||
{
|
||||
if (!ntp_sync_successful())
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
bool retval = false;
|
||||
// after the maxmimum offline time has been reached, the sync is considered timed out
|
||||
if (_now >= (_ntp_sync_timestamp_s + (time_t)_ntp_max_offline_time_s))
|
||||
{
|
||||
_tm_state = TM_SYNC_TIMEOUT;
|
||||
retval = true;
|
||||
}
|
||||
return retval;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief NTP time update, should be called in loop().
|
||||
*
|
||||
* @retval true if last update was successful
|
||||
*/
|
||||
TimeUpdateState TimeManager::get_time()
|
||||
{
|
||||
TimeUpdateState retval = TIME_UPDATE_PENDING; // NTP time update
|
||||
uint32 timestamp_us = system_get_time(); // NTP update start time
|
||||
struct tm time_info; // local NTP time info
|
||||
|
||||
do
|
||||
{
|
||||
_now = time(nullptr); // update time
|
||||
(void)localtime_r(&_now, &time_info); // convert time
|
||||
yield(); // since this loop could take up to NTP_MAX_UPDATE_TIME_US
|
||||
|
||||
} while (((system_get_time() - timestamp_us) <= NTP_MAX_UPDATE_TIME_US) && (time_info.tm_year < (NTP_MINIMUM_RX_YEAR - NTP_START_YEAR)));
|
||||
|
||||
retval = (time_info.tm_year <= (NTP_MINIMUM_RX_YEAR - NTP_START_YEAR)) ? TIME_UPDATE_FAILED : TIME_UPDATE_OK; // sanity check
|
||||
|
||||
if (retval == TIME_UPDATE_OK)
|
||||
{
|
||||
_time_info = time_info; // take over time_info to member variable
|
||||
_tm_state = TM_NORMAL;
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.log_string("NTP-Update was not successful. Retrying in " + String(sntp_update_delay_MS_rfc_not_less_than_15000()) + "ms.");
|
||||
}
|
||||
|
||||
return retval;
|
||||
}
|
||||
|
||||
bool TimeManager::isdst(void) const
|
||||
{
|
||||
return (_time_info.tm_isdst > 0);
|
||||
}
|
||||
|
||||
int TimeManager::day(void) const
|
||||
{
|
||||
return (_time_info.tm_mday + 1); // add 1 to get actual day
|
||||
}
|
||||
|
||||
int TimeManager::hour(void) const
|
||||
{
|
||||
return _time_info.tm_hour;
|
||||
}
|
||||
|
||||
int TimeManager::minute(void) const
|
||||
{
|
||||
return _time_info.tm_min;
|
||||
}
|
||||
|
||||
int TimeManager::month(void) const
|
||||
{
|
||||
return (_time_info.tm_mon + 1); // add 1 to get actual month
|
||||
}
|
||||
|
||||
int TimeManager::year(void) const
|
||||
{
|
||||
return _time_info.tm_year + NTP_START_YEAR; // add start year to get actual year
|
||||
}
|
||||
|
||||
struct tm TimeManager::time_info(void) const
|
||||
{
|
||||
return _time_info;
|
||||
}
|
||||
|
||||
TimeManagerState TimeManager::tm_state(void) const
|
||||
{
|
||||
return _tm_state;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Log time_info as string.
|
||||
*
|
||||
* @param local_time
|
||||
*/
|
||||
void TimeManager::log_time() const
|
||||
{
|
||||
log_time(_time_info);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Log time_info as string.
|
||||
*
|
||||
* @param local_time
|
||||
*/
|
||||
void TimeManager::log_time(struct tm time_info) const
|
||||
{
|
||||
char strftime_buf[64]; // Time string buffer
|
||||
strftime(strftime_buf, sizeof(strftime_buf), "%c", &time_info);
|
||||
logger.log_string(String(strftime_buf));
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Sets up the NTP server config
|
||||
*
|
||||
*/
|
||||
void TimeManager::_set_up_ntp(void)
|
||||
{
|
||||
if ((_tz != nullptr) && (_ntp_server != nullptr))
|
||||
{
|
||||
// set up NTP server and timezone at init
|
||||
configTime(_tz, _ntp_server);
|
||||
_tm_state = TM_INITIAL_SYNC;
|
||||
logger.log_string(String("NTP configuration was set up successfully!"));
|
||||
}
|
||||
else
|
||||
{
|
||||
_tm_state = TM_SETUP_FAILED;
|
||||
logger.log_string(String("ERROR: Timezone and/or NTP-Server were not given correctly!"));
|
||||
}
|
||||
}
|
||||
|
||||
void TimeManager::time_set_cb(void)
|
||||
{
|
||||
if ((*_is_wifi_connected)())
|
||||
{
|
||||
if (get_time() == TIME_UPDATE_OK)
|
||||
{
|
||||
_ntp_sync_timestamp_s = _now;
|
||||
logger.log_string("NTP successfully synced at...");
|
||||
log_time();
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.log_string("NTP sync failed!");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.log_string("NTP sync failed, WiFi is not connected!");
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,6 @@
|
||||
#include "udp_logger.h"
|
||||
|
||||
UDPLogger::UDPLogger()
|
||||
{
|
||||
}
|
||||
UDPLogger::UDPLogger() {}
|
||||
|
||||
UDPLogger::UDPLogger(IPAddress interface_addr, IPAddress multicast_addr, int port, String name)
|
||||
{
|
||||
@@ -26,8 +24,10 @@ void UDPLogger::log_string(String message)
|
||||
delay(10);
|
||||
}
|
||||
message = _name + ": " + message;
|
||||
#ifdef SERIAL_DEBUG
|
||||
Serial.println(message);
|
||||
delay(10);
|
||||
#endif /* SERIAL_DEBUG */
|
||||
_udp.beginPacketMulticast(_multicastAddr, _port, _interfaceAddr);
|
||||
message.toCharArray(_packetBuffer, 100);
|
||||
_udp.print(_packetBuffer);
|
||||
|
||||
@@ -21,7 +21,7 @@ const uint32_t colors_24bit[NUM_COLORS] = {
|
||||
* @param mybrightness the initial brightness of the leds
|
||||
* @param mylogger pointer to the UDPLogger object
|
||||
*/
|
||||
LEDMatrix::LEDMatrix(Adafruit_NeoMatrix *matrix, uint8_t brightness, UDPLogger *logger)
|
||||
LEDMatrix::LEDMatrix(FastLED_NeoMatrix *matrix, uint8_t brightness, UDPLogger *logger)
|
||||
{
|
||||
_neomatrix = matrix;
|
||||
_brightness = brightness;
|
||||
@@ -181,6 +181,11 @@ void LEDMatrix::flush(void)
|
||||
_target_minute_indicators[3] = 0;
|
||||
}
|
||||
|
||||
uint16_t LEDMatrix::get_fps(void)
|
||||
{
|
||||
return FastLED.getFPS();
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Write target pixels directly to leds
|
||||
*
|
||||
|
||||
@@ -179,58 +179,79 @@ String time_to_string(uint8_t hours, uint8_t minutes)
|
||||
// show hours
|
||||
switch (hours)
|
||||
{
|
||||
case 0:
|
||||
if (minutes >= 0 && minutes < 5)
|
||||
case 0:
|
||||
{
|
||||
message += "MITTERNACHT ";
|
||||
if (minutes >= 0 && minutes < 5)
|
||||
{
|
||||
message += "MITTERNACHT ";
|
||||
}
|
||||
else
|
||||
{
|
||||
message += "ZWOLF ";
|
||||
}
|
||||
break;
|
||||
}
|
||||
else
|
||||
case 1:
|
||||
{
|
||||
message += "EIN";
|
||||
message += (minutes > 4) ? "S " : " "; // add "S" if needed
|
||||
break;
|
||||
}
|
||||
case 2:
|
||||
{
|
||||
message += "ZWEI ";
|
||||
break;
|
||||
}
|
||||
case 3:
|
||||
{
|
||||
message += "DREI ";
|
||||
break;
|
||||
}
|
||||
case 4:
|
||||
{
|
||||
message += "VIER ";
|
||||
break;
|
||||
}
|
||||
case 5:
|
||||
{
|
||||
message += "FUNF ";
|
||||
break;
|
||||
}
|
||||
case 6:
|
||||
{
|
||||
message += "SECHS ";
|
||||
break;
|
||||
}
|
||||
case 7:
|
||||
{
|
||||
message += "SIEBEN ";
|
||||
break;
|
||||
}
|
||||
case 8:
|
||||
{
|
||||
message += "ACHT ";
|
||||
break;
|
||||
}
|
||||
case 9:
|
||||
{
|
||||
message += "NEUN ";
|
||||
break;
|
||||
}
|
||||
case 10:
|
||||
{
|
||||
message += "ZEHN ";
|
||||
break;
|
||||
}
|
||||
case 11:
|
||||
{
|
||||
message += "ELF ";
|
||||
break;
|
||||
}
|
||||
case 12:
|
||||
{
|
||||
message += "ZWOLF ";
|
||||
break;
|
||||
}
|
||||
break;
|
||||
case 1:
|
||||
message += "EIN";
|
||||
// EIN(S)
|
||||
if (minutes > 4)
|
||||
{
|
||||
message += "S";
|
||||
}
|
||||
message += " ";
|
||||
break;
|
||||
case 2:
|
||||
message += "ZWEI ";
|
||||
break;
|
||||
case 3:
|
||||
message += "DREI ";
|
||||
break;
|
||||
case 4:
|
||||
message += "VIER ";
|
||||
break;
|
||||
case 5:
|
||||
message += "FUNF ";
|
||||
break;
|
||||
case 6:
|
||||
message += "SECHS ";
|
||||
break;
|
||||
case 7:
|
||||
message += "SIEBEN ";
|
||||
break;
|
||||
case 8:
|
||||
message += "ACHT ";
|
||||
break;
|
||||
case 9:
|
||||
message += "NEUN ";
|
||||
break;
|
||||
case 10:
|
||||
message += "ZEHN ";
|
||||
break;
|
||||
case 11:
|
||||
message += "ELF ";
|
||||
break;
|
||||
case 12:
|
||||
message += "ZWOLF ";
|
||||
break;
|
||||
}
|
||||
if ((minutes < 5) && (hours != 0))
|
||||
{
|
||||
|
||||
@@ -23,18 +23,17 @@
|
||||
#include <Arduino.h>
|
||||
#include "wordclock_esp8266.h"
|
||||
|
||||
#include <Adafruit_GFX.h> // https://github.com/adafruit/Adafruit-GFX-Library
|
||||
#include <Adafruit_NeoMatrix.h> // https://github.com/adafruit/Adafruit_NeoMatrix
|
||||
#include <Adafruit_NeoPixel.h> // NeoPixel library used to run the NeoPixel LEDs: https://github.com/adafruit/Adafruit_NeoPixel
|
||||
#include <Adafruit_GFX.h> // https://github.com/adafruit/Adafruit-GFX-Library
|
||||
#include <base64.hpp>
|
||||
#include <EEPROM.h> //from ESP8266 Arduino Core (automatically installed when ESP8266 was installed via Boardmanager)
|
||||
#include <EEPROM.h> // from ESP8266 Arduino Core (automatically installed when ESP8266 was installed via Boardmanager)
|
||||
#include <ESP8266WebServer.h>
|
||||
#include <ESP8266WiFi.h>
|
||||
#include <time.h>
|
||||
#include <FastLED.h>
|
||||
#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager WiFi Configuration Magic
|
||||
|
||||
// own libraries
|
||||
#include "animation_functions.h"
|
||||
#include "diagnosis.h"
|
||||
#include "led_matrix.h"
|
||||
#include "littlefs_wrapper.h"
|
||||
#include "ota_functions.h"
|
||||
@@ -42,6 +41,7 @@
|
||||
#include "render_functions.h"
|
||||
#include "snake.h"
|
||||
#include "tetris.h"
|
||||
#include "time_manager.h"
|
||||
#include "udp_logger.h"
|
||||
#include "wordclock_constants.h"
|
||||
|
||||
@@ -49,11 +49,12 @@
|
||||
// GLOBAL VARIABLES
|
||||
// ----------------------------------------------------------------------------------
|
||||
UDPLogger logger; // Global UDP logger instance
|
||||
Adafruit_NeoMatrix matrix = Adafruit_NeoMatrix(MATRIX_WIDTH, MATRIX_HEIGHT + 1, NEOPIXEL_PIN,
|
||||
NEO_MATRIX_TOP + NEO_MATRIX_LEFT + NEO_MATRIX_ROWS + NEO_MATRIX_ZIGZAG,
|
||||
NEO_GRB + NEO_KHZ800); // NeoMatrix
|
||||
|
||||
CRGB leds[NUM_MATRIX]; // LED array for FastLED
|
||||
FastLED_NeoMatrix matrix = FastLED_NeoMatrix(leds, MATRIX_WIDTH, (MATRIX_HEIGHT + 1),
|
||||
NEO_MATRIX_TOP + NEO_MATRIX_LEFT + NEO_MATRIX_ROWS + NEO_MATRIX_ZIGZAG);
|
||||
LEDMatrix led_matrix = LEDMatrix(&matrix, DEFAULT_BRIGHTNESS, &logger); // FastLED_NeoMatrix wrapper
|
||||
ESP8266WebServer webserver(HTTP_PORT); // Webserver
|
||||
LEDMatrix led_matrix = LEDMatrix(&matrix, DEFAULT_BRIGHTNESS, &logger); // NeoMatrix wrapper
|
||||
|
||||
// ----------------------------------------------------------------------------------
|
||||
// STATIC VARIABLES
|
||||
@@ -69,12 +70,8 @@ static Pong pong = Pong(&led_matrix, &logger);
|
||||
static Snake snake = Snake(&led_matrix, &logger);
|
||||
static Tetris tetris = Tetris(&led_matrix, &logger);
|
||||
|
||||
// Time
|
||||
static struct tm time_info; // Structure tm holds time information
|
||||
static time_t time_now; // Seconds since Epoch (1970) - UTC
|
||||
|
||||
// NTP
|
||||
static uint32 last_ntp_update_us = 0; // Time of last NTP update
|
||||
// Time Manager
|
||||
static TimeManager tm_mgr;
|
||||
|
||||
// State variables
|
||||
static bool flg_night_mode = false; // State of nightmode
|
||||
@@ -82,7 +79,7 @@ static bool flg_reset_wifi_creds = false; // Used to reset stored
|
||||
static float filter_factor = DEFAULT_SMOOTHING_FACTOR; // Stores smoothing factor for led transition, value of 1 represents no smoothing.
|
||||
static uint32_t main_color_clock = colors_24bit[2]; // Color of the clock and digital clock
|
||||
static uint8_t current_brightness = DEFAULT_BRIGHTNESS; // Current brightness of LEDs
|
||||
static uint8_t current_state = (uint8_t)ST_CLOCK; // Stores current state
|
||||
static ClockState_en current_state = ST_CLOCK; // Stores current state
|
||||
|
||||
// Other variables
|
||||
static uint32 last_led_direct_us = 0; // Time of last direct LED command (=> fall back to normal mode after timeout)
|
||||
@@ -98,9 +95,10 @@ static const float qtly_brightness_factor[96] = {
|
||||
0.998f, 0.997f, 0.995f, 0.991f, 0.986f, 0.978f, 0.966f, 0.949f, 0.927f, 0.896f, 0.858f, 0.811f, 0.755f, 0.691f,
|
||||
0.62f, 0.545f, 0.468f, 0.392f, 0.32f, 0.253f, 0.194f, 0.143f, 0.101f, 0.069f, 0.044f, 0.026f, 0.014f, 0.007f,
|
||||
0.003f, 0.001f, 0.0f, 0.0f};
|
||||
static const uint32_t period_timings[NUM_STATES] = {PERIOD_CLOCK_UPDATE_US, PERIOD_CLOCK_UPDATE_US,
|
||||
static const uint32_t period_timings[NUM_STATES] = {PERIOD_TIME_UPDATE_US, PERIOD_TIME_UPDATE_US,
|
||||
PERIOD_ANIMATION_US, PERIOD_TETRIS_US, PERIOD_SNAKE_US,
|
||||
PERIOD_PONG_US, PERIOD_ANIMATION_US};
|
||||
|
||||
// ----------------------------------------------------------------------------------
|
||||
// SETUP
|
||||
// ----------------------------------------------------------------------------------
|
||||
@@ -120,6 +118,9 @@ void setup()
|
||||
Serial.printf("Reset address: %u\n", reset_info->excvaddr);
|
||||
Serial.println();
|
||||
|
||||
// Init FastLED
|
||||
FastLED.addLeds<WS2812B, FASTLED_PIN, COLOR_ORDER>(leds, NUM_MATRIX);
|
||||
|
||||
// Init EEPROM
|
||||
EEPROM.begin(EEPROM_SIZE);
|
||||
|
||||
@@ -137,7 +138,7 @@ void setup()
|
||||
led_matrix.set_current_limit(CURRENT_LIMIT_LED);
|
||||
|
||||
// Turn on minutes LEDs (blue)
|
||||
led_matrix.set_min_indicator(15, colors_24bit[6]);
|
||||
led_matrix.set_min_indicator((uint8_t)0b1111, colors_24bit[6]);
|
||||
led_matrix.draw_on_matrix_instant();
|
||||
|
||||
/* Use WiFiMaanger for handling initial Wifi setup */
|
||||
@@ -156,18 +157,18 @@ void setup()
|
||||
WiFi.persistent(true);
|
||||
|
||||
// Turn off minutes LEDs
|
||||
led_matrix.set_min_indicator(15, 0);
|
||||
led_matrix.set_min_indicator((uint8_t)0b1111, 0);
|
||||
led_matrix.draw_on_matrix_instant();
|
||||
|
||||
// init ESP8266 File manager (LittleFS)
|
||||
setup_filesystem();
|
||||
|
||||
// setup OTA
|
||||
// set up OTA
|
||||
setupOTA(HOSTNAME);
|
||||
|
||||
webserver.on("/cmd", handle_command); // process commands
|
||||
webserver.on("/data", handle_data_request); // process data requests
|
||||
webserver.on("/leddirect", HTTP_POST, handle_led_direct); // Call the 'handle_led_direct' function when a POST request is made to URI "/leddirect"
|
||||
webserver.on("/leddirect", HTTP_POST, handle_led_direct); // call the 'handle_led_direct' function when a POST request is made to URI "/leddirect"
|
||||
webserver.begin();
|
||||
|
||||
// create UDP Logger to send logging messages via UDP multicast
|
||||
@@ -178,22 +179,26 @@ void setup()
|
||||
cold_start_setup();
|
||||
}
|
||||
|
||||
// setup NTP
|
||||
configTime(MY_TZ, NTP_SERVER_URL);
|
||||
ntp_time_update(NTP_MAX_UPDATE_TIME_US); // NTP time update
|
||||
// set up time manager and get initial time
|
||||
tm_mgr = TimeManager(MY_TZ, NTP_SERVER_URL, check_wifi_status, NTP_MAX_OFFLINE_TIME_S, &logger);
|
||||
tm_mgr.init();
|
||||
|
||||
// show the current time for short time in words
|
||||
String timeMessage = time_to_string(time_info.tm_hour, time_info.tm_min);
|
||||
show_string_on_clock(timeMessage, main_color_clock);
|
||||
draw_minute_indicator(time_info.tm_min, main_color_clock);
|
||||
led_matrix.draw_on_matrix_smooth(filter_factor);
|
||||
if (tm_mgr.get_time() == TIME_UPDATE_OK)
|
||||
{
|
||||
// show the current time for short time in words
|
||||
String timeMessage = time_to_string(tm_mgr.hour(), tm_mgr.minute());
|
||||
show_string_on_clock(timeMessage, main_color_clock);
|
||||
draw_minute_indicator(tm_mgr.minute(), main_color_clock);
|
||||
led_matrix.draw_on_matrix_smooth(filter_factor);
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.log_string("Warning: Initial time sync failed! Retrying in a bit.");
|
||||
}
|
||||
|
||||
// init all animation modes
|
||||
// init snake
|
||||
random_snake(true, 8, colors_24bit[1], -1);
|
||||
// init spiral
|
||||
draw_spiral(true, spiral_direction, MATRIX_WIDTH - 6);
|
||||
// init random tetris
|
||||
random_tetris(true);
|
||||
|
||||
// Set range limits
|
||||
@@ -214,56 +219,61 @@ void loop()
|
||||
uint32 current_time_us = system_get_time();
|
||||
|
||||
// Timestamp variables
|
||||
static uint32 last_animation_step_us = 0; // time of last animation step
|
||||
static uint32 last_matrix_update_us = 0; // time of last Matrix update
|
||||
static uint32 last_heartbeat_us = 0; // time of last heartbeat sending
|
||||
static uint32 last_nightmode_check_us = 0; // time of last nightmode check
|
||||
static uint32 last_animation_step_us = 0; // timestamp of last animation step
|
||||
static uint32 last_matrix_update_us = 0; // timestamp of last Matrix update
|
||||
static uint32 last_time_update_us = 0; // timestamp of last time update
|
||||
static uint32 last_heartbeat_us = 0; // timestamp of last heartbeat sending
|
||||
static uint32 last_nightmode_check_us = 0; // timestamp of last nightmode check
|
||||
static uint32 last_brightness_update_us = 0; // timestamp of last brightness update
|
||||
|
||||
handleOTA(); // handle OTA
|
||||
|
||||
webserver.handleClient(); // handle webserver
|
||||
|
||||
handle_button(); // handle button press
|
||||
|
||||
// send regularly heartbeat messages via UDP multicast
|
||||
if ((current_time_us - last_heartbeat_us) > PERIOD_HEARTBEAT_US)
|
||||
if ((current_time_us - last_heartbeat_us) >= PERIOD_HEARTBEAT_US)
|
||||
{
|
||||
send_heartbeat(); // send heartbeat update
|
||||
last_heartbeat_us = system_get_time();
|
||||
delay(10);
|
||||
}
|
||||
|
||||
if (!flg_night_mode && ((current_time_us - last_animation_step_us) > period_timings[current_state]) &&
|
||||
((current_time_us - last_led_direct_us) > TIMEOUT_LEDDIRECT_US))
|
||||
((current_time_us - last_led_direct_us) >= TIMEOUT_LEDDIRECT_US))
|
||||
{
|
||||
handle_current_state(); // handle current state
|
||||
last_animation_step_us = system_get_time();
|
||||
delay(10);
|
||||
}
|
||||
|
||||
if ((current_time_us - last_matrix_update_us) > PERIOD_MATRIX_UPDATE_US)
|
||||
if ((current_time_us - last_brightness_update_us) >= PERIOD_BRIGHTNESS_UPDATE_US)
|
||||
{
|
||||
current_brightness = update_brightness(); // update brightness
|
||||
logger.log_string("Brightness: " + String(((uint16_t)current_brightness * 100) / UINT8_MAX) + "%");
|
||||
last_brightness_update_us = system_get_time();
|
||||
}
|
||||
|
||||
if ((current_time_us - last_matrix_update_us) >= PERIOD_MATRIX_UPDATE_US)
|
||||
{
|
||||
update_matrix(); // update matrix
|
||||
last_matrix_update_us = system_get_time();
|
||||
delay(10);
|
||||
}
|
||||
|
||||
handle_button(); // handle button press
|
||||
|
||||
if ((current_time_us - last_ntp_update_us) > PERIOD_NTP_UPDATE_US)
|
||||
if ((current_time_us - last_time_update_us) >= PERIOD_TIME_UPDATE_US)
|
||||
{
|
||||
check_wifi_status(); // check WiFi status before NTP update
|
||||
delay(10);
|
||||
(void)tm_mgr.get_time(); // NTP time update
|
||||
|
||||
ntp_time_update(NTP_MAX_UPDATE_TIME_US); // NTP time update
|
||||
delay(10);
|
||||
if (tm_mgr.ntp_sync_timeout())
|
||||
{
|
||||
logger.log_string("Trigger restart due to being offline for too long...");
|
||||
delay(100);
|
||||
ESP.restart();
|
||||
}
|
||||
|
||||
current_brightness = update_brightness(); // update brightness every PERIOD_NTP_UPDATE_US
|
||||
delay(10);
|
||||
|
||||
logger.log_string("Brightness: " + String(((uint16_t)current_brightness * 100) / UINT8_MAX) + "%");
|
||||
delay(10);
|
||||
last_time_update_us = system_get_time();
|
||||
}
|
||||
|
||||
if ((current_time_us - last_nightmode_check_us) > PERIOD_NIGHTMODE_CHECK_US)
|
||||
if ((current_time_us - last_nightmode_check_us) >= PERIOD_NIGHTMODE_CHECK_US)
|
||||
{
|
||||
check_night_mode(); // check night mode
|
||||
last_nightmode_check_us = system_get_time();
|
||||
@@ -288,7 +298,7 @@ void log_data()
|
||||
logger.log_string("Nightmode starts at: " + String(night_mode_times_ps->start_hour) + ":" + String(night_mode_times_ps->start_min));
|
||||
logger.log_string("Nightmode ends at: " + String(night_mode_times_ps->end_hour) + ":" + String(night_mode_times_ps->end_min));
|
||||
|
||||
logger.log_string("Brightness: " + String(((uint16_t)current_brightness * 100) / UINT8_MAX) + "%");
|
||||
logger.log_string("Brightness: " + String(((uint16_t)current_brightness * 100) / UINT8_MAX) + "%\n");
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -329,38 +339,6 @@ void cold_start_setup()
|
||||
led_matrix.draw_on_matrix_instant();
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Updates the NTP time
|
||||
*
|
||||
* @return boolean - true if NTP update was successful, false otherwise
|
||||
*/
|
||||
bool get_ntp_time(uint32 timeout)
|
||||
{
|
||||
uint32 start_time_us = system_get_time();
|
||||
do
|
||||
{
|
||||
time(&time_now);
|
||||
localtime_r(&time_now, &time_info);
|
||||
yield();
|
||||
} while (((system_get_time() - start_time_us) <= timeout) && (time_info.tm_year < (NTP_MININUM_RX_YEAR - NTP_MININUM_YEAR)));
|
||||
|
||||
logger.log_string(String("NTP-Update duration: " + String(system_get_time() - start_time_us) + String("us")));
|
||||
|
||||
return ((time_info.tm_year <= (NTP_MININUM_RX_YEAR - NTP_MININUM_YEAR)) ? false : true);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Log local_time.
|
||||
*
|
||||
* @param local_time
|
||||
*/
|
||||
void log_time(tm local_time)
|
||||
{
|
||||
char strftime_buf[64]; // Time string buffer
|
||||
strftime(strftime_buf, sizeof(strftime_buf), "%c", &time_info);
|
||||
logger.log_string(String(strftime_buf));
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Update and control word clock states.
|
||||
*/
|
||||
@@ -370,13 +348,40 @@ void handle_current_state()
|
||||
{
|
||||
case ST_CLOCK: // state clock
|
||||
{
|
||||
(void)show_string_on_clock(time_to_string((uint8_t)time_info.tm_hour, (uint8_t)time_info.tm_min), main_color_clock);
|
||||
draw_minute_indicator((uint8_t)time_info.tm_min, main_color_clock);
|
||||
if (tm_mgr.tm_state() == TM_NORMAL)
|
||||
{
|
||||
(void)show_string_on_clock(time_to_string((uint8_t)tm_mgr.hour(), (uint8_t)tm_mgr.minute()), main_color_clock);
|
||||
draw_minute_indicator((uint8_t)tm_mgr.minute(), main_color_clock);
|
||||
}
|
||||
else if (tm_mgr.ntp_sync_overdue()) // if NTP sync is overdue
|
||||
{
|
||||
(void)show_string_on_clock(time_to_string((uint8_t)tm_mgr.hour(), (uint8_t)tm_mgr.minute()), main_color_clock);
|
||||
draw_minute_indicator((uint8_t)tm_mgr.minute(), colors_24bit[6]); // in blue to indicate a network problem
|
||||
}
|
||||
else // if no NTP sync has been done, only show 4 blue minute indicators
|
||||
{
|
||||
// clear matrix
|
||||
led_matrix.flush();
|
||||
// Turn on minutes LEDs (blue)
|
||||
led_matrix.set_min_indicator((uint8_t)0b1111, colors_24bit[6]);
|
||||
led_matrix.draw_on_matrix_instant();
|
||||
}
|
||||
break;
|
||||
}
|
||||
case ST_DICLOCK: // state diclock
|
||||
{
|
||||
show_digital_clock((uint8_t)time_info.tm_hour, (uint8_t)time_info.tm_min, main_color_clock);
|
||||
if (tm_mgr.ntp_sync_successful())
|
||||
{
|
||||
show_digital_clock((uint8_t)tm_mgr.hour(), (uint8_t)tm_mgr.minute(), main_color_clock);
|
||||
}
|
||||
else
|
||||
{
|
||||
// clear matrix
|
||||
led_matrix.flush();
|
||||
// Turn on minutes LEDs (blue)
|
||||
led_matrix.set_min_indicator((uint8_t)0b1111, colors_24bit[6]);
|
||||
led_matrix.draw_on_matrix_instant();
|
||||
}
|
||||
break;
|
||||
}
|
||||
case ST_SPIRAL: // state spiral
|
||||
@@ -452,14 +457,18 @@ void send_heartbeat()
|
||||
* @brief Check WiFi status and try to reconnect if needed. Should be called in loop() before NTP update.
|
||||
*
|
||||
* @param None
|
||||
*
|
||||
* @retval bool - true if WiFi is connected, false otherwise
|
||||
*/
|
||||
void check_wifi_status()
|
||||
bool check_wifi_status()
|
||||
{
|
||||
bool connected = (WiFi.status() == WL_CONNECTED);
|
||||
// Check wifi status
|
||||
if (WiFi.status() != WL_CONNECTED)
|
||||
if (!connected)
|
||||
{
|
||||
Serial.println("WiFi connection lost! Trying to reconnect automatically...");
|
||||
}
|
||||
return connected;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -469,9 +478,9 @@ void check_wifi_status()
|
||||
*/
|
||||
void check_night_mode()
|
||||
{
|
||||
// check if nightmode need to be activated
|
||||
int hours = time_info.tm_hour;
|
||||
int minutes = time_info.tm_min;
|
||||
// Check if nightmode needs to be activated. This only toggles at the exact minute.
|
||||
int hours = tm_mgr.hour();
|
||||
int minutes = tm_mgr.minute();
|
||||
|
||||
if ((hours == night_mode_times_ps->start_hour) && (minutes == night_mode_times_ps->start_min))
|
||||
{
|
||||
@@ -483,38 +492,6 @@ void check_night_mode()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief NTP time update, should be called in loop().
|
||||
*
|
||||
* @param None
|
||||
*/
|
||||
void ntp_time_update(uint32 max_update_time)
|
||||
{
|
||||
static int watchdog_counter = NTP_WATCHDOG_COUNTER_INIT; // Watchdog counter to trigger restart if NTP update was not possible 30 times in a row (5min)
|
||||
bool ntp_retval = get_ntp_time(max_update_time); // NTP time update
|
||||
|
||||
if (ntp_retval == true)
|
||||
{
|
||||
log_time(time_info);
|
||||
last_ntp_update_us = system_get_time();
|
||||
watchdog_counter = NTP_WATCHDOG_COUNTER_INIT;
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.log_string("NTP-Update was not successful.");
|
||||
last_ntp_update_us += NTP_NEXT_UPDATE_DELAY_US;
|
||||
watchdog_counter--;
|
||||
}
|
||||
|
||||
logger.log_string("Watchdog counter: " + String(watchdog_counter));
|
||||
if (watchdog_counter <= 0)
|
||||
{
|
||||
logger.log_string("Trigger restart due to watchdog...");
|
||||
delay(100);
|
||||
ESP.restart();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief call entry action of given state
|
||||
*
|
||||
@@ -557,21 +534,21 @@ void on_state_entry(uint8_t state)
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief execute a state change to given newState
|
||||
* @brief execute a state change to given new_state
|
||||
*
|
||||
* @param newState the new state to be changed to
|
||||
* @param new_state the new state to be changed to
|
||||
*/
|
||||
void state_change(uint8_t newState)
|
||||
void state_change(ClockState_en new_state)
|
||||
{
|
||||
if (flg_night_mode)
|
||||
{
|
||||
set_night_mode(false); // deactivate Nightmode
|
||||
}
|
||||
|
||||
led_matrix.flush(); // first clear matrix
|
||||
current_state = newState; // set new state
|
||||
on_state_entry(current_state);
|
||||
logger.log_string("State change to: " + state_names[current_state]);
|
||||
led_matrix.flush(); // first clear matrix
|
||||
current_state = new_state; // set new state
|
||||
on_state_entry((uint8_t)current_state);
|
||||
logger.log_string("State change to: " + state_names[(uint8_t)current_state]);
|
||||
logger.log_string("FreeMemory=" + String(ESP.getFreeHeap()));
|
||||
}
|
||||
|
||||
@@ -663,7 +640,7 @@ void handle_button()
|
||||
}
|
||||
else
|
||||
{
|
||||
state_change((current_state + 1) % (uint8_t)NUM_STATES);
|
||||
state_change((ClockState_en)(((uint8_t)current_state + 1) % (uint8_t)NUM_STATES));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -713,13 +690,16 @@ void draw_main_color()
|
||||
*/
|
||||
void handle_command()
|
||||
{
|
||||
bool send204 = true; // flag to send 204 response
|
||||
// receive command and handle accordingly
|
||||
#ifdef SERIAL_DEBUG
|
||||
for (uint8_t i = 0; i < webserver.args(); i++)
|
||||
{
|
||||
Serial.print(webserver.argName(i));
|
||||
Serial.print(F(": "));
|
||||
Serial.println(webserver.arg(i));
|
||||
}
|
||||
#endif /* SERIAL_DEBUG */
|
||||
|
||||
if (webserver.argName(0).equals("led")) // the parameter which was sent to this server is led color
|
||||
{
|
||||
@@ -738,6 +718,7 @@ void handle_command()
|
||||
{
|
||||
String mode_str = webserver.arg(0);
|
||||
logger.log_string("Mode change via Webserver to: " + mode_str);
|
||||
|
||||
// set current mode/state accordant sent mode
|
||||
if (mode_str.equals("clock"))
|
||||
{
|
||||
@@ -819,7 +800,6 @@ void handle_command()
|
||||
else if (webserver.argName(0).equals("tetris"))
|
||||
{
|
||||
String cmd_str = webserver.arg(0);
|
||||
// logger.log_string("Tetris cmd via Webserver to: " + cmd_str);
|
||||
if (cmd_str.equals("up"))
|
||||
{
|
||||
tetris.ctrlUp();
|
||||
@@ -848,7 +828,6 @@ void handle_command()
|
||||
else if (webserver.argName(0).equals("snake"))
|
||||
{
|
||||
String cmd_str = webserver.arg(0);
|
||||
// logger.log_string("Snake cmd via Webserver to: " + cmd_str);
|
||||
if (cmd_str.equals("up"))
|
||||
{
|
||||
snake.ctrlUp();
|
||||
@@ -873,7 +852,6 @@ void handle_command()
|
||||
else if (webserver.argName(0).equals("pong"))
|
||||
{
|
||||
String cmd_str = webserver.arg(0);
|
||||
// logger.log_string("Pong cmd via Webserver to: " + cmd_str);
|
||||
if (cmd_str.equals("up"))
|
||||
{
|
||||
pong.ctrlUp(1);
|
||||
@@ -887,8 +865,18 @@ void handle_command()
|
||||
pong.initGame(1);
|
||||
}
|
||||
}
|
||||
else if (webserver.argName(0).equals("diag"))
|
||||
{
|
||||
String cmd_str = webserver.arg(0);
|
||||
Diagnosis diag(&logger, &led_matrix);
|
||||
webserver.send(200, "text/plain", diag.handle_command(cmd_str));
|
||||
send204 = false;
|
||||
}
|
||||
|
||||
webserver.send(204, "text/plain", "No Content"); // this page doesn't send back content --> 204
|
||||
if (send204)
|
||||
{
|
||||
webserver.send(204, "text/plain", "No Content"); // this page doesn't send back content --> 204
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -897,6 +885,7 @@ void handle_command()
|
||||
*/
|
||||
void handle_data_request()
|
||||
{
|
||||
#ifdef SERIAL_DEBUG
|
||||
// receive data request and handle accordingly
|
||||
for (uint8_t i = 0; i < webserver.args(); i++)
|
||||
{
|
||||
@@ -904,7 +893,7 @@ void handle_data_request()
|
||||
Serial.print(F(": "));
|
||||
Serial.println(webserver.arg(i));
|
||||
}
|
||||
|
||||
#endif /* SERIAL_DEBUG */
|
||||
if (webserver.argName(0).equals("key"))
|
||||
{
|
||||
String message = "{";
|
||||
@@ -1052,9 +1041,9 @@ uint8_t update_brightness()
|
||||
{
|
||||
new_brightness = calculate_dynamic_brightness(brightness_ps->dyn_brightness_min,
|
||||
brightness_ps->dyn_brightness_max,
|
||||
time_info.tm_hour,
|
||||
time_info.tm_min,
|
||||
time_info.tm_isdst);
|
||||
tm_mgr.hour(),
|
||||
tm_mgr.minute(),
|
||||
tm_mgr.isdst());
|
||||
}
|
||||
else // use static brightness
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user