Coffee/decent-advanced-rest-api
1
0
Fork 0
mirror of https://github.com/randomcoffeesnob/decent-advanced-rest-api.git synced 2026-09-21 11:13:31 +00:00
Code Issues Projects Packages Wiki Activity
Mirror of https://github.com/randomcoffeesnob/decent-advanced-rest-api — REST API / home-automation integration for the DE1 tablet app (pull-mirror, syncs with upstream)
50 commits 1 branch 1 tag 127 KiB
  • HTML 58.4%
  • Tcl 41.6%
Find a file
Exact
Vid Tadel f6752e674b bump version
2024-10-23 18:37:59 +02:00
homeassistant send water level in mls 2024-06-02 20:00:37 +02:00
doc.json update documentation 2024-06-02 22:03:37 +02:00
homebridge_http-switch_config.json Added homebridge accessory configuration 2021-06-22 07:52:58 +02:00
index.html popup when setting next dye shot 2024-06-02 10:34:55 +02:00
plugin.tcl bump version 2024-10-23 18:37:59 +02:00
readme.md Update Home Assistant config 2023-02-14 18:38:42 +01:00
settings.tdb Initial upload 2021-05-24 22:21:31 +02:00

readme.md

The idea

Before I even received my Decent Espresso Machine I was searching for possibilities to integrate the machine with Home Automation systems.

On the diaspora I stubled upon the Web API created by Johanna Schander (https://github.com/decentespresso/de1app/tree/main/de1plus/plugins/web_api) and also the more detailed API by Henrik Pejer (https://github.com/pejer/decentespresso_module_system/tree/modules/modules/pejer_web_api). The second one was integrated directly to the app. So it will break with every update. Since there is a good working plugin system I thought this should be used.

I talked to both and with their "blessing" I combined both ideas and added mine to it.

What does it do?

  • get a simple or detailed state of the machine
  • change the state to standby or enable it
  • get, display or download shot files
  • get, download or upload profiles

How to use it?

  • Copy the files to the plugin folder into a folder called "advanced_rest_api".
  • Adjust the plugin settings in the settings file if needed.
  • Activate the plugin in the app settings.

API

There is a documentation about all available API endpoints in the attached json - which is also displayed in the Web UI.

Web UI

Navigate to http://DECENT-IP:8888 in your preferred browser. The port can be changed in the settings. 8080 should be prevented if it is used with the webcast feature.

Home Assistant

There is example configuration for Home Assistant (https://home-assistant.io) in the homeassistant directory.

Homebridge

As requested I added a Homebridge accessory config.

Update: there is now a better way to integrate this plugin with Homebridge: https://github.com/muelmx/homebridge-decent-advanced-rest-api / https://www.npmjs.com/package/homebridge-decent-advanced-rest-api Many thanks to muelmx :-)

... please contact me for feature requests.

Disclaimer

Of course the usage of this is at your own risk. It may break your machine. You are creating a web server with an unencypted connection in your network. Please be cautious.

This is my first work in TCL - please be nice ;-)