https://github.com/itis-enrico-fermi/edstream

Realtime streaming facility for embedded displays
https://github.com/itis-enrico-fermi/edstream

bitmap c esp-idf esp32 facility freertos image lib library oled oled-display oled-display-ssd1306 open-source-project pio platformio python3 stream tools video video-stream

Last synced: 6 months ago
JSON representation

Realtime streaming facility for embedded displays

• Host: GitHub
• URL: https://github.com/itis-enrico-fermi/edstream
• Owner: ITIS-Enrico-Fermi
• Created: 2021-03-01T21:32:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-30T08:49:14.000Z (about 3 years ago)
• Last Synced: 2025-02-03T00:28:18.064Z (over 1 year ago)
• Topics: bitmap, c, esp-idf, esp32, facility, freertos, image, lib, library, oled, oled-display, oled-display-ssd1306, open-source-project, pio, platformio, python3, stream, tools, video, video-stream
• Language: Python
• Homepage:
• Size: 1.85 MB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# edstream

Bitmap streaming facility for ESP32 and OLED displays.







## Setting up

Clone this project into _lib_ folder inside your PIO workspace

```

cd lib

git clone https://github.com/ITIS-Enrico-Fermi/edstream

cd ..

```

Clone _ssd1306_ library into _components_ folder inside your PIO workspace

```

mkdir components && cd components

git clone https://github.com/lexus2k/ssd1306

cd ..

```

for more information see: [https://github.com/lexus2k/ssd1306#setting-up]()

Copy PlatformIO configuration for a quick setup

```

cp lib/edstream/platformio.ini .

```

```

cp lib/edstream/sdkconfig .

```

## Protocol

### Start byte

![Start byte](diagrams/Protocol.svg)

### Send bitmap

![Send bitmap](diagrams/SendBitmap.svg)

### Set refresh rate

![Set refresh rate](diagrams/SetRefreshRate.svg)


 With _set_rr_ bit set to 1


 1 byte payload expected

### Clear framebuffer

![Cleare framebuffer](diagrams/Clear.svg)


 With _clear_ bit set to 1


 No payload expected

### Toggle animation

![Start animation](diagrams/Start.svg)


 With _start_ / _stop_ bit set to 1


 No payload expected

## Release numbering

(major release).(new features).(bug fixing)