pixelbrackets/lametric-notification-broadcast

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Receive a message and forward it to multiple LaMetric devices in your network

1.0.0 2020-10-07 09:25 UTC

This package is auto-updated.

Last update: 2021-09-09 19:09:47 UTC


README

Version Build Status Made With License Contribution

Receive a message and forward it to multiple LaMetric devices in your network.

Screenshot

Vision

This project provides a way to send a message to multiple LaMetric devices in a local network.

This allows setting up one notification endpoint only in other services, and not register all devices individually.

The endpoint also reduces the payload structure to a minimum by default.

This project does not display data permanently. Use an indicator app like »My Data (DIY)« instead.

Requirements

  • PHP

Installation

Packagist Entry https://packagist.org/packages/pixelbrackets/lametric-notification-broadcast/

  • Point your webserver to the web directory
  • Copy data/subscriptions.template.json and rename it to data/subscriptions.json.

Source

https://gitlab.com/pixelbrackets/lametric-notification-broadcast/

Mirror https://github.com/pixelbrackets/lametric-notification-broadcast/

Usage

  1. Register each LaMetric in data/subscriptions.json
  2. Send a request with JSON payload to the local project instance

    HTTPie example request for domain localhost.local

    http POST localhost.local/hook message="Hi" icon="26175"
    

Options

  • JSON body
    • message – string – Text that will be displayed - Keep it short, if it is too long it will scroll
    • icon (optional) – string – ID of an icon in the LaMetric Icon Gallery

License

GNU General Public License version 2 or later

The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.

Author

Dan Untenzu (mail@pixelbrackets.de / @pixelbrackets)

Changelog

See ./CHANGELOG.md

Contribution

This script is Open Source, so please use, patch, extend or fork it.

Contributions are welcome!