Skip to content

iobroker-archive/ioBroker.gotify.-.ThomasPohl

 
 

Repository files navigation

Logo

ioBroker.gotify

NPM version Downloads Number of Installations (latest) Number of Installations (stable)

NPM

Tests: Test and Release

gotify adapter for ioBroker

Send push notifications from ioBroker to Gotify

Changelog

0.3.0

  • (Thomas Pohl) The token is stored now encrypted
  • (Thomas Pohl) node.js 22 is supported

0.2.1

  • (Thomas Pohl) Optimized startup behavior when adapter is not configured

0.2.0

  • (Thomas Pohl) Add timeout for http calls
  • (Thomas Pohl) Update dependency versions

0.1.0

  • (Thomas Pohl) Update to adapter-core 2.5.1

0.0.2-RC1.0 (2022-02-09)

  • (Thomas Pohl) Update dependencies

0.0.1

  • (Thomas Pohl) initial release

Installation

Preparation

  • Login with you user in gotify
  • Create an application for ioBroker
  • Note the token of your new application new application

In ioBroker

  • Goto Adapter
  • Click on github-cat-icon
  • Go to Custom tab
  • Enter https://github.com/ThomasPohl/ioBroker.gotify
  • Install
  • Create a new instance for the gotify-adapter
  • Enter the Url auf you installation
  • Add the previously created token

Usage

Blockly

To send messages using blockly. Just add the gotify block to your script: Blockly

If yoou choose Markdown as format you can use Markdown to format your messages.

Javascript

sendTo("gotify.0", "send", {
    title: "DG lüften",
    message: "Luftfeuchtigkeit im DG zu hoch!",
});

Communication

The following diagramm illustrates how ioBroker sends push notifications to your smartphone. Communication diagram

Both the ioBroker and the smartphone app connect to the gotify server using REST. The mobile app keeps an open websocket to the gotify server to be able to receive new notification.

When the ioBroker-adapter wants to push a notification it send a POST request to the Gotify server. The gotify server takes care of pushing the notification to the client.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2024 Thomas Pohl [email protected]

About

Use gotify to receive notifications from ioBroker

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 56.2%
  • TypeScript 22.7%
  • HTML 17.5%
  • CSS 3.2%
  • Dockerfile 0.4%