Plugin ‚deebot_ozmo‘ Konfiguration

plugin logo

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

ACHTUNG: Dieses Plugin ist als develop gekennzeichnet. Es kann daher sein, dass es noch nicht sämtliche Funktionen unterstützt oder noch fehlerhaft ist.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.5

Konfiguration

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

  • Datentyp: str

continent

  • Datentyp: str

country

  • Datentyp: str

device

  • Datentyp: str

  • Standardwert: NONE

interval

  • Datentyp: int

  • Standardwert: 60

password

  • Datentyp: str

Item Attribute

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

Keine

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.

components

Components lifespan item_structs

  • components (foo, Components lifespan item_structs)

    • brush (num, —)

    • sideBrush (num, —)

    • filter (num, —)

controls

Remote control items

  • controls (foo, Remote control items)

    • clean (bool, —)

    • pause (bool, —)

    • stop (bool, —)

    • charge (bool, —)

    • locate (bool, —)

general

General information

  • general (foo, General information)

    • nick (str, —)

    • did (str, —)

    • model (str, —)

    • icon_URL (str, —)

    • available (bool, —)

    • state (str, —)

    • state_text (str, —)

    • battery_level (num, —)

history

Logs

  • history (foo, Logs)

    • last_clean_logs (list, —)

maps

Maps and rooms

  • maps (foo, Maps and rooms)

    • live_map_base64 (str, —)

    • last_clean_map_URL (str, —)

    • rooms (list, —)

settings

Modifiable settings

  • settings (foo, Modifiable settings)

    • water_level (str, —)

    • water_level_text (str, —)

    • fan_speed (str, —)

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

charge()

  • Ergebnistyp der Funktion: bool

clean()

  • Ergebnistyp der Funktion: bool

clean_spot_area(area)

  • Ergebnistyp der Funktion: bool

area

  • Datentyp: num

locate()

  • Ergebnistyp der Funktion: bool

pause()

  • Ergebnistyp der Funktion: bool

resume()

  • Ergebnistyp der Funktion: bool

set_fan_speed(speed)

  • Ergebnistyp der Funktion: bool

speed

  • Datentyp: num

set_water_level(level)

  • Ergebnistyp der Funktion: bool

level

  • Datentyp: num