Skip to content

Opener

Get all intercom brands.

GET /opener/brand

Returns:

Type Description
list[dict]

list[dict]: List of intercom brands with fields: - brandId (int) - brand (str)
Source code in nukiwebapi/opener.py 
 8
 9
10
11
12
13
14
15
16
17
18
def list_brands(self) -> list[dict]:
    """Get all intercom brands.

    GET /opener/brand

    Returns:
        list[dict]: List of intercom brands with fields:
            - brandId (int)
            - brand (str)
    """
    return self.client._request("GET", "/opener/brand")

Get a specific intercom brand.

GET /opener/brand/{brandId}

Parameters:

Name Type Description Default
brand_id int

The brand ID.

 required

Returns:

Name Type Description
dict dict

Brand object with fields: - brandId (int) - brand (str)
Source code in nukiwebapi/opener.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def get_brand(self, brand_id: int) -> dict:
    """Get a specific intercom brand.

    GET /opener/brand/{brandId}

    Args:
        brand_id (int): The brand ID.

    Returns:
        dict: Brand object with fields:
            - brandId (int)
            - brand (str)
    """
    return self.client._request("GET", f"/opener/brand/{brand_id}")

Get a list of intercom models.

GET /opener/intercom

Parameters:

Name Type Description Default
brand_id int

Filter for brandId. Required if recently_changed is not set.

 None
ignore_verified bool

If True, return intercoms ignoring their verified value.

 None
recently_changed bool

If True, return all intercoms which were recently updated.

 None

Returns:

Type Description
list[dict]

list[dict]: List of intercom objects with fields: - intercomId (int) - brandId (int) - type (int) - model (str) - verified (int) - conGndBus (str) - conBusAudio (str) - conAudioout (str) - conDoorbellPlus (str) - conDoorbellMinus (str) - conOpendoor (str) - conGndAnalogue (str) - busModeSwitch (int) - busModeSwitchShortCircuitDuration (int) - creationDate (str) - updateDate (str)
Source code in nukiwebapi/opener.py 
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
def list_intercoms(
    self,
    brand_id: int | None = None,
    ignore_verified: bool | None = None,
    recently_changed: bool | None = None,
) -> list[dict]:
    """Get a list of intercom models.

    GET /opener/intercom

    Args:
        brand_id (int, optional): Filter for brandId. Required if recently_changed is not set.
        ignore_verified (bool, optional): If True, return intercoms ignoring their verified value.
        recently_changed (bool, optional): If True, return all intercoms which were recently updated.

    Returns:
        list[dict]: List of intercom objects with fields:
            - intercomId (int)
            - brandId (int)
            - type (int)
            - model (str)
            - verified (int)
            - conGndBus (str)
            - conBusAudio (str)
            - conAudioout (str)
            - conDoorbellPlus (str)
            - conDoorbellMinus (str)
            - conOpendoor (str)
            - conGndAnalogue (str)
            - busModeSwitch (int)
            - busModeSwitchShortCircuitDuration (int)
            - creationDate (str)
            - updateDate (str)
    """
    params = {}
    if brand_id is not None:
        params["brandId"] = brand_id
    if ignore_verified is not None:
        params["ignoreVerified"] = ignore_verified
    if recently_changed is not None:
        params["recentlyChanged"] = recently_changed
    return self.client._request("GET", "/opener/intercom", params=params or None)

Get a specific intercom model.

GET /opener/intercom/{intercomId}

Parameters:

Name Type Description Default
intercom_id int

The intercom ID.

 required

Returns:

Name Type Description
dict dict

Intercom object with fields: - intercomId (int) - brandId (int) - type (int) - model (str) - verified (int) - conGndBus (str) - conBusAudio (str) - conAudioout (str) - conDoorbellPlus (str) - conDoorbellMinus (str) - conOpendoor (str) - conGndAnalogue (str) - busModeSwitch (int) - busModeSwitchShortCircuitDuration (int) - creationDate (str) - updateDate (str)
Source code in nukiwebapi/opener.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_intercom(self, intercom_id: int) -> dict:
    """Get a specific intercom model.

    GET /opener/intercom/{intercomId}

    Args:
        intercom_id (int): The intercom ID.

    Returns:
        dict: Intercom object with fields:
            - intercomId (int)
            - brandId (int)
            - type (int)
            - model (str)
            - verified (int)
            - conGndBus (str)
            - conBusAudio (str)
            - conAudioout (str)
            - conDoorbellPlus (str)
            - conDoorbellMinus (str)
            - conOpendoor (str)
            - conGndAnalogue (str)
            - busModeSwitch (int)
            - busModeSwitchShortCircuitDuration (int)
            - creationDate (str)
            - updateDate (str)
    """
    return self.client._request("GET", f"/opener/intercom/{intercom_id}")