hassio-bluetti-bt/custom_components/bluetti_bt/bluetti_bt_lib/field_attributes.py

"""Field attributes for device fields."""

from dataclasses import dataclass
from enum import Enum, auto, unique

from .field_enums import AutoSleepMode, OutputMode, SplitPhaseMachineType, UpsMode


@unique
class FieldType(Enum):
    NUMERIC = auto()
    BOOL = auto()
    ENUM = auto()
    BUTTON = auto()


@dataclass(frozen=True)
class FieldAttributes:
    type: FieldType
    setter: bool = False
    name: str
    unit_of_measurement: str|None = None
    device_class: str|None = None
    state_class: str|None = None
    options: Enum

@dataclass(frozen=True)
class PowerFieldAttributes(FieldAttributes):
    type = FieldType.NUMERIC
    unit_of_measurement = 'W'
    device_class = 'power'
    state_class = 'measurement'

@dataclass
class VoltageFieldAttributes(FieldAttributes):
    type = FieldType.NUMERIC
    unit_of_measurement = 'V'
    device_class = 'voltage'
    state_class = 'measurement'

@dataclass
class CurrentFieldAttributes(FieldAttributes):
    type = FieldType.NUMERIC
    unit_of_measurement = 'A'
    device_class = 'current'
    state_class = 'measurement'

@dataclass
class FrequencyFieldAttributes(FieldAttributes):
    type = FieldType.NUMERIC,
    unit_of_measurement = 'Hz',
    device_class = 'frequency',
    state_class ='measurement',

@dataclass(frozen=True)
class OutletFieldAttributes(FieldAttributes):
    type = FieldType.BOOL
    device_class = 'outlet'

FIELD_ATTRIBUTES = {
    # Base device fields
    'dc_input_power': PowerFieldAttributes(
        name = 'DC Input Power',
    ),
    'ac_input_power': PowerFieldAttributes(
        name = 'AC Input Power',
    ),
    'ac_output_power': PowerFieldAttributes(
        name = 'AC Output Power',
    ),
    'dc_output_power': PowerFieldAttributes(
        name = 'DC Output Power',
    ),
    'power_generation': FieldAttributes(
        type = FieldType.NUMERIC,
        name = 'Total Power Generation',
        unit_of_measurement = 'kWh',
        device_class = 'energy',
        state_class = 'total_increasing',
    ),
    'total_battery_percent': FieldAttributes(
        type = FieldType.NUMERIC,
        name = 'Total Battery Percent',
        unit_of_measurement = '%',
        device_class = 'battery',
        state_class ='measurement',
    ),
    'total_battery_voltage': VoltageFieldAttributes(
        name = 'Total Battery Voltage',
    ),
    'ac_output_on': OutletFieldAttributes(
        name = 'AC Output',
    ),
    'dc_output_on': OutletFieldAttributes(
        name = 'DC Output',
    ),

    # Controls
    'ac_output_on_switch': OutletFieldAttributes(
        name = 'AC Output',
        setter = True,
    ),
    'dc_output_on_switch': OutletFieldAttributes(
        name = 'DC Output',
        setter = True,
    ),

    # Device specific fields
    'ac_output_mode': FieldAttributes(
        type = FieldType.ENUM,
        name = 'AC Output Mode',
        options = OutputMode,
    ),
    'internal_ac_voltage': VoltageFieldAttributes(
        name = 'Internal AC Voltage',
    ),
    'internal_current_one': CurrentFieldAttributes(
        name = 'Internal Current Sensor 1',
    ),
    'internal_power_one': PowerFieldAttributes(
        name = 'Internal Power Sensor 1',
    ),
    'internal_ac_frequency': FrequencyFieldAttributes(
        name = 'Internal AC Frequency',
    ),
    'internal_current_two': CurrentFieldAttributes(
        name = 'Internal Current Sensor 2',
    ),
    'internal_power_two': PowerFieldAttributes(
        name = 'Internal Power Sensor 2',
    ),
    'ac_input_voltage': VoltageFieldAttributes(
        name = 'AC Input Voltage',
    ),
    'internal_current_three': CurrentFieldAttributes(
        name = 'Internal Current Sensor 3',
    ),
    'internal_power_three': PowerFieldAttributes(
        name = 'Internal Power Sensor 3',
    ),
    'ac_input_frequency': FrequencyFieldAttributes(
        name = 'AC Input Frequency',
    ),
    'internal_dc_input_voltage': VoltageFieldAttributes(
        name = 'Internal DC Input Voltage',
    ),
    'internal_dc_input_power': PowerFieldAttributes(
        name = 'Internal DC Input Power',
    ),
    'internal_dc_input_current': CurrentFieldAttributes(
        name = 'Internal DC Input Current',
    ),

    # Device specific controls
    'power_off': FieldAttributes(
        type = FieldType.BUTTON,
        setter = True,
        name = 'Power Off',
    ),
    'auto_sleep_mode': FieldAttributes(
        type = FieldType.ENUM,
        setter = True,
        name = 'Screen Auto Sleep Mode',
        options = AutoSleepMode,
    ),
    'ups_mode': FieldAttributes(
        type = FieldType.ENUM,
        setter = False, # Disabled for safety reasons
        name = 'UPS Working Mode',
        options = UpsMode,
    ),
    'split_phase_on': FieldAttributes(
        type = FieldType.BOOL,
        setter = False, # Disabled for safety reasons
        name = 'Split Phase',
    ),
    'split_phase_machine_mode': FieldAttributes(
        type = FieldType.ENUM,
        setter = False, # Disabled for safety reasons
        name = 'Split Phase Machine Type',
        options = SplitPhaseMachineType,
    ),
    'grid_charge_on': FieldAttributes(
        type = FieldType.BOOL,
        setter = False, # Disabled for safety reasons
        name = 'Grid Charge',
    ),
    'time_control_on': FieldAttributes(
        type = FieldType.BOOL,
        setter = False, # Disabled for safety reasons
        name = 'Time Control',
    ),
    'battery_range_start': FieldAttributes(
        type = FieldType.NUMERIC,
        setter = False, # Disabled
        name = 'Battery Range Start',
        unit_of_measurement = '%',
    ),
    'battery_range_end': FieldAttributes(
        type = FieldType.NUMERIC,
        setter = False, # Disabled
        name = 'Battery Range End',
        unit_of_measurement = '%',
    ),
}

def PACK_FIELD_ATTRIBUTES(pack: int):
    return {
        'pack_voltage': VoltageFieldAttributes(
            name = f'Battery Pack {pack} Voltage',
        ),
        'pack_battery_percent': FieldAttributes(
            type = FieldType.NUMERIC,
            name = f'Battery Pack {pack} Percent',
            unit_of_measurement = '%',
            device_class ='battery',
            state_class ='measurement',
        ),
        'pack_bms_version': FieldAttributes(
            type = FieldType.NUMERIC,
            name = f'Battery Pack {pack} BMS Version',
        ),
    }