Skip to content

Roof Controller

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in src/roof_controller/__init__.pyi
41
42
43
44
45
46
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

get_all_caddy_element_ids()

Gets all caddy elements

Returns:

Type Description
List[int]

element ID list

Source code in src/roof_controller/__init__.pyi
24
25
26
27
28
29
def get_all_caddy_element_ids() -> List[int]:
    """Gets all caddy elements

    Returns:
        element ID list
    """

get_edge_length(element_id, edge_type)

Gets the edge length

Parameters:

Name Type Description Default
element_id int

element_id

required
edge_type str

edge_type

required

Returns:

Type Description
float

edge length

Source code in src/roof_controller/__init__.pyi
13
14
15
16
17
18
19
20
21
22
def get_edge_length(element_id: int, edge_type: str) -> float:
    """Gets the edge length

    Parameters:
        element_id: element_id
        edge_type: edge_type

    Returns:
        edge length
    """

get_last_error(a0)

get last error

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in src/roof_controller/__init__.pyi
31
32
33
34
35
36
37
38
39
def get_last_error(a0: int) -> str:
    """get last error

    Parameters:
        a0: a0

    Returns:
        str
    """

get_profile_length(element_id)

Gets the profile length

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
float

profile length

Source code in src/roof_controller/__init__.pyi
 3
 4
 5
 6
 7
 8
 9
10
11
def get_profile_length(element_id: int) -> float:
    """Gets the profile length

    Parameters:
        element_id: element_id

    Returns:
        profile length
    """