diff --git a/README.md b/README.md index bf9d2daf..a7917345 100644 --- a/README.md +++ b/README.md @@ -8,31 +8,31 @@ } -->
- + ![Alt text](/cover.png?raw=true "logo")
![GitHub all releases](https://img.shields.io/github/downloads/blueforcer/awtrix3/total?style=flat-square) ![GitHub Sponsors](https://img.shields.io/github/sponsors/blueforcer?style=flat-square) ![Discord](https://img.shields.io/discord/546407049148366859?label=Discord&style=flat-square) -
-
- + +
+ **AWTRIX 3 is an open‑source custom firmware for the [Ulanzi Smart Pixel clock TC001](https://www.ulanzi.com/products/ulanzi-pixel-smart-clock-2882?ref=28e02dxl) or as upgrade for the old AWTRIX 2 Mainboard and even self build matrix clock** **Note: This Firmware is only compatible with ESP32** You can get an Ulanzi TC001 [here](https://www.ulanzi.com/products/ulanzi-pixel-smart-clock-2882?ref=28e02dxl) (affiliate link) -AWTRIX3 meant to be a companion for your smarthome like HomeAssistant, IOBroker, FHEM, NodeRed and so on. -Even if you don't have a Smarthome system, but would like to experiment with NodeRed or N8N, you are still welcome to join us. -Our discord community, with over 5000 people, are willing to help you! +AWTRIX3 meant to be a companion for your smarthome like Home Assistant, IOBroker, FHEM, NodeRed and so on. +Even if you don't have a Smarthome system, but would like to experiment with NodeRed or N8N, you are still welcome to join us. +Our discord community, with over 5000 people, are willing to help you! -It is ready to use straight out of the box, with time, date, temperature, and humidity pages pre-installed. You don't need to do anything other than turning it on to start using these features. +It is ready to use straight out of the box, with time, date, temperature, and humidity pages pre-installed. You don't need to do anything other than turning it on to start using these features. -However, for those with more advanced skills, the customization options available with customapps and mqtt commands allows you to take AWTRIX 3 to its full potential. +However, for those with more advanced skills, the customization options available with customapps and mqtt commands allows you to take AWTRIX 3 to its full potential. -**Note: -In AWTRIX, the term 'Apps' does not refer to traditional smartphone apps that you download and install. Instead, in AWTRIX, CustomApps function more like dynamic pages that rotate within the App loop of the display. These pages do not store or execute their own logic; instead, they display content that is sent from an external system, such as a smarthome. This content must be transmitted using MQTT or HTTP protocols via the CustomApp API. +**Note: +In AWTRIX, the term 'Apps' does not refer to traditional smartphone apps that you download and install. Instead, in AWTRIX, CustomApps function more like dynamic pages that rotate within the App loop of the display. These pages do not store or execute their own logic; instead, they display content that is sent from an external system, such as a smarthome. This content must be transmitted using MQTT or HTTP protocols via the CustomApp API. It is important to note that all the logic for managing the content displayed in these CustomApps needs to be handled by your external system. AWTRIX only provides the platform for displaying the information. You have the flexibility to update the content shown on your CustomApps in real-time at any moment, making it a versatile tool for displaying personalized information in your smarthome setup.** Join the thousands of satisfied awtrix users who have already chosen Awtrix 2 and AWTRIX 3 and experience the difference today! @@ -65,13 +65,13 @@ Support our journey and enhance your Awtrix experience. Your contribution matter # AWTRIX 3 flows -This is your go-to hub for sharing and discovering AWTRIX 3 automations. Enhance your AWTRIX 3 experience, exchange ideas, and get inspired. Let's bring our creative automations to life together! +This is your go-to hub for sharing and discovering AWTRIX 3 automations. Enhance your AWTRIX 3 experience, exchange ideas, and get inspired. Let's bring our creative automations to life together! https://flows.blueforcer.de/ - + # Features - Easy to setup - Online flasher -- Homeassistant discovery +- Home Assistant discovery - Onscreen menu where you can change your settings directly on the device - Pre-installed Apps like time, date, temperature, humidity and battery - Add customapps without recompiling straight from your Smarthome. @@ -90,34 +90,34 @@ https://flows.blueforcer.de/ # Getting Started Starting is easy as 1-2-3 [with the documentation](https://blueforcer.github.io/awtrix3/) - + # Community -Join the discord channel with over 5000 Users -https://discord.gg/cyBCpdx +Join the discord channel with over 5000 Users +https://discord.gg/cyBCpdx -Youtube videos from some awesome creators to get a quick first look. +YouTube videos from some awesome creators to get a quick first look.
Watch the video - - + + Watch the video - - + + Watch the video - + # Support If you want to support my work, I really appreciate your donation! All the money will be allocated towards purchasing new hardware for testing purposes, software licenses, server costs, and a significant portion will also be set aside for dinners and trips with my wife and kids so that they can continue to endure the many hours I spend programming :) -https://www.paypal.me/blueforcer -https://github.com/sponsors/Blueforcer -https://www.buymeacoffee.com/blueforcer +https://www.paypal.me/blueforcer +https://github.com/sponsors/Blueforcer +https://www.buymeacoffee.com/blueforcer - + # Contributors diff --git a/Shares.md b/Shares.md index 0f727b01..c6cd704a 100644 --- a/Shares.md +++ b/Shares.md @@ -1,36 +1,36 @@ -**Adafruit_SHT31** -https://github.com/adafruit/Adafruit_SHT31 -https://github.com/adafruit/Adafruit_SHT31/blob/master/license.txt -**Arduino JSON** -https://github.com/bblanchon/ArduinoJson -https://github.com/bblanchon/ArduinoJson/blob/6.x/LICENSE.txt -**EasyButton** -https://github.com/evert-arias/EasyButton -https://github.com/evert-arias/EasyButton/blob/main/LICENSE -**FastLED** -https://github.com/FastLED/FastLED -https://github.com/FastLED/FastLED/blob/master/LICENSE -**FastLED NeoMatrix** -https://github.com/marcmerlin/FastLED_NeoMatrix -https://github.com/marcmerlin/FastLED_NeoMatrix/blob/master/COPYING -**pubsubclient** -https://github.com/knolleary/pubsubclient -https://github.com/knolleary/pubsubclient/blob/master/LICENSE.txt -**GifPLayer (Highly customized by me)** -https://github.com/pixelmatix/aurora -https://github.com/pixelmatix/aurora/blob/master/LICENSE.txt -**Melody Player (Customized by me)** -https://github.com/fabianoriccardi/melody-player -https://github.com/fabianoriccardi/melody-player/blob/main/LICENSE -**TJpg_Decoder (Customized by me)** -https://github.com/Bodmer/TJpg_Decoder -https://github.com/Bodmer/TJpg_Decoder/blob/master/license.txt -**LDR** -https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library -https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library/blob/master/LICENSE.md -**Homeassistant integration (Customized by me)** -https://github.com/dawidchyrzynski/arduino-home-assistant -https://github.com/dawidchyrzynski/arduino-home-assistant/blob/main/LICENSE -**Webserver (Highly customized by me)** -https://github.com/cotestatnt/esp-fs-webserver -https://github.com/cotestatnt/esp-fs-webserver/blob/master/LICENSE +**Adafruit_SHT31** +https://github.com/adafruit/Adafruit_SHT31 +https://github.com/adafruit/Adafruit_SHT31/blob/master/license.txt +**Arduino JSON** +https://github.com/bblanchon/ArduinoJson +https://github.com/bblanchon/ArduinoJson/blob/6.x/LICENSE.txt +**EasyButton** +https://github.com/evert-arias/EasyButton +https://github.com/evert-arias/EasyButton/blob/main/LICENSE +**FastLED** +https://github.com/FastLED/FastLED +https://github.com/FastLED/FastLED/blob/master/LICENSE +**FastLED NeoMatrix** +https://github.com/marcmerlin/FastLED_NeoMatrix +https://github.com/marcmerlin/FastLED_NeoMatrix/blob/master/COPYING +**pubsubclient** +https://github.com/knolleary/pubsubclient +https://github.com/knolleary/pubsubclient/blob/master/LICENSE.txt +**GifPLayer (Highly customized by me)** +https://github.com/pixelmatix/aurora +https://github.com/pixelmatix/aurora/blob/master/LICENSE.txt +**Melody Player (Customized by me)** +https://github.com/fabianoriccardi/melody-player +https://github.com/fabianoriccardi/melody-player/blob/main/LICENSE +**TJpg_Decoder (Customized by me)** +https://github.com/Bodmer/TJpg_Decoder +https://github.com/Bodmer/TJpg_Decoder/blob/master/license.txt +**LDR** +https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library +https://github.com/QuentinCG/Arduino-Light-Dependent-Resistor-Library/blob/master/LICENSE.md +**Home Assistant integration (Customized by me)** +https://github.com/dawidchyrzynski/arduino-home-assistant +https://github.com/dawidchyrzynski/arduino-home-assistant/blob/main/LICENSE +**Webserver (Highly customized by me)** +https://github.com/cotestatnt/esp-fs-webserver +https://github.com/cotestatnt/esp-fs-webserver/blob/master/LICENSE diff --git a/docs/faq.md b/docs/faq.md index f89da000..d73e9800 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -30,8 +30,8 @@ A: If you encounter errors during the flashing process, i recommend trying a dif A: The AWTRIX GIF renderer currently supports only 8-bit GIFs without transparency. If you notice graphic glitches on the matrix, try replacing transparent pixels with solid black. You can easily do this using an online tool like [this one](https://onlinegiftools.com/add-gif-background). #### Q: I only have 192KB of free flash memory. What's wrong? -A: The issue arises because Ulanzi uses a different partition table, resulting in a smaller SPIFFS partition. -To utilize the full 1350KB of flash memory, make sure to use the AWTRIX online flasher, which also writes to all other partitions. +A: The issue arises because Ulanzi uses a different partition table, resulting in a smaller SPIFFS partition. +To utilize the full 1350KB of flash memory, make sure to use the AWTRIX online flasher, which also writes to all other partitions. The Ulanzi web updater only writes to the program partition. #### Q: What should I do if I accidentally touched the `DoNotTouch.json` file in AWTRIX Web File Manager? @@ -39,7 +39,7 @@ A: The `DoNotTouch.json` file contains settings such as: - Static IP configuration settings - MQTT settings -- Homeassistant Discovery +- Home Assistant Discovery - NTP Server / TimeZone - HTTP Auth password diff --git a/src/MQTTManager.cpp b/src/MQTTManager.cpp index 6dba2c97..23192f83 100644 --- a/src/MQTTManager.cpp +++ b/src/MQTTManager.cpp @@ -541,7 +541,7 @@ void MQTTManager_::setup() if (HA_DISCOVERY) { if (DEBUG_MODE) - DEBUG_PRINTLN(F("Starting Homeassistant discovery")); + DEBUG_PRINTLN(F("Starting Home Assistant discovery")); mqtt.setDiscoveryPrefix(HA_PREFIX.c_str()); mqtt.setDataPrefix(MQTT_PREFIX.c_str()); uint8_t mac[6]; @@ -732,7 +732,7 @@ void MQTTManager_::setup() } else { - Serial.println(F("Homeassistant discovery disabled")); + Serial.println(F("Home Assistant discovery disabled")); mqtt.disableHA(); } diff --git a/src/ServerManager.cpp b/src/ServerManager.cpp index 0da6d87f..73df6fce 100644 --- a/src/ServerManager.cpp +++ b/src/ServerManager.cpp @@ -235,7 +235,7 @@ void ServerManager_::setup() mws.addOption("Username", MQTT_USER); mws.addOption("Password", MQTT_PASS); mws.addOption("Prefix", MQTT_PREFIX); - mws.addOption("Homeassistant Discovery", HA_DISCOVERY); + mws.addOption("Home Assistant Discovery", HA_DISCOVERY); mws.addOptionBox("Time"); mws.addOption("NTP Server", NTP_SERVER); mws.addOption("Timezone", NTP_TZ); @@ -367,7 +367,7 @@ void ServerManager_::loadSettings() MQTT_PREFIX = doc["Prefix"].as(); MQTT_PREFIX.trim(); NET_STATIC = doc["Static IP"]; - HA_DISCOVERY = doc["Homeassistant Discovery"]; + HA_DISCOVERY = doc["Home Assistant Discovery"]; NET_IP = doc["Local IP"].as(); NET_GW = doc["Gateway"].as(); NET_SN = doc["Subnet"].as();