File: vesync_device_base.md

package info (click to toggle)
pyvesync 3.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,832 kB
  • sloc: python: 16,169; makefile: 3
file content (59 lines) | stat: -rw-r--r-- 1,686 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
# Documentation for Base Devices

This is the base device inherited by all device classes. This should *NOT* be instantiated directly.

All methods and attributes are available on all devices.

::: pyvesync.base_devices.vesyncbasedevice.VeSyncBaseToggleDevice
    handler: python
    options:
      group_by_category: true
      show_category_heading: true
      show_root_full_path: false
      show_root_heading: true
      show_source: true
      merge_init_into_class: true
      show_if_no_docstring: true
      show_signature_annotations: true
      inherited_members: true
      docstring_options:
            ignore_init_summary: true
      filters:
        - "!.*pid"
        - "!^__*"
        - "!displayJSON"

::: pyvesync.base_devices.vesyncbasedevice.VeSyncBaseDevice
    handler: python
    options:
      group_by_category: true
      show_category_heading: true
      show_root_full_path: false
      show_root_heading: true
      show_source: true
      show_signature_annotations: true
      merge_init_into_class: true
      show_if_no_docstring: true
      show_signature_annotations: true
      docstring_options:
        ignore_init_summary: false
      filters:
        - "!^__*"
        - "!displayJSON"

::: pyvesync.base_devices.vesyncbasedevice.DeviceState
    handler: python
    options:
      group_by_category: true
      show_root_full_path: false
      show_category_heading: true
      show_root_heading: true
      show_source: true
      merge_init_into_class: true
      show_if_no_docstring: true
      show_signature_annotations: true
      docstring_options:
        ignore_init_summary: false
      filters:
        - "!.*pid"
        - "!^__*"