roto_plugin/plugin.yaml at develop · ivan73/roto_plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# Metadata for the Smart-Plugin
plugin:
    # Global plugin attributes
    type: interface                 # plugin type (gateway, interface, protocol, system, web)
    description:
        de: 'Steuerung ROTO- Dachfenster'
        en: 'control ROTO roof window'
    maintainer: 'ivande'
#    tester:                        # Who tests this plugin?
#    keywords: iot xyz
#    documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin        # url of documentation (wiki) page
#    support: https://knx-user-forum.de/forum/supportforen/smarthome-py

    version: 1.6.2                 # Plugin version
    sh_minversion: 1.8             # minimum shNG version to use this plugin
#    sh_maxversion:                 # maximum shNG version to use this plugin (leave empty if latest)
    multi_instance: False           # plugin supports multi instance
    classname: Roto          # class containing the plugin

parameters: NONE
    # Definition of parameters to be configured in etc/plugin.yaml

item_attributes:
    # Definition of item attributes defined by this plugin
    type:
        type: str
        valid_list:
          - 'bool'
        valid_list_description:
            de: ['Der Item Typ muss auf bool gestellt werden!']
            en: ['The item type has to be set to bool']
        description:
            de: 'Datentyp des Objekt-Items. Muss "bool" sein.'
            en: 'Data type of the object item. Has to be "bool"'
    roto_plugin:
        type: str
        mandatory: True
        valid_list:
          - 'active'
          - 'inactive'
        valid_list_description:
            de: ['Aktiviert das Plugin', 'Jeder andere Wert deaktiviert das Plugin']
            en: ['Activates the plugin', 'Any other value deactivates the plugin']
        description:
            de: 'Kennzeichnet das Item als Objekt-Item des Roto-Plugins. Ist der Wert nicht "active", werden keine Zustände evaluiert.'
            en: 'Makes the Roto-Plugin aware of this item as an object item. If the value is not "active", the state are not evaluated.'
    roto_actor_close:
        type: str
        description:
            de: 'Item welches das Plugin zum Zufahren beschreibt'
    roto_actor_open:
        type: str
        description:
            de: 'Item welches das Plugin zum Auffahren beschreibt'
    roto_position:
        type: str
        description:
            de: 'Fährt Position an, wenn das angegebene Item geschrieben wird'
    roto_up_down:
        type: str
        description:
            de: 'Fährt Auf oder Ab an, wenn das angegebene Item geschrieben wird'
    roto_stop:
        type: str
        description:
            de: 'Stoppt oder fährt Schritt, wenn das angegebene Item geschrieben wird'
    roto_time_down:
        type: num
        default: 60
        description:
            de: 'benötigte Zeit (Sekunden) zum Runterfahren'
    roto_time_up:
        type: num
        default: 60
        description:
            de: 'benötigte Zeit (Sekunden) zum Hochfahren'
    roto_time_step:
        type: num
        default: 5
        description:
            de: 'Zeit (Sekunden) wie lange ein Schritt gefahren wird'

plugin_functions: NONE
# Definition of plugin functions defined by this plugin

logic_parameters: NONE
    # Definition of logic parameters defined by this plugin

item_structs: NONE