File: switches.md

package info (click to toggle)
pyvesync 3.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,824 kB
  • sloc: python: 15,994; makefile: 3
file content (84 lines) | stat: -rw-r--r-- 2,590 bytes parent folder | download
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
# Documentation for Etekcity Smart Switches <!-- omit in toc -->

## Contents

<!-- markdownlint-disable MD051 -->

See each device class for available attributes and methods:

- [SwitchState Class](#pyvesync.base_devices.switch_base.SwitchState)
- [Etekcity Dimmer Switch EWD16](#pyvesync.devices.vesyncswitch.VeSyncDimmerSwitch)
- [Etekcity Wall Switch ESWL01 & ESWL03](#pyvesync.devices.vesyncswitch.VeSyncWallSwitch)
- [VeSyncSwitch Abstract Base Class](#pyvesync.base_devices.switch_base.VeSyncSwitch)

::: pyvesync.base_devices.switch_base.SwitchState
    options:
        toc_label: "SwitchState"
        filters:
            - "!^_.*"
        summary:
            functions: false
        group_by_category: true
        show_root_heading: true
        show_root_toc_entry: true
        show_category_heading: true
        show_source: true
        show_if_no_docstring: true
        inherited_members: true
        docstring_options:
            ignore_init_summary: true
        merge_init_into_class: true

::: pyvesync.devices.vesyncswitch.VeSyncWallSwitch
    options:
        toc_label: "VeSyncWall & 3-Way Switch"
        filters:
            - "!^_.*"
        summary:
            functions: false
        group_by_category: true
        show_root_heading: true
        show_root_toc_entry: true
        show_category_heading: true
        show_source: true
        show_if_no_docstring: true
        inherited_members: true
        docstring_options:
            ignore_init_summary: true
        merge_init_into_class: true

::: pyvesync.devices.vesyncswitch.VeSyncDimmerSwitch
    options:
        toc_label: "Etekcity Dimmer Switch"
        filters:
            - "!^_.*"
        summary:
            functions: false
        group_by_category: true
        show_root_heading: true
        show_root_toc_entry: true
        show_category_heading: true
        show_source: true
        show_if_no_docstring: true
        inherited_members: true
        docstring_options:
            ignore_init_summary: true
        merge_init_into_class: true

::: pyvesync.base_devices.switch_base.VeSyncSwitch
    options:
        toc_label: "VeSyncSwitch Base Device"
        filters:
            - "!^_.*"
        summary:
            functions: false
        group_by_category: true
        show_root_heading: true
        show_root_toc_entry: true
        show_category_heading: true
        show_source: true
        show_if_no_docstring: true
        inherited_members: true
        docstring_options:
            ignore_init_summary: true
        merge_init_into_class: true