Plugin ‚avm‘ Konfiguration

plugin logo

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

Konfiguration

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

avm_home_automation

  • Datentyp: bool

  • Standardwert: False

call_monitor

  • Datentyp: bool

  • Standardwert: False

call_monitor_incoming_filter

  • Datentyp: str

cycle

  • Datentyp: int

  • Standardwert: 300

host

  • Datentyp: str

log_entry_count

  • Datentyp: int

  • Standardwert: 200

password

  • Datentyp: str

port

  • Datentyp: int

  • Standardwert: 49443

ssl

  • Datentyp: bool

  • Standardwert: True

tr064_item_blacklist

  • Datentyp: bool

  • Standardwert: False

username

  • Datentyp: str

verify

  • Datentyp: bool

  • Standardwert: False

Item Attribute

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

avm_ain

  • Datentyp: str

avm_data_cycle

  • Datentyp: int

avm_data_type

  • Datentyp: str

  • Mögliche Werte:

    • uptime

    • serial_number

    • software_version

    • hardware_version

    • manufacturer

    • product_class

    • manufacturer_oui

    • model_name

    • description

    • device_log

    • security_port

    • reboot

    • myfritz_status

    • call_direction

    • call_event

    • monitor_trigger

    • is_call_incoming

    • last_caller_incoming

    • last_call_date_incoming

    • call_event_incoming

    • last_number_incoming

    • last_called_number_incoming

    • is_call_outgoing

    • last_caller_outgoing

    • last_call_date_outgoing

    • call_event_outgoing

    • last_number_outgoing

    • last_called_number_outgoing

    • call_duration_incoming

    • call_duration_outgoing

    • tam

    • tam_name

    • tam_new_message_number

    • tam_old_message_number

    • tam_total_message_number

    • wan_connection_status

    • wan_connection_error

    • wan_is_connected

    • wan_uptime

    • wan_ip

    • wan_upstream

    • wan_downstream

    • wan_total_packets_sent

    • wan_total_packets_received

    • wan_current_packets_sent

    • wan_current_packets_received

    • wan_total_bytes_sent

    • wan_total_bytes_received

    • wan_current_bytes_sent

    • wan_current_bytes_received

    • wan_link

    • wlanconfig

    • wlanconfig_ssid

    • wlan_guest_time_remaining

    • wlan_associates

    • wps_active

    • wps_status

    • wps_mode

    • wlan_total_associates

    • hosts_count

    • hosts_info

    • mesh_topology

    • number_of_hosts

    • hosts_url

    • mesh_url

    • network_device

    • device_ip

    • device_connection_type

    • device_hostname

    • connection_status

    • is_host_active

    • host_info

    • number_of_deflections

    • deflections_details

    • deflection_details

    • deflection_enable

    • deflection_type

    • deflection_number

    • deflection_to_number

    • deflection_mode

    • deflection_outgoing

    • deflection_phonebook_id

    • aha_device

    • hkr_device

    • set_temperature

    • temperature

    • set_temperature_reduced

    • set_temperature_comfort

    • firmware_version

    • device_id

    • manufacturer

    • product_name

    • fw_version

    • connected

    • device_name

    • tx_busy

    • device_functions

    • set_target_temperature

    • target_temperature

    • current_temperature

    • temperature_reduced

    • temperature_comfort

    • temperature_offset

    • set_window_open

    • window_open

    • windowopenactiveendtime

    • set_hkr_boost

    • hkr_boost

    • boost_active

    • boostactiveendtime

    • summer_active

    • holiday_active

    • battery_low

    • battery_level

    • lock

    • device_lock

    • errorcode

    • set_simpleonoff

    • simpleonoff

    • set_level

    • level

    • set_levelpercentage

    • levelpercentage

    • set_hue

    • hue

    • set_saturation

    • saturation

    • set_colortemperature

    • colortemperature

    • unmapped_hue

    • unmapped_saturation

    • color

    • hsv

    • color_mode

    • supported_color_mode

    • fullcolorsupport

    • mapped

    • switch_state

    • switch_mode

    • switch_toggle

    • power

    • energy

    • voltage

    • humidity

    • alert_state

    • blind_mode

    • endpositionsset

    • statistics_temp

    • statistics_hum

    • statistics_voltage

    • statistics_power

    • statistics_energy

