Plugin ‚robonect‘ Konfiguration

plugin type logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin robonect 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 interface Plugin.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.6

Konfiguration

Im folgenden ist beschrieben, wie das Plugin robonect 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: 60

ip

  • Datentyp: ip

mode

  • Datentyp: str

  • Standardwert: api

  • Mögliche Werte:

    • api

    • mqtt

password

  • Datentyp: str

topic_prefix

  • Datentyp: str

  • Standardwert: Robonect

user

  • Datentyp: str

Item Attribute

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

robonect_battery_index

  • Datentyp: num

robonect_data_type

  • Datentyp: str

  • Mögliche Werte:

    • control

    • control/mode

    • device/name

    • robonect_id

    • robonect_version

    • robonect_version_comment

    • robonect_version_compiled

    • device/serial

    • hardware_serial

    • production_date

    • msw_title

    • msw_version

    • msw_compiled

    • wlan_at-version

    • wlan_sdk-version

    • remotestart_name

    • remotestart_visible

    • remotestart_path

    • remotestart_proportion

    • remotestart_distance

    • mower/status

    • mower/status/text

    • status_text_translated

    • mower/distance

    • mower/stopped

    • mower/status/duration

    • mower/mode

    • mower/mode/text

    • mode_text_translated

    • mower/battery/charge

    • mower/statistic/hours

    • blades_quality

    • blades_hours

    • blades_days

    • mower/error/code

    • mower/error/message

    • error_date

    • error_time

    • error_unix

    • wlan/rssi

    • health/climate/temperature

    • health/climate/humidity

    • date

    • time

    • unix

    • battery_id

    • battery_charge

    • battery_voltage

    • battery_current

    • battery_temperature

    • battery_capacity_full

    • battery_capacity_remaining

    • motor_drive_left_power

    • motor_drive_left_speed

    • motor_drive_left_current

    • motor_drive_right_power

    • motor_drive_right_speed

    • motor_drive_right_current

    • motor_blade_speed

    • motor_blade_current

    • motor_blade_average

    • weather_location_zip

    • weather_location_country

    • weather_rain

    • weather_temperature

    • weather_humidity

    • weather_sunrise

    • weather_sunset

    • weather_day

    • weather_icon

    • weather_condition_toorainy

    • weather_condition_toocold

    • weather_condition_toowarm

    • weather_condition_toodry

    • weather_condition_toowet

    • weather_condition_day

    • weather_condition_night

    • weather_date

    • weather_time

    • weather_unix

robonect_remote_index

  • Datentyp: num

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.

batteries

  • batteries (foo, —)

    • battery_0_id (num, —)

    • battery_0_charge (num, —)

    • battery_0_voltage (num, —)

    • battery_0_current (num, —)

    • battery_0_temperature (num, Battery Temperature in °C)

    • battery_0_capacity_full (num, —)

    • battery_0_capacity_remaining (num, —)

main

Main Data From Robonect HX Module

  • main (foo, Main Data From Robonect HX Module)

    • robonect_name (str, Lawnmower Nickname)

    • robonect_id (str, Robonect ID)

    • robonect_version (str, Firmware Version of the Robonect Module)

    • robonect_version_comment (str, Firmware Version Comment (e.g. Sub Version) of the Robonect Module)

    • robonect_version_compiled (str, Firmware Compilation Date of the Robonect Module)

    • robonect_serial (str, Serial Number of the Robonect Module)

    • mower (foo, Information About the Hardware and Software of the Mower)
      • hardware (foo, —)

        • serial (str, Serial of the Robotic Lawnmower)

        • production_date (str, Production Date of the Robotic Lawnmower)

      • msw (foo, —)

        • title (str, Model Name of the Automower)

        • version (str, Firmware Version of the Automower)

        • compiled (str, Firmware Compilation Date of the Automower)

      • wlan (foo, —)

        • at-version (str, —)

        • sdk-version (str, —)

    • remote (foo, —)
      • remotestart_1 (foo, OrderedDict([(‚type‘, ‚str‘), (‚robonect_data_type‘, ‚remotestart_name‘), (‚robonect_remote_index‘, 1)]))

        • name (str, —)

        • visible (bool, —)

        • rstart_path (num, —)

        • proportion (num, —)

        • distance (num, —)

      • remotestart_2 (foo, OrderedDict([(‚type‘, ‚str‘), (‚robonect_data_type‘, ‚remotestart_name‘), (‚robonect_remote_index‘, 2)]))

        • name (str, —)

        • visible (bool, —)

        • rstart_path (num, —)

        • proportion (num, —)

        • distance (num, —)

    • control (str, Control of the Mower)

      • mode (str, Control Mode of the Mower)

    • status (num, Status Code)
      • text (str, Status of the Mower as Text)

        • translated (str, Status of the Mower as Translated Text)

      • distance (num, —)

      • stopped (bool, —)

      • duration (num, Duration of Mode in Minutes)

      • mode (num, Mode of the Mower)
        • text (str, Mode of the Mower as Text)

          • translated (str, Status of the Mower as Translated Text)

      • battery (num, Battery Level in %)

      • hours (num, —)

      • blades (foo, —)

        • quality (num, Quality of Blades in %)

        • hours (num, Runtime of Blades in hours)

        • days (num, Age of Blades in days)

      • error (foo, —)

        • error_code (num, —)

        • error_message (str, —)

        • date (str, —)

        • time (str, —)

        • unix (num, —)

    • wlan (foo, —)

      • signal (num, Wifi Signal Strength)

    • health (foo, —)

      • temperature (num, Internal Temperature)

      • humidity (num, Internal Humidity)

    • clock (foo, —)

      • date (str, —)

      • time (str, —)

      • unix (num, —)

