From 9f00721e49b510c049f07a36eef2e93b70e8299f Mon Sep 17 00:00:00 2001 From: Dominik Meyer Date: Fri, 23 Feb 2024 21:52:33 +0100 Subject: [PATCH] FIX: added missing basic documentation (commandref) FIXES: #2 TIME: 2h --- FHEM/98_NTFY_CLIENT.pm | 90 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 79 insertions(+), 11 deletions(-) diff --git a/FHEM/98_NTFY_CLIENT.pm b/FHEM/98_NTFY_CLIENT.pm index dd10ab6..3b36e1f 100644 --- a/FHEM/98_NTFY_CLIENT.pm +++ b/FHEM/98_NTFY_CLIENT.pm @@ -477,16 +477,84 @@ sub NTFY_Attr ######################################### =pod -=item summary devices to send and receive push notifications through ntfy.sh and self hosted instances - -

NTFY_CLIENT

-
  • - ntfy.sh is a service to publish messages to and receive messages from topics. It is also possible - to host own instances of the service. The service can be used from the commandline using curl or - wget and also from smartphone applications. The later are available for IOS and Android. -
    • -
  • - Module development takes place at https://rm.byterazor.de/projects/fhem-ntfy. -
    • +=item summary A module for pushing and receiving notifications from an ntfy.sh compatible server + +=item summary_DE Ein module zu senden und empfangen von Benachrichtigungen über einen ntfy.sh kompatiblen server + +=begin html + +

    NTFY_CLIENT

    + +
    + NTFY_CLIENT is a module for connecting to an ntfy.sh compatible server.
    + It supports ntfy.sh in the cloud but also self-hosted instances as long as + the fhem server is able to connect to it.
    + +

    Wiki

    + The wiki for this module can be found here. + +

    Integration with globalMSG

    + This module integrates with the fhem messaging system.
    + To use it you have to set the msgCmdPush attribute of the + globalMSG device to someting like
    + set %DEVICE% publish @%RECIPIENT% !%PRIORITY% *%TITLE% %MSG% +
    + After that you can use the msg to send out notifications to topics configured within devices. +
    + Please look for the MSG documentation for more information. + + + +

    Define

    + define NTFY0 NTFY_CLIENT <url> password=<password> user=<user> + +
    +
    url
    +
    The url to the ntfy.sh compatible server. This parameter is mandatory.
    +
    password
    +
    If you have an account at one ntfy server you can put the password in here. This parameter is optional.
    +
    user
    +
    If you have an account at one ntfy server you can put the username in here. This parameter is optional.
    +
    + + If you want to use token authentication just set the token as the password and ignore the user parameter. + + +

    Set

    + The module supports the following set commands +
    +
    publish
    +
    + This set command publishes a notification through the configured ntfy server.
    + set publish @fhem-topic #keyword !high *title this is my message
    + The following key tags are supported right now +
      +
    • @ - identifies a topic. Can be used multiple times.
      • +
    • # - a ntfy keyword. Can be used multiple times.
      • +
    • ! - the priority. The last mentioned priority wins. (high, medium, low, default)
      • +
    • * - the title of the notification. The last mentioned title wins.
      • +
    + Everything without a prefix is considered the messages and is concatenated. +
    +
    + + +

    Get

    + No get commands supported yet. + + +

    Attributes

    + No own attributes supported yet. + +=end html + +=begin html_DE + +

    NTFY_CLIENT

    + + blabla + +=end html_DE + =cut \ No newline at end of file