Module ambianic.device

Base classes for an Ambianic Edge device abstraction

"""Base classes for an Ambianic Edge device abstraction"""
from pydantic import BaseModel, Field


class DeviceInfo(BaseModel):
    version: str = Field(None, description="Ambianic Edge software version.")
    display_name: str = Field(
        None, description="User friendly display name for this device."
    )
    notifications_enabled: bool = Field(
        False, description="Indicates whether device notifications are enabled."
    )

Classes

class DeviceInfo (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class DeviceInfo(BaseModel):
    version: str = Field(None, description="Ambianic Edge software version.")
    display_name: str = Field(
        None, description="User friendly display name for this device."
    )
    notifications_enabled: bool = Field(
        False, description="Indicates whether device notifications are enabled."
    )

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Subclasses

• StatusResponse

Class variables

var display_name : str

var notifications_enabled : bool

var version : str