motor

  • motor (foo, —)
    • drive (foo, —)
      • left (foo, —)

        • power (num, —)

        • speed (num, —)

        • current (num, —)

      • right (foo, —)

        • power (num, —)

        • speed (num, —)

        • current (num, —)

    • blade (foo, —)

      • speed (num, —)

      • current (num, —)

      • average (num, —)

weather

  • weather (foo, —)
    • location (foo, —)

      • zip (str, —)

      • country (str, —)

    • weather_data (foo, —)

      • rain (num, —)

      • temperature (num, —)

      • humidity (num, —)

      • sunrise (num, —)

      • sunset (num, —)

      • day (bool, —)

      • icon (str, —)

    • weather_condition (foo, —)

      • toorainy (bool, —)

      • toocold (bool, —)

      • toowarm (bool, —)

      • toodry (bool, —)

      • toowet (bool, —)

      • day (bool, —)

      • night (bool, —)

    • weather_timestamp (foo, —)

      • date (str, —)

      • time (str, —)

      • unix (num, —)

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.

get_mode()

  • Ergebnistyp der Funktion: int

get_mode_as_text(mode)

  • Ergebnistyp der Funktion: str

mode

  • Datentyp: int

  • Mögliche Werte:

    • 1

    • 2

    • 3

    • 4

get_status()

  • Ergebnistyp der Funktion: int

get_status_as_text(status)

  • Ergebnistyp der Funktion: str

status

  • Datentyp: int

is_mower_offline()

  • Ergebnistyp der Funktion: bool

set_mode_via_api(mode, remotestart, after, start, end, duration)

  • Ergebnistyp der Funktion: foo

mode

  • Datentyp: str

  • Mögliche Werte:

    • home

    • eod

    • man

    • auto

    • job

remotestart

  • Datentyp: int

  • Mögliche Werte:

    • 0

    • 1

    • 2

after

  • Datentyp: str

  • Mögliche Werte:

    • 1

    • 2

    • 3

    • 4

    • home

    • eod

    • man

    • auto

    • job

start

  • Datentyp: str

end

  • Datentyp: str

duration

  • Datentyp: int

set_name_via_api(name)

  • Ergebnistyp der Funktion: foo

name

  • Datentyp: str

set_remote_via_api(index, name, distance, visible, proportion)

  • Ergebnistyp der Funktion: foo

index

  • Datentyp: int

name

  • Datentyp: str

distance

  • Datentyp: int

visible

  • Datentyp: bool

proportion

  • Datentyp: int

set_timer_via_api(index, enabled, start, end, mo, tu, we, th, fr, sa, su)

  • Ergebnistyp der Funktion: foo

index

  • Datentyp: int

enabled

  • Datentyp: bool

start

  • Datentyp: str

end

  • Datentyp: str

mo

  • Datentyp: bool

tu

  • Datentyp: bool

we

  • Datentyp: bool

th

  • Datentyp: bool

fr

  • Datentyp: bool

sa

  • Datentyp: bool

su

  • Datentyp: bool

start_mower_via_api()

  • Ergebnistyp der Funktion: foo

stop_mower_via_api()

  • Ergebnistyp der Funktion: foo