avm_deflection_index

  • Datentyp: int

  • Minimalwert: 1

  • Maximalwert: 32

avm_incoming_allowed

  • Datentyp: str

avm_mac

  • Datentyp: mac

avm_read_after_write

  • Datentyp: int

avm_tam_index

  • Datentyp: int

  • Minimalwert: 1

  • Maximalwert: 5

avm_target_number

  • Datentyp: str

avm_wlan_index

  • Datentyp: int

  • Minimalwert: 1

  • Maximalwert: 3

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.

aha_alert

  • aha_alert (foo, —)

    • state (bool, —)

aha_blind

  • aha_blind (foo, —)

    • blind_mode (str, —)

    • endpositionsset (bool, —)

aha_button

  • aha_button (foo, —)

    • battery_low (bool, —)

    • battery_level (num, —)

aha_color

  • aha_color (foo, —)

    • color_mode (num, —)

    • supported_color_mode (num, —)

    • fullcolorsupport (bool, —)

    • mapped (bool, —)

    • hue (num, —)

    • saturation (num, —)

    • unmapped_hue (bool, —)

    • unmapped_saturation (bool, —)

    • colortemperature (num, —)

aha_general

  • aha_general (foo, OrderedDict([(‚type‘, ‚str‘), (‚avm_data_type@instance‘, ‚device_name‘), (‚avm_data_cycle@instance‘, 0)]))

    • name (str, —)

    • identifier (str, —)

    • productname (str, —)

    • manufacturer (str, —)

    • firmware_version (str, —)

    • present (bool, —)

    • functions (list, —)

aha_humidity_sensor

  • aha_humidity_sensor (foo, —)

    • humidity (num, —)

aha_level

  • aha_level (foo, —)

    • level (num, —)

    • level_percentage (num, —)

aha_on_off

  • aha_on_off (foo, —)

    • on_off (bool, —)

aha_powermeter

  • aha_powermeter (foo, —)

    • power (num, —)

    • energy (num, —)

    • voltage (num, —)

aha_switch

  • aha_switch (foo, —)

    • switch_state (bool, —)

    • switch_mode (str, —)

    • switch_toggle (bool, —)

aha_temperature_sensor

  • aha_temperature_sensor (foo, —)

    • current_temperature (num, —)

    • temperature_offset (num, —)

aha_thermostat

  • aha_thermostat (foo, —)

    • target_temperature (num, —)

    • comfort_temperature (num, —)

    • eco_temperature (num, —)

    • battery_low (bool, —)

    • battery_level (num, —)

    • window_open (bool, —)

    • windowopenactiveendtime (num, —)

    • summer_active (bool, —)

    • holiday_active (bool, —)

    • errorcode (num, —)

    • hkr_boost (bool, —)

    • boostactiveendtime (num, —)

    • lock (bool, —)

    • device_lock (bool, —)

deflection

  • deflection (bool, —)

    • deflection_type (str, —)

    • deflection_number (str, —)

    • deflection_to_number (str, —)

    • deflection_mode (str, —)

    • deflection_outgoing (str, —)

    • deflection_phonebook_id (num, —)

device

  • device (bool, —)

    • ip (str, —)

    • connection_type (str, —)

    • hostname (str, —)

info

  • info (foo, —)

    • uptime (num, —)

    • serial_number (str, —)

    • firmware (str, —)

    • hardware_version (str, —)

    • myfritz (bool, —)

monitor

  • monitor (foo, —)

    • trigger (bool, —)

    • incoming (foo, —)

      • is_call_incoming (bool, —)

      • duration (num, —)

      • last_caller (str, —)

      • last_calling_number (str, —)

      • last_called_number (str, —)

      • last_call_date (str, —)

      • event (str, —)

    • outgoing (foo, —)

      • is_call_outgoing (bool, —)

      • duration (num, —)

      • last_caller (str, —)

      • last_calling_number (str, —)

      • last_called_number (str, —)

      • last_call_date (str, —)

      • event (str, —)

    • newest (foo, —)

      • direction (str, —)

      • event (str, —)

