Plugin ‚indego4shng‘ Konfiguration

plugin type logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin indego4shng konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Es handelt sich bei diesem Plugin um ein web Plugin.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.6

Konfiguration

Im folgenden ist beschrieben, wie das Plugin indego4shng konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

cycle

  • Datentyp: int

  • Standardwert: 30

img_pfad

  • Datentyp: str

  • Standardwert: /tmp/garden.svg

indego_credentials

  • Datentyp: str

indego_url

  • Datentyp: str

  • Standardwert: https://api.indego.iot.bosch-si.com/api/v1/

parent_item

  • Datentyp: str

  • Standardwert: indego

path_2_weather_pics

  • Datentyp: str

  • Standardwert: /smartVISU/lib/weather/pics/

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

indego_add_key

  • Datentyp: str

indego_attr_name

  • Datentyp: str

indego_attr_type

  • Datentyp: str

indego_command

  • Datentyp: str

indego_config

  • Datentyp: str

indego_config_url

  • Datentyp: str

indego_function_4_all

  • Datentyp: str

indego_function_4_visu

  • Datentyp: str

indego_parse_2_attr

  • Datentyp: str

indego_plugin_handled

  • Datentyp: str

indego_smart

  • Datentyp: str

Item-Structs

Das Plugin stellt die folgenden Item-Structs zur Verfügung. Diese Informationen sind aus der plugin.yaml entnommen und möglicherweise nicht vollständig.

child

