Plugin ‚neato‘ Konfiguration

plugin logo

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

Konfiguration

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

account_email

  • Datentyp: str

account_pass

  • Datentyp: str

robot_vendor

  • Datentyp: str

  • Standardwert: neato

  • Mögliche Werte:

    • neato

    • vorwerk

token

  • Datentyp: str

Item Attribute

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

neato_attribute

  • Datentyp: str

  • Mögliche Werte:

    • name

    • command

    • state

    • alert

    • state_action

    • is_docked

    • is_schedule_enabled

    • is_charging

    • charge_percentage

    • message

    • command_goToBaseAvailable

    • command_startAvailable

    • clean_room

    • online_status

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.

Alert

  • Alert (str, —)

ChargePercentage

  • ChargePercentage (num, —)

Command

  • Command (num, —)

GoToBaseAvailable

  • GoToBaseAvailable (bool, —)

IsCharging

  • IsCharging (bool, —)

IsDocked

  • IsDocked (bool, —)

IsScheduleEnabled

  • IsScheduleEnabled (bool, —)

Neato

  • Neato (str, —)

State

  • State (str, —)

StateAction

  • StateAction (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.

disable_schedule()

  • Ergebnistyp der Funktion: bool

dismiss_current_alert()

  • Ergebnistyp der Funktion: bool

enable_schedule()

  • Ergebnistyp der Funktion: bool

get_map_boundaries(map_id)

  • Ergebnistyp der Funktion: bool

map_id

  • Datentyp: str

start_robot(boundary_id, map_id)

  • Ergebnistyp der Funktion: bool

boundary_id

  • Datentyp: str

map_id

  • Datentyp: str