https://github.com/ramdacxp/dcache

JSON data cache for Home Assistant, TRMNL and more
https://github.com/ramdacxp/dcache

home-assistant php rest-api trmnl webapi webapp

Last synced: 8 days ago
JSON representation

JSON data cache for Home Assistant, TRMNL and more

• Host: GitHub
• URL: https://github.com/ramdacxp/dcache
• Owner: ramdacxp
• License: mit
• Created: 2024-07-11T17:51:08.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T21:23:05.000Z (6 months ago)
• Last Synced: 2024-07-19T05:30:35.019Z (6 months ago)
• Topics: home-assistant, php, rest-api, trmnl, webapi, webapp
• Language: CSS
• Homepage: https://dcache.schademarmelade.de/
• Size: 110 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-trmnl - Dcache - Visualize Selected Home Assistant entities on TRMNL by ramdacxp (🔌 Plugins)
• awesome-trmnl - Dcache - Visualize Selected Home Assistant entities on TRMNL by ramdacxp (🔌 Plugins)

README

        
# dcache

**dcache** is a PHP REST API implementing a JSON data cache.

* The data cache consists of _data sets_ containing multiple _properties_ as key-value-pairs.

* A _data set_ is identified by an unique _token_.

* _Data Provider_ can create, update, and remove _data sets_.

* _Consumer_ can query a _data set_ identified by the provided _token_.

A running demo is available at: .

![dcache Table View](doc/tableview.png)

Usage examples:

* Selected [Home Assistant](https:c//www.home-assistant.io/) entities can be pushed to **dcache** and visualized on a [TRMNL](https://usetrmnl.com/) e-ink display via a [custom TRMNL-Plugin](https://help.usetrmnl.com/en/articles/9510536-custom-plugins).

* The result status of a DevOps build pipeline can be sent to **dcache** and visualized on a WLED led strip.

* The battery status of multiple IoT devices is available in a single **dcache** data set.

* ...

A typical data flow between Home Assistant, **dcache**, and TRMNL could look like this:

* HA provides `temperature=25`

* HA provides `humidity=65`

* TRMNL receives `{ temperature=25, humidity=65 }`

* HA provides `fan=on`

* HA provides `humidity=40`

* TRMNL receives `{ temperature=25, humidity=40, fan=on }`

## Server Setup

Simply upload the `www` folder to your PHP enabled webserver and open the related address in a browser to setup your database connection.

## Development Setup

Local development on Windows requires the following setup:

* Install Git, NodeJs and VSCode.

* Clone the GitHub repo `https://github.com/ramdacxp/dcache` in VSCode.

* Open the created local folder in VSCode and confirm the installation of all recommended extensions.

* Install PHP and MariaDB locally into a `bin` subfolder by executing `npm install`.

* Import database test data via `reset-testdata.cmd`.

The installation can be repeated by executing the related `install-xxx.cmd` batch files.

No system wide settings are modified during the installation.

The database content can be reset to the initial test data with `reset-testdata.cmd`.

Already existing data in dcache tables will be removed!

All tools and test data can be removed completely by deleting the `bin` and `node_modules` sub-folders.

## Run dcache locally

* Execute `npm start` or choose `Terminal > Run Build Task...` in VSCode.

* Open the local dev webserver address  in your browser.

* Stop the servers by pressing `Ctrl-C` in the Terminal window.

## Settings

If the settings file `src/settings.php` is missing, a settings form is shown on the website to interactively configure the database connection.

Simply accept the default values if using the development servers.

Once configured, the form is no longer available. To revert the configuration, the settings file `src/settings.php` needs to be removed.

The default `src/settings.php` will have the following content:

```php