Skip to content

Commit

Permalink
Master branch related modifications after merge from Development branch.
Browse files Browse the repository at this point in the history
  • Loading branch information
BlueAndi committed Dec 17, 2022
1 parent f55264a commit eb2e7e4
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 27 deletions.
2 changes: 1 addition & 1 deletion data/plugins/ThreeIconPlugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h1 class="mt-5">ThreeIconPlugin</h1>
<p><img src="/images/ThreeIconPlugin.jpg" alt="Screenshot" /></p>
<p>The plugin is able to show three different icons.</p>
<p>Each icon can be set separately via the REST API.</p>
<p>If a Sprite Sheet is used the animation of an can be controlled via the REST API (see <a href="https://github.com/BlueAndi/esp-rgb-led-matrix/blob/Development/doc/SPRITESHEET.md"> Sprite Sheet</a>).</p>
<p>If a Sprite Sheet is used the animation of an can be controlled via the REST API (see <a href="https://github.com/BlueAndi/esp-rgb-led-matrix/blob/master/doc/SPRITESHEET.md"> Sprite Sheet</a>).</p>
<p>Show bitmap in one of the three slots. Supported are bitmap files (.bmp) with:</p>
<ul>
<li>24 or 32 bits per pixel.</li>
Expand Down
4 changes: 2 additions & 2 deletions doc/PLUGIN-DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Therefore if you need periodically stuff, but you can't do it in the ```update()

## Static View

![plugin-service-dynamic](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/plugin-service.wsd)
![plugin-service-dynamic](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/plugin-service.wsd)

## Dynamic View

![plugin-service-dynamic](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/plugin-service-dynamic.wsd)
![plugin-service-dynamic](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/plugin-service-dynamic.wsd)

# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/esp-rgb-led-matrix/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
Expand Down
8 changes: 6 additions & 2 deletions doc/SENSORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ A "X" in the development board column means valid all development boards. Except
| Development Board | Photoresistor pin 1 | Photoresistor pin 2 |
| ----------------- | ------------------- | ------------------- |
| X | Vcc | Pin 34 |
| TTGO ESP32 T-Display | Vcc | Pin 32 |
| Lilygo&reg; TTGO ESP32 T-Display | Vcc | Pin 32 |
| Lilygo&reg; ESP32 T-Display S3 | Vcc | Pin 10 |

# Temperature and humidity sensors

Expand All @@ -45,13 +46,15 @@ A "X" in the development board column means valid all development boards. Except
| Development Board | DHTx pin 1 | DHTx pin 2 |
| ----------------- | ---------- | ---------- |
| X | Vcc | Pin 5 |
| TTGO ESP32 T-Display | Vcc | Pin 27 |
| Lilygo&reg; TTGO ESP32 T-Display | Vcc | Pin 27 |
| Lilygo&reg; ESP32 T-Display S3 | Vcc | Pin 21 |

## SHT3x (I2C)

| Development Board | I2C SCL | I2C SDA |
| ----------------- | ------- | ------- |
| X | Pin 22 | Pin 21 |
| Lilygo&reg; ESP32 T-Display S3 | Pin 17 | Pin 18 |

# Audio (digital micropohone with I2S)

Expand All @@ -61,6 +64,7 @@ Only the left channel is supported, therefore the L/R channel select signal shal
| Development Board | Left/Right Clock (LRCL) | Data Output (DOUT) | Bit Clock (BCLK) | Left/Right Channel Select (L/R) | Chip Enable (CHIPEN) |
| ----------------- | ----------------------- | ------------------ | ---------------- | ------------------------------- | -------------------- |
| X | Pin 25 | Pin 33 | Pin 26 | GND | Vcc |
| Lilygo&reg; ESP32 T-Display S3 | Pin 12 | Pin 18 | Pin 11 | GND | Vcc |

# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/esp-rgb-led-matrix/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
Expand Down
32 changes: 16 additions & 16 deletions doc/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ The SW architecture document is valid for the PIXELIX project.
# Context
PIXELIX as a system is not complete alone. It interacts with other neighbor systems over different kind of interfaces.

![context-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/context.wsd)
![context-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/context.wsd)

