File: device_mixins.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 (55 lines) | stat: -rw-r--r-- 1,404 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
# Device Mixins

The `pyvesync.utils.device_mixins` modules are used to add boilerplate code for the common API requests that are used by different devices.

Please reference [Development](../index.md#vesync-apis) for more information on how to use the device mixins.

## Bypass V1 Mixins and functions

::: pyvesync.utils.device_mixins.BypassV1Mixin
    handler: python
    options:
      toc_label: "BypassV1Mixin Class"
      show_root_heading: true
      heading_level: 3
      show_source: true
      filters:
        - "!.*pid"
        - "!^__*"

::: pyvesync.utils.device_mixins.process_bypassv1_result
    handler: python
    options:
      group_by_category: true
      show_category_heading: true
      heading_level: 3
      show_root_heading: true
      show_source: true
      filters:
        - "!.*pid"
        - "!^__*"

## Bypass V2 Mixins and functions

::: pyvesync.utils.device_mixins.BypassV2Mixin
    handler: python
    options:
      toc_label: "BypassV2Mixin Class"
      show_root_heading: true
      heading_level: 3
      show_source: true
      filters:
        - "!.*pid"
        - "!^__*"

::: pyvesync.utils.device_mixins.process_bypassv2_result
    handler: python
    options:
      group_by_category: true
      show_category_heading: true
      heading_level: 3
      show_root_heading: true
      show_source: true
      filters:
        - "!.*pid"
        - "!^__*"