dashboard/README.md

105 lines
2.3 KiB
Markdown
Raw Normal View History

2021-08-23 18:39:09 +00:00
dashboard
=========
My dashboard, for my house. Display RSS feeds and other custom bits of info via
2022-01-28 21:42:52 +00:00
direct SDL2 calls.
2021-08-23 18:39:09 +00:00
Features/TODO
=============
2022-01-28 21:42:52 +00:00
- (DONE) Write straight to framebuffer (sdl2)
2021-12-23 02:59:12 +00:00
- (DONE) Display Weather ~~rss~~ json feed
- Get UV Data from openUV
2022-01-28 21:42:52 +00:00
- (DONE) Display Wifi qrcode
- Get wifispeed and number of clients from home assistant
2021-12-24 18:29:05 +00:00
- (DONE) Display plex currently playing
2021-12-23 02:59:12 +00:00
- Display camera feed
2022-01-28 21:42:52 +00:00
- Integrate with Home assistant data (New panel)
- https://developers.home-assistant.io/docs/api/rest/
2022-01-28 21:42:52 +00:00
- (DONE) Presence
- Integrate with octoprint
2021-08-23 18:39:09 +00:00
Depends on
==========
- sdl2
- stdlib
2021-12-24 18:29:05 +00:00
- rapidxml
- rapidjson
- libcurl
2021-08-23 18:39:09 +00:00
optional dependencies
---------------------
2021-12-24 18:29:05 +00:00
- Weather
- rapidjson
2021-10-02 18:14:58 +00:00
- libcurl
2021-12-24 18:29:05 +00:00
- Plex
- rapidjson
- libcurl
- Wifi
- qrencode (for generating join code)
2021-08-23 18:39:09 +00:00
Building sdl2 on rpi
--------------------
2021-12-18 23:25:03 +00:00
2021-08-23 18:39:09 +00:00
Run in this order
```
sudo apt-get install libdrm-dev libgdm-dev
```
Next downlad the SDL source tarball
```
cd sdl-src
./configure --enable-video-kmsdrm
make -j4
sudo make install
```
compile the test.cpp file provided in ./tests . There should be output on the
screen as flashing. Feel free to change the desired graphics driver in the
raspberry pi config
2021-12-24 18:29:05 +00:00
Developing your own panels
2021-09-17 02:01:40 +00:00
===========================
2021-12-24 18:21:22 +00:00
Refer to the [development](DEVELOPMENT.md) documentation
2021-08-23 18:39:09 +00:00
Usage
=====
To compile:
`make all`
To install:
`make install`
To uninstall:
`make uninstall`
Wifi
----
The makefile by default will call a script that will generate a wifi qr code
for you. You can add your SSID and password by editing the `WIFI_SSID` and
`WIFI_PASS` variables in the make file, or by calling the script yourself in
`./scripts`. You can cleanup the wifi image at any time by calling
`make clean-wifi`. Next time the executable is built it will regenerate the
image.
The qr code generation relies on the program `qrencode`. It can be installed on
2021-12-21 23:10:27 +00:00
any debian system using `sudo apt install qrencode`. By default the image has a
transparent background. If you would like a different background, you will need
to adjust wifi.cpp to adjust where it is located to your preference.
2021-12-24 18:21:22 +00:00
Plex
----
The plex panel relies on you having Tautilli installed on your local network.
In `plex_config.hpp` just change the IP and Port to your local Tautulli server
and everything should work.