› ›

Support for Smart Plug commands like TP-LINK (either directly or via HTTP POST request)

2»

Comments

  • RepetierRepetier
    Wrong file location! I thought you found the already existing in /var/lib/Repetier-Server/database/excommands.xml already. Server does only load that one.
  • GamerPixelTVGamerPixelTV
    edited March 2020
    oh wenn du deutsch kannst dann erklär nochmal deinen Satz auf deutsch xD Englisch ist nicht so meins. danke xD
    also wie geschrieben funktioniert das irgendwie nicht. und meiner Meinung nach ist ja alles richtig.
  • RepetierRepetier
    Der Pfad der Datei war falsch. Korrekter pfad ist /var/lib/Repetier-Server/database/excommands.xml - da liegt auch schon eine die du nur anpassen musst und dann server neu starten.
  • GamerPixelTVGamerPixelTV
    die datei hab ich ja genommen. die gibt es ja auch nur in diesem ordner
  • TAOGTAOG
    edited March 2020
    die datei hab ich ja genommen. die gibt es ja auch nur in diesem ordner
    und jetzt musst du nur die Datei hsB100.sh noch selbstausführend machen. ich glaube das ist "chmod -x Dateiname" als Befehl.

    https://wiki.ubuntuusers.de/Shell/Bash-Skripting-Guide_f%C3%BCr_Anf%C3%A4nger/ Noch eine Erklärung dazu

    Dann ging es auch mit meiner xml Datei ohne Probleme 
  • GamerPixelTVGamerPixelTV
    ah ok. teste ich nachher mal. momentan druckt er. ich melde mich dann ob es geklappt hat oder nicht :)

  • GamerPixelTVGamerPixelTV
    edited March 2020
    es funktioniert !! VIELEN LIEBEN DANK :) 
  • TAOGTAOG
    anyone does have successfully implement 'sleep 360' before @execute TPLINKOFF ?
    my @execute TPLINKOFF goes direct to OFF at the end of the last printed line.
  • RepetierRepetier
    How do you add it before @execute? 
    sleep 360
    is no valid gcode so nothing will happen.

    G4 S360
    @syncMotion
    @execute TPLINKOFF

    should work. Here firmware sleeps and @syncMotion waits for all commands in firmware to be executed. Without it would continue with next line. Drawback is that you can not control firmware any more.

    Better would be to add the sleep command in TPLINKOFF script it self before it sends the link. If that is a bash script 
    sleep 360
    would then be the correct syntax.
  • TAOGTAOG
    edited March 2020
    Repetier said:
    How do you add it before @execute? 
    sleep 360
    is no valid gcode so nothing will happen.

    G4 S360
    @syncMotion
    @execute TPLINKOFF

    should work. Here firmware sleeps and @syncMotion waits for all commands in firmware to be executed. Without it would continue with next line. Drawback is that you can not control firmware any more.

    Better would be to add the sleep command in TPLINKOFF script it self before it sends the link. If that is a bash script 
    sleep 360
    would then be the correct syntax.
    Well this works :)

  • ARCH_TARCH_T
    Repetier said:
    Just a side node - next release will natively support web requests as commands to e.g. call IFTTT maker webhooks to disable a plug. These commands will also be available in menus then. That makes it very easy to switch any plug with IFTTT support.
    Thanks :) Any prediction of when the next release will be available?
  • RepetierRepetier
    I hope in april.
  • ARCH_TARCH_T
    Repetier said:
    I hope in april.
    :) Thanks!
  • ARCH_TARCH_T
    Repetier said:
    Just a side node - next release will natively support web requests as commands to e.g. call IFTTT maker webhooks to disable a plug. These commands will also be available in menus then. That makes it very easy to switch any plug with IFTTT support.
    Could you please tell me how can i make a smart plug (tp-link hs100) turns on/off with web actions through ifttt? Thanks in advance.
  • RepetierRepetier
    See https://www.repetier-server.com/knowledgebase/web-action-to-control-a-remote-controlled-socket/
  • ARCH_TARCH_T
    Repetier said:
    Thanks Repetier, It works :) Can you tell me how I can find a URL for the icon? 
  • RepetierRepetier
    Url can be empty. But it can be any url to a image with matching size. So if you see a icon image you want to use just try it as link by copying image url (right click copy image url). 
  • ARCH_TARCH_T
    Thanks :)
  • twobittwobit
    Freakadude said:
    Right. So i found the script to this online (don't remember where anymore) so i am not taking any credit for that.
    But in essence with setting a few parameters with that script you can tell your switch to turn on or off. You then build it into repetier server either as a switch or to be triggered with an @execute command using the event dependant g-code settings.

    So what you need to do is following:

    1. Download the script ( i put it up on dropbox here: https://www.dropbox.com/s/00nt6lsma7mbf73/hs100B.sh?dl=0 ). Check the script as it has some instructions in it on how to use it. Basically you run it with passing 3 parameters and then it does its thing.

    2. Copy the script onto your RPI or whatever you are running your repetier server on into a folder.

    3. Open and edit your extcommands.xml file on your repetier server. 
     
    4. Add following line at the very end just before the </config>: <execute name="TPLINKOFF" allowParams="true">/pathtoyourscript/hs100B.sh ipofyourTPLinkswitch 9999 off</execute>

    You can name your command whatever you want. I named mine TPLINKOFF as seen above.

    5. In the repetier server webgui go to Printer Settings->G-Codes->Event Dependent and in the Run after job section add: @execute TPLINKOFF

    Now whenever repetier server has finished your print it will trigger this script as entered with the parameters in the extcommands.xml file. So in this case it will tell the switch to turn itself off.

    Now since i usually also make timelapses of my prints and repetier server does some compiling still even after the print is finished i personally also added a timer into the script to wait for 180 seconds after being activated before it turns off the switch. This gives repetier enough time to finish up the timelapse. If you want to do a similar delay then you need to edit the script. Open it up in notepad++ and search for the line: cmd_switch_off(){
    I added command sleep 180 (this tells the script to wait for 180 seconds at this point before proceeding with the next command which is the actual command it sends to the TP LINK switch to turn itself off) which takes care of the delay.

    And thats it.





    Any chance someone has the script file, the links seems to be dead now.
  • RepetierRepetier
    You can now also just use the web actions to send http requests.

    After reading the answer i must add that just disabling the pi with a switch is not best solution. You should always shut down the oi before unpowering or you risk a file imconsistency on the sd card. Will work most of the time but it might as well be in a bad state and start creating strange errors over time due to defect files or folders.
  • TAOGTAOG
    twobit said:
    Right. So i found the script to this online (don't remember where anymore) so i am not taking any credit for that.
    But in essence with setting a few parameters with that script you can tell your switch to turn on or off. You then build it into repetier server either as a switch or to be triggered with an @execute command using the event dependant g-code settings.

    So what you need to do is following:

    1. Download the script ( i put it up on dropbox here: https://www.dropbox.com/s/00nt6lsma7mbf73/hs100B.sh?dl=0 ). Check the script as it has some instructions in it on how to use it. Basically you run it with passing 3 parameters and then it does its thing.

    2. Copy the script onto your RPI or whatever you are running your repetier server on into a folder.

    3. Open and edit your extcommands.xml file on your repetier server. 
     
    4. Add following line at the very end just before the </config>: <execute name="TPLINKOFF" allowParams="true">/pathtoyourscript/hs100B.sh ipofyourTPLinkswitch 9999 off</execute>

    You can name your command whatever you want. I named mine TPLINKOFF as seen above.

    5. In the repetier server webgui go to Printer Settings->G-Codes->Event Dependent and in the Run after job section add: @execute TPLINKOFF

    Now whenever repetier server has finished your print it will trigger this script as entered with the parameters in the extcommands.xml file. So in this case it will tell the switch to turn itself off.

    Now since i usually also make timelapses of my prints and repetier server does some compiling still even after the print is finished i personally also added a timer into the script to wait for 180 seconds after being activated before it turns off the switch. This gives repetier enough time to finish up the timelapse. If you want to do a similar delay then you need to edit the script. Open it up in notepad++ and search for the line: cmd_switch_off(){
    I added command sleep 180 (this tells the script to wait for 180 seconds at this point before proceeding with the next command which is the actual command it sends to the TP LINK switch to turn itself off) which takes care of the delay.

    And thats it.





    Any chance someone has the script file, the links seems to be dead now.
    #!/bin/bash

    set -o errexit

    (( "$DEBUG" )) && set -o xtrace

    here=$(cd $(dirname $BASH_SOURCE[0]); echo $PWD)

    ##
    #  Switch the TP-LINK HS100 wlan smart plug on and off, query for status
    #  Tested with firmware 1.0.8
    #
    #  Credits to Thomas Baust for the query/status/emeter commands
    #
    #  Author George Georgovassilis, https://github.com/ggeorgovassilis/linuxscripts

    # encoded (the reverse of decode) commands to send to the plug

    # encoded {"system":{"set_relay_state":{"state":1}}}
    payload_on="AAAAKtDygfiL/5r31e+UtsWg1Iv5nPCR6LfEsNGlwOLYo4HyhueT9tTu36Lfog=="

    # encoded {"system":{"set_relay_state":{"state":0}}}
    payload_off="AAAAKtDygfiL/5r31e+UtsWg1Iv5nPCR6LfEsNGlwOLYo4HyhueT9tTu3qPeow=="

    # encoded { "system":{ "get_sysinfo":null } }
    payload_query="AAAAI9Dw0qHYq9+61/XPtJS20bTAn+yV5o/hh+jK8J7rh+vLtpbr"

    # the encoded request { "emeter":{ "get_realtime":null } }
    payload_emeter="AAAAJNDw0rfav8uu3P7Ev5+92r/LlOaD4o76k/6buYPtmPSYuMXlmA=="

    # BSD base64 decode on osx has different options
    # BSD od (octal dump) on osx has different options
    od_offset=4
    # BSD netcat on osx has different options
    nc_timeout=2
    NCOPTS=""
    #NCOPTS+='-v' # verbose
    case $OSTYPE in
       darwin*)
          BASE64DEC="-D"
          ODOPTS="-j $od_offset -A n -t u1"
          NCOPTS+=" -G $nc_timeout"
          ;;
       linux*)
          BASE64DEC="-d"
          ODOPTS="--skip-bytes=$od_offset --address-radix=n -t u1 --width=9999"
          NCOPTS+=" -w $nc_timeout"
          ;;
    esac


    # tools

    error(){
       echo >&2 "$@"
       exit 2
    }

    quiet(){
       $@ >/dev/null 2>&1
    }

    mac_from_ip()
    {
        # if you've contacted an IP recently, the arp cache has juicy info
        local ip=$1
        mac=$(arp -a \
                | grep "($ip)" \
                | egrep -o '(([0-9a-fA-F]{1,2}:){5}[0-9a-fA-F]{1,2})' )
        [ -z "$mac" ] && { echo 2>&1 "arp didn't find a MAC for $ip!"; return 1; }
        echo $mac
    }

    unique_hostname()
    {
        # given a prefix and a MAC for a host, construct a unique name for the host
        local prefix=$1;    [ -n $prefix ] || return 1
        local mac=$2;       [ -n $mac ] || return 1

        # use the first 7 characters of the shasum as unique ID
        hash=$(echo $mac | shasum)
        hs100host=hs100${hash:0:7}
        echo $hs100host
    }

    host_entry()
    {
        host=$1
        ip=$2
        printf "${ip}\t${host}\n" >> /etc/hosts
        echo plug $host has ip $ip
    }

    my_plugs()
    {
        cat /etc/hosts | grep hs100 | awk '{ print $2 }'
    }

    check_dependency()
    {
        dep=$1; shift
        quiet command -v "$dep" || error "$message"
    }

    check_dependencies() {
        check_dependency nc \
           "The nc programme for sending data over the network isn't" \
           "in the path, communication with the plug will fail"
        check_dependency base64 \
           "The base64 programme for decoding base64 encoded strings isn't" \
           "info the path, decoding of payloads will fail"
        check_dependency od \
            "The od programme for converting binary data to numbers isn't" \
            "in the path, the status and emeter commands will fail"
        check_dependency nmap \
            "The nmap programme for mapping networks isn't"\
            "in the path, the discover command will fail"
        check_dependency shasum \
            "The shasum programme for hashing strings isn't"\
            "in the path, the sudo discover command will fail"
        check_dependency arp \
            "The arp programme to access Address Resolution Protocol cache isn't"\
            "in the path, the sudo discover command will fail"
    }

    usage() {
       echo "Usage: $0 [-i IP] [-p PORT] COMMAND"
       echo "where COMMAND is one of: ${commands[@]}"
       exit 1
    }

    check_arg() {
       name="$1"
       value="$2"
       if [ -z "$value" ]; then
          echo "missing argument $name"
          usage
       fi
    }

    # Check for a single string in a list of space-separated strings.
    # e.g. has "foo" "foo bar baz" is true, but has "f" "foo bar baz" is not.
    has()
    { [[ " ${*:2} " == *" $1 "* ]]; }

    check_command()
    { has "$1" "$commands"; }

    send_to_plug() {
       ip="$1"
       port="$2"
       payload="$3"
       if ! echo -n "$payload" | base64 ${BASE64DEC} | nc $NCOPTS $ip $port
       then
          echo couldn''t connect to $ip:$port, nc failed with exit code $?
       fi
    }

    decode(){
       code=171
       input_num=`od $ODOPTS`
       IFS=' ' read -r -a array <<< "$input_num"
       args_for_printf=""
       for element in "${array[@]}"
       do
          output=$(( $element ^ $code ))
          args_for_printf="$args_for_printf\x$(printf %x $output)"
          code=$element
       done
       printf "$args_for_printf"
    }

    pretty_json()
    {
        # read from stdin
        if quiet command -v python
        then
             python -m json.tool
        else
             cat
             echo
        fi
    }

    query_plug(){
       payload=$1
       check_dependency od \
           "The od programme for converting binary data to numbers isn't" \
           "in the path, the status and emeter commands will fail"
       check_arg "ip" $plugs
       check_arg "port" $port
       for ip in ${plugs[@]}
       do
            send_to_plug $ip $port "$payload" | decode | pretty_json
       done
    }

    # plug commands
    cmd_discover(){
        check_arg "port" $port
        check_dependency nmap \
            "The nmap programme for mapping networks isn't"\
            "in the path, the discover command will fail"
        myip="`${here}/myip.sh`"
        subnet=$(echo $myip | egrep -o '([0-9]{1,3}\.){3}')
        subnet=${subnet}0-255
        declare -a hs100ip
        hs100ip=( $(nmap -Pn -p ${port} --open ${subnet} \
                    | grep 'Nmap scan report for' \
                    | egrep -o '(([0-9]{1,3}\.){3}[0-9]{1,3})' ) \
                ) \
            || error "Could not find any hs100 plugs"

        # if we can't write this to /etc/hosts, echo what we found and quit
        if ! [ -w /etc/hosts ]
        then
            echo HS100 plugs found: ${hs100ip[@]}
            return 0
        fi

        check_dependency shasum \
            "The shasum programme for hashing strings isn't"\
            "in the path, the sudo discover command will fail"
        check_dependency arp \
            "The arp programme to access Address Resolution Protocol cache isn't"\
            "in the path, the sudo discover command will fail"

        # remove existing hs100* hosts entries
        sed -i.bak /hs100/d /etc/hosts

        if [[ ${#hs100ip[@]} = 1 ]]
        then
            host_entry hs100 $hs100ip
            return 0
        fi

        # multiple HS100 plugs on the network, hash MAC address for unique hostname
        for ip in ${hs100ip[@]}
        do
            # since we just hit it with nmap, it should be in the arp cache
            mac=`mac_from_ip $ip`
            hs100host=`unique_hostname hs100 $mac`
            host_entry $hs100host $ip
        done
        return 0
    }

    cmd_print_plug_relay_state(){
       check_arg "ip" $plugs
       check_arg "port" $port
       for ip in ${plugs[@]}
       do
           printf "$ip\t"
           output=`send_to_plug $ip $port "$payload_query" \
                   | decode \
                   | egrep -o 'relay_state":[0,1]' \
                   | egrep -o '[0,1]'`
           if (( output == 0 )); then
             echo OFF
           elif (( output == 1 )); then
             echo ON
           else
             echo Couldn''t understand plug response $output
           fi
       done
    }

    cmd_print_plug_status(){
       query_plug "$payload_query"
    }

    cmd_print_plug_consumption(){
       query_plug "$payload_emeter"
    }

    cmd_switch_on(){
       check_arg "ip" $plugs
       check_arg "port" $port
       for ip in ${plugs[@]}
       do
          send_to_plug $ip $port $payload_on > /dev/null
       done
    }

    cmd_switch_off(){
       check_arg "ip" $plugs
       check_arg "port" $port
       for ip in ${plugs[@]}
       do
           send_to_plug $ip $port $payload_off > /dev/null
       done
    }

    commands=" on off check status emeter discover list "

    # run the Main progamme, if we are not being sourced
    if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then

    # process args with getopt(1). See `man getopt`
    args=`getopt qvi:p: $*` || { usage; exit 1; }
    set -- $args

    declare -a plugs;

    do
        case "$i" in
        -q) opt_quiet=yes; shift;;
        -v) set -o xtrace; shift;;
        -i) plugs=$2; shift; shift;;
        -p) port=$2; shift; shift;;
        --) shift; break;;
        #*)  error "Getopt broke! Found $i"
        esac
    done

    : ${plugs=`my_plugs`}
    : ${port=9999}
    cmd=$1


    check_dependency nc \
       "The nc programme for sending data over the network isn't" \
       "in the path, communication with the plug will fail"
    check_dependency base64 \
       "The base64 programme for decoding base64 encoded strings isn't" \
       "info the path, decoding of payloads will fail"

    check_arg "command" $cmd
    check_command $cmd

    case "$cmd" in
      discover) cmd_discover;;
      list)     plugs=`my_plugs`; for p in ${plugs[@]}; do echo $p; done;;
      on)       cmd_switch_on;;
      off)      cmd_switch_off;;
      check)    cmd_print_plug_relay_state;;
      status)   cmd_print_plug_status;;
      emeter)   cmd_print_plug_consumption;;
      *)        usage;;
    esac

    fi # end main program

  • PapsDizzyPapsDizzy
    edited April 2022
    hi ich bin neu bei rs und würde gerne das script her zum laufen bekommen.  die extcommands.xml hab ich schon bearbeitet und <execute name="TPLINKOFF" allowParams="true">/home/pi/script/hs100B.sh 192.168.178.45 9999 off</execute> am ende vor dem </config> eingetragen. meine vermutung warum es bei mir nicht geht das ich ein fehler in der hs100.sh habe. was muss ich wo in der hs100.sh eintragen?
    sorry für die dumme frage aber ich find es einfach nicht.

    so also einen teilerfolg habe ich. über putty kann ich mit bash hs100.sh -i 192.168.178.45 off ausschalten und mit bash hs100.sh -i 192.168.178.45 on anschalten.
    das einzige was nicht will ist das mit dem  @execute TPLINKOFF.
    in der extcommands.xml hab ich jetzt unten das drin <execute name="TPLINKOFF" allowParams="true">/home/pi/bash hs100.sh -i 192.168.178.45 off</execute> aber es will nicht über die rs konsole gehen.
  • PapsDizzyPapsDizzy
    PapsDizzy said:
    hi ich bin neu bei rs und würde gerne das script her zum laufen bekommen.  die extcommands.xml hab ich schon bearbeitet und <execute name="TPLINKOFF" allowParams="true">/home/pi/script/hs100B.sh 192.168.178.45 9999 off</execute> am ende vor dem </config> eingetragen. meine vermutung warum es bei mir nicht geht das ich ein fehler in der hs100.sh habe. was muss ich wo in der hs100.sh eintragen?
    sorry für die dumme frage aber ich find es einfach nicht.

    so also einen teilerfolg habe ich. über putty kann ich mit bash hs100.sh -i 192.168.178.45 off ausschalten und mit bash hs100.sh -i 192.168.178.45 on anschalten.
    das einzige was nicht will ist das mit dem  @execute TPLINKOFF.
    in der extcommands.xml hab ich jetzt unten das drin <execute name="TPLINKOFF" allowParams="true">/home/pi/bash hs100.sh -i 192.168.178.45 off</execute> aber es will nicht über die rs konsole gehen.
    so ich hab meinen fehler gefunden. ich hab das bash falsch gesetzt gehabt nun gehts mit 
    <execute name="TPLINKOFF" allowParams="true">bash /home/pi/hs100.sh -i 192.168.178.45 off</execute>
    geht es ohne probleme mit @execute TPLINKOFF.
    der weg ist das Ziel!
Sign In or Register to comment.