Plugin ‚roomba‘ Konfiguration

plugin type logo

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

Konfiguration

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

  • Minimalwert: 0

socket_addr

  • Datentyp: str

socket_port

  • Datentyp: int

  • Standardwert: 0

socket_type

  • Datentyp: str

  • Standardwert: bt

  • Mögliche Werte:

    • bt

    • tcp

Item Attribute

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

roomba_cmd

  • Datentyp: list(str)

roomba_get

  • Datentyp: str

  • Mögliche Werte:

    • current

    • temperature

    • voltage

    • buttons_clean

    • capacity

    • charge

    • angle

    • distance

    • buttons_max

    • buttons_clean

    • buttons_spot

    • buttons_power

    • remote_opcode

    • dirt_detect_right

    • dirt_detect_left

    • motor_overcurrent_side_brush

    • motor_overcurrent_vacuum

    • motor_overcurrent_main_brush

    • motor_overcurrent_drive_left

    • virtual_wall

    • cliff_right

    • cliff_front_right

    • cliff_front_left

    • cliff_left

    • wall

    • bumps_wheeldrops_bump_right

    • bumps_wheeldrops_bump_left

    • bumps_wheeldrops_wheeldrop_right

    • bumps_wheeldrops_wheeldrop_left

roomba_raw

  • Datentyp: list(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.

commands

  • commands (foo, —)

    • clean (bool, clean)

    • dock (bool, dock)

    • power_off (bool, power_off)

    • spot (bool, spot)

    • max (bool, max)

sensors

  • sensors (foo, —)

    • current (num, —)

    • temperature (num, —)

    • voltage (num, —)

    • button_clean (bool, —)

    • capacity (num, —)

    • charge (num, —)

    • angle (num, —)

    • distance (num, —)

    • buttons_max (bool, —)

    • buttons_clean (bool, —)

    • buttons_spot (bool, —)

    • buttons_power (bool, —)

    • remote_opcode (num, —)

    • dirt_detect_right (bool, —)

    • dirt_detect_left (bool, —)

    • motor_overcurrent_side_brush (bool, —)

    • motor_overcurrent_vacuum (bool, —)

    • motor_overcurrent_main_brush (bool, —)

    • motor_overcurrent_drive_left (bool, —)

    • virtual_wall (bool, —)

    • cliff_right (bool, —)

    • cliff_front_right (bool, —)

    • cliff_front_left (bool, —)

    • cliff_left (bool, —)

    • wall (bool, —)

    • bumps_wheeldrops_bump_right (bool, —)

    • bumps_wheeldrops_bump_left (bool, —)

    • bumps_wheeldrops_wheeldrop_right (bool, —)

    • bumps_wheeldrops_wheeldrop_left (bool, —)

    • bumps_wheeldrops_wheeldrop_caster (bool, —)

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.

Keine