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

Receive a message and forward it to multiple LaMetric devices in your network – Mirror of https://gitlab.com/pixelbrackets/lametric-notification-broadcast/
https://github.com/pixelbrackets/lametric-notification-broadcast

broadcast lametric notification php

Last synced: 3 months ago
JSON representation

Receive a message and forward it to multiple LaMetric devices in your network – Mirror of https://gitlab.com/pixelbrackets/lametric-notification-broadcast/

• Host: GitHub
• URL: https://github.com/pixelbrackets/lametric-notification-broadcast
• Owner: pixelbrackets
• Created: 2020-10-14T07:56:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-04T08:47:48.000Z (about 4 years ago)
• Last Synced: 2025-03-06T18:29:38.887Z (about 1 year ago)
• Topics: broadcast, lametric, notification, php
• Language: PHP
• Homepage: https://gitlab.com/pixelbrackets/lametric-notification-broadcast/
• Size: 27.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# LaMetric Notification Broadcast

[![Version](https://img.shields.io/packagist/v/pixelbrackets/lametric-notification-broadcast.svg?style=flat-square)](https://packagist.org/packages/pixelbrackets/lametric-notification-broadcast/)

[![Build Status](https://img.shields.io/gitlab/pipeline/pixelbrackets/lametric-notification-broadcast?style=flat-square)](https://gitlab.com/pixelbrackets/lametric-notification-broadcast/pipelines)

[![Made With](https://img.shields.io/badge/made_with-php-blue?style=flat-square)](https://gitlab.com/pixelbrackets/lametric-notification-broadcast#requirements)

[![License](https://img.shields.io/badge/license-gpl--2.0--or--later-blue.svg?style=flat-square)](https://spdx.org/licenses/GPL-2.0-or-later.html)

[![Contribution](https://img.shields.io/badge/contributions_welcome-%F0%9F%94%B0-brightgreen.svg?labelColor=brightgreen&style=flat-square)](https://gitlab.com/pixelbrackets/lametric-notification-broadcast/-/blob/master/CONTRIBUTING.md)

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

![Screenshot](./docs/screenshot.png)

## 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)](https://apps.lametric.com/apps/my_data__diy_/8942)« 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`

   - For field `ip` see [Device IP Discovery](https://lametric-documentation.readthedocs.io/en/latest/guides/first-steps/first-local-notification.html#discover-ip-address)

   - For field `token` see [API Key Listing](https://lametric-documentation.readthedocs.io/en/latest/guides/first-steps/first-local-notification.html#find-api-key)

1. Send a request with JSON payload to the local project instance

   HTTPie example request for domain `localhost.local`

   ```bash

   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](https://developer.lametric.com/icons)

## 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 ( / [@pixelbrackets](https://pixelbrackets.de))

## Changelog

See [./CHANGELOG.md](CHANGELOG.md)

## Contribution

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

[Contributions](CONTRIBUTING.md) are welcome!