tam

  • tam (bool, OrderedDict([(‚type‘, ‚str‘), (‚visu_acl‘, ‚ro‘), (‚avm_data_type@instance‘, ‚tam_name‘)]))

    • name (str, —)

    • message_number_old (num, —)

    • message_number_new (num, —)

    • message_number_total (num, —)

wan

  • wan (foo, —)

    • connection_status (str, —)

    • connection_error (str, —)

    • is_connected (bool, —)

    • uptime (num, —)

    • upstream (num, —)

    • downstream (num, —)

    • total_packets_sent (num, —)

    • total_packets_received (num, —)

    • total_bytes_sent (num, —)

    • total_bytes_received (num, —)

    • current_bytes_sent (num, —)

    • current_bytes_receive (num, —)

    • link (bool, —)

    • reconnect (bool, —)

wlan

  • wlan (foo, —)

    • wlan_1 (bool, —)

    • wlan_1_ssid (str, —)

    • wlan_1_associates (num, —)

    • wlan_2 (bool, —)

    • wlan_2_ssid (str, —)

    • wlan_2_associates (num, —)

    • wlan_gast (bool, —)

    • wlan_gast_ssid (str, —)

    • wlan_gast_associates (num, —)

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

cancel_call()

  • Die Funktion liefert kein Ergebnis

get_call_origin()

  • Ergebnistyp der Funktion: str

get_calllist(filter_incoming= ‚‘, phonebook_id=0)

  • Ergebnistyp der Funktion: list(dict(str))

filter_incoming

  • Datentyp: str

phonebook_id

  • Datentyp: int

  • Standardwert: 0

get_contact_name_by_phone_number(phone_number, phonebook_id=0)

  • Ergebnistyp der Funktion: str

phone_number

  • Datentyp: str

phonebook_id

  • Datentyp: int

  • Standardwert: 0

get_deflection(deflection_id)

  • Ergebnistyp der Funktion: bool

deflection_id

  • Datentyp: int

get_deflections()

  • Ergebnistyp der Funktion: bool

get_device_log_from_lua()

  • Ergebnistyp der Funktion: list(list(str))

get_device_log_from_tr064()

  • Ergebnistyp der Funktion: list(str)

get_host_details(index)

  • Ergebnistyp der Funktion: dict(str)

index

  • Datentyp: int

get_hosts(only_active)

  • Ergebnistyp der Funktion: list(dict(str))

only_active

  • Datentyp: bool

get_hosts_dict(only_active)

  • Ergebnistyp der Funktion: dict

only_active

  • Datentyp: bool

get_hosts_list(identifier_list, filter_dict)

  • Ergebnistyp der Funktion: list(dict)

identifier_list

  • Datentyp: list

filter_dict

  • Datentyp: dict

get_mesh_topology()

  • Ergebnistyp der Funktion: dict

get_number_of_deflections()

  • Ergebnistyp der Funktion: bool

get_phone_name(index)

  • Ergebnistyp der Funktion: str

index

  • Datentyp: int

get_phone_numbers_by_name(name, phonebook_id=0)

  • Ergebnistyp der Funktion: dict(dict(str))

name

  • Datentyp: str

phonebook_id

  • Datentyp: int

  • Standardwert: 0

is_host_active(mac_address)

  • Ergebnistyp der Funktion: bool

mac_address

  • Datentyp: mac

reboot()

  • Die Funktion liefert kein Ergebnis

reconnect()

  • Die Funktion liefert kein Ergebnis

set_call_origin(phone_name)

  • Die Funktion liefert kein Ergebnis

phone_name

  • Datentyp: mac

set_deflection_enable(deflection_id, enable)

  • Ergebnistyp der Funktion: bool

deflection_id

  • Datentyp: int

enable

  • Datentyp: bool

start_call(phone_number)

  • Die Funktion liefert kein Ergebnis

phone_number

  • Datentyp: str

wol(mac_address)

  • Die Funktion liefert kein Ergebnis

mac_address

  • Datentyp: mac