jerome
/
EspHoMaTriXv2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

spell and gramar

Browse Source
pull/15/head
LuBeDa 3 years ago
parent 125d0c2d55
commit 3d0ad21e8f
3 changed files with 65 additions and 57 deletions
Show Stats Download Patch File Download Diff File

80
README.md
Unescape View File

@ -4,7 +4,7 @@
## Important information ## Important information
If you like my work, please donate me a star on github and consider sponsoring me!! If you like my work, please donate me a star on GitHub and consider sponsoring me!!
## Introduction ## Introduction
@ -24,7 +24,7 @@ There are some "RGB-matrices" status displays/clocks out there, the commercial o
The solutions have their pros and cons. I tried some and used AwTrix for a long time. But the cons are so big (in my opinion) that I started an esphome.io variant. Targeted to an optimized Home Assistant integration, without paid blueprints and the need of MQTT. The solutions have their pros and cons. I tried some and used AwTrix for a long time. But the cons are so big (in my opinion) that I started an esphome.io variant. Targeted to an optimized Home Assistant integration, without paid blueprints and the need of MQTT.
But it had to be extensible, e.g. for the use as pool thermometer or as media player. All done by the magical power of esphome. But it had to be extensible, e.g. for the use as a pool thermometer or as a media player. All done by the magical power of esphome.
### Features ### Features
@ -32,13 +32,13 @@ Based on a 8x32 RGB matrix, it displays a clock, the date and up to 24 other 'sc
### State ### State
After the [old](https://github.com/lubeda/EsphoMaTrix) component became favorite, there were some feature requests, which showed that my old code was a mess. I reworked the whole code and restructured it, so it is now hopefully more extensible. After the [old](https://github.com/lubeda/EsphoMaTrix) component became favorite, there were some feature requests, which indicated that my old code was a mess. I reworked the whole code and restructured it, so it is now hopefully more extensible.
## How to use ## How to use
### The easy way ### The easy way
There is a little hype around the Ulanzi TC001 pixel clock. The easy way works with the Ulanzi TC001 hardware. For more customization and other hardware look [here](#the-funny-but-more-elaborate-way). There is a little hype around the Ulanzi TC001 pixel clock. The easy way works with the Ulanzi TC001 hardware. For more customization and other hardware, look [here](#the-funny-but-more-elaborate-way).
In easy mode you'll have a clock with auto brightness control and after step 3 you can send states to the display an toggle on or off additional screen elements. In easy mode you'll have a clock with auto brightness control and after step 3 you can send states to the display an toggle on or off additional screen elements.
@ -75,13 +75,13 @@ If not, check the esphome logs for further investigations.
### The funny but more elaborate way ### The funny but more elaborate way
This is for the more advanced users. If you understand the concept of esphome, you can display nearly everything with this component. You are also able to create your own customized esphome based display with multiple sensors or even use it as microphone for the new [voice assist](https://esphome.io/components/voice_assistant.html) feature from home assistant. This is for the more advanced users. If you understand the concept of esphome, you can display nearly everything with this component. You are also able to create your own customized esphome based display with multiple sensors, or even use it as a microphone for the new [voice assist](https://esphome.io/components/voice_assistant.html) feature from home assistant.
#### Concept #### Concept
You can add screens to a queue and all these screens are displayed one after another. You can add screens to a queue and all these screens are displayed one after another.
![timing](./images/timingv2.png) ![timing](./images/timingv2.png)
Each screen can display different information or animation or text, even in rainbox color. They all have a lifetime, if a screen isn't refreshed during its lifetime it will be removed from the queue. If there is nothing left in the queue, the date and time screens are displayed. Some screens can show additional features like an alarm or indicator see [elements](#display-elements). Each screen can display different information or animation or text, even in rainbow color. They all have a lifetime, if a screen isn't refreshed during its lifetime it will be removed from the queue. If there is nothing left in the queue, the date and time screens are displayed. Some screens can show additional features like an alarm or indicator see [elements](#display-elements).
You can add screens from home assistant with service-calls or from esphome via lambdas in your YAML. You can add screens from home assistant with service-calls or from esphome via lambdas in your YAML.
#### Screen types a.k.a. what is possible #### Screen types a.k.a. what is possible
@ -103,7 +103,7 @@ rainbow_date_screen => {"lifetime", "screen_time", "default_font"}
###### Lambda ###### Lambda
You cann use these in [lambdas](https://esphome.io/guides/automations.html?highlight=lambda#lambda-action) in your esphome YAML. You can use these in [lambdas](https://esphome.io/guides/automations.html?highlight=lambda#lambda-action) in your esphome YAML.
all parameters have a default value. all parameters have a default value.
@ -155,7 +155,7 @@ void full_screen(string iconname, int =D_LIFETIME, int screen_time=D_SCREEN_TIME
##### alarm ##### alarm
The alarm is displayed in the upper right corner at all screen types! You can set its color and its size. The alarm is displayed in the upper-right corner at all screen types! You can set its color and its size.
###### service ###### service
@ -163,7 +163,7 @@ The alarm is displayed in the upper right corner at all screen types! You can s
show_alarm => { "r", "g", "b","size"} show_alarm => { "r", "g", "b","size"}
``` ```
###### api ###### API
```c ```c
void EHMTX::show_alarm(int r, int g, int b, int size=2); void EHMTX::show_alarm(int r, int g, int b, int size=2);
@ -188,7 +188,7 @@ void hide_alarm();
##### Indicator ##### Indicator
The indicator is in the lower left corner, but not displayed in fullscreen 8x32 animations. You can set its color. The indicator is in the lower-left corner, but not displayed in full screen 8x32 animations. You can set its color.
###### Service ###### Service
@ -236,9 +236,9 @@ void show_gauge(int percent, int r, int g, int b);
``` ```
percent: 0-100 (resolution: one pixel per 12,5%) percent: 0-100 (resolution: one pixel per 12,5%)
r,g,b: 0-255 color components r, g, b: 0-255 color components
To remove it call: To remove it, call:
###### service ###### service
@ -246,7 +246,7 @@ To remove it call:
hide_gauge => no parameter hide_gauge => no parameter
``` ```
###### api ###### API
```c ```c
void hide_gauge(); void hide_gauge();
@ -254,7 +254,7 @@ void hide_gauge();
#### Installation of **EspHoMaTriXv2** custom component #### Installation of **EspHoMaTriXv2** custom component
**EspHoMaTriXv2** is a custom component, you have to include it in your YAML configuration. To always use the newest features you should use the repo, to use a stable version, you copy a working version to your esphome installation. **EspHoMaTriXv2** is a custom component, you have to include it in your YAML configuration. To always use the newest features, you should use the repo, to use a stable version, you copy a working version to your esphome installation.
##### use of local copy ##### use of local copy
@ -269,7 +269,7 @@ external_components:
##### use from repo ##### use from repo
Use the GitHub repo as component. Esphome refreshes the external components "only" once a day, perhaps you have to refresh it manually. In this mode, there may be breaking changes, so read the changelog and check the logs while installing the firmware. Use the GitHub repo as a component. Esphome refreshes the external components "only" once a day, perhaps you have to refresh it manually. In this mode, there may be breaking changes, so read the changelog and check the logs while installing the firmware.
```yaml ```yaml
external_components: external_components:
@ -281,7 +281,7 @@ external_components:
#### Addressable_light component #### Addressable_light component
The **EspHoMaTriXv2** component requires a 8x32 pixel addressable_light, it is referenced by the id `matrix_component`. The **EspHoMaTriXv2** component requires an 8x32 pixel addressable_light, it is referenced by the id `matrix_component`.
See the default [options](https://esphome.io/components/display/index.html) See the default [options](https://esphome.io/components/display/index.html)
@ -321,7 +321,7 @@ display:
..... .....
``` ```
##### Type 3 (daisy chained 8x8 panels) ##### Type 3 (daisy-chained 8x8 panels)
```yaml ```yaml
display: display:
@ -351,7 +351,7 @@ display:
The light component is used by the addressable_light component and referenced by id under `addressable_light_id:`. The light component is used by the addressable_light component and referenced by id under `addressable_light_id:`.
To use the light component directly from home assistant add the sample lambdas```on_turn_on``` and ```on_turn_off``` to the light component. To use the light component directly from home assistant, add the sample lambdas```on_turn_on``` and ```on_turn_off``` to the light component.
***Sample*** ***Sample***
@ -380,7 +380,7 @@ light:
#### Time component #### Time component
Since it is a clock, you need a time component e.g. [homeassistant](https://esphome.io/components/time/homeassistant.html). It is referenced by its id under `time_component:` The display shows `!t!` until the time source is synchronized and valid. Since it is a clock, you need a time component, e.g. [homeassistant](https://esphome.io/components/time/homeassistant.html). It is referenced by its id under `time_component:` The display shows `!t!` until the time source is synchronized and valid.
#### Font #### Font
@ -392,7 +392,7 @@ You can configure two fonts if you like.
DarkPoet78 is also providing special fonts for 8x32 matrices in his [repo](https://github.com/darkpoet78/MatrixClockFonts) DarkPoet78 is also providing special fonts for 8x32 matrices in his [repo](https://github.com/darkpoet78/MatrixClockFonts)
For european starters you can use the font EHMTXv2.ttf of the copy2esphome folder. For Europeans starters, you can use the font EHMTXv2.ttf of the copy2esphome folder.
```yaml ```yaml
font: font:
@ -436,13 +436,13 @@ emhtx:
url: https://github.com/home-assistant/assets/raw/master/logo/logo-special.png url: https://github.com/home-assistant/assets/raw/master/logo/logo-special.png
``` ```
The id of the icons is used later to configure the screens to display. So you should name them wisely. If you like to group icons, you should prefix them e.g. with "weather_" (see Service **del_screen**) The id of the icons is used later to configure the screens to display. So, you should name them wisely. If you like to group icons, you should prefix them e.g. with "weather_" (see Service **del_screen**)
The first defined icon will be used as a fallback icon, in case of an error, e.g. if you use a non-existing icon id. The first defined icon will be used as a fallback icon, in case of an error, e.g. if you use a non-existing icon id.
GIFs are limited to 110 frames to limit the used amount of flash space. GIFs are limited to 110 frames to limit the used amount of flash space.
All other solutions provide ready-made icons, especially Lametric has a big database of [icons](https://developer.lametric.com/icons). Please check the copyright of the icons you use. The maximum amount of icons is limited to 90 in the code and also by the flash space and the RAM of your board. All other solutions provide ready-made icons, especially Lametric has a big database of [icons](https://developer.lametric.com/icons). Please check the copyright of the icons you use. The maximum number of icons is limited to 90 in the code and also by the flash space and the RAM of your board.
See also [icon parameter](#icons) See also [icon parameter](#icons)
@ -507,9 +507,9 @@ ehmtxv2:
**week_start_monday** (optional, bool): default Monday is first day of week, false => Sunday **week_start_monday** (optional, bool): default Monday is first day of week, false => Sunday
**scroll_interval** (optional, ms): the interval in ms to scroll the text (default=80), should be a multiple of the ```update_interval``` of the [display](https://esphome.io/components/display/addressable_light.html) **scroll_interval** (optional, ms): the interval in ms to scroll the text (default=80), should be a multiple of the ```update_interval``` from the [display](https://esphome.io/components/display/addressable_light.html)
**frame_interval** (optional, ms): the interval in ms to display the next animation/icon frame (default = 192), should be a multiple of the ```update_interval``` of the [display](https://esphome.io/components/display/addressable_light.html). Can be overwritten per icon/GIF, see [icons](#icons-and-animations) parameter `frame_duration` **frame_interval** (optional, ms): the interval in ms to display the next animation/icon frame (default = 192), should be a multiple of the ```update_interval``` of the [display](https://esphome.io/components/display/addressable_light.html). It can be overwritten per icon/GIF, see [icons](#icons-and-animations) parameter `frame_duration`
**icons2html** (optional, boolean): If true, generate the HTML-file (*filename*.html) to show all included icons. (default = `false`) **icons2html** (optional, boolean): If true, generate the HTML-file (*filename*.html) to show all included icons. (default = `false`)
@ -521,8 +521,8 @@ ehmtxv2:
***Parameters*** ***Parameters***
See [icon details](#icons-and-animations) See [icon details](#icons-and-animations)
- **frame_duration** (optional, ms): in case of a GIF-file the component tries to read the default interval for each frame. The default/fallback interval is 192 ms. In case you need to override the default value, set the duration per icon. - **frame_duration** (optional, ms): in the case of a GIF-file, the component tries to read the default interval for each frame. The default/fallback interval is 192 ms. In case you need to override the default value, set the duration per icon.
- **pingpong** (optional, boolean): in case of a GIF-file you can reverse the frames instead of starting from the first frame. - **pingpong** (optional, boolean): in the case of a GIF-file, you can reverse the frames instead of starting from the first frame.
- **file** (Exclusive, filename): a local filename - **file** (Exclusive, filename): a local filename
- **url** (Exclusive, url): a URL to download the icon - **url** (Exclusive, url): a URL to download the icon
@ -540,7 +540,7 @@ See [icon details](#icons-and-animations)
## Control your display ## Control your display
A lot of features are accessible with services from home assistant and lambdas you can use in your YAML. Numerous features are accessible with services from home assistant and lambdas you can use in your YAML.
### Public functions/services ### Public functions/services
@ -553,15 +553,15 @@ A lot of features are accessible with services from home assistant and lambdas y
|`hide_indicator`|none|hides the indicator| |`hide_indicator`|none|hides the indicator|
|`hide_gauge`|none|hides the gauge| |`hide_gauge`|none|hides the gauge|
|`hide_alarm`|none|hides the alarm| |`hide_alarm`|none|hides the alarm|
|`show_gauge"`|"percent", "r", "g", "b"|set the heught of the gauge according to the percentage in the given color| |`show_gauge"`|"percent", "r", "g", "b"|set the height of the gauge according to the percentage in the given color|
|`show_alarm`|"r", "g", "b", "size"|shows the color with the given size in the upper right corner| |`show_alarm`|"r", "g", "b", "size"|shows the color with the given size in the upper-right corner|
|`show_indicator`|"r", "g", "b", "size"|shows the color with the given size in the lower right corner| |`show_indicator`|"r", "g", "b", "size"|shows the color with the given size in the lower-right corner|
|`clock_color`|"r", "g", "b"|set the default color for the clock/date display| |`clock_color`|"r", "g", "b"|set the default color for the clock/date display|
|`today_color"`|"r", "g", "b"|set the special color for today in the day of week line| |`today_color"`|"r", "g", "b"|set the special color for today in the day of week line|
|`weekday_color"`|"r", "g", "b"|set the default color in the day of week line| |`weekday_color"`|"r", "g", "b"|set the default color in the day of week line|
|`del_screen`|"icon_name", "mode"|deletes the specified icon screen from the queue, the [mode](#modes) is a filter| |`del_screen`|"icon_name", "mode"|deletes the specified icon screen from the queue, the [mode](#modes) is a filter|
|`force_screen`|"icon_name", "mode"|displayes the seleted the specified icon screen from the queue, the [mode](#modes) is a filter| |`force_screen`|"icon_name", "mode"|displays the selected the specified icon screen from the queue, the [mode](#modes) is a filter|
|`full_screen`|"icon_name", "lifetime", "screen_time"|show the specified 8x32 icon as fullscreen| |`full_screen`|"icon_name", "lifetime", "screen_time"|show the specified 8x32 icon as full screen|
|`icon_screen`|"icon_name", "text", "lifetime", "screen_time", "default_font", "r", "g", "b"|show the specified icon with text| |`icon_screen`|"icon_name", "text", "lifetime", "screen_time", "default_font", "r", "g", "b"|show the specified icon with text|
|`rainbow_icon_screen`|"icon_name", "text", "lifetime", "screen_time", "default_font"|show the specified icon with text in rainbow color| |`rainbow_icon_screen`|"icon_name", "text", "lifetime", "screen_time", "default_font"|show the specified icon with text in rainbow color|
|`text_screen`|"text", "lifetime", "screen_time", "default_font", "r", "g", "b"|show the specified text| |`text_screen`|"text", "lifetime", "screen_time", "default_font", "r", "g", "b"|show the specified text|
@ -598,7 +598,7 @@ sensor:
##### Force screen ##### Force screen
Force the selected [icon_screen](#icon-screen) ```icon_name``` to be displayed next. Afterward the loop continues from this screen. e.g. helpful for alarms. Or after an update of the value/text. Force the selected [icon_screen](#icon-screen) ```icon_name``` to be displayed next. Afterward, the loop continues from this screen. e.g. helpful for alarms. Or after an update of the value/text.
```yaml ```yaml
id(rgb8x32)->force_screen("homeassistant"); id(rgb8x32)->force_screen("homeassistant");
@ -681,7 +681,7 @@ ehmtxv2:
##### Send an event to Home Assistant ##### Send an event to Home Assistant
To send data back to home assistant you can use events. To send data back to home assistant, you can use events.
```yaml ```yaml
ehmtxv2: ehmtxv2:
@ -791,7 +791,7 @@ switch:
Service **skip_screen** Service **skip_screen**
If there is more than one screen in the queue, it skip the actual displayed screen to the next screen. If there is more than one screen in the queue, it skips the actual displayed screen to the next screen.
e.g. on the Ulanzi TC001 e.g. on the Ulanzi TC001
@ -846,7 +846,7 @@ To control your display, it has to be integrated in Home Assistant. Then it prov
### Services ### Services
All communication with Home Assistant use the homeasistant-api. The services can be provided by default or also defined additionally in the YAML. To define the additional services you need the id of the ehmtx-component e.g. ```id(rgb8x32)```. All communication with Home Assistant use the homeasistant-api. The services can be provided by default or also defined additionally in the YAML. To define the additional services, you need the id of the ehmtx-component e.g. ```id(rgb8x32)```.
### Use in Home Assistant automations ### Use in Home Assistant automations
@ -957,7 +957,7 @@ action:
### Integrate in Home Assistant UI ### Integrate in Home Assistant UI
Add entities to Home Assistant UI for interactive control of your display Add entities to the Home Assistant UI for interactive control of your display
#### Brightness #### Brightness
@ -995,9 +995,9 @@ switch:
### automatic brightness ### automatic brightness
Awtrix and PixelIt have hard-coded functionality. EHMTX is also capable to built something like that by lambdas. But this is all your freedom. See the Ulanzi simple YAML as a guide. Awtrix and PixelIt have hard-coded functionality. EHMTX is also capable of building something like that by lambdas. But this is all your freedom. See the Ulanzi simple YAML as a guide.
Example: automatic brightness control with an bh1570 sensor Example: automatic brightness control with a bh1570 sensor
```yaml ```yaml
sensor: sensor:
@ -1022,7 +1022,7 @@ sensor:
See this German tutorial video with information on setting up your display [RGB-LED Status Display für Home Assistant mit ESPHome | ESPHoMaTrix](https://www.youtube.com/watch?v=DTd9vAhet9A). See this German tutorial video with information on setting up your display [RGB-LED Status Display für Home Assistant mit ESPHome | ESPHoMaTrix](https://www.youtube.com/watch?v=DTd9vAhet9A).
Another german tutorial video focused at the Ulanzi [Smarte Pixel Clock über Home Assistant steuern - Entitäten / Icons und mehr in der Ulanzi](https://www.youtube.com/watch?v=LgaT0mNbl34) Another german tutorial video focused on the Ulanzi [Smarte Pixel Clock über Home Assistant steuern - Entitäten / Icons und mehr in der Ulanzi](https://www.youtube.com/watch?v=LgaT0mNbl34)
See this [nice article](https://blakadder.com/esphome-pixel-clock/) about EsphoMaTrix on a Ulanzi TC001 from [blakadder](https://github.com/blakadder). See this [nice article](https://blakadder.com/esphome-pixel-clock/) about EsphoMaTrix on a Ulanzi TC001 from [blakadder](https://github.com/blakadder).

34
TODO.md
Unescape View File

@ -1,30 +1,30 @@
# To Do's # To-Do's
## function ## function
- [x] alarm on all screen but fullscreen - [x] alarm on all screens but full screen
- [x] indicator on all screen but fullscreen and clock - [x] indicator on all screens but full screen and clock
- [x] refreshing an icon screen should extend the display time - [x] refreshing an icon screen should extend the display time
- [ ] scroll left to right - [ ] scroll left to right
- [x] size of indicator and alarm - [x] size of indicator and alarm
- [x] center text - [x] center text
- [x] alarm unabhängig von screen - [x] alarm independent of screen
- [x] del_screen with * and filter by type do delete all clocks etc. - [x] del_screen with * and filter by type, do delete all clocks etc.
- [x] force_screen with * and filter by type do delete all clocks etc. - [x] force_screen with * and filter by type, do delete all clocks etc.
- [x] gauge mit farbe und del_gaugeall clocks etc. - [x] gauge with color and del_gaugeall clocks etc.
- [ ] seconds point moveable - [ ] seconds point moveable
- [ ] seconds point to clock screen only - [ ] seconds point to clock screen only
- [x] rainbow icon and text - [x] rainbow icon and text
- [x] del_slot noch active? - [x] del_slot still active?
- [x] CONF_ALARM weg? - [x] CONF_ALARM remove?
- [x] reintroduce resize - [x] reintroduce resize
## ux ## user experience
- [ ] blueprints - [ ] blueprints
- [ ] Color in blueprints - [x] Color in blueprints
- [ ] all modes in one blueprint - [ ] all modes in one blueprint
- [ ] external html with more blueprint helpers (icons and modes) - [ ] external HTML with more blueprint helpers (icons and modes)
- [x] default values for all functions - [x] default values for all functions
- [x] provide sample font from [url](https://www.pentacom.jp/pentacom/bitfontmaker2/) - [x] provide sample font from [url](https://www.pentacom.jp/pentacom/bitfontmaker2/)
- [x] start animation - [x] start animation
@ -32,7 +32,7 @@
## style ## style
- [ ] in screen rename text_color to color - [ ] in screen rename text_color to color
- [x] default_font before alarm paramater - [x] default_font before alarm parameter
- [x] screen_time instead of showtime - [x] screen_time instead of showtime
- [x] lifetime instead of durations - [x] lifetime instead of durations
- [x] remove actions in favor of functions - [x] remove actions in favor of functions
@ -44,9 +44,9 @@
- [ ] remake documentation - [ ] remake documentation
- [ ] more explanation for fonts - [ ] more explanation for fonts
- [ ] reference to https://www.pentacom.jp/pentacom/bitfontmaker2/gallery/?id=13768 - [ ] reference to https://www.pentacom.jp/pentacom/bitfontmaker2/gallery/?id=13768
- [ ] sample yaml with voice - [ ] sample YAML with voice
## noch prüfen ## do check
- [ ] Timer display with formation H:M:S - [ ] Timer display with format H:M:S
- [ ] find a way for automatically add smallfont - [ ] find a way to automatically add smallfont

8
components/ehmtxv2/EHMTX.cpp
Unescape View File

@ -574,6 +574,10 @@ namespace esphome
screen->default_font = default_font; screen->default_font = default_font;
screen->mode = MODE_RAINBOW_ICON; screen->mode = MODE_RAINBOW_ICON;
screen->calc_scroll_time(); screen->calc_scroll_time();
for (auto *t : on_add_screen_triggers_)
{
t->process(screen->icon_name,(uint8_t)screen->mode);
}
ESP_LOGD(TAG, "rainbow_icon_screen icon: %d iconname: %s text: %s lifetime: %d screen_time: %d", icon, iconname.c_str(), text.c_str(), lifetime, screen_time); ESP_LOGD(TAG, "rainbow_icon_screen icon: %d iconname: %s text: %s lifetime: %d screen_time: %d", icon, iconname.c_str(), text.c_str(), lifetime, screen_time);
screen->status(); screen->status();
} }
@ -625,6 +629,10 @@ namespace esphome
screen->icon_name = iconname; screen->icon_name = iconname;
screen->screen_time = screen_time; screen->screen_time = screen_time;
screen->endtime = this->clock->now().timestamp + lifetime * 60; screen->endtime = this->clock->now().timestamp + lifetime * 60;
for (auto *t : on_add_screen_triggers_)
{
t->process(screen->icon_name,(uint8_t)screen->mode);
}
ESP_LOGD(TAG, "full screen: icon: %d iconname: %s lifetime: %d screen_time:%d ", icon, iconname.c_str(), lifetime, screen_time); ESP_LOGD(TAG, "full screen: icon: %d iconname: %s lifetime: %d screen_time:%d ", icon, iconname.c_str(), lifetime, screen_time);
screen->status(); screen->status();
} }

Write Preview
Loading…
Cancel
Save