# Deployment

![deployment-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/deployment.wsd)
![deployment-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/deployment.wsd)

| Task name | Core | Description |
| --------- | ---- | ----------- |
Expand All @@ -68,52 +68,52 @@ PIXELIX as a system is not complete alone. It interacts with other neighbor syst
| wifi | PRO_CPU | WiFi handling. |

# Layers
![general-layers](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/general_layers.wsd)
![general-layers](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/general_layers.wsd)

## Application
![app-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/app_layer.wsd)
![app-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/app_layer.wsd)

## Services
![hal-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/service_layer.wsd)
![hal-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/service_layer.wsd)

## Hardware Abstraction Layer (HAL)
![hal-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/hal_layer.wsd)
![hal-layer](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/hal_layer.wsd)

# System Startup

## High Level
![startup-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/startup.wsd)
![startup-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/startup.wsd)

# System States
![system-states-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/system_state_machine.wsd)
![system-states-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/system_state_machine.wsd)

# Details

## Hardware Abstraction Layer (HAL)
![hal-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/hal.wsd)
![hal-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/hal.wsd)

## Graphic Base Functionality
![gfx-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/gfx.wsd)
![gfx-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/gfx.wsd)

## Widgets
![widgets-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/widgets.wsd)
![widgets-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/widgets.wsd)

## User Button Handling
![button-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/button.wsd)
![button-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/button.wsd)

## Plugin Handling

### Static View
![plugin-service-static-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/plugin-service.wsd)
![plugin-service-static-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/plugin-service.wsd)

### Dynamic View
![plugin-service-dynamic-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/plugin-service-dynamic.wsd)
![plugin-service-dynamic-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/plugin-service-dynamic.wsd)

## Spectrum Analyzer
![specturm-analyzer-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/spectrum-analyzer.wsd)
![specturm-analyzer-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/spectrum-analyzer.wsd)

## Slot Handling
![slot-handling-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/slot_handling.wsd)
![slot-handling-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/slot_handling.wsd)

# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/esp-rgb-led-matrix/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
Expand Down
2 changes: 1 addition & 1 deletion doc/boards/pixelix/v1.5/ELECTRONIC.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ PCB board v1.5

# System Diagram

![system-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/system.wsd)
![system-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/system.wsd)

# ESP32 DevKit V1

Expand Down
2 changes: 1 addition & 1 deletion doc/boards/pixelix/v2.0/ELECTRONIC.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PCB board v2.0

# System Diagram

![system-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/architecture/uml/system.wsd)
![system-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/architecture/uml/system.wsd)

# Differences to v1.5

Expand Down
2 changes: 1 addition & 1 deletion doc/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The SW build environment is based on [PlatformIO](https://platformio.org/). The

## Logical Configuration Hierarchy And Dependencies

![pio-env-dependencies](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/Development/doc/config/uml/pio-env-dependencies.wsd)
![pio-env-dependencies](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/esp-rgb-led-matrix/master/doc/config/uml/pio-env-dependencies.wsd)

# Version Numbers
The concept behind the version number follows the [semantic versioning](https://semver.org/).
Expand Down
2 changes: 1 addition & 1 deletion doc/homeassistant/pixelix-justtext.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ blueprint:
name: Pixelix LED Matrix Wrapper for JustText Plugin
description: Pixelix LED Matrix Wrapper for JustText Plugin
domain: automation
source_url: https://github.com/BlueAndi/esp-rgb-led-matrix/blob/Development/doc/homeassistant/pixelix-justtext.yaml
source_url: https://github.com/BlueAndi/esp-rgb-led-matrix/blob/master/doc/homeassistant/pixelix-justtext.yaml
input:
uid:
name: The uid of the Plugin
Expand Down
4 changes: 2 additions & 2 deletions platformio.ini
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ build_flags =
; Select mode here!
; ********************************************************************************
[mode:selected]
extends = mode:debug
extends = mode:release
build_flags =
${mode:debug.build_flags}
${mode:release.build_flags}

; ********************************************************************************
; Common for esp32 environments
Expand Down

0 comments on commit eb2e7e4

Please sign in to comment.