Skip to content

Client Settings

Module: s2auth.client.settings

CommunicationProtocol

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_common.py 
17
18
class CommunicationProtocol(str, Enum):
    WebSocket = "WebSocket"

Deployment

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_common.py 
44
45
46
class Deployment(str, Enum):
    WAN = "WAN"
    LAN = "LAN"

Role

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_common.py 
39
40
41
class Role(str, Enum):
    CEM = "CEM"
    RM = "RM"

HmacHashingAlgorithm

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_pairing.py 
58
59
class HmacHashingAlgorithm(str, Enum):
    SHA256 = "SHA256"

ClientSettings

Bases: BaseSettings

Settings for the high-level S2 pairing client API.

Values can be provided directly or loaded from environment variables/.env files.

Source code in src/s2auth/client/settings.py 
 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
class ClientSettings(BaseSettings):
    """Settings for the high-level S2 pairing client API.

    Values can be provided directly or loaded from environment variables/.env files.
    """

    model_config = SettingsConfigDict(
        env_file=[".env", ".env.docker"],
        extra="ignore",
        env_nested_delimiter="__",
    )

    server_url: str = "http://localhost"
    pairing_token: str | None = None
    pairing_s2_node_id: str | None = None
    client_s2_node_id: str | None = None

    client_role: Role = Role.RM
    client_deployment: Deployment | None = None
    domain_name: str | None = None

    verify_tls: bool = True
    ssl_certfile: str | None = Field(default=None)
    storage_db_url: str = "sqlite:///connection_details.db"

    supported_s2_versions: list[str] = Field(default_factory=lambda: ["v1"])
    supported_communication_protocols: list[CommunicationProtocol] = Field(
        default_factory=lambda: [CommunicationProtocol.WebSocket]
    )
    supported_hmac_hashing_algorithms: list[HmacHashingAlgorithm] = Field(
        default_factory=lambda: [HmacHashingAlgorithm.SHA256]
    )

    cleint_brand: str = "ExampleHeatCo"
    client_device_type: str = "Heatpump"
    client_model_name: str = "SmartHeatPump X200"