Vorlage Struktur Indego-Mower

  • child (foo, Vorlage Struktur Indego-Mower)
    • visu (foo, —)
      • battery_load (num, —)

      • battery_load_icon (num, —)

      • refresh (bool, —)

      • network (foo, —)
        • act_provider (str, —)

        • available_provider (str, —)

      • model (str, —)

      • model_type (num, —)

      • avoid_temperature (bool, —)

      • avoid_rain (bool, —)

      • use_grass_growth (bool, —)

      • full_cuts (num, —)

      • use_exclude_time_4_sms (bool, —)

      • store_sms_profile (bool, —)

      • alerts (dict, —)

      • alert_new (bool, —)

      • alerts_reset (bool, —)

      • alerts_read (bool, —)

      • alerts_set_read (list, —)

      • alerts_set_clear (list, —)

      • cal_2_show (str, —)

      • smartmow_days (list, —)

      • wintermodus (str, —)

      • svg_pos (str, —)

      • mow_track (list, —)
        • last_percent_mowed (num, —)

      • svg_mow_track (str, —)

      • show_mow_track (bool, —)

      • add_svg_images (str, —)

      • mower_colour (str, —)

      • map_2_display (str, —)

      • fire_uszu_popup (str, —)

    • trigger (foo, —)
      • state_trigger_1 (bool, —)
        • state (str, —)

      • state_trigger_2 (bool, —)
        • state (str, —)

      • state_trigger_3 (bool, —)
        • state (str, —)

      • state_trigger_4 (bool, —)
        • state (str, —)

      • alarm_trigger_1 (bool, —)
        • alarm (str, —)

      • alarm_trigger_2 (bool, —)
        • alarm (str, —)

      • alarm_trigger_3 (bool, —)
        • alarm (str, —)

      • alarm_trigger_4 (bool, —)
        • alarm (str, —)

    • webif (foo, —)
      • laststateCode (num, —)

      • state_protocoll (list, —)

      • communication_protocoll (list, —)

      • garden_map (str, —)

      • location_longitude (num, —)

      • location_latitude (num, —)

    • wartung (foo, —)
      • messer_zaehler (bool, —)

      • update (str, —)

      • update_start (bool, —)

      • update_auto (bool, —)

      • wintermodus (bool, —)

      • alm_config (foo, —)

      • bump_sensitivity (num, bump_sensitivity = 0 = normal / bump_sensitivity = 1 = hohe / bump_sensitivity = 2 = niedrig)

    • states_str (str, —)

    • weather_pics (str, —)

    • providers (str, —)

    • mowertype (str, —)

    • active_mode (num, —)
      • kalender (bool, —)

      • aus (bool, —)

      • smart (bool, —)

      • uzsu (num, —)
        • schaltuhr (dict, —)
          • active (bool, —)

        • calendar_list (dict, —)

    • show_uzsu_popup (bool, —)

    • update_active_mode (bool, —)

    • online (bool, —)

    • stateCode (num, —)

    • laststateCode (num, —)

    • state_str (str, —)

    • stateError (num, —)

    • config_change (bool, —)

    • mow_trig (bool, —)

    • stateLevel (num, —)

    • docked (bool, —)

    • moving (bool, —)

    • pause (bool, —)

    • help (bool, —)

    • mowedPercent (num, —)

    • mowedPercent_soll (num, —)

    • mapSvgCacheDate (foo, —)

    • mapUpdateAvailable (bool, —)

    • mowedDate (foo, —)

    • xPos (num, —)

    • yPos (num, —)

    • svg_xPos (num, —)

    • svg_yPos (num, —)

    • mowmode (num, —)

    • next_time (foo, —)

    • last_time (foo, —)

    • runtimeTotalOperationMins (num, —)
      • dhm (str, —)

    • runtimeTotalChargeMins (num, —)
      • dhm (str, —)

    • runtimeSessionOperationMins (num, —)

    • runtimeSessionChargeMins (num, —)

    • SMART (bool, —)

    • MOW (bool, —)

    • PAUSE (bool, —)

    • RETURN (bool, —)

    • alm_sn (num, —)

    • alm_name (str, —)

    • service_counter (num, —)
      • dhm (str, —)

    • needs_service (bool, —)

    • alm_mode (str, —)

    • alm_mode.str (str, —)

    • bareToolnumber (str, —)

    • alm_firmware_version (str, —)
      • before (str, —)

      • changed (foo, —)

    • calendar (dict, —)

    • calendar_list (dict, —)

    • calendar_sel_cal (num, —)

    • calendar_result (str, —)

    • calendar_save (bool, —)

    • calendar_predictive (dict, —)

    • calendar_predictive_list (dict, —)

    • calendar_predictive_sel_cal (num, —)

    • calendar_predictive_result (str, —)

    • calendar_predictive_save (bool, —)

    • weather (foo, —)
      • int_0 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_1 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_2 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_3 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_4 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_5 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_6 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_7 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_8 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_9 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_10 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_11 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_12 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_13 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_14 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_15 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_16 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_17 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_18 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_19 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_20 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_21 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_22 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_23 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_24 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_25 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_26 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • int_27 (foo, —)
        • wwsymbol_mg2008 (num, —)

        • dateTime (foo, —)

        • tt (num, —)

        • rrr (num, —)

        • prrr (num, —)

        • intervalLength (num, —)

        • picture (str, —)

      • day_0 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_1 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_2 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_3 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_4 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_5 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

      • day_6 (foo, —)
        • tx (num, —)

        • wochentag (str, —)

        • tn (num, —)

    • operatingInfo (foo, —)
      • hmiKeys (num, —)

      • garden (foo, OrderedDict([(‚type‘, ‚num‘), (‚cache‘, ‚on‘)]))
        • charge (num, —)

        • last_mow (num, —)

        • runtime (num, —)

        • id (num, —)

        • size (num, —)

        • inner_bounds (num, —)

        • name (num, —)

        • stops (num, —)

        • bumps (num, —)

        • cuts (num, —)

        • map_cell_size (num, —)

        • signal_id (num, —)

      • runtime (foo, —)
        • total (foo, —)
          • charge (num, —)

          • operate (num, —)

        • session (foo, —)
          • charge (num, —)

          • operate (num, —)

      • battery (foo, —)
        • voltage (num, —)

        • cycles (num, —)

        • battery_temp (num, —)

        • discharge (num, —)

        • percent (num, —)

        • ambient_temp (num, —)

    • network (foo, —)
      • mcc (num, —)

      • mnc (num, —)

      • rssi (num, —)

      • currMode (str, —)

      • configMode (str, —)

      • steeredRssi (num, —)

      • networkCount (num, —)

      • networks (list, —)

    • smartmowsetup (dict, —)

    • location (dict, —)
      • latitude (str, —)

      • longitude (str, —)

      • timezone (str, —)

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

send_command(payload= ‚{„state“:“mow“}‘, trigger= ‚Logic‘)

  • Ergebnistyp der Funktion: str

payload
  • Datentyp: str

  • Standardwert: {„state“:“mow“}

  • Mögliche Werte:

    • {„state“:“mow“}

    • {„state“:“pause“}

    • {„state“:“returnToDock“}

trigger
  • Datentyp: str

  • Standardwert: Logic