search

Qrome / marquee-scroller

Marquee Scroller Clock News Weather and More
https://www.thingiverse.com/thing:2867294
MIT License
324 stars 159 forks source link
3d-printing clock news weather wemos-d1-mini wifi

readme

Marquee Scroller (Clock, Weather, News, and More)

NOTICE

The latest version of Marquee Scroller 3.01 works with ESP8266 Core 3.0.2 -- if you are upgrading from Marquee Scroller 2.X version this may require you to enter in all your API Keys and settings. Always meake sure you have coppied all your API keys somewhere before updating. The ESP8266 Core 3.0.2 uses the newer FS (file system) that may require a fresh start on the configuration. Make sure you update to the latest version of WifiManager library (link below).

Features include:

Required Parts:

Note: Using the links provided here help to support these types of projects. Thank you for the support.

Wiring for the Wemos D1 Mini to the Dot Matrix Display

CLK -> D5 (SCK)
CS -> D6
DIN -> D7 (MOSI)
VCC -> 5V+
GND -> GND-

Marquee Scroller Wiring

3D Printed Case by David Payne:

Original Single Panel version: https://www.thingiverse.com/thing:2867294
Double Wide LED version: https://www.thingiverse.com/thing:2989552

Upgrading from version 2.5 or Higher

In version 2.6 and higher, the binary files that can be uploaded to your marque scrolling clock via the web interface. From the main menu in the web interface select "Firmware Update" and follow the prompts.

Compiling and Loading to Wemos D1

It is recommended to use Arduino IDE. You will need to configure Arduino IDE to work with the Wemos board and USB port and installed the required USB drivers etc.

Loading Supporting Library Files in Arduino

Use the Arduino guide for details on how to installing and manage libraries https://www.arduino.cc/en/Guide/Libraries
Packages -- the following packages and libraries are used (download and install):

--> https://github.com/tzapu/WiFiManager (latest) --> https://github.com/PaulStoffregen/Time --> https://github.com/adafruit/Adafruit-GFX-Library --> https://github.com/markruys/arduino-Max72xxPanel --> https://github.com/squix78/json-streaming-parser Note ArduinoJson (version 5.13.1) is now included as a library file in version 2.7 and later. ## Initial Configuration Editing the **Settings.h** file is totally optional and not required. All API Keys are now managed in the Web Interface. It is not required to edit the Settings.h file before loading and running the code. * Open Weather Map free API key: http://openweathermap.org/ -- this is used to get weather data and the latitude and longitude for the current time zone. Weather API key is required for correct time. * TimeZoneDB free registration for API key: https://timezonedb.com/register -- this is used for setting the time and getting the correct time zone as well as managing time changes due to Day Light Savings time by regions. This key is set and managed only through the web interface and added in version 2.10 of Marquee Scroller. TimeZoneDB key is required for correct time display. * News API key (free): https://newsapi.org/ -- Optional if you want to get current news headlines. * Your OctoPrint API Key -- optional if you use the OctoPrint status. * Version 2.0 supports Chained 4x1 LED displays -- configure up to 16x1 in the Settings.h file. NOTE: The settings in the Settings.h are the default settings for the first loading. After loading you will manage changes to the settings via the Web Interface. If you want to change settings again in the settings.h, you will need to erase the file system on the Wemos or use the “Reset Settings” option in the Web Interface. ## Web Interface The Marquee Scroller uses the **WiFiManager** so when it can't find the last network it was connected to it will become a **AP Hotspot** -- connect to it with your phone and you can then enter your WiFi connection information. After connected to your WiFi network it will display the IP addressed assigned to it and that can be used to open a browser to the Web Interface. You will be able to manage your API Keys through the web interface. The default user / password for the configuration page is: admin / password The Clock will display the time of the City selected for the weather.

## Donation or Tip Please do not feel obligated, but donations and tips are warmly welcomed. I have added the donation button at the request of a few people that wanted to contribute and show appreciation. Thank you, and enjoy the application and project. [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A82AT6FLN2MPY) Or -- you can buy me something from my Amazon Wishlist: https://www.amazon.com/hz/wishlist/ls/GINC2PHRNEY3 ## Contributors David Payne Nathan Glaus Daniel Eichhorn -- Author of the TimeClient class (in older versions) yanvigdev nashiko-s magnum129 Contributing to this software is warmly welcomed. You can do this basically by forking from master, committing modifications and then making a pulling requests against the latest DEV branch to be reviewed (follow the links above for operating guide). Detailed comments are encouraged. Adding change log and your contact into file header is encouraged. Thanks for your contribution. When considering making a code contribution, please keep in mind the following goals for the project: * User should not be required to edit the Settings.h file to compile and run. This means the feature should be simple enough to manage through the web interface. * Changes should always support the recommended hardware (links above). ![Marquee Scroller](/images/5d7f02ccbf01125cabbf246f97f2ead1_preview_featured.jpg) ![Marquee Parts](/images/1ffa0c835554d280258c13be5513c4fe_preview_featured